X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeConstraint.pm;h=298656fa10a64bf764da10a0d05647a4cc00bc0b;hb=c24269b37a781e0358c3682e8717cfd539269550;hp=f3c1c0a946f51e6344fb1d8ff962132cf9bb1106;hpb=b77fdbed20f583feab7a3990da4ebc04898217fc;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/TypeConstraint.pm b/lib/Moose/Meta/TypeConstraint.pm index f3c1c0a..298656f 100644 --- a/lib/Moose/Meta/TypeConstraint.pm +++ b/lib/Moose/Meta/TypeConstraint.pm @@ -5,17 +5,30 @@ use strict; use warnings; use metaclass; -use Sub::Name 'subname'; -use Carp 'confess'; -use Scalar::Util 'blessed'; +use overload '""' => sub { shift->name }, # stringify to tc name + fallback => 1; -our $VERSION = '0.07'; +use Scalar::Util qw(blessed refaddr); +use Sub::Name qw(subname); -use Moose::Meta::TypeConstraint::Union; +use base qw(Class::MOP::Object); -__PACKAGE__->meta->add_attribute('name' => (reader => 'name' )); -__PACKAGE__->meta->add_attribute('parent' => (reader => 'parent' )); -__PACKAGE__->meta->add_attribute('constraint' => (reader => 'constraint')); +our $VERSION = '0.88'; +$VERSION = eval $VERSION; +our $AUTHORITY = 'cpan:STEVAN'; + +__PACKAGE__->meta->add_attribute('name' => (reader => 'name')); +__PACKAGE__->meta->add_attribute('parent' => ( + reader => 'parent', + predicate => 'has_parent', +)); + +my $null_constraint = sub { 1 }; +__PACKAGE__->meta->add_attribute('constraint' => ( + reader => 'constraint', + writer => '_set_constraint', + default => sub { $null_constraint } +)); __PACKAGE__->meta->add_attribute('message' => ( accessor => 'message', predicate => 'has_message' @@ -25,134 +38,264 @@ __PACKAGE__->meta->add_attribute('coercion' => ( predicate => 'has_coercion' )); -# private accessor -__PACKAGE__->meta->add_attribute('compiled_type_constraint' => ( - accessor => '_compiled_type_constraint' -)); - __PACKAGE__->meta->add_attribute('hand_optimized_type_constraint' => ( init_arg => 'optimized', accessor => 'hand_optimized_type_constraint', - predicate => 'has_hand_optimized_type_constraint', + predicate => 'has_hand_optimized_type_constraint', +)); + +sub parents { + my $self; + $self->parent; +} + +# private accessors + +__PACKAGE__->meta->add_attribute('compiled_type_constraint' => ( + accessor => '_compiled_type_constraint', + predicate => '_has_compiled_type_constraint' +)); +__PACKAGE__->meta->add_attribute('package_defined_in' => ( + accessor => '_package_defined_in' )); -sub new { +sub new { my $class = shift; - my $self = $class->meta->new_object(@_); - $self->compile_type_constraint(); + 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 || confess "Cannot coerce without a type coercion")->coerce(@_) -} -sub _collect_all_parents { + +sub coerce { my $self = shift; - my @parents; - my $current = $self->parent; - while (defined $current) { - push @parents => $current; - $current = $current->parent; + + my $coercion = $self->coercion; + + unless ($coercion) { + require Moose; + Moose->throw_error("Cannot coerce without a type coercion"); } - return @parents; + + return $_[0] if $self->check($_[0]); + + return $coercion->coerce(@_); } -sub compile_type_constraint { - my $self = shift; - - if ($self->has_hand_optimized_type_constraint) { - my $type_constraint = $self->hand_optimized_type_constraint; - $self->_compiled_type_constraint(sub { - return undef unless $type_constraint->($_[0]); - return 1; - }); - return; - } - - my $check = $self->constraint; - (defined $check) - || confess "Could not compile type constraint '" . $self->name . "' because no constraint check"; - my $parent = $self->parent; - if (defined $parent) { - # we have a subtype ... - # so we gather all the parents in order - # and grab their constraints ... - my @parents; - foreach my $parent ($self->_collect_all_parents) { - if ($parent->has_hand_optimized_type_constraint) { - unshift @parents => $parent->hand_optimized_type_constraint; - last; - } - else { - unshift @parents => $parent->constraint; - } - } - - # then we compile them to run without - # having to recurse as we did before - $self->_compiled_type_constraint(subname $self->name => sub { - local $_ = $_[0]; - foreach my $parent (@parents) { - return undef unless $parent->($_[0]); - } - return undef unless $check->($_[0]); - 1; - }); +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)) { + return undef; } else { - # we have a type .... - $self->_compiled_type_constraint(subname $self->name => sub { - local $_ = $_[0]; - return undef unless $check->($_[0]); - 1; - }); + $self->get_message($value); } } -sub check { $_[0]->_compiled_type_constraint->($_[1]) } +sub assert_valid { + my ($self, $value) = @_; + + my $error = $self->validate($value); + return 1 if ! defined $error; -sub validate { + require Moose; + Moose->throw_error($error); +} + +sub get_message { my ($self, $value) = @_; - if ($self->_compiled_type_constraint->($value)) { - return undef; + if (my $msg = $self->message) { + local $_ = $value; + return $msg->($value); } else { - if ($self->has_message) { - local $_ = $value; - return $self->message->($value); - } - else { - return "Validation failed for '" . $self->name . "' failed"; - } + $value = (defined $value ? overload::StrVal($value) : 'undef'); + return "Validation failed for '" . $self->name . "' failed with value $value"; } } +## type predicates ... + +sub equals { + my ( $self, $type_or_name ) = @_; + + my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return; + + return 1 if refaddr($self) == refaddr($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; + } + + return unless $self->constraint == $other->constraint; + + if ( $self->has_parent ) { + return unless $other->has_parent; + return unless $self->parent->equals( $other->parent ); + } else { + return if $other->has_parent; + } + + return 1; +} + sub is_a_type_of { - my ($self, $type_name) = @_; - ($self->name eq $type_name || $self->is_subtype_of($type_name)); + my ($self, $type_or_name) = @_; + + my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return; + + ($self->equals($type) || $self->is_subtype_of($type)); } sub is_subtype_of { - my ($self, $type_name) = @_; + my ($self, $type_or_name) = @_; + + my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name) or return; + my $current = $self; + while (my $parent = $current->parent) { - return 1 if $parent->name eq $type_name; + return 1 if $parent->equals($type); $current = $parent; } + return 0; } -sub union { - my ($class, @type_constraints) = @_; - (scalar @type_constraints >= 2) - || confess "You must pass in at least 2 Moose::Meta::TypeConstraint instances to make a union"; - (blessed($_) && $_->isa('Moose::Meta::TypeConstraint')) - || confess "You must pass in only Moose::Meta::TypeConstraint instances to make unions" - foreach @type_constraints; - return Moose::Meta::TypeConstraint::Union->new( - type_constraints => \@type_constraints, - ); +## compiling the type constraint + +sub compile_type_constraint { + my $self = shift; + $self->_compiled_type_constraint($self->_actually_compile_type_constraint); +} + +## type compilers ... + +sub _actually_compile_type_constraint { + my $self = shift; + + return $self->_compile_hand_optimized_type_constraint + if $self->has_hand_optimized_type_constraint; + + my $check = $self->constraint; + unless ( defined $check ) { + require Moose; + Moose->throw_error( "Could not compile type constraint '" + . $self->name + . "' because no constraint check" ); + } + + return $self->_compile_subtype($check) + if $self->has_parent; + + return $self->_compile_type($check); +} + +sub _compile_hand_optimized_type_constraint { + my $self = shift; + + my $type_constraint = $self->hand_optimized_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; +} + +sub _compile_subtype { + my ($self, $check) = @_; + + # gather all the parent constraintss in order + my @parents; + my $optimized_parent; + foreach my $parent ($self->_collect_all_parents) { + # if a parent is optimized, the optimized constraint already includes + # all of its parents tcs, so we can break the loop + if ($parent->has_hand_optimized_type_constraint) { + push @parents => $optimized_parent = $parent->hand_optimized_type_constraint; + last; + } + else { + push @parents => $parent->constraint; + } + } + + @parents = grep { $_ != $null_constraint } reverse @parents; + + unless ( @parents ) { + return $self->_compile_type($check); + } elsif( $optimized_parent and @parents == 1 ) { + # the case of just one optimized parent is optimized to prevent + # looping and the unnecessary localization + if ( $check == $null_constraint ) { + return $optimized_parent; + } else { + return subname($self->name, sub { + return undef unless $optimized_parent->($_[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 subname($self->name => sub { + my (@args) = @_; + local $_ = $args[0]; + foreach my $check (@checks) { + return undef unless $check->(@args); + } + return 1; + }); + } +} + +sub _compile_type { + my ($self, $check) = @_; + + return $check if $check == $null_constraint; # Item, Any + + return subname($self->name => sub { + my (@args) = @_; + local $_ = $args[0]; + $check->(@args); + }); +} + +## other utils ... + +sub _collect_all_parents { + my $self = shift; + my @parents; + my $current = $self->parent; + while (defined $current) { + push @parents => $current; + $current = $current->parent; + } + return @parents; +} + +sub create_child_type { + my ($self, %opts) = @_; + my $class = ref $self; + return $class->new(%opts, parent => $self); } 1; @@ -167,77 +310,156 @@ 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 store in a +L object as objects of this +class. -If you wish to use features at this depth, please come to the -#moose IRC channel on irc.perl.org and we can talk :) +=head1 INHERITANCE + +C is a subclass of L. =head1 METHODS =over 4 -=item B +=item B<< Moose::Meta::TypeConstraint->new(%options) >> + +This creates a new type constraint based on the provided C<%options>: -=item B +=over 8 -=item B +=item * name -This checks the current type name, and if it does not match, -checks if it is a subtype of it. +The constraint name. If a name is not provided, it will be set to +"__ANON__". -=item B +=item * parent -=item B +A C object which is the parent type for +the type being created. This is optional. -=item B +=item * constraint -This will apply the type-coercion if applicable. +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 method will return a true (C<1>) if the C<$value> passes the -constraint, and false (C<0>) otherwise. +A subroutine reference which is used to generate an error message when +the constraint fails. This is optional. -=item B +=item * coercion -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 L object representing the coercions to +the type. This is optional. -=item B +=item * optimized -=item B +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. -=back +=item B<< $constraint->coerce($value) >> -=over 4 +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<< $constraint->check($value) >> + +Returns true if the given value passes the constraint for the type. + +=item B<< $constraint->validate($value) >> + +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<< $constraint->name >> + +Returns the type's name, as provided to the constructor. + +=item B<< $constraint->parent >> + +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) >> + +This returns a new type constraint of the same class using the +provided C<%options>. The C option will be the current type. -=item B +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 +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. @@ -247,11 +469,11 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006, 2007 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +it under the same terms as Perl itself. =cut