X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeConstraint%2FUnion.pm;h=e1d134fafcf3c85099292a695a9f8ba750192c5d;hb=e462f6f3d260687b8f7372b112a50c5c2a2c431c;hp=2a24f22e060077f0962c15e908dbb758bbcd3474;hpb=d1e11f1b9587b09a4231416b7272c3787578730d;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/TypeConstraint/Union.pm b/lib/Moose/Meta/TypeConstraint/Union.pm index 2a24f22..e1d134f 100644 --- a/lib/Moose/Meta/TypeConstraint/Union.pm +++ b/lib/Moose/Meta/TypeConstraint/Union.pm @@ -5,85 +5,86 @@ use strict; use warnings; use metaclass; -our $VERSION = '0.05'; +use Moose::Meta::TypeCoercion::Union; + +use List::Util qw(first); + +our $VERSION = '1.05'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; +use base 'Moose::Meta::TypeConstraint'; + __PACKAGE__->meta->add_attribute('type_constraints' => ( accessor => 'type_constraints', default => sub { [] } )); -sub new { - my $class = shift; - my $self = $class->meta->new_object(@_); +sub new { + my ($class, %options) = @_; + + my $name = join '|' => sort { $a cmp $b } + map { $_->name } @{ $options{type_constraints} }; + + my $self = $class->SUPER::new( + name => $name, + %options, + ); + + $self->_set_constraint(sub { $self->check($_[0]) }); + $self->coercion(Moose::Meta::TypeCoercion::Union->new( + type_constraint => $self + )); return $self; } -sub name { join ' | ' => map { $_->name } @{$_[0]->type_constraints} } - -# NOTE: -# this should probably never be used -# but we include it here for completeness -sub constraint { +sub _actually_compile_type_constraint { my $self = shift; - sub { $self->check($_[0]) }; + + my @constraints = @{ $self->type_constraints }; + + return sub { + my $value = shift; + foreach my $type (@constraints) { + return 1 if $type->check($value); + } + return undef; + }; } -# conform to the TypeConstraint API -sub parent { undef } -sub message { undef } -sub has_message { 0 } -# FIXME: -# not sure what this should actually do here -sub coercion { undef } +sub equals { + my ( $self, $type_or_name ) = @_; -# this should probably be memoized -sub has_coercion { - my $self = shift; - foreach my $type (@{$self->type_constraints}) { - return 1 if $type->has_coercion - } - return 0; -} + my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name); -# NOTE: -# this feels too simple, and may not always DWIM -# correctly, especially in the presence of -# close subtype relationships, however it should -# work for a fair percentage of the use cases -sub coerce { - my $self = shift; - my $value = shift; - foreach my $type (@{$self->type_constraints}) { - if ($type->has_coercion) { - my $temp = $type->coerce($value); - return $temp if $self->check($temp); - } - } - return undef; -} + return unless $other->isa(__PACKAGE__); -sub _compiled_type_constraint { - my $self = shift; - return sub { - my $value = shift; - foreach my $type (@{$self->type_constraints}) { - return 1 if $type->check($value); + my @self_constraints = @{ $self->type_constraints }; + my @other_constraints = @{ $other->type_constraints }; + + return unless @self_constraints == @other_constraints; + + # FIXME presort type constraints for efficiency? + constraint: foreach my $constraint ( @self_constraints ) { + for ( my $i = 0; $i < @other_constraints; $i++ ) { + if ( $constraint->equals($other_constraints[$i]) ) { + splice @other_constraints, $i, 1; + next constraint; + } } - return undef; } + + return @other_constraints == 0; } -sub check { - my $self = shift; - my $value = shift; - $self->_compiled_type_constraint->($value); +sub parents { + my $self = shift; + $self->type_constraints; } sub validate { - my $self = shift; - my $value = shift; + my ($self, $value) = @_; my $message; foreach my $type (@{$self->type_constraints}) { my $err = $type->validate($value); @@ -91,7 +92,13 @@ sub validate { $message .= ($message ? ' and ' : '') . $err if defined $err; } - return ($message . ' in (' . $self->name . ')') ; + return ($message . ' in (' . $self->name . ')') ; +} + +sub find_type_for { + my ($self, $value) = @_; + + return first { $_->check($value) } @{ $self->type_constraints }; } sub is_a_type_of { @@ -99,7 +106,7 @@ sub is_a_type_of { foreach my $type (@{$self->type_constraints}) { return 1 if $type->is_a_type_of($type_name); } - return 0; + return 0; } sub is_subtype_of { @@ -110,19 +117,28 @@ sub is_subtype_of { return 0; } -## hand optimized constraints - -# NOTE: -# it will just use all the hand optimized -# type constraints from it's list of type -# constraints automatically, but there is -# no simple way to optimize it even more -# (without B::Deparse or something). So -# we just stop here. -# - SL +sub create_child_type { + my ( $self, %opts ) = @_; + + my $constraint + = Moose::Meta::TypeConstraint->new( %opts, parent => $self ); + + # if we have a type constraint union, and no + # type check, this means we are just aliasing + # the union constraint, which means we need to + # handle this differently. + # - SL + if ( not( defined $opts{constraint} ) + && $self->has_coercion ) { + $constraint->coercion( + Moose::Meta::TypeCoercion::Union->new( + type_constraint => $self, + ) + ); + } -sub has_hand_optimized_type_constraint { 0 } -sub hand_optimized_type_constraint { undef } + return $constraint; +} 1; @@ -136,73 +152,85 @@ Moose::Meta::TypeConstraint::Union - A union of Moose type constraints =head1 DESCRIPTION -This metaclass represents a union of Moose type constraints. More -details to be explained later (possibly in a Cookbook::Recipe). - -This actually used to be part of Moose::Meta::TypeConstraint, but it -is now better off in it's own file. +This metaclass represents a union of type constraints. A union takes +multiple type constraints, and is true if any one of its member +constraints is true. -=head1 METHODS +=head1 INHERITANCE -This class is not a subclass of Moose::Meta::TypeConstraint, -but it does provide the same API +C is a subclass of +L. =over 4 -=item B +=item B<< Moose::Meta::TypeConstraint::Union->new(%options) >> -=item B +This creates a new class type constraint based on the given +C<%options>. -=item B +It takes the same options as its parent. It also requires an +additional option, C. This is an array reference +containing the L objects that are the +members of the union type. The C option defaults to the names +all of these member types sorted and then joined by a pipe (|). -=item B +The constructor sets the implementation of the constraint so that is +simply calls C on the newly created object. -=item B +Finally, the constructor also makes sure that the object's C +attribute is a L object. -=back +=item B<< $constraint->type_constraints >> -=head2 Overriden methods +This returns the array reference of C provided to +the constructor. -=over 4 +=item B<< $constraint->parents >> -=item B +This returns the same constraint as the C method. -=item B +=item B<< $constraint->check($value) >> -=item B +=item B<< $constraint->validate($value) >> -=item B +These two methods simply call the relevant method on each of the +member type constraints in the union. If any type accepts the value, +the value is valid. -=item B +With C the error message returned includes all of the error +messages returned by the member type constraints. -=back +=item B<< $constraint->equals($type_name_or_object) >> -=head2 Empty or Stub methods +A type is considered equal if it is also a union type, and the two +unions have the same member types. -These methods tend to not be very relevant in -the context of a union. Either that or they are -just difficult to specify and not very useful -anyway. They are here for completeness. +=item B<< $constraint->find_type_for($value) >> -=over 4 +This returns the first member type constraint for which C is +true, allowing you to determine which of the Union's member type constraints +a given value matches. + +=item B<< $constraint->is_a_type_of($type_name_or_object) >> -=item B +This returns true if any of the member type constraints return true +for the C method. -=item B +=item B<< $constraint->is_subtype_of >> -=item B +This returns true if any of the member type constraints return true +for the C method. -=item B +=item B<< $constraint->create_child_type(%options) >> -=item B +This returns a new L object with the type +as its parent. =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 @@ -210,7 +238,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006, 2007 by Infinity Interactive, Inc. +Copyright 2006-2010 by Infinity Interactive, Inc. L