bump version to 0.97
[gitmo/Moose.git] / lib / Moose / Meta / Method / Constructor.pm
index 706866c..c71cc60 100644 (file)
@@ -4,13 +4,13 @@ package Moose::Meta::Method::Constructor;
 use strict;
 use warnings;
 
-use Scalar::Util 'blessed', 'weaken', 'looks_like_number';
+use Scalar::Util 'blessed', 'weaken', 'looks_like_number', 'refaddr';
 
-our $VERSION   = '0.64';
+our $VERSION   = '0.97';
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Moose::Meta::Method',
-         'Class::MOP::Method::Generated';
+         'Class::MOP::Method::Constructor';
 
 sub new {
     my $class   = shift;
@@ -25,16 +25,12 @@ sub new {
         || $class->throw_error("You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT");
 
     my $self = bless {
-        # from our superclass
-        'body'          => undef, 
+        'body'          => undef,
         'package_name'  => $options{package_name},
         'name'          => $options{name},
-        # specific to this subclass
         'options'       => $options{options},
-        'meta_instance' => $meta->get_meta_instance,
-        'attributes'    => [ $meta->compute_all_applicable_attributes ],
-        # ...
         'associated_metaclass' => $meta,
+        '_expected_method_class' => $options{_expected_method_class} || 'Moose::Object',
     } => $class;
 
     # we don't want this creating
@@ -42,84 +38,14 @@ sub new {
     # needed
     weaken($self->{'associated_metaclass'});
 
-    $self->initialize_body;
+    $self->_initialize_body;
 
     return $self;
 }
 
-sub can_be_inlined {
-    my $self      = shift;
-    my $metaclass = $self->associated_metaclass;
-
-    my $expected_class = $self->_expected_constructor_class;
-
-    # If any of our parents have been made immutable, we are okay to
-    # inline our own new method. The assumption is that an inlined new
-    # method provided by a parent does not actually get used by
-    # children anyway.
-    for my $meta (
-        grep { $_->is_immutable }
-        map  { ( ref $metaclass )->initialize($_) }
-        grep { $_ ne $expected_class }
-        $metaclass->linearized_isa
-        ) {
-        my $transformer = $meta->get_immutable_transformer;
-
-        # This is actually a false positive if we're in a subclass of
-        # this class, _and_ the expected class is not overridden (but
-        # should be), and the real expected class is actually
-        # immutable itself (see Fey::Object::Table for an example of
-        # how this can happen). I'm not sure how to actually handle
-        # that case, since it's effectively a bug in the subclass (for
-        # not overriding _expected_constructor_class).
-        return 1 if $transformer->inlined_constructor;
-    }
-
-    if ( my $constructor = $metaclass->find_method_by_name( $self->name ) ) {
-        my $class = $self->associated_metaclass->name;
-
-        if ( $constructor->body != $expected_class->can('new') ) {
-            my $warning
-                = "Not inlining a constructor for $class since it is not"
-                . " inheriting the default $expected_class constructor\n";
-
-            $warning .= " (constructor has method modifiers which would be lost if it were inlined)\n"
-                if $constructor->isa('Class::MOP::Method::Wrapped');
-
-            warn $warning;
-
-            return 0;
-        }
-        else {
-            return 1;
-        }
-    }
-
-    # This would be a rather weird case where we have no constructor
-    # in the inheritance chain.
-    return 1;
-}
-
-# This is here so can_be_inlined can be inherited by MooseX modules.
-sub _expected_constructor_class {
-    return 'Moose::Object';
-}
-
-## accessors
-
-sub options       { (shift)->{'options'}       }
-sub meta_instance { (shift)->{'meta_instance'} }
-sub attributes    { (shift)->{'attributes'}    }
-
-sub associated_metaclass { (shift)->{'associated_metaclass'} }
-
 ## method
 
-# this was changed in 0.41, but broke MooseX::Singleton, so try to catch
-# any other code using the original broken spelling
-sub intialize_body { Moose->throw_error("Please correct the spelling of 'intialize_body' to 'initialize_body'") }
-
-sub initialize_body {
+sub _initialize_body {
     my $self = shift;
     # TODO:
     # the %options should also include a both
@@ -129,23 +55,22 @@ sub initialize_body {
     # requires some adaption on the part of
     # the author, after all, nothing is free)
     my $source = 'sub {';
-    $source .= "\n" . 'my $class = shift;';
-
-    $source .= "\n" . 'return $class->Moose::Object::new(@_)';
-    $source .= "\n" . '    if $class ne \'' . $self->associated_metaclass->name . '\';';
+    $source .= "\n" . 'my $_instance = shift;';
 
-    $source .= "\n" . 'my $params = ' . $self->_generate_BUILDARGS('$class', '@_');
+    $source .= "\n" . 'my $class = Scalar::Util::blessed($_instance) || $_instance;';
 
-    $source .= ";\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class');
+    $source .= "\n" . 'return $class->Moose::Object::new(@_)';
+    $source .= "\n    if \$class ne '" . $self->associated_metaclass->name
+            .  "';\n";
 
-    $source .= ";\n" . (join ";\n" => map {
-        $self->_generate_slot_initializer($_)
-    } 0 .. (@{$self->attributes} - 1));
+    $source .= $self->_generate_params('$params', '$class');
+    $source .= $self->_generate_instance('$instance', '$class');
+    $source .= $self->_generate_slot_initializers;
 
-    $source .= ";\n" . $self->_generate_triggers();    
+    $source .= $self->_generate_triggers();
     $source .= ";\n" . $self->_generate_BUILDALL();
 
-    $source .= ";\n" . 'return $instance';
+    $source .= ";\nreturn \$instance";
     $source .= ";\n" . '}';
     warn $source if $self->options->{debug};
 
@@ -158,7 +83,7 @@ sub initialize_body {
     # because the inlined code is using the index of the attributes
     # to determine where to find the type constraint
 
-    my $attrs = $self->attributes;
+    my $attrs = $self->_attributes;
 
     my @type_constraints = map {
         $_->can('type_constraint') ? $_->type_constraint : undef
@@ -168,7 +93,7 @@ sub initialize_body {
         defined $_ ? $_->_compiled_type_constraint : undef;
     } @type_constraints;
 
-    my $code = $self->_compile_code(
+    my ( $code, $e ) = $self->_compile_code(
         code => $source,
         environment => {
             '$meta'  => \$self,
@@ -176,11 +101,34 @@ sub initialize_body {
             '@type_constraints' => \@type_constraints,
             '@type_constraint_bodies' => \@type_constraint_bodies,
         },
-    ) or $self->throw_error("Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@", error => $@, data => $source );
+    );
+
+    $self->throw_error(
+        "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$e",
+        error => $e, data => $source )
+        if $e;
 
     $self->{'body'} = $code;
 }
 
+sub _generate_params {
+    my ( $self, $var, $class_var ) = @_;
+    "my $var = " . $self->_generate_BUILDARGS( $class_var, '@_' ) . ";\n";
+}
+
+sub _generate_instance {
+    my ( $self, $var, $class_var ) = @_;
+    "my $var = "
+        . $self->_meta_instance->inline_create_instance($class_var) . ";\n";
+}
+
+sub _generate_slot_initializers {
+    my ($self) = @_;
+    return (join ";\n" => map {
+        $self->_generate_slot_initializer($_)
+    } 0 .. (@{$self->_attributes} - 1)) . ";\n";
+}
+
 sub _generate_BUILDARGS {
     my ( $self, $class, $args ) = @_;
 
@@ -190,7 +138,7 @@ sub _generate_BUILDARGS {
         return join("\n",
             'do {',
             $self->_inline_throw_error('"Single parameters to new() must be a HASH ref"', 'data => $_[0]'),
-            '    if scalar @_ == 1 && defined $_[0] && ref($_[0]) ne q{HASH};',
+            '    if scalar @_ == 1 && !( defined $_[0] && ref $_[0] eq q{HASH} );',
             '(scalar @_ == 1) ? {%{$_[0]}} : {@_};',
             '}',
         );
@@ -211,34 +159,39 @@ sub _generate_BUILDALL {
 sub _generate_triggers {
     my $self = shift;
     my @trigger_calls;
-    foreach my $i (0 .. $#{ $self->attributes }) {
-        my $attr = $self->attributes->[$i];
-        if ($attr->can('has_trigger') && $attr->has_trigger) {
-            if (defined(my $init_arg = $attr->init_arg)) {
-                push @trigger_calls => (
-                    '(exists $params->{\'' . $init_arg . '\'}) && do {' . "\n    "
-                    .   '$attrs->[' . $i . ']->trigger->('
-                    .       '$instance, ' 
-                    .        $self->meta_instance->inline_get_slot_value(
-                                 '$instance',
-                                 ("'" . $attr->name . "'")
-                             ) 
-                             . ', '
-                    .        '$attrs->[' . $i . ']'
-                    .   ');'
-                    ."\n}"
-                );
-            } 
-        }
+    foreach my $i ( 0 .. $#{ $self->_attributes } ) {
+        my $attr = $self->_attributes->[$i];
+
+        next unless $attr->can('has_trigger') && $attr->has_trigger;
+
+        my $init_arg = $attr->init_arg;
+
+        next unless defined $init_arg;
+
+        push @trigger_calls => '(exists $params->{\''
+            . $init_arg
+            . '\'}) && do {'
+            . "\n    "
+            . '$attrs->['
+            . $i
+            . ']->trigger->('
+            . '$instance, '
+            . $self->_meta_instance->inline_get_slot_value(
+                  '$instance',
+                  $attr->name,
+              )
+            . ', '
+            . ');' . "\n}";
     }
-    return join ";\n" => @trigger_calls;    
+
+    return join ";\n" => @trigger_calls;
 }
 
 sub _generate_slot_initializer {
     my $self  = shift;
     my $index = shift;
 
-    my $attr = $self->attributes->[$index];
+    my $attr = $self->_attributes->[$index];
 
     my @source = ('## ' . $attr->name);
 
@@ -246,7 +199,7 @@ sub _generate_slot_initializer {
 
     if ($is_moose && defined($attr->init_arg) && $attr->is_required && !$attr->has_default && !$attr->has_builder) {
         push @source => ('(exists $params->{\'' . $attr->init_arg . '\'}) ' .
-                        '|| ' . $self->_inline_throw_error('"Attribute (' . $attr->name . ') is required"') .';');
+                        '|| ' . $self->_inline_throw_error('"Attribute (' . quotemeta($attr->name) . ') is required"') .';');
     }
 
     if (($attr->has_default || $attr->has_builder) && !($is_moose && $attr->is_lazy)) {
@@ -262,18 +215,18 @@ sub _generate_slot_initializer {
             my $default;
             if ( $attr->has_default ) {
                 $default = $self->_generate_default_value($attr, $index);
-            } 
+            }
             else {
                my $builder = $attr->builder;
                $default = '$instance->' . $builder;
             }
-            
+
             push @source => '{'; # wrap this to avoid my $val overwrite warnings
             push @source => ('my $val = ' . $default . ';');
             push @source => $self->_generate_type_constraint_and_coercion($attr, $index)
-                if $is_moose; 
+                if $is_moose;
             push @source => $self->_generate_slot_assignment($attr, '$val', $index);
-            push @source => '}'; # close - wrap this to avoid my $val overrite warnings           
+            push @source => '}'; # close - wrap this to avoid my $val overrite warnings
 
         push @source => "}" if defined $attr->init_arg;
     }
@@ -284,16 +237,16 @@ sub _generate_slot_initializer {
             if ($is_moose && $attr->has_type_constraint) {
                 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
                     push @source => $self->_generate_type_coercion(
-                        $attr, 
-                        '$type_constraints[' . $index . ']', 
-                        '$val', 
+                        $attr,
+                        '$type_constraints[' . $index . ']',
+                        '$val',
                         '$val'
                     );
                 }
                 push @source => $self->_generate_type_constraint_check(
-                    $attr, 
-                    '$type_constraint_bodies[' . $index . ']', 
-                    '$type_constraints[' . $index . ']',                     
+                    $attr,
+                    '$type_constraint_bodies[' . $index . ']',
+                    '$type_constraints[' . $index . ']',
                     '$val'
                 );
             }
@@ -309,30 +262,30 @@ sub _generate_slot_assignment {
     my ($self, $attr, $value, $index) = @_;
 
     my $source;
-    
+
     if ($attr->has_initializer) {
         $source = (
             '$attrs->[' . $index . ']->set_initial_value($instance, ' . $value . ');'
-        );        
+        );
     }
     else {
         $source = (
-            $self->meta_instance->inline_set_slot_value(
+            $self->_meta_instance->inline_set_slot_value(
                 '$instance',
-                ("'" . $attr->name . "'"),
+                $attr->name,
                 $value
             ) . ';'
-        );        
+        );
     }
-    
-    my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME        
+
+    my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
 
     if ($is_moose && $attr->is_weak_ref) {
         $source .= (
             "\n" .
-            $self->meta_instance->inline_weaken_slot_value(
+            $self->_meta_instance->inline_weaken_slot_value(
                 '$instance',
-                ("'" . $attr->name . "'")
+                $attr->name
             ) .
             ' if ref ' . $value . ';'
         );
@@ -343,9 +296,9 @@ sub _generate_slot_assignment {
 
 sub _generate_type_constraint_and_coercion {
     my ($self, $attr, $index) = @_;
-    
+
     return unless $attr->has_type_constraint;
-    
+
     my @source;
     if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
         push @source => $self->_generate_type_coercion(
@@ -358,7 +311,7 @@ sub _generate_type_constraint_and_coercion {
     push @source => $self->_generate_type_constraint_check(
         $attr,
         ('$type_constraint_bodies[' . $index . ']'),
-        ('$type_constraints[' . $index . ']'),            
+        ('$type_constraints[' . $index . ']'),
         '$val'
     );
     return @source;
@@ -373,8 +326,8 @@ sub _generate_type_constraint_check {
     my ($self, $attr, $type_constraint_cv, $type_constraint_obj, $value_name) = @_;
     return (
         $self->_inline_throw_error('"Attribute (' # FIXME add 'dad'
-        . $attr->name 
-        . ') does not pass the type constraint because: " . ' 
+        . quotemeta( $attr->name )
+        . ') does not pass the type constraint because: " . '
         . $type_constraint_obj . '->get_message(' . $value_name . ')')
         . "\n\t unless " .  $type_constraint_cv . '->(' . $value_name . ');'
     );
@@ -408,32 +361,20 @@ Moose::Meta::Method::Constructor - Method Meta Object for constructors
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Method> which handles
-constructing an approprate Constructor methods. This is primarily
-used in the making of immutable metaclasses, otherwise it is
-not particularly useful.
-
-=head1 METHODS
-
-=over 4
-
-=item B<new>
-
-=item B<can_be_inlined>
-
-=item B<attributes>
-
-=item B<meta_instance>
+This class is a subclass of L<Class::MOP::Class::Constructor> that
+provides additional Moose-specific functionality
 
-=item B<options>
+To understand this class, you should read the the
+L<Class::MOP::Class::Constructor> documentation as well.
 
-=item B<initialize_body>
+=head1 INHERITANCE
 
-=item B<associated_metaclass>
+C<Moose::Meta::Method::Constructor> is a subclass of
+L<Moose::Meta::Method> I<and> L<Class::MOP::Method::Constructor>.
 
-=item B<can_be_inlined>
+=head1 BUGS
 
-=back
+See L<Moose/BUGS> for details on reporting bugs.
 
 =head1 AUTHORS
 
@@ -441,7 +382,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>