Split role application to a module like Moose
[gitmo/Mouse.git] / lib / Mouse / Meta / TypeConstraint.pm
index 13b4495..7817b15 100644 (file)
 package Mouse::Meta::TypeConstraint;
-use strict;
-use warnings;
+use Mouse::Util qw(:meta); # enables strict and warnings
+use Scalar::Util ();
 
-use overload '""'     => sub { shift->{name} },   # stringify to tc name
-             fallback => 1;
+sub new {
+    my $class = shift;
+    my %args  = @_ == 1 ? %{$_[0]} : @_;
 
-use Carp ();
+    $args{name} = '__ANON__' if !defined $args{name};
 
-use Mouse::Util qw(:meta);
+    my $check = delete $args{optimized};
 
-sub new {
-    my $class = shift;
-    my %args = @_;
-    my $name = $args{name} || '__ANON__';
+    if($check){
+        $args{hand_optimized_type_constraint} = $check;
+        $args{compiled_type_constraint}       = $check;
+    }
 
-    my $check = $args{_compiled_type_constraint} or Carp::croak("missing _compiled_type_constraint");
-    if (ref $check eq 'Mouse::Meta::TypeConstraint') {
-        $check = $check->{_compiled_type_constraint};
+    $check = $args{constraint};
+
+    if(defined($check) && ref($check) ne 'CODE'){
+        $class->throw_error(
+            "Constraint for $args{name} is not a CODE reference");
     }
 
-    bless +{
-        name                      => $name,
-        _compiled_type_constraint => $check,
-        message                   => $args{message}
-    }, $class;
-}
+    my $self = bless \%args, $class;
+    $self->compile_type_constraint()
+        if !$self->{hand_optimized_type_constraint};
 
-sub name { shift->{name} }
+    $self->_compile_union_type_coercion() if $self->{type_constraints};
+    return $self;
+}
 
-sub check {
+sub create_child_type{
     my $self = shift;
-    $self->{_compiled_type_constraint}->(@_);
+    return ref($self)->new(
+        # a child inherits its parent's attributes
+        %{$self},
+
+        # but does not inherit 'compiled_type_constraint'
+        # and 'hand_optimized_type_constraint'
+        compiled_type_constraint       => undef,
+        hand_optimized_type_constraint => undef,
+
+        # and is given child-specific args, of course.
+        @_,
+
+        # and its parent
+        parent => $self,
+   );
 }
 
-sub validate {
-    my ($self, $value) = @_;
-    if ($self->{_compiled_type_constraint}->($value)) {
-        return undef;
+sub name;
+sub parent;
+sub message;
+sub has_coercion;
+
+sub check;
+
+sub type_parameter;
+sub __is_parameterized;
+
+sub _compiled_type_constraint;
+sub _compiled_type_coercion;
+
+sub compile_type_constraint;
+
+
+sub _add_type_coercions { # ($self, @pairs)
+    my $self = shift;
+
+    my $coercions = ($self->{coercion_map} ||= []);
+    my %has       = map{ $_->[0] => undef } @{$coercions};
+
+    for(my $i = 0; $i < @_; $i++){
+        my $from   = $_[  $i];
+        my $action = $_[++$i];
+
+        if(exists $has{$from}){
+            $self->throw_error("A coercion action already exists for '$from'");
+        }
+
+        my $type = Mouse::Util::TypeConstraints::find_or_parse_type_constraint($from)
+            or $self->throw_error(
+                "Could not find the type constraint ($from) to coerce from");
+
+        push @{$coercions}, [ $type => $action ];
     }
-    else {
-        $self->get_message($value);
+
+    # compile
+    if(exists $self->{type_constraints}){ # union type
+        $self->throw_error(
+            "Cannot add additional type coercions to Union types");
+    }
+    else{
+        $self->_compile_type_coercion();
     }
+    return;
 }
 
-sub assert_valid {
-    my ($self, $value) = @_;
+sub _compile_type_coercion {
+    my($self) = @_;
+
+    my @coercions = @{$self->{coercion_map}};
+
+    $self->{_compiled_type_coercion} = sub {
+       my($thing) = @_;
+       foreach my $pair (@coercions) {
+            #my ($constraint, $converter) = @$pair;
+            if ($pair->[0]->check($thing)) {
+              local $_ = $thing;
+              return $pair->[1]->($thing);
+            }
+       }
+       return $thing;
+    };
+    return;
+}
 
-    my $error = $self->validate($value);
-    return 1 if ! defined $error;
+sub _compile_union_type_coercion {
+    my($self) = @_;
 
-    Carp::confess($error);
+    my @coercions;
+    foreach my $type(@{$self->{type_constraints}}){
+        if($type->has_coercion){
+            push @coercions, $type;
+        }
+    }
+    if(@coercions){
+        $self->{_compiled_type_coercion} = sub {
+            my($thing) = @_;
+            foreach my $type(@coercions){
+                my $value = $type->coerce($thing);
+                return $value if $self->check($value);
+            }
+            return $thing;
+        };
+    }
+    return;
 }
 
+sub coerce {
+    my $self = shift;
+
+    my $coercion = $self->_compiled_type_coercion;
+    if(!$coercion){
+        $self->throw_error("Cannot coerce without a type coercion");
+    }
+
+    return $_[0] if $self->check(@_);
 
-sub message {
-    return $_[0]->{message};
+    return  $coercion->(@_);
 }
 
 sub get_message {
@@ -64,19 +158,80 @@ sub get_message {
         return $msg->($value);
     }
     else {
-        $value = ( defined $value ? overload::StrVal($value) : 'undef' );
-        return
-            "Validation failed for '"
-          . $self->name
-          . "' failed with value $value";
+        if(not defined $value) {
+            $value = 'undef';
+        }
+        elsif( ref($value) && defined(&overload::StrVal) ) {
+            $value = overload::StrVal($value);
+        }
+        return "Validation failed for '$self' with value $value";
     }
 }
 
 sub is_a_type_of{
-    my($self, $tc_name) = @_;
+    my($self, $other) = @_;
 
-    return $self->name eq $tc_name
-        || $self->name =~ /\A $tc_name \[/xms; # "ArrayRef" =~ "ArrayRef[Foo]"
+    # ->is_a_type_of('__ANON__') is always false
+    return 0 if !ref($other) && $other eq '__ANON__';
+
+    (my $other_name = $other) =~ s/\s+//g;
+
+    return 1 if $self->name eq $other_name;
+
+    if(exists $self->{type_constraints}){ # union
+        foreach my $type(@{$self->{type_constraints}}) {
+            return 1 if $type->name eq $other_name;
+        }
+    }
+
+    for(my $p = $self->parent; defined $p; $p = $p->parent) {
+        return 1 if $p->name eq $other_name;
+    }
+
+    return 0;
+}
+
+# See also Moose::Meta::TypeConstraint::Parameterizable
+sub parameterize{
+    my($self, $param, $name) = @_;
+
+    if(!ref $param){
+        require Mouse::Util::TypeConstraints;
+        $param = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($param);
+    }
+
+    $name ||= sprintf '%s[%s]', $self->name, $param->name;
+
+    my $generator = $self->{constraint_generator}
+        || $self->throw_error("The $name constraint cannot be used,"
+            . " because $param doesn't subtype from a parameterizable type");
+
+    return Mouse::Meta::TypeConstraint->new(
+        name           => $name,
+        parent         => $self,
+        type_parameter => $param,
+        constraint     => $generator->($param), # must be 'constraint', not 'optimized'
+    );
+}
+
+sub assert_valid {
+    my ($self, $value) = @_;
+
+    if(!$self->check($value)){
+        $self->throw_error($self->get_message($value));
+    }
+    return 1;
+}
+
+sub _as_string { $_[0]->name                  } # overload ""
+sub _identity  { Scalar::Util::refaddr($_[0]) } # overload 0+
+
+sub _unite { # overload infix:<|>
+    my($lhs, $rhs) = @_;
+    require Mouse::Util::TypeConstraints;
+    return Mouse::Util::TypeConstraints::find_or_parse_type_constraint(
+       " $lhs | $rhs",
+    );
 }
 
 1;
@@ -86,23 +241,44 @@ __END__
 
 Mouse::Meta::TypeConstraint - The Mouse Type Constraint metaclass
 
-=head1 DESCRIPTION
+=head1 VERSION
+
+This document describes Mouse version 0.70
 
-For the most part, the only time you will ever encounter an
-instance of this class is if you are doing some serious deep
-introspection. This API should not be considered final, but
-it is B<highly unlikely> that this will matter to a regular
-Mouse user.
+=head1 DESCRIPTION
 
-Don't use this.
+This class represents a type constraint, including built-in
+type constraints, union type constraints, parameterizable/
+parameterized type constraints, as well as custom type
+constraints
 
 =head1 METHODS
 
-=over 4
+=over 
+
+=item C<< Mouse::Meta::TypeConstraint->new(%options) >>
+
+=item C<< $constraint->name >>
+
+=item C<< $constraint->parent >>
+
+=item C<< $constraint->constraint >>
+
+=item C<< $constraint->has_coercion >>
+
+=item C<< $constraint->message >>
+
+=item C<< $constraint->is_a_subtype_of($name or $object) >>
+
+=item C<< $constraint->coerce($value) >>
+
+=item C<< $constraint->check($value) >>
+
+=item C<< $constraint->assert_valid($value) >>
 
-=item B<new>
+=item C<< $constraint->get_message($value) >>
 
-=item B<name>
+=item C<< $constraint->create_child_type(%options) >>
 
 =back