RT#83929: fix memory leak in union types
[gitmo/Moose.git] / lib / Moose / Meta / TypeConstraint / Union.pm
index 9167111..0ee8165 100644 (file)
@@ -5,84 +5,143 @@ use strict;
 use warnings;
 use metaclass;
 
-our $VERSION = '0.03';
+use Moose::Meta::TypeCoercion::Union;
+
+use List::MoreUtils qw(all);
+use List::Util qw(first);
+
+use base 'Moose::Meta::TypeConstraint';
 
 __PACKAGE__->meta->add_attribute('type_constraints' => (
     accessor  => 'type_constraints',
-    default   => sub { [] }
+    default   => sub { [] },
+    Class::MOP::_definition_context(),
 ));
 
-sub new { 
-    my $class = shift;
-    my $self  = $class->meta->new_object(@_);
-    return $self;
-}
+sub new {
+    my ($class, %options) = @_;
 
-sub name { join ' | ' => map { $_->name } @{$_[0]->type_constraints} }
+    my $name = join '|' => sort { $a cmp $b }
+        map { $_->name } @{ $options{type_constraints} };
 
-# NOTE:
-# this should probably never be used
-# but we include it here for completeness
-sub constraint    { 
-    my $self = shift;
-    sub { $self->check($_[0]) }; 
+    my $self = $class->SUPER::new(
+        name => $name,
+        %options,
+    );
+
+    $self->_set_constraint( $self->_compiled_type_constraint );
+
+    return $self;
 }
 
-# conform to the TypeConstraint API
-sub parent        { undef  }
-sub message       { undef  }
-sub has_message   { 0      }
+# XXX - this is a rather gross implementation of laziness for the benefit of
+# MX::Types. If we try to call ->has_coercion on the objects during object
+# construction, this does not work when defining a recursive constraint with
+# MX::Types.
+sub coercion {
+    my $self = shift;
 
-# FIXME:
-# not sure what this should actually do here
-sub coercion { undef  }
+    return $self->{coercion} if exists $self->{coercion};
 
-# this should probably be memoized
-sub has_coercion  {
-    my $self  = shift;
-    foreach my $type (@{$self->type_constraints}) {
-        return 1 if $type->has_coercion
+    # Using any instead of grep here causes a weird error with some corner
+    # cases when MX::Types is in use. See RT #61001.
+    if ( grep { $_->has_coercion } @{ $self->type_constraints } ) {
+        return $self->{coercion} = Moose::Meta::TypeCoercion::Union->new(
+            type_constraint => $self );
+    }
+    else {
+        return $self->{coercion} = undef;
     }
-    return 0;    
 }
 
-# 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;    
+sub has_coercion {
+    return defined $_[0]->coercion;
 }
 
-sub _compiled_type_constraint {
-    my $self  = shift;
+sub _actually_compile_type_constraint {
+    my $self = shift;
+
+    my @constraints = @{ $self->type_constraints };
+
     return sub {
         my $value = shift;
-        foreach my $type (@{$self->type_constraints}) {
+        foreach my $type (@constraints) {
             return 1 if $type->check($value);
         }
-        return undef;    
+        return undef;
+    };
+}
+
+sub can_be_inlined {
+    my $self = shift;
+
+    # This was originally done with all() from List::MoreUtils, but that
+    # caused some sort of bizarro parsing failure under 5.10.
+    for my $tc ( @{ $self->type_constraints } ) {
+        return 0 unless $tc->can_be_inlined;
     }
+
+    return 1;
 }
 
-sub check {
-    my $self  = shift;
-    my $value = shift;
-    $self->_compiled_type_constraint->($value);
+sub _inline_check {
+    my $self = shift;
+    my $val  = shift;
+
+    return '('
+               . (
+                  join ' || ', map { '(' . $_->_inline_check($val) . ')' }
+                  @{ $self->type_constraints }
+                 )
+           . ')';
+}
+
+sub inline_environment {
+    my $self = shift;
+
+    return { map { %{ $_->inline_environment } }
+            @{ $self->type_constraints } };
+}
+
+sub equals {
+    my ( $self, $type_or_name ) = @_;
+
+    my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name);
+
+    return unless $other->isa(__PACKAGE__);
+
+    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 @other_constraints == 0;
+}
+
+sub parent {
+    my $self = shift;
+
+    my ($first, @rest) = @{ $self->type_constraints };
+
+    for my $parent ( $first->_collect_all_parents ) {
+        return $parent if all { $_->is_a_type_of($parent) } @rest;
+    }
+
+    return;
 }
 
 sub validate {
-    my $self  = shift;
-    my $value = shift;
+    my ($self, $value) = @_;
     my $message;
     foreach my $type (@{$self->type_constraints}) {
         my $err = $type->validate($value);
@@ -90,29 +149,138 @@ 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 {
     my ($self, $type_name) = @_;
-    foreach my $type (@{$self->type_constraints}) {
-        return 1 if $type->is_a_type_of($type_name);
-    }
-    return 0;    
+
+    return all { $_->is_a_type_of($type_name) } @{ $self->type_constraints };
 }
 
 sub is_subtype_of {
     my ($self, $type_name) = @_;
-    foreach my $type (@{$self->type_constraints}) {
-        return 1 if $type->is_subtype_of($type_name);
+
+    return all { $_->is_subtype_of($type_name) } @{ $self->type_constraints };
+}
+
+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,
+            )
+        );
     }
-    return 0;
+
+    return $constraint;
 }
 
 1;
 
+# ABSTRACT: A union of Moose type constraints
+
 __END__
 
 =pod
 
+=head1 DESCRIPTION
+
+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 INHERITANCE
+
+C<Moose::Meta::TypeConstraint::Union> is a subclass of
+L<Moose::Meta::TypeConstraint>.
+
+=over 4
+
+=item B<< Moose::Meta::TypeConstraint::Union->new(%options) >>
+
+This creates a new class type constraint based on the given
+C<%options>.
+
+It takes the same options as its parent. It also requires an
+additional option, C<type_constraints>. This is an array reference
+containing the L<Moose::Meta::TypeConstraint> objects that are the
+members of the union type. The C<name> option defaults to the names
+all of these member types sorted and then joined by a pipe (|).
+
+The constructor sets the implementation of the constraint so that is
+simply calls C<check> on the newly created object.
+
+Finally, the constructor also makes sure that the object's C<coercion>
+attribute is a L<Moose::Meta::TypeCoercion::Union> object.
+
+=item B<< $constraint->type_constraints >>
+
+This returns the array reference of C<type_constraints> provided to
+the constructor.
+
+=item B<< $constraint->parent >>
+
+This returns the nearest common ancestor of all the components of the union.
+
+=item B<< $constraint->check($value) >>
+
+=item B<< $constraint->validate($value) >>
+
+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.
+
+With C<validate> the error message returned includes all of the error
+messages returned by the member type constraints.
+
+=item B<< $constraint->equals($type_name_or_object) >>
+
+A type is considered equal if it is also a union type, and the two
+unions have the same member types.
+
+=item B<< $constraint->find_type_for($value) >>
+
+This returns the first member type constraint for which C<check($value)> 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) >>
+
+This returns true if all of the member type constraints return true
+for the C<is_a_type_of> method.
+
+=item B<< $constraint->is_subtype_of >>
+
+This returns true if all of the member type constraints return true
+for the C<is_a_subtype_of> method.
+
+=item B<< $constraint->create_child_type(%options) >>
+
+This returns a new L<Moose::Meta::TypeConstraint> object with the type
+as its parent.
+
+=back
+
+=head1 BUGS
+
+See L<Moose/BUGS> for details on reporting bugs.
+
 =cut