bump version
[gitmo/Class-MOP.git] / lib / Class / MOP / Immutable.pm
index 3037a1a..540890e 100644 (file)
@@ -9,7 +9,7 @@ use Class::MOP::Method::Constructor;
 use Carp         'confess';
 use Scalar::Util 'blessed';
 
-our $VERSION   = '0.71';
+our $VERSION   = '0.73';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -36,6 +36,7 @@ sub new {
         'metaclass'           => $metaclass,
         'options'             => $options,
         'immutable_metaclass' => undef,
+        'inlined_constructor' => undef,
     );
 
     return $self;
@@ -58,6 +59,7 @@ sub immutable_metaclass {
 
 sub metaclass           { (shift)->{'metaclass'}           }
 sub options             { (shift)->{'options'}             }
+sub inlined_constructor { (shift)->{'inlined_constructor'} }
 
 sub create_immutable_metaclass {
     my $self = shift;
@@ -116,191 +118,255 @@ sub make_metaclass_immutable {
 
     %$options = %options; # FIXME who the hell is relying on this?!? tests fail =(
 
-    if ($options{inline_accessors}) {
-        foreach my $attr_name ($metaclass->get_attribute_list) {
-            # inline the accessors
-            $metaclass->get_attribute($attr_name)
-                      ->install_accessors(1);
-        }
-    }
+    $self->_inline_accessors( $metaclass, \%options );
+    $self->_inline_constructor( $metaclass, \%options );
+    $self->_inline_destructor( $metaclass, \%options );
+    $self->_check_memoized_methods( $metaclass, \%options );
 
-    if ($options{inline_constructor}) {
-        my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor';
-        $metaclass->add_method(
-            $options{constructor_name},
-            $constructor_class->new(
-                options      => \%options,
-                metaclass    => $metaclass,
-                is_inline    => 1,
-                package_name => $metaclass->name,
-                name         => $options{constructor_name}
-            )
-        ) if $options{replace_constructor} or !$metaclass->has_method($options{constructor_name});
-    }
+    $metaclass->{'___original_class'} = blessed($metaclass);
+    bless $metaclass => $self->immutable_metaclass->name;
+}
 
-    if ($options{inline_destructor}) {
-        (exists $options{destructor_class})
-            || confess "The 'inline_destructor' option is present, but "
-                     . "no destructor class was specified";
-
-        my $destructor_class = $options{destructor_class};
-
-        # NOTE:
-        # we allow the destructor to determine
-        # if it is needed or not before we actually 
-        # create the destructor too
-        # - SL
-        if ($destructor_class->is_needed($metaclass)) {
-            my $destructor = $destructor_class->new(
-                options      => \%options,
-                metaclass    => $metaclass,
-                package_name => $metaclass->name,
-                name         => 'DESTROY'            
-            );
-
-            $metaclass->add_method('DESTROY' => $destructor)
-                # NOTE:
-                # we allow the destructor to determine
-                # if it is needed or not, it can perform
-                # all sorts of checks because it has the
-                # metaclass instance
-                if $destructor->is_needed;
-        }
-    }
+sub _inline_accessors {
+    my ( $self, $metaclass, $options ) = @_;
 
-    my $memoized_methods = $self->options->{memoize};
-    foreach my $method_name (keys %{$memoized_methods}) {
-        my $type = $memoized_methods->{$method_name};
+    return unless $options->{inline_accessors};
 
-        ($metaclass->can($method_name))
-            || confess "Could not find the method '$method_name' in " . $metaclass->name;
+    foreach my $attr_name ( $metaclass->get_attribute_list ) {
+        $metaclass->get_attribute($attr_name)->install_accessors(1);
     }
-
-    $metaclass->{'___original_class'} = blessed($metaclass);
-    bless $metaclass => $self->immutable_metaclass->name;
 }
 
-sub make_metaclass_mutable {
-    my ($self, $immutable, $options) = @_;
+sub _inline_constructor {
+    my ( $self, $metaclass, $options ) = @_;
 
-    my %options = %$options;
+    return unless $options->{inline_constructor};
 
-    my $original_class = $immutable->get_mutable_metaclass_name;
-    delete $immutable->{'___original_class'} ;
-    bless $immutable => $original_class;
+    return
+        unless $options->{replace_constructor}
+            or !$metaclass->has_method( $options->{constructor_name} );
 
-    my $memoized_methods = $self->options->{memoize};
-    foreach my $method_name (keys %{$memoized_methods}) {
-        my $type = $memoized_methods->{$method_name};
+    my $constructor_class = $options->{constructor_class}
+        || 'Class::MOP::Method::Constructor';
 
-        ($immutable->can($method_name))
-          || confess "Could not find the method '$method_name' in " . $immutable->name;
-        if ($type eq 'SCALAR' || $type eq 'ARRAY' ||  $type eq 'HASH' ) {
-            delete $immutable->{'___' . $method_name};
-        }
-    }
+    my $constructor = $constructor_class->new(
+        options      => $options,
+        metaclass    => $metaclass,
+        is_inline    => 1,
+        package_name => $metaclass->name,
+        name         => $options->{constructor_name},
+    );
 
-    if ($options{inline_destructor} && $immutable->has_method('DESTROY')) {
-        $immutable->remove_method('DESTROY')
-          if blessed($immutable->get_method('DESTROY')) eq $options{destructor_class};
+    if ( $options->{replace_constructor} or $constructor->can_be_inlined ) {
+        $metaclass->add_method( $options->{constructor_name} => $constructor );
+        $self->{inlined_constructor} = $constructor;
     }
+}
 
-    # NOTE:
-    # 14:01 <@stevan> nah,. you shouldnt
-    # 14:01 <@stevan> they are just inlined
-    # 14:01 <@stevan> which is the default in Moose anyway
-    # 14:02 <@stevan> and adding new attributes will just DWIM
-    # 14:02 <@stevan> and you really cant change an attribute anyway
-    # if ($options{inline_accessors}) {
-    #     foreach my $attr_name ($immutable->get_attribute_list) {
-    #         my $attr = $immutable->get_attribute($attr_name);
-    #         $attr->remove_accessors;
-    #         $attr->install_accessors(0);
-    #     }
-    # }
+sub _inline_destructor {
+    my ( $self, $metaclass, $options ) = @_;
 
-    # 14:26 <@stevan> the only user of ::Method::Constructor is immutable
-    # 14:27 <@stevan> if someone uses it outside of immutable,.. they are either: mst or groditi
-    # 14:27 <@stevan> so I am not worried
-    if ($options{inline_constructor}  && $immutable->has_method($options{constructor_name})) {
-        my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor';
-        $immutable->remove_method( $options{constructor_name}  )
-          if blessed($immutable->get_method($options{constructor_name})) eq $constructor_class;
+    return unless $options->{inline_destructor};
+
+    ( exists $options->{destructor_class} )
+        || confess "The 'inline_destructor' option is present, but "
+        . "no destructor class was specified";
+
+    my $destructor_class = $options->{destructor_class};
+
+    return unless $destructor_class->is_needed($metaclass);
+
+    my $destructor = $destructor_class->new(
+        options      => $options,
+        metaclass    => $metaclass,
+        package_name => $metaclass->name,
+        name         => 'DESTROY'
+    );
+
+    return unless $destructor->is_needed;
+
+    $metaclass->add_method( 'DESTROY' => $destructor )
+}
+
+sub _check_memoized_methods {
+    my ( $self, $metaclass, $options ) = @_;
+
+    my $memoized_methods = $self->options->{memoize};
+    foreach my $method_name ( keys %{$memoized_methods} ) {
+        my $type = $memoized_methods->{$method_name};
+
+        ( $metaclass->can($method_name) )
+            || confess "Could not find the method '$method_name' in "
+            . $metaclass->name;
     }
 }
 
 sub create_methods_for_immutable_metaclass {
     my $self = shift;
 
-    my %methods = %DEFAULT_METHODS;
+    my %methods   = %DEFAULT_METHODS;
     my $metaclass = $self->metaclass;
-    my $meta = $metaclass->meta;
+    my $meta      = $metaclass->meta;
+
+    $methods{get_mutable_metaclass_name}
+        = sub { (shift)->{'___original_class'} };
+
+    $methods{immutable_transformer} = sub {$self};
+
+    return {
+        %DEFAULT_METHODS,
+        $self->_make_read_only_methods( $metaclass, $meta ),
+        $self->_make_uncallable_methods( $metaclass, $meta ),
+        $self->_make_memoized_methods( $metaclass, $meta ),
+        $self->_make_wrapped_methods( $metaclass, $meta ),
+        get_mutable_metaclass_name => sub { (shift)->{'___original_class'} },
+        immutable_transformer      => sub {$self},
+    };
+}
+
+sub _make_read_only_methods {
+    my ( $self, $metaclass, $meta ) = @_;
 
-    foreach my $read_only_method (@{$self->options->{read_only}}) {
+    my %methods;
+    foreach my $read_only_method ( @{ $self->options->{read_only} } ) {
         my $method = $meta->find_method_by_name($read_only_method);
 
-        (defined $method)
-            || confess "Could not find the method '$read_only_method' in " . $metaclass->name;
+        ( defined $method )
+            || confess "Could not find the method '$read_only_method' in "
+            . $metaclass->name;
 
         $methods{$read_only_method} = sub {
             confess "This method is read-only" if scalar @_ > 1;
-            goto &{$method->body}
+            goto &{ $method->body };
         };
     }
 
-    foreach my $cannot_call_method (@{$self->options->{cannot_call}}) {
+    return %methods;
+}
+
+sub _make_uncallable_methods {
+    my ( $self, $metaclass, $meta ) = @_;
+
+    my %methods;
+    foreach my $cannot_call_method ( @{ $self->options->{cannot_call} } ) {
         $methods{$cannot_call_method} = sub {
-            confess "This method ($cannot_call_method) cannot be called on an immutable instance";
+            confess
+                "This method ($cannot_call_method) cannot be called on an immutable instance";
         };
     }
 
+    return %methods;
+}
+
+sub _make_memoized_methods {
+    my ( $self, $metaclass, $meta ) = @_;
+
+    my %methods;
+
     my $memoized_methods = $self->options->{memoize};
-    foreach my $method_name (keys %{$memoized_methods}) {
-        my $type = $memoized_methods->{$method_name};
-        my $key = '___' . $method_name;
+    foreach my $method_name ( keys %{$memoized_methods} ) {
+        my $type   = $memoized_methods->{$method_name};
+        my $key    = '___' . $method_name;
         my $method = $meta->find_method_by_name($method_name);
 
-        if ($type eq 'ARRAY') {
+        if ( $type eq 'ARRAY' ) {
             $methods{$method_name} = sub {
-                @{$_[0]->{$key}} = $method->execute($_[0])
+                @{ $_[0]->{$key} } = $method->execute( $_[0] )
                     if !exists $_[0]->{$key};
-                return @{$_[0]->{$key}};
+                return @{ $_[0]->{$key} };
             };
         }
-        elsif ($type eq 'HASH') {
+        elsif ( $type eq 'HASH' ) {
             $methods{$method_name} = sub {
-                %{$_[0]->{$key}} = $method->execute($_[0])
+                %{ $_[0]->{$key} } = $method->execute( $_[0] )
                     if !exists $_[0]->{$key};
-                return %{$_[0]->{$key}};
+                return %{ $_[0]->{$key} };
             };
         }
-        elsif ($type eq 'SCALAR') {
+        elsif ( $type eq 'SCALAR' ) {
             $methods{$method_name} = sub {
-                $_[0]->{$key} = $method->execute($_[0])
+                $_[0]->{$key} = $method->execute( $_[0] )
                     if !exists $_[0]->{$key};
                 return $_[0]->{$key};
             };
         }
     }
-    
+
+    return %methods;
+}
+
+sub _make_wrapped_methods {
+    my ( $self, $metaclass, $meta ) = @_;
+
+    my %methods;
+
     my $wrapped_methods = $self->options->{wrapped};
-    
-    foreach my $method_name (keys %{ $wrapped_methods }) {
+
+    foreach my $method_name ( keys %{$wrapped_methods} ) {
         my $method = $meta->find_method_by_name($method_name);
 
-        (defined $method)
-            || confess "Could not find the method '$method_name' in " . $metaclass->name;
+        ( defined $method )
+            || confess "Could not find the method '$method_name' in "
+            . $metaclass->name;
 
         my $wrapper = $wrapped_methods->{$method_name};
 
-        $methods{$method_name} = sub { $wrapper->($method, @_) };
+        $methods{$method_name} = sub { $wrapper->( $method, @_ ) };
+    }
+
+    return %methods;
+}
+
+sub make_metaclass_mutable {
+    my ($self, $immutable, $options) = @_;
+
+    my %options = %$options;
+
+    my $original_class = $immutable->get_mutable_metaclass_name;
+    delete $immutable->{'___original_class'} ;
+    bless $immutable => $original_class;
+
+    my $memoized_methods = $self->options->{memoize};
+    foreach my $method_name (keys %{$memoized_methods}) {
+        my $type = $memoized_methods->{$method_name};
+
+        ($immutable->can($method_name))
+          || confess "Could not find the method '$method_name' in " . $immutable->name;
+        if ($type eq 'SCALAR' || $type eq 'ARRAY' ||  $type eq 'HASH' ) {
+            delete $immutable->{'___' . $method_name};
+        }
     }
 
-    $methods{get_mutable_metaclass_name} = sub { (shift)->{'___original_class'} };
+    if ($options{inline_destructor} && $immutable->has_method('DESTROY')) {
+        $immutable->remove_method('DESTROY')
+          if blessed($immutable->get_method('DESTROY')) eq $options{destructor_class};
+    }
 
-    $methods{immutable_transformer} = sub { $self };
+    # NOTE:
+    # 14:01 <@stevan> nah,. you shouldnt
+    # 14:01 <@stevan> they are just inlined
+    # 14:01 <@stevan> which is the default in Moose anyway
+    # 14:02 <@stevan> and adding new attributes will just DWIM
+    # 14:02 <@stevan> and you really cant change an attribute anyway
+    # if ($options{inline_accessors}) {
+    #     foreach my $attr_name ($immutable->get_attribute_list) {
+    #         my $attr = $immutable->get_attribute($attr_name);
+    #         $attr->remove_accessors;
+    #         $attr->install_accessors(0);
+    #     }
+    # }
+
+    # 14:26 <@stevan> the only user of ::Method::Constructor is immutable
+    # 14:27 <@stevan> if someone uses it outside of immutable,.. they are either: mst or groditi
+    # 14:27 <@stevan> so I am not worried
+    if ($options{inline_constructor}  && $immutable->has_method($options{constructor_name})) {
+        my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor';
 
-    return \%methods;
+        if ( blessed($immutable->get_method($options{constructor_name})) eq $constructor_class ) {
+            $immutable->remove_method( $options{constructor_name}  );
+            $self->{inlined_constructor} = undef;
+        }
+    }
 }
 
 1;
@@ -396,6 +462,11 @@ This will change the C<$metaclass> into the mutable version by reversing
 the immutable process. C<%options> should be the same options that were
 given to make_metaclass_immutable.
 
+=item B<inlined_constructor>
+
+If the constructor was inlined, this returns the constructor method
+object that was created to do this.
+
 =back
 
 =head1 AUTHORS