2 package Moose::Meta::TypeConstraint::Union;
8 use Moose::Meta::TypeCoercion::Union;
10 use List::Util qw(first);
12 our $VERSION = '1.23';
13 $VERSION = eval $VERSION;
14 our $AUTHORITY = 'cpan:STEVAN';
16 use base 'Moose::Meta::TypeConstraint';
18 __PACKAGE__->meta->add_attribute('type_constraints' => (
19 accessor => 'type_constraints',
24 my ($class, %options) = @_;
26 my $name = join '|' => sort { $a cmp $b }
27 map { $_->name } @{ $options{type_constraints} };
29 my $self = $class->SUPER::new(
34 $self->_set_constraint(sub { $self->check($_[0]) });
39 # XXX - this is a rather gross implementation of laziness for the benefit of
40 # MX::Types. If we try to call ->has_coercion on the objects during object
41 # construction, this does not work when defining a recursive constraint with
46 return $self->{coercion} if exists $self->{coercion};
48 # Using any instead of grep here causes a weird error with some corner
49 # cases when MX::Types is in use. See RT #61001.
50 if ( grep { $_->has_coercion } @{ $self->type_constraints } ) {
51 return $self->{coercion} = Moose::Meta::TypeCoercion::Union->new(
52 type_constraint => $self );
55 return $self->{coercion} = undef;
60 return defined $_[0]->coercion;
63 sub _actually_compile_type_constraint {
66 my @constraints = @{ $self->type_constraints };
70 foreach my $type (@constraints) {
71 return 1 if $type->check($value);
79 my ( $self, $type_or_name ) = @_;
81 my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name);
83 return unless $other->isa(__PACKAGE__);
85 my @self_constraints = @{ $self->type_constraints };
86 my @other_constraints = @{ $other->type_constraints };
88 return unless @self_constraints == @other_constraints;
90 # FIXME presort type constraints for efficiency?
91 constraint: foreach my $constraint ( @self_constraints ) {
92 for ( my $i = 0; $i < @other_constraints; $i++ ) {
93 if ( $constraint->equals($other_constraints[$i]) ) {
94 splice @other_constraints, $i, 1;
100 return @other_constraints == 0;
105 $self->type_constraints;
109 my ($self, $value) = @_;
111 foreach my $type (@{$self->type_constraints}) {
112 my $err = $type->validate($value);
113 return unless defined $err;
114 $message .= ($message ? ' and ' : '') . $err
117 return ($message . ' in (' . $self->name . ')') ;
121 my ($self, $value) = @_;
123 return first { $_->check($value) } @{ $self->type_constraints };
127 my ($self, $type_name) = @_;
128 foreach my $type (@{$self->type_constraints}) {
129 return 1 if $type->is_a_type_of($type_name);
135 my ($self, $type_name) = @_;
136 foreach my $type (@{$self->type_constraints}) {
137 return 1 if $type->is_subtype_of($type_name);
142 sub create_child_type {
143 my ( $self, %opts ) = @_;
146 = Moose::Meta::TypeConstraint->new( %opts, parent => $self );
148 # if we have a type constraint union, and no
149 # type check, this means we are just aliasing
150 # the union constraint, which means we need to
151 # handle this differently.
153 if ( not( defined $opts{constraint} )
154 && $self->has_coercion ) {
155 $constraint->coercion(
156 Moose::Meta::TypeCoercion::Union->new(
157 type_constraint => $self,
173 Moose::Meta::TypeConstraint::Union - A union of Moose type constraints
177 This metaclass represents a union of type constraints. A union takes
178 multiple type constraints, and is true if any one of its member
183 C<Moose::Meta::TypeConstraint::Union> is a subclass of
184 L<Moose::Meta::TypeConstraint>.
188 =item B<< Moose::Meta::TypeConstraint::Union->new(%options) >>
190 This creates a new class type constraint based on the given
193 It takes the same options as its parent. It also requires an
194 additional option, C<type_constraints>. This is an array reference
195 containing the L<Moose::Meta::TypeConstraint> objects that are the
196 members of the union type. The C<name> option defaults to the names
197 all of these member types sorted and then joined by a pipe (|).
199 The constructor sets the implementation of the constraint so that is
200 simply calls C<check> on the newly created object.
202 Finally, the constructor also makes sure that the object's C<coercion>
203 attribute is a L<Moose::Meta::TypeCoercion::Union> object.
205 =item B<< $constraint->type_constraints >>
207 This returns the array reference of C<type_constraints> provided to
210 =item B<< $constraint->parents >>
212 This returns the same constraint as the C<type_constraints> method.
214 =item B<< $constraint->check($value) >>
216 =item B<< $constraint->validate($value) >>
218 These two methods simply call the relevant method on each of the
219 member type constraints in the union. If any type accepts the value,
222 With C<validate> the error message returned includes all of the error
223 messages returned by the member type constraints.
225 =item B<< $constraint->equals($type_name_or_object) >>
227 A type is considered equal if it is also a union type, and the two
228 unions have the same member types.
230 =item B<< $constraint->find_type_for($value) >>
232 This returns the first member type constraint for which C<check($value)> is
233 true, allowing you to determine which of the Union's member type constraints
234 a given value matches.
236 =item B<< $constraint->is_a_type_of($type_name_or_object) >>
238 This returns true if any of the member type constraints return true
239 for the C<is_a_type_of> method.
241 =item B<< $constraint->is_subtype_of >>
243 This returns true if any of the member type constraints return true
244 for the C<is_a_subtype_of> method.
246 =item B<< $constraint->create_child_type(%options) >>
248 This returns a new L<Moose::Meta::TypeConstraint> object with the type
255 See L<Moose/BUGS> for details on reporting bugs.
259 Stevan Little E<lt>stevan@iinteractive.comE<gt>
261 =head1 COPYRIGHT AND LICENSE
263 Copyright 2006-2010 by Infinity Interactive, Inc.
265 L<http://www.iinteractive.com>
267 This library is free software; you can redistribute it and/or modify
268 it under the same terms as Perl itself.