Bump all versions to 0.68
[gitmo/Class-MOP.git] / lib / Class / MOP / Immutable.pm
index 1d530e5..642b0f0 100644 (file)
@@ -9,29 +9,54 @@ use Class::MOP::Method::Constructor;
 use Carp         'confess';
 use Scalar::Util 'blessed';
 
-our $VERSION   = '0.01';
+our $VERSION   = '0.68';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
+use base 'Class::MOP::Object';
+
 sub new {
-    my ($class, $metaclass, $options) = @_;
+    my ($class, @args) = @_;
+
+    my ( $metaclass, $options );
+
+    if ( @args == 2 ) {
+        # compatibility args
+        ( $metaclass, $options ) = @args;
+    } else {
+        unshift @args, "metaclass" if @args % 2 == 1;
 
-    my $self = bless {
-        '$!metaclass'           => $metaclass,
-        '%!options'             => $options,
-        '$!immutable_metaclass' => undef,
-    } => $class;
+        # default named args
+        my %options = @args;
+        $options = \%options;
+        $metaclass = $options{metaclass};
+    }
+
+    my $self = $class->_new(
+        'metaclass'           => $metaclass,
+        'options'             => $options,
+        'immutable_metaclass' => undef,
+    );
 
     # NOTE:
     # we initialize the immutable
     # version of the metaclass here
+    # FIXME lazify
     $self->create_immutable_metaclass;
 
     return $self;
 }
 
