X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeConstraint.pm;h=206a0a6f6614d79b0f29d4e502187a3339a9ec70;hb=db31d100fb6cd8d260452ce3156fa8411b9936c5;hp=c301eba80a5d4f91e8599874403f599525028105;hpb=85a9908f23fbb88856149822236cf6844641c699;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/TypeConstraint.pm b/lib/Moose/Meta/TypeConstraint.pm index c301eba..206a0a6 100644 --- a/lib/Moose/Meta/TypeConstraint.pm +++ b/lib/Moose/Meta/TypeConstraint.pm @@ -5,45 +5,99 @@ use strict; use warnings; use metaclass; -use overload '""' => sub { shift->name }, # stringify to tc name +use overload '0+' => sub { refaddr(shift) }, # id an object + '""' => sub { shift->name }, # stringify to tc name + 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); +use Try::Tiny; use base qw(Class::MOP::Object); -our $VERSION = '0.59'; -$VERSION = eval $VERSION; -our $AUTHORITY = 'cpan:STEVAN'; - -__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', + default => sub { {} }, + Class::MOP::_definition_context(), )); sub parents { - my $self; + my $self = shift; $self->parent; } @@ -51,22 +105,85 @@ 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 { my $class = shift; - my $self = $class->_new(@_); + my ($first, @rest) = @_; + 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; } -sub coerce { ((shift)->coercion || Moose->throw_error("Cannot coerce without a type coercion"))->coerce(@_) } -sub check { $_[0]->_compiled_type_constraint->($_[1]) ? 1 : undef } + + +sub coerce { + my $self = shift; + + my $coercion = $self->coercion; + + unless ($coercion) { + require Moose; + Moose->throw_error("Cannot coerce without a type coercion"); + } + + return $_[0] if $self->check($_[0]); + + return $coercion->coerce(@_); +} + +sub assert_coerce { + my $self = shift; + + my $coercion = $self->coercion; + + unless ($coercion) { + require Moose; + Moose->throw_error("Cannot coerce without a type coercion"); + } + + return $_[0] if $self->check($_[0]); + + my $result = $coercion->coerce(@_); + + $self->assert_valid($result); + + return $result; +} + +sub check { + my ($self, @args) = @_; + my $constraint_subref = $self->_compiled_type_constraint; + return $constraint_subref->(@args) ? 1 : undef; +} + sub validate { my ($self, $value) = @_; if ($self->_compiled_type_constraint->($value)) { @@ -77,16 +194,58 @@ sub validate { } } +sub can_be_inlined { + my $self = shift; + + if ( $self->has_parent && $self->constraint == $null_constraint ) { + return $self->parent->can_be_inlined; + } + + return $self->_has_inlined_type_constraint; +} + +sub _inline_check { + my $self = shift; + + unless ( $self->can_be_inlined ) { + require Moose; + Moose->throw_error( 'Cannot inline a type constraint check for ' . $self->name ); + } + + if ( $self->has_parent && $self->constraint == $null_constraint ) { + return $self->parent->_inline_check(@_); + } + + 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 { + my ($self, $value) = @_; + + my $error = $self->validate($value); + return 1 if ! defined $error; + + require Moose; + Moose->throw_error($error); +} + sub get_message { my ($self, $value) = @_; - if (my $msg = $self->message) { - local $_ = $value; - return $msg->($value); - } - else { - $value = (defined $value ? overload::StrVal($value) : 'undef'); - return "Validation failed for '" . $self->name . "' failed with value $value"; - } + my $msg = $self->has_message + ? $self->message + : $self->_default_message; + local $_ = $value; + return $msg->($value); } ## type predicates ... @@ -96,7 +255,7 @@ sub equals { my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return; - return 1 if refaddr($self) == refaddr($other); + return 1 if $self == $other; if ( $self->has_hand_optimized_type_constraint and $other->has_hand_optimized_type_constraint ) { return 1 if $self->hand_optimized_type_constraint == $other->hand_optimized_type_constraint; @@ -111,7 +270,7 @@ sub equals { return if $other->has_parent; } - return 1; + return; } sub is_a_type_of { @@ -152,11 +311,20 @@ sub _actually_compile_type_constraint { return $self->_compile_hand_optimized_type_constraint if $self->has_hand_optimized_type_constraint; + if ( $self->can_be_inlined ) { + return eval_closure( + source => 'sub { ' . $self->_inline_check('$_[0]') . ' }', + environment => $self->inline_environment, + ); + } + my $check = $self->constraint; - (defined $check) - || Moose->throw_error("Could not compile type constraint '" + unless ( defined $check ) { + require Moose; + Moose->throw_error( "Could not compile type constraint '" . $self->name - . "' because no constraint check"); + . "' because no constraint check" ); + } return $self->_compile_subtype($check) if $self->has_parent; @@ -169,7 +337,10 @@ sub _compile_hand_optimized_type_constraint { my $type_constraint = $self->hand_optimized_type_constraint; - Moose->throw_error("Hand optimized type constraint is not a code reference") unless ref $type_constraint; + unless ( ref $type_constraint ) { + require Moose; + Moose->throw_error("Hand optimized type constraint is not a code reference"); + } return $type_constraint; } @@ -202,20 +373,22 @@ sub _compile_subtype { if ( $check == $null_constraint ) { return $optimized_parent; } else { - return Class::MOP::subname($self->name, sub { + return subname($self->name, sub { return undef unless $optimized_parent->($_[0]); - local $_ = $_[0]; - $check->($_[0]); + my (@args) = @_; + local $_ = $args[0]; + $check->(@args); }); } } else { # general case, check all the constraints, from the first parent to ourselves my @checks = @parents; push @checks, $check if $check != $null_constraint; - return Class::MOP::subname($self->name => sub { - local $_ = $_[0]; + return subname($self->name => sub { + my (@args) = @_; + local $_ = $args[0]; foreach my $check (@checks) { - return undef unless $check->($_[0]); + return undef unless $check->(@args); } return 1; }); @@ -227,9 +400,10 @@ sub _compile_type { return $check if $check == $null_constraint; # Item, Any - return Class::MOP::subname($self->name => sub { - local $_ = $_[0]; - $check->($_[0]); + return subname($self->name => sub { + my (@args) = @_; + local $_ = $args[0]; + $check->(@args); }); } @@ -252,139 +426,205 @@ sub create_child_type { return $class->new(%opts, parent => $self); } -## this should get deprecated actually ... - -sub union { Carp::croak "DEPRECATED" } - 1; +# ABSTRACT: The Moose Type Constraint metaclass + __END__ =pod -=head1 NAME - -Moose::Meta::TypeConstraint - The Moose Type Constraint metaclass - =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 that this will matter to a regular -Moose user. +This class represents a single type constraint. Moose's built-in type +constraints, as well as constraints you define, are all stored in a +L object as objects of this +class. + +=head1 INHERITANCE -If you wish to use features at this depth, please come to the -#moose IRC channel on irc.perl.org and we can talk :) +C is a subclass of L. =head1 METHODS =over 4 -=item B +=item B<< Moose::Meta::TypeConstraint->new(%options) >> -=item B +This creates a new type constraint based on the provided C<%options>: -=item B +=over 8 -This checks the current type against the supplied type (only). -Returns false if the two types are not equal. It also returns false if -you provide the type as a name, and the type name isn't found in the -type registry. +=item * name -=item B +The constraint name. If a name is not provided, it will be set to +"__ANON__". -This checks the current type against the supplied type, or if the -current type is a sub-type of the type name or object supplied. It -also returns false if you provide the type as a name, and the type -name isn't found in the type registry. +=item * parent -=item B +A C object which is the parent type for +the type being created. This is optional. -This checks the current type is a sub-type of the type name or object -supplied. It also returns false if you provide the type as a name, and -the type name isn't found in the type registry. +=item * constraint -=item B +This is the subroutine reference that implements the actual constraint +check. This defaults to a subroutine which always returns true. -=item B +=item * message -This will apply the type-coercion if applicable. +A subroutine reference which is used to generate an error message when +the constraint fails. This is optional. -=item B +=item * coercion -This method will return a true (C<1>) if the C<$value> passes the -constraint, and false (C<0>) otherwise. +A L object representing the coercions to +the type. This is optional. -=item B +=item * inlined -This method is similar to C, but it deals with the error -message. If the C<$value> passes the constraint, C will be -returned. If the C<$value> does B pass the constraint, then -the C will be used to construct a custom error message. +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]">. -=item B +This is optional. -The name of the type in the global type registry. +=item * inline_environment -=item B +A hash reference of variables to close over. The keys are variables names, and +the values are I to the variables. -This type's parent type. +=item * optimized -=item B +B -Returns true if this type has a parent type. +This is a variant of the C parameter that is somehow +optimized. Typically, this means incorporating both the type's +constraint and all of its parents' constraints into a single +subroutine reference. -=item B +=back -=item B +=item B<< $constraint->equals($type_name_or_object) >> -=item B +Returns true if the supplied name or type object is the same as the +current type. -=item B +=item B<< $constraint->is_subtype_of($type_name_or_object) >> -=item B +Returns true if the supplied name or type object is a parent of the +current type. -=item B +=item B<< $constraint->is_a_type_of($type_name_or_object) >> -=item B +Returns true if the given type is the same as the current type, or is +a parent of the current type. This is a shortcut for checking +C and C. -=item B +=item B<< $constraint->coerce($value) >> -=item B +This will attempt to coerce the value to the type. If the type does not +have any defined coercions this will throw an error. -=item B +If no coercion can produce a value matching C<$constraint>, the original +value is returned. -=back +=item B<< $constraint->assert_coerce($value) >> -=head2 DEPRECATED METHOD +This method behaves just like C, but if the result is not valid +according to C<$constraint>, an error is thrown. -=over 4 +=item B<< $constraint->check($value) >> -=item B +Returns true if the given value passes the constraint for the type. -This was just bad idea on my part,.. use the L -itself instead. +=item B<< $constraint->validate($value) >> -=back +This is similar to C. However, if the type I then the +method returns an explicit C. If the type is not valid, we call +C<< $self->get_message($value) >> internally to generate an error +message. -=head1 BUGS +=item B<< $constraint->assert_valid($value) >> + +Like C and C, this method checks whether C<$value> is +valid under the constraint. If it is, it will return true. If it is not, +an exception will be thrown with the results of +C<< $self->get_message($value) >>. + +=item B<< $constraint->name >> -All complex software has bugs lurking in it, and this module is no -exception. If you find a bug please either email me, or add the bug -to cpan-RT. +Returns the type's name, as provided to the constructor. -=head1 AUTHOR +=item B<< $constraint->parent >> -Stevan Little Estevan@iinteractive.comE +Returns the type's parent, as provided to the constructor, if any. -=head1 COPYRIGHT AND LICENSE +=item B<< $constraint->has_parent >> -Copyright 2006-2008 by Infinity Interactive, Inc. +Returns true if the type has a parent type. -L +=item B<< $constraint->parents >> + +Returns all of the types parents as an list of type constraint objects. + +=item B<< $constraint->constraint >> + +Returns the type's constraint, as provided to the constructor. + +=item B<< $constraint->get_message($value) >> + +This generates a method for the given value. If the type does not have +an explicit message, we generate a default message. + +=item B<< $constraint->has_message >> + +Returns true if the type has a message. + +=item B<< $constraint->message >> + +Returns the type's message as a subroutine reference. + +=item B<< $constraint->coercion >> + +Returns the type's L object, if one +exists. + +=item B<< $constraint->has_coercion >> + +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 + +Returns the type's hand optimized constraint, as provided to the +constructor via the C option. + +=item B<< $constraint->has_hand_optimized_type_constraint >> + +B + +Returns true if the type has an optimized constraint. + +=item B<< $constraint->create_child_type(%options) >> + +This returns a new type constraint of the same class using the +provided C<%options>. The C option will be the current type. + +This method exists so that subclasses of this class can override this +behavior and change how child types are created. + +=back + +=head1 BUGS -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L for details on reporting bugs. =cut