starting from the deepest tc isn't necessary
[gitmo/Moose.git] / lib / Moose / Meta / TypeConstraint.pm
index ab6e6e7..2b56617 100644 (file)
@@ -10,6 +10,8 @@ use overload '0+'     => sub { refaddr(shift) }, # id an object
              bool     => sub { 1 },
              fallback => 1;
 
+use Carp qw(confess);
+use Class::Load qw(load_class);
 use Eval::Closure;
 use Scalar::Util qw(blessed refaddr);
 use Sub::Name qw(subname);
@@ -17,43 +19,81 @@ use Try::Tiny;
 
 use base qw(Class::MOP::Object);
 
-__PACKAGE__->meta->add_attribute('name'       => (reader => 'name'));
+__PACKAGE__->meta->add_attribute('name'       => (
+    reader => 'name',
+    Class::MOP::_definition_context(),
+));
 __PACKAGE__->meta->add_attribute('parent'     => (
     reader    => 'parent',
     predicate => 'has_parent',
+    Class::MOP::_definition_context(),
 ));
 
 my $null_constraint = sub { 1 };
 __PACKAGE__->meta->add_attribute('constraint' => (
     reader  => 'constraint',
     writer  => '_set_constraint',
-    default => sub { $null_constraint }
+    default => sub { $null_constraint },
+    Class::MOP::_definition_context(),
 ));
+
 __PACKAGE__->meta->add_attribute('message'   => (
     accessor  => 'message',
-    predicate => 'has_message'
+    predicate => 'has_message',
+    Class::MOP::_definition_context(),
+));
+
+__PACKAGE__->meta->add_attribute('_default_message' => (
+    accessor  => '_default_message',
+    Class::MOP::_definition_context(),
 ));