-sub immutable_metaclass { (shift)->{'$!immutable_metaclass'} }
-sub metaclass           { (shift)->{'$!metaclass'}           }
-sub options             { (shift)->{'%!options'}             }
+sub _new {
+    my $class = shift;
+    my $options = @_ == 1 ? $_[0] : {@_};
+
+    bless $options, $class;
+}
+
+sub immutable_metaclass { (shift)->{'immutable_metaclass'} }
+sub metaclass           { (shift)->{'metaclass'}           }
+sub options             { (shift)->{'options'}             }
 
 sub create_immutable_metaclass {
     my $self = shift;
@@ -41,7 +66,7 @@ sub create_immutable_metaclass {
     # metaclass is just a anon-class
     # which shadows the methods
     # appropriately
-    $self->{'$!immutable_metaclass'} = Class::MOP::Class->create_anon_class(
+    $self->{'immutable_metaclass'} = Class::MOP::Class->create_anon_class(
         superclasses => [ blessed($self->metaclass) ],
         methods      => $self->create_methods_for_immutable_metaclass,
     );
@@ -53,11 +78,19 @@ my %DEFAULT_METHODS = (
     meta => sub {
         my $self = shift;
         # if it is not blessed, then someone is asking
-        # for the meta of Class::MOP::Class::Immutable
+        # for the meta of Class::MOP::Immutable
         return Class::MOP::Class->initialize($self) unless blessed($self);
         # otherwise, they are asking for the metaclass
         # which has been made immutable, which is itself
-        return $self;
+        # except in the cases where it is a metaclass itself
+        # that has been made immutable and for that we need 
+        # to dig a bit ...
+        if ($self->isa('Class::MOP::Class')) {
+            return $self->{'___original_class'}->meta;
+        }
+        else {
+            return $self;
+        }
     },
     is_mutable     => sub { 0  },
     is_immutable   => sub { 1  },
@@ -69,13 +102,18 @@ my %DEFAULT_METHODS = (
 # existing metaclass to an immutable
 # version of itself
 sub make_metaclass_immutable {
-    my ($self, $metaclass, %options) = @_;
+    my ($self, $metaclass, $options) = @_;
+
+    my %options = (
+        inline_accessors   => 1,
+        inline_constructor => 1,
+        inline_destructor  => 0,
+        constructor_name   => 'new',
+        debug              => 0,
+        %$options,
+    );
 
-    $options{inline_accessors}   = 1     unless exists $options{inline_accessors};
-    $options{inline_constructor} = 1     unless exists $options{inline_constructor};
-    $options{inline_destructor}  = 0     unless exists $options{inline_destructor};
-    $options{constructor_name}   = 'new' unless exists $options{constructor_name};
-    $options{debug}              = 0     unless exists $options{debug};
+    %$options = %options; # FIXME who the hell is relying on this?!? tests fail =(
 
     if ($options{inline_accessors}) {
         foreach my $attr_name ($metaclass->get_attribute_list) {
@@ -90,10 +128,13 @@ sub make_metaclass_immutable {
         $metaclass->add_method(
             $options{constructor_name},
             $constructor_class->new(
-                options   => \%options,
-                metaclass => $metaclass,
+                options      => \%options,
+                metaclass    => $metaclass,
+                is_inline    => 1,
+                package_name => $metaclass->name,
+                name         => $options{constructor_name}
             )
-        ) unless $metaclass->has_method($options{constructor_name});
+        ) if $options{replace_constructor} or !$metaclass->has_method($options{constructor_name});
     }
 
     if ($options{inline_destructor}) {
@@ -103,18 +144,27 @@ sub make_metaclass_immutable {
 
         my $destructor_class = $options{destructor_class};
 
-        my $destructor = $destructor_class->new(
-            options   => \%options,
-            metaclass => $metaclass,
-        );
-
-        $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;
+        # 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;
+        }
     }
 
     my $memoized_methods = $self->options->{memoize};
@@ -135,16 +185,14 @@ sub make_metaclass_immutable {
         }
     }
 
-    #I'm not sure i understand this, stevan suggested the addition i don't think its actually needed
-    #my $is_immutable = $metaclass->is_anon_class;
-    #$self->immutable_metaclass->add_method('is_anon_class' => sub { $is_immutable });
-
     $metaclass->{'___original_class'} = blessed($metaclass);
     bless $metaclass => $self->immutable_metaclass->name;
 }
 
 sub make_metaclass_mutable {
-    my ($self, $immutable, %options) = @_;
+    my ($self, $immutable, $options) = @_;
+
+    my %options = %$options;
 
     my $original_class = $immutable->get_mutable_metaclass_name;
     delete $immutable->{'___original_class'} ;
@@ -163,30 +211,30 @@ sub make_metaclass_mutable {
 
     if ($options{inline_destructor} && $immutable->has_method('DESTROY')) {
         $immutable->remove_method('DESTROY')
-          if $immutable->get_method('DESTROY')->blessed eq $options{destructor_class};
+          if blessed($immutable->get_method('DESTROY')) eq $options{destructor_class};
     }
 
-    #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
-    $options{constructor_name} = 'new' unless exists $options{constructor_name};
-    if ($options{inline_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);
+    #     }
+    # }
+
+    # 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 $immutable->get_method($options{constructor_name})->blessed eq $constructor_class;
+          if blessed($immutable->get_method($options{constructor_name})) eq $constructor_class;
     }
 }
 
@@ -226,9 +274,24 @@ sub create_methods_for_immutable_metaclass {
             $methods{$method_name} = sub { $_[0]->{'___' . $method_name} };
         }
     }
+    
+    my $wrapped_methods = $self->options->{wrapped};
+    
+    foreach my $method_name (keys %{ $wrapped_methods }) {
+        my $method = $self->metaclass->meta->find_method_by_name($method_name);
+
+        (defined $method)
+            || confess "Could not find the method '$method_name' in " . $self->metaclass->name;
+
+        my $wrapper = $wrapped_methods->{$method_name};
+
+        $methods{$method_name} = sub { $wrapper->($method, @_) };
+    }
 
     $methods{get_mutable_metaclass_name} = sub { (shift)->{'___original_class'} };
 
+    $methods{immutable_transformer} = sub { $self };
+
     return \%methods;
 }
 
@@ -274,8 +337,9 @@ metaclass. Current features include making methods read-only,
 making methods un-callable and memoizing methods (in a type specific
 way too).
 
-This module is fairly new to the MOP, and quite possibly will be
-expanded and further generalized as the need arises.
+This module is not for the feint of heart, it does some whacky things
+to the metaclass in order to make it immutable. If you are just curious, 
+I suggest you turn back now, there is nothing to see here.
 
 =head1 METHODS
 
@@ -332,7 +396,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006, 2007 by Infinity Interactive, Inc.
+Copyright 2006-2008 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>