Split role application to a module like Moose
[gitmo/Mouse.git] / lib / Mouse / Meta / TypeConstraint.pm
index 5650c25..7817b15 100644 (file)
@@ -1,24 +1,10 @@
 package Mouse::Meta::TypeConstraint;
 use Mouse::Util qw(:meta); # enables strict and warnings
-
-use overload
-    'bool'   => sub { 1 },             # always true
-
-    '""'     => sub { $_[0]->name },   # stringify to tc name
-
-    '|'      => sub {                  # or-combination
-        require Mouse::Util::TypeConstraints;
-        return Mouse::Util::TypeConstraints::find_or_parse_type_constraint(
-            "$_[0] | $_[1]",
-        );
-    },
-
-    fallback => 1;
-
-use Carp         ();
+use Scalar::Util ();
 
 sub new {
-    my($class, %args) = @_;
+    my $class = shift;
+    my %args  = @_ == 1 ? %{$_[0]} : @_;
 
     $args{name} = '__ANON__' if !defined $args{name};
 
@@ -32,11 +18,13 @@ sub new {
     $check = $args{constraint};
 
     if(defined($check) && ref($check) ne 'CODE'){
-        Carp::confess("Constraint for $args{name} is not a CODE reference");
+        $class->throw_error(
+            "Constraint for $args{name} is not a CODE reference");
     }
 
     my $self = bless \%args, $class;
-    $self->compile_type_constraint() if !$self->{hand_optimized_type_constraint};
+    $self->compile_type_constraint()
+        if !$self->{hand_optimized_type_constraint};
 
     $self->_compile_union_type_coercion() if $self->{type_constraints};
     return $self;
@@ -44,12 +32,12 @@ sub new {
 
 sub create_child_type{
     my $self = shift;
-    # 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'
+        # but does not inherit 'compiled_type_constraint'
+        # and 'hand_optimized_type_constraint'
         compiled_type_constraint       => undef,
         hand_optimized_type_constraint => undef,
 
@@ -66,6 +54,8 @@ sub parent;
 sub message;
 sub has_coercion;
 
+sub check;
+
 sub type_parameter;
 sub __is_parameterized;
 
@@ -74,10 +64,11 @@ sub _compiled_type_coercion;
 
 sub compile_type_constraint;
 
-sub _add_type_coercions{
+
+sub _add_type_coercions { # ($self, @pairs)
     my $self = shift;
 
-    my $coercions = ($self->{_coercion_map} ||= []);
+    my $coercions = ($self->{coercion_map} ||= []);
     my %has       = map{ $_->[0] => undef } @{$coercions};
 
     for(my $i = 0; $i < @_; $i++){
@@ -85,18 +76,20 @@ sub _add_type_coercions{
         my $action = $_[++$i];
 
         if(exists $has{$from}){
-            Carp::confess("A coercion action already exists for '$from'");
+            $self->throw_error("A coercion action already exists for '$from'");
         }
 
         my $type = Mouse::Util::TypeConstraints::find_or_parse_type_constraint($from)
-            or Carp::confess("Could not find the type constraint ($from) to coerce from");
+            or $self->throw_error(
+                "Could not find the type constraint ($from) to coerce from");
 
         push @{$coercions}, [ $type => $action ];
     }
 
     # compile
     if(exists $self->{type_constraints}){ # union type
-        Carp::confess("Cannot add additional type coercions to Union types");
+        $self->throw_error(
+            "Cannot add additional type coercions to Union types");
     }
     else{
         $self->_compile_type_coercion();
@@ -107,7 +100,7 @@ sub _add_type_coercions{
 sub _compile_type_coercion {
     my($self) = @_;
 
-    my @coercions = @{$self->{_coercion_map}};
+    my @coercions = @{$self->{coercion_map}};
 
     $self->{_compiled_type_coercion} = sub {
        my($thing) = @_;
@@ -145,20 +138,15 @@ sub _compile_union_type_coercion {
     return;
 }
 
-sub check {
-    my $self = shift;
-    return $self->_compiled_type_constraint->(@_);
-}
-
 sub coerce {
     my $self = shift;
 
     my $coercion = $self->_compiled_type_coercion;
     if(!$coercion){
-        Carp::confess("Cannot coerce without a type coercion");
+        $self->throw_error("Cannot coerce without a type coercion");
     }
 
-    return $_[0] if $self->_compiled_type_constraint->(@_);
+    return $_[0] if $self->check(@_);
 
     return  $coercion->(@_);
 }
@@ -170,8 +158,13 @@ sub get_message {
         return $msg->($value);
     }
     else {
-        $value = ( defined $value ? overload::StrVal($value) : 'undef' );
-        return "Validation failed for '$self' 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";
     }
 }
 
@@ -186,13 +179,13 @@ sub is_a_type_of{
     return 1 if $self->name eq $other_name;
 
     if(exists $self->{type_constraints}){ # union
-        foreach my $type(@{$self->{type_constraints}}){
+        foreach my $type(@{$self->{type_constraints}}) {
             return 1 if $type->name eq $other_name;
         }
     }
 
-    for(my $parent = $self->parent; defined $parent; $parent = $parent->parent){
-        return 1 if $parent->name eq $other_name;
+    for(my $p = $self->parent; defined $p; $p = $p->parent) {
+        return 1 if $p->name eq $other_name;
     }
 
     return 0;
@@ -210,27 +203,37 @@ sub parameterize{
     $name ||= sprintf '%s[%s]', $self->name, $param->name;
 
     my $generator = $self->{constraint_generator}
-        || Carp::confess("The $name constraint cannot be used, because $param doesn't subtype from a parameterizable type");
+        || $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'
-
-        type           => 'Parameterized',
     );
 }
 
 sub assert_valid {
     my ($self, $value) = @_;
 
-    if(!$self->_compiled_type_constraint->($value)){
-        Carp::confess($self->get_message($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;
 __END__
 
@@ -240,25 +243,42 @@ Mouse::Meta::TypeConstraint - The Mouse Type Constraint metaclass
 
 =head1 VERSION
 
-This document describes Mouse version 0.50_02
+This document describes Mouse version 0.70
 
 =head1 DESCRIPTION
 
-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.
-
-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