+
+# can't make this a default because it has to close over the type name, and
+# cmop attributes don't have lazy
+my $_default_message_generator = sub {
+    my $name = shift;
+    sub {
+        my $value = shift;
+        # have to load it late like this, since it uses Moose itself
+        my $can_partialdump = try {
+            # versions prior to 0.14 had a potential infinite loop bug
+            load_class('Devel::PartialDump', { -version => 0.14 });
+            1;
+        };
+        if ($can_partialdump) {
+            $value = Devel::PartialDump->new->dump($value);
+        }
+        else {
+            $value = (defined $value ? overload::StrVal($value) : 'undef');
+        }
+        return "Validation failed for '" . $name . "' with value $value";
+    }
+};
 __PACKAGE__->meta->add_attribute('coercion'   => (
     accessor  => 'coercion',
-    predicate => 'has_coercion'
+    predicate => 'has_coercion',
+    Class::MOP::_definition_context(),
 ));
 
 __PACKAGE__->meta->add_attribute('hand_optimized_type_constraint' => (
     init_arg  => 'optimized',
     accessor  => 'hand_optimized_type_constraint',
     predicate => 'has_hand_optimized_type_constraint',
+    Class::MOP::_definition_context(),
 ));
 
 __PACKAGE__->meta->add_attribute('inlined' => (
     init_arg  => 'inlined',
     accessor  => 'inlined',
     predicate => '_has_inlined_type_constraint',
+    Class::MOP::_definition_context(),
 ));
 
 __PACKAGE__->meta->add_attribute('inline_environment' => (
     init_arg => 'inline_environment',
-    accessor => 'inline_environment',
+    accessor => '_inline_environment',
     default  => sub { {} },
+    Class::MOP::_definition_context(),
 ));
 
 sub parents {
@@ -65,10 +105,13 @@ sub parents {
 
 __PACKAGE__->meta->add_attribute('compiled_type_constraint' => (
     accessor  => '_compiled_type_constraint',
-    predicate => '_has_compiled_type_constraint'
+    predicate => '_has_compiled_type_constraint',
+    Class::MOP::_definition_context(),
 ));
+
 __PACKAGE__->meta->add_attribute('package_defined_in' => (
-    accessor => '_package_defined_in'
+    accessor => '_package_defined_in',
+    Class::MOP::_definition_context(),
 ));
 
 sub new {
@@ -77,9 +120,25 @@ sub new {
     my %args = ref $first ? %$first : $first ? ($first, @rest) : ();
     $args{name} = $args{name} ? "$args{name}" : "__ANON__";
 
+    if ( $args{optimized} ) {
+        Moose::Deprecated::deprecated(
+            feature => 'optimized type constraint sub ref',
+            message =>
+                'Providing an optimized subroutine ref for type constraints is deprecated.'
+                . ' Use the inlining feature (inline_as) instead.'
+        );
+    }
+
+    if ( exists $args{message}
+      && (!ref($args{message}) || ref($args{message}) ne 'CODE') ) {
+        confess("The 'message' parameter must be a coderef");
+    }
+
     my $self  = $class->_new(%args);
     $self->compile_type_constraint()
         unless $self->_has_compiled_type_constraint;
+    $self->_default_message($_default_message_generator->($self->name))
+        unless $self->has_message;
     return $self;
 }
 
@@ -135,11 +194,11 @@ sub validate {
     }
 }
 
-sub has_inlined_type_constraint {
+sub can_be_inlined {
     my $self = shift;
 
     if ( $self->has_parent && $self->constraint == $null_constraint ) {
-        return $self->parent->has_inlined_type_constraint;
+        return $self->parent->can_be_inlined;
     }
 
     return $self->_has_inlined_type_constraint;
@@ -148,7 +207,7 @@ sub has_inlined_type_constraint {
 sub _inline_check {
     my $self = shift;
 
-    unless ( $self->has_inlined_type_constraint ) {
+    unless ( $self->can_be_inlined ) {
         require Moose;
         Moose->throw_error( 'Cannot inline a type constraint check for ' . $self->name );
     }
@@ -157,7 +216,17 @@ sub _inline_check {
         return $self->parent->_inline_check(@_);
     }
 
-    return $self->inlined->( $self, @_ );
+    return '( do { ' . $self->inlined->( $self, @_ ) . ' } )';
+}
+
+sub inline_environment {
+    my $self = shift;
+
+    if ( $self->has_parent && $self->constraint == $null_constraint ) {
+        return $self->parent->inline_environment;
+    }
+
+    return $self->_inline_environment;
 }
 
 sub assert_valid {
@@ -172,25 +241,11 @@ sub assert_valid {
 
 sub get_message {
     my ($self, $value) = @_;
-    if (my $msg = $self->message) {
-        local $_ = $value;
-        return $msg->($value);
-    }
-    else {
-        # have to load it late like this, since it uses Moose itself
-        my $can_partialdump = try {
-            # versions prior to 0.14 had a potential infinite loop bug
-            Class::MOP::load_class('Devel::PartialDump', { -version => 0.14 });
-            1;
-        };
-        if ($can_partialdump) {
-            $value = Devel::PartialDump->new->dump($value);
-        }
-        else {
-            $value = (defined $value ? overload::StrVal($value) : 'undef');
-        }
-        return "Validation failed for '" . $self->name . "' with value $value";
-    }
+    my $msg = $self->has_message
+        ? $self->message
+        : $self->_default_message;
+    local $_ = $value;
+    return $msg->($value);
 }
 
 ## type predicates ...
@@ -256,7 +311,7 @@ sub _actually_compile_type_constraint {
     return $self->_compile_hand_optimized_type_constraint
         if $self->has_hand_optimized_type_constraint;
 
-    if ( $self->has_inlined_type_constraint ) {
+    if ( $self->can_be_inlined ) {
         return eval_closure(
             source      => 'sub { ' . $self->_inline_check('$_[0]') . ' }',
             environment => $self->inline_environment,
@@ -425,8 +480,24 @@ the constraint fails. This is optional.
 A L<Moose::Meta::TypeCoercion> object representing the coercions to
 the type. This is optional.
 
+=item * inlined
+
+A subroutine which returns a string suitable for inlining this type
+constraint. It will be called as a method on the type constraint object, and
+will receive a single additional parameter, a variable name to be tested
+(usually C<"$_"> or C<"$_[0]">.
+
+This is optional.
+
+=item * inline_environment
+
+A hash reference of variables to close over. The keys are variables names, and
+the values are I<references> to the variables.
+
 =item * optimized
 
+B<This option is deprecated.>
+
 This is a variant of the C<constraint> parameter that is somehow
 optimized. Typically, this means incorporating both the type's
 constraint and all of its parents' constraints into a single
@@ -524,13 +595,23 @@ exists.
 
 Returns true if the type has a coercion.
 
+=item B<< $constraint->can_be_inlined >>
+
+Returns true if this type constraint can be inlined. A type constraint which
+subtypes an inlinable constraint and does not add an additional constraint
+"inherits" its parent type's inlining.
+
 =item B<< $constraint->hand_optimized_type_constraint >>
 
+B<This method is deprecated.>
+
 Returns the type's hand optimized constraint, as provided to the
 constructor via the C<optimized> option.
 
 =item B<< $constraint->has_hand_optimized_type_constraint >>
 
+B<This method is deprecated.>
+
 Returns true if the type has an optimized constraint.
 
 =item B<< $constraint->create_child_type(%options) >>