X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeConstraint.pm;h=dcce6d4943694c6e0a0112ec7a6372da6c3cfa15;hb=2e7576bdd6c4a179beadc2d21623c6cad1d66469;hp=9c445ae06e67a81f9700facea5cd3c0c832cbfd2;hpb=f5bc97e5bbde4f29f52d85ac7c03251665dfd52b;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/TypeConstraint.pm b/lib/Moose/Meta/TypeConstraint.pm index 9c445ae..dcce6d4 100644 --- a/lib/Moose/Meta/TypeConstraint.pm +++ b/lib/Moose/Meta/TypeConstraint.pm @@ -9,10 +9,11 @@ use overload '""' => sub { shift->name }, # stringify to tc name fallback => 1; use Scalar::Util qw(blessed refaddr); +use Sub::Name qw(subname); use base qw(Class::MOP::Object); -our $VERSION = '0.60'; +our $VERSION = '0.96'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -36,6 +37,7 @@ __PACKAGE__->meta->add_attribute('coercion' => ( accessor => 'coercion', predicate => 'has_coercion' )); + __PACKAGE__->meta->add_attribute('hand_optimized_type_constraint' => ( init_arg => 'optimized', accessor => 'hand_optimized_type_constraint', @@ -59,14 +61,39 @@ __PACKAGE__->meta->add_attribute('package_defined_in' => ( 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__"; + + my $self = $class->_new(%args); $self->compile_type_constraint() unless $self->_has_compiled_type_constraint; 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 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,6 +104,16 @@ sub validate { } } +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) { @@ -84,9 +121,9 @@ sub get_message { return $msg->($value); } else { - $value = (defined $value ? overload::StrVal($value) : 'undef'); + $value = (defined $value ? overload::StrVal($value) : 'undef'); return "Validation failed for '" . $self->name . "' failed with value $value"; - } + } } ## type predicates ... @@ -153,10 +190,12 @@ sub _actually_compile_type_constraint { if $self->has_hand_optimized_type_constraint; 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 +208,11 @@ 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; + Carp::confess ("Hand optimized type constraint for " . $self->name . " is not a code reference"); + Moose->throw_error("Hand optimized type constraint is not a code reference"); + } return $type_constraint; } @@ -202,20 +245,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 +272,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,10 +298,6 @@ sub create_child_type { return $class->new(%opts, parent => $self); } -## this should get deprecated actually ... - -sub union { Carp::croak "DEPRECATED" } - 1; __END__ @@ -268,111 +310,163 @@ 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 * optimized -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. +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 -The name of the type in the global type registry. +=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. -This type's parent type. +=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. -Returns true if this type has a parent type. +=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 +have any defined coercions this will throw an error. -=item B +=item B<< $constraint->check($value) >> -=item B +Returns true if the given value passes the constraint for the type. -=item B +=item B<< $constraint->validate($value) >> -=item B +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. -=item B +=item B<< $constraint->assert_valid($value) >> -=item B +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 +=item B<< $constraint->name >> -=back +Returns the type's name, as provided to the constructor. -=head2 DEPRECATED METHOD +=item B<< $constraint->parent >> -=over 4 +Returns the type's parent, as provided to the constructor, if any. + +=item B<< $constraint->has_parent >> + +Returns true if the type has a parent type. + +=item B<< $constraint->parents >> + +A synonym for C. This is useful for polymorphism with types +that can have more than one parent. + +=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->hand_optimized_type_constraint >> + +Returns the type's hand optimized constraint, as provided to the +constructor via the C option. + +=item B<< $constraint->has_hand_optimized_type_constraint >> + +Returns true if the type has an optimized constraint. + +=item B<< $constraint->create_child_type(%options) >> -=item B +This returns a new type constraint of the same class using the +provided C<%options>. The C option will be the current type. -This was just bad idea on my part,.. use the L -itself instead. +This method exists so that subclasses of this class can override this +behavior and change how child types are created. =back =head1 BUGS -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. +See L for details on reporting bugs. =head1 AUTHOR @@ -380,7 +474,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2010 by Infinity Interactive, Inc. L