Add VERSION section to pods
[gitmo/Mouse.git] / lib / Mouse / Meta / TypeConstraint.pm
index c9afe63..05b9c5f 100644 (file)
@@ -1,6 +1,5 @@
 package Mouse::Meta::TypeConstraint;
-use strict;
-use warnings;
+use Mouse::Util qw(:meta); # enables strict and warnings
 
 use overload
     '""'     => sub { shift->{name} },   # stringify to tc name
@@ -9,8 +8,6 @@ use overload
 use Carp qw(confess);
 use Scalar::Util qw(blessed reftype);
 
-use Mouse::Util qw(:meta);
-
 my $null_check = sub { 1 };
 
 sub new {
@@ -18,54 +15,193 @@ sub new {
 
     $args{name} = '__ANON__' if !defined $args{name};
 
-    my $check = $args{_compiled_type_constraint} || $args{constraint};
+    my $check = delete $args{optimized};
+
+    if($args{_compiled_type_constraint}){
+        Carp::cluck("'_compiled_type_constraint' has been deprecated, use 'optimized' instead")
+            if _MOUSE_VERBOSE;
+
+        $check = $args{_compiled_type_constraint};
+    }
+
+    if($check){
+        $args{hand_optimized_type_constraint} = $check;
+        $args{compiled_type_constraint}       = $check;
+    }
+
+    $check = $args{constraint};
 
-    # FIXME
     if(blessed($check)){
-        $check = $check->{_compiled_type_constraint};
+        Carp::cluck("Constraint for $args{name} must be a CODE reference");
+        $check = $check->{compiled_type_constraint};
     }
 
     if(defined($check) && ref($check) ne 'CODE'){
-        confess("Type constraint for $args{name} is not a CODE reference");
+        confess("Constraint for $args{name} is not a CODE reference");
     }
 
+    $args{package_defined_in} ||= caller;
+
     my $self = bless \%args, $class;
-    $self->{_compiled_type_constraint} ||= $self->_compile();
+    $self->compile_type_constraint() if !$self->{hand_optimized_type_constraint};
+
+    if($self->{type_constraints}){ # Union
+        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 $self;
 }
 
 sub create_child_type{
     my $self = shift;
-    return ref($self)->new(@_, parent => $self);
+    # XXX: FIXME
+    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 name    { $_[0]->{name}    }
 sub parent  { $_[0]->{parent}  }
 sub message { $_[0]->{message} }
 
-sub check {
-    my $self = shift;
-    $self->{_compiled_type_constraint}->(@_);
+sub _compiled_type_constraint{ $_[0]->{compiled_type_constraint} }
+
+sub has_coercion{ exists $_[0]->{_compiled_type_coercion} }
+
+sub compile_type_constraint{
+    my($self) = @_;
+
+    # add parents first
+    my @checks;
+    for(my $parent = $self->parent; defined $parent; $parent = $parent->parent){
+         if($parent->{hand_optimized_type_constraint}){
+            push @checks, $parent->{hand_optimized_type_constraint};
+            last; # a hand optimized constraint must include all the parents
+        }
+        elsif($parent->{constraint}){
+            push @checks, $parent->{constraint};
+        }
+    }
+
+    # then add child
+    if($self->{constraint}){
+        push @checks, $self->{constraint};
+    }
+
+    if($self->{type_constraints}){ # Union
+        my @types = map{ $_->_compiled_type_constraint } @{ $self->{type_constraints} };
+        push @checks, sub{
+            foreach my $c(@types){
+                return 1 if $c->($_[0]);
+            }
+            return 0;
+        };
+    }
+
+    if(@checks == 0){
+        $self->{compiled_type_constraint} = $null_check;
+    }
+    elsif(@checks == 1){
+        my $c = $checks[0];
+        $self->{compiled_type_constraint} = sub{
+            my(@args) = @_;
+            local $_ = $args[0];
+            return $c->(@args);
+        };
+    }
+    else{
+        $self->{compiled_type_constraint} =  sub{
+            my(@args) = @_;
+            local $_ = $args[0];
+            foreach my $c(@checks){
+                return undef if !$c->(@args);
+            }
+            return 1;
+        };
+    }
+    return;
 }
 
-sub validate {
-    my ($self, $value) = @_;
-    if ($self->{_compiled_type_constraint}->($value)) {
-        return undef;
+sub _add_type_coercions{
+    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}){
+            confess("A coercion action already exists for '$from'");
+        }
+
+        my $type = Mouse::Util::TypeConstraints::find_or_parse_type_constraint($from)
+            or confess("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
+        confess("Cannot add additional type coercions to Union types");
+    }
+    else{
+        $self->{_compiled_type_coercion} = sub {
+           my($thing) = @_;\r
+           foreach my $pair (@{$coercions}) {\r
+                #my ($constraint, $converter) = @$pair;\r
+                if ($pair->[0]->check($thing)) {\r
+                  local $_ = $thing;
+                  return $pair->[1]->($thing);
+                }\r
+           }\r
+           return $thing;\r
+        };
     }
+    return;
 }
 
-sub assert_valid {
-    my ($self, $value) = @_;
+sub check {
+    my $self = shift;
+    return $self->_compiled_type_constraint->(@_);
+}
+
+sub coerce {
+    my $self = shift;
+    if(!$self->{_compiled_type_coercion}){
+        confess("Cannot coerce without a type coercion ($self)");
+    }
 
-    my $error = $self->validate($value);
-    return 1 if ! defined $error;
+    return $_[0] if $self->_compiled_type_constraint->(@_);
 
-    confess($error);
+    return $self->{_compiled_type_coercion}->(@_);
 }
 
 sub get_message {
@@ -76,10 +212,7 @@ sub get_message {
     }
     else {
         $value = ( defined $value ? overload::StrVal($value) : 'undef' );
-        return
-            "Validation failed for '"
-          . $self->name
-          . "' failed with value $value";
+        return "Validation failed for '$self' failed with value $value";
     }
 }
 
@@ -106,48 +239,6 @@ sub is_a_type_of{
     return 0;
 }
 
-sub _compile{
-    my($self) = @_;
-
-    # add parents first
-    my @checks;
-    for(my $parent = $self->parent; defined $parent; $parent = $parent->parent){
-        if($parent->{constraint}){
-            push @checks, $parent->{constraint};
-         }
-         elsif($parent->{_compiled_type_constraint} && $parent->{_compiled_type_constraint} != $null_check){
-            # hand-optimized constraint
-            push @checks, $parent->{_compiled_type_constraint};
-            last;
-        }
-    }
-    # then add child
-    if($self->{constraint}){
-        push @checks, $self->{constraint};
-    }
-
-    if(@checks == 0){
-        return $null_check;
-    }
-    elsif(@checks == 1){
-        my $c = $checks[0];
-        return sub{
-            my(@args) = @_;
-            local $_ = $args[0];
-            return $c->(@args);
-        };
-    }
-    else{
-        return sub{
-            my(@args) = @_;
-            local $_ = $args[0];
-            foreach my $c(@checks){
-                return undef if !$c->(@args);
-            }
-            return 1;
-        };
-    }
-}
 
 1;
 __END__
@@ -156,6 +247,10 @@ __END__
 
 Mouse::Meta::TypeConstraint - The Mouse Type Constraint metaclass
 
+=head1 VERSION
+
+This document describes Mouse version 0.37_06
+
 =head1 DESCRIPTION
 
 For the most part, the only time you will ever encounter an