Immutable fix to work with new Class::MOP, and trailing whitespace fuckup. Doh!
Guillermo Roditi [Sat, 2 Jun 2007 21:48:20 +0000 (21:48 +0000)]
Changes
lib/Moose/Meta/Class.pm
t/300_immutable_moose.t

diff --git a/Changes b/Changes
index 3d102b9..3e3eec6 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,5 +1,10 @@
 Revision history for Perl extension Moose
 
+0.23
+    * Moose::Meta::Class
+      - Modify make_immutable to work with the new Class::MOP immutable
+        mechanism + POD + very basic test (groditi)
+
 0.22 Thurs. May 31, 2007
     * Moose::Util::TypeConstraints
       - fix for prototype undeclared issue when Moose::Util::TypeConstraints 
index cf577c4..6b7d379 100644 (file)
@@ -25,11 +25,11 @@ sub initialize {
     my $class = shift;
     my $pkg   = shift;
     $class->SUPER::initialize($pkg,
-        'attribute_metaclass' => 'Moose::Meta::Attribute', 
+        'attribute_metaclass' => 'Moose::Meta::Attribute',
         'method_metaclass'    => 'Moose::Meta::Method',
-        'instance_metaclass'  => 'Moose::Meta::Instance', 
+        'instance_metaclass'  => 'Moose::Meta::Instance',
         @_);
-}  
+}
 
 sub add_role {
     my ($self, $role) = @_;
@@ -49,7 +49,7 @@ sub does_role {
     (defined $role_name)
         || confess "You must supply a role name to look for";
     foreach my $class ($self->class_precedence_list) {
-        next unless $class->can('meta');        
+        next unless $class->can('meta');
         foreach my $role (@{$class->meta->roles}) {
             return 1 if $role->does_role($role_name);
         }
@@ -61,14 +61,14 @@ sub excludes_role {
     my ($self, $role_name) = @_;
     (defined $role_name)
         || confess "You must supply a role name to look for";
-    foreach my $class ($self->class_precedence_list) {  
-        next unless $class->can('meta');      
+    foreach my $class ($self->class_precedence_list) {
+        next unless $class->can('meta');
         # NOTE:
         # in the pretty rare instance when a Moose metaclass
-        # is itself extended with a role, this check needs to 
+        # is itself extended with a role, this check needs to
         # be done since some items in the class_precedence_list
-        # might in fact be Class::MOP based still. 
-        next unless $class->meta->can('roles');              
+        # might in fact be Class::MOP based still.
+        next unless $class->meta->can('roles');
         foreach my $role (@{$class->meta->roles}) {
             return 1 if $role->excludes_role($role_name);
         }
@@ -82,12 +82,12 @@ sub new_object {
     foreach my $attr ($class->compute_all_applicable_attributes()) {
         # FIXME:
         # this does not accept undefined
-        # values, nor does it accept false 
+        # values, nor does it accept false
         # values to be passed into the init-arg
         next unless $params{$attr->init_arg} && $attr->can('has_trigger') && $attr->has_trigger;
         $attr->trigger->($self, $params{$attr->init_arg}, $attr);
     }
-    return $self;    
+    return $self;
 }
 
 sub construct_instance {
@@ -96,9 +96,9 @@ sub construct_instance {
     # FIXME:
     # the code below is almost certainly incorrect
     # but this is foreign inheritence, so we might
-    # have to kludge it in the end. 
+    # have to kludge it in the end.
     my $instance = $params{'__INSTANCE__'} || $meta_instance->create_instance();
-    foreach my $attr ($class->compute_all_applicable_attributes()) { 
+    foreach my $attr ($class->compute_all_applicable_attributes()) {
         $attr->initialize_instance_slot($meta_instance, $instance, \%params)
     }
     return $instance;
@@ -107,23 +107,23 @@ sub construct_instance {
 
 # FIXME:
 # This is ugly
-sub get_method_map {    
+sub get_method_map {
     my $self = shift;
-    my $map  = $self->{'%!methods'}; 
-    
+    my $map  = $self->{'%!methods'};
+
     my $class_name       = $self->name;
     my $method_metaclass = $self->method_metaclass;
-    
+
     foreach my $symbol ($self->list_all_package_symbols('CODE')) {
-        
+
         my $code = $self->get_package_symbol('&' . $symbol);
-        
-        next if exists  $map->{$symbol} && 
-                defined $map->{$symbol} && 
-                        $map->{$symbol}->body == $code;        
-        
+
+        next if exists  $map->{$symbol} &&
+                defined $map->{$symbol} &&
+                        $map->{$symbol}->body == $code;
+
         my $gv = B::svref_2object($code)->GV;
-        
+
         my $pkg = $gv->STASH->NAME;
         if ($pkg->can('meta') && $pkg->meta && $pkg->meta->isa('Moose::Meta::Role')) {
             #my $role = $pkg->meta->name;
@@ -131,12 +131,12 @@ sub get_method_map {
         }
         else {
             next if ($gv->STASH->NAME || '') ne $class_name &&
-                    ($gv->NAME        || '') ne '__ANON__';                
+                    ($gv->NAME        || '') ne '__ANON__';
         }
-   
+
         $map->{$symbol} = $method_metaclass->wrap($code);
     }
-    
+
     return $map;
 }
 
@@ -147,8 +147,8 @@ sub add_attribute {
     my $name = shift;
     if (scalar @_ == 1 && ref($_[0]) eq 'HASH') {
         # NOTE:
-        # if it is a HASH ref, we de-ref it.        
-        # this will usually mean that it is 
+        # if it is a HASH ref, we de-ref it.
+        # this will usually mean that it is
         # coming from a role
         $self->SUPER::add_attribute($name => %{$_[0]});
     }
@@ -166,7 +166,7 @@ sub add_override_method_modifier {
     $_super_package ||= $self->name;
     my $super = $self->find_next_method_by_name($name);
     (defined $super)
-        || confess "You cannot override '$name' because it has no super method";    
+        || confess "You cannot override '$name' because it has no super method";
     $self->add_method($name => Moose::Meta::Method::Overriden->wrap(sub {
         my @args = @_;
         no warnings 'redefine';
@@ -181,23 +181,23 @@ sub add_override_method_modifier {
 }
 
 sub add_augment_method_modifier {
-    my ($self, $name, $method) = @_;  
+    my ($self, $name, $method) = @_;
     (!$self->has_method($name))
-        || confess "Cannot add an augment method if a local method is already present";    
+        || confess "Cannot add an augment method if a local method is already present";
     my $super = $self->find_next_method_by_name($name);
     (defined $super)
-        || confess "You cannot augment '$name' because it has no super method";    
-    my $_super_package = $super->package_name;   
-    # BUT!,... if this is an overriden method ....     
+        || confess "You cannot augment '$name' because it has no super method";
+    my $_super_package = $super->package_name;
+    # BUT!,... if this is an overriden method ....
     if ($super->isa('Moose::Meta::Method::Overriden')) {
-        # we need to be sure that we actually 
-        # find the next method, which is not 
+        # we need to be sure that we actually
+        # find the next method, which is not
         # an 'override' method, the reason is
-        # that an 'override' method will not 
+        # that an 'override' method will not
         # be the one calling inner()
-        my $real_super = $self->_find_next_method_by_name_which_is_not_overridden($name);        
+        my $real_super = $self->_find_next_method_by_name_which_is_not_overridden($name);
         $_super_package = $real_super->package_name;
-    }      
+    }
     $self->add_method($name => sub {
         my @args = @_;
         no warnings 'redefine';
@@ -208,7 +208,7 @@ sub add_augment_method_modifier {
         } else {
           return $super->(@args);
         }
-    });    
+    });
 }
 
 ## Private Utility methods ...
@@ -216,7 +216,7 @@ sub add_augment_method_modifier {
 sub _find_next_method_by_name_which_is_not_overridden {
     my ($self, $name) = @_;
     foreach my $method ($self->find_all_methods_by_name($name)) {
-        return $method->{code} 
+        return $method->{code}
             if blessed($method->{code}) && !$method->{code}->isa('Moose::Meta::Method::Overriden');
     }
     return undef;
@@ -227,15 +227,15 @@ sub _fix_metaclass_incompatability {
     foreach my $super (@superclasses) {
         # don't bother if it does not have a meta.
         next unless $super->can('meta');
-        # get the name, make sure we take 
+        # get the name, make sure we take
         # immutable classes into account
-        my $super_meta_name = ($super->meta->is_immutable 
+        my $super_meta_name = ($super->meta->is_immutable
                                 ? $super->meta->get_mutable_metaclass_name
                                 : blessed($super->meta));
-        # if it's meta is a vanilla Moose, 
-        # then we can safely ignore it.        
+        # if it's meta is a vanilla Moose,
+        # then we can safely ignore it.
         next if $super_meta_name eq 'Moose::Meta::Class';
-        # but if we have anything else, 
+        # but if we have anything else,
         # we need to check it out ...
         unless (# see if of our metaclass is incompatible
                 ($self->isa($super_meta_name) &&
@@ -246,20 +246,20 @@ sub _fix_metaclass_incompatability {
             # re-initialize the meta ...
             my $super_meta = $super->meta;
             # NOTE:
-            # We might want to consider actually 
-            # transfering any attributes from the 
-            # original meta into this one, but in 
+            # We might want to consider actually
+            # transfering any attributes from the
+            # original meta into this one, but in
             # general you should not have any there
-            # at this point anyway, so it's very 
+            # at this point anyway, so it's very
             # much an obscure edge case anyway
             $self = $super_meta->reinitialize($self->name => (
-                'attribute_metaclass' => $super_meta->attribute_metaclass,                            
+                'attribute_metaclass' => $super_meta->attribute_metaclass,
                 'method_metaclass'    => $super_meta->method_metaclass,
                 'instance_metaclass'  => $super_meta->instance_metaclass,
             ));
         }
     }
-    return $self;    
+    return $self;
 }
 
 sub _apply_all_roles {
@@ -278,7 +278,7 @@ sub _apply_all_roles {
         Moose::Meta::Role->combine(
             map { $_->meta } @roles
         )->apply($self);
-    }    
+    }
 }
 
 sub _process_attribute {
@@ -292,8 +292,8 @@ sub _process_attribute {
             my $metaclass_name = $options{metaclass};
             eval {
                 my $possible_full_name = 'Moose::Meta::Attribute::Custom::' . $metaclass_name;
-                Class::MOP::load_class($possible_full_name);                
-                $metaclass_name = $possible_full_name->can('register_implementation') 
+                Class::MOP::load_class($possible_full_name);
+                $metaclass_name = $possible_full_name->can('register_implementation')
                     ? $possible_full_name->register_implementation
                     : $possible_full_name;
             };
@@ -305,7 +305,7 @@ sub _process_attribute {
         else {
             $self->add_attribute($name, %options);
         }
-    }    
+    }
 }
 
 sub _process_inherited_attribute {
@@ -322,8 +322,8 @@ sub _process_inherited_attribute {
         # kind of a kludge to handle Class::MOP::Attributes
         $new_attr = Moose::Meta::Attribute::clone_and_inherit_options(
             $inherited_attr, %options
-        );                        
-    }    
+        );
+    }
     return $new_attr;
 }
 
@@ -332,51 +332,47 @@ sub _process_inherited_attribute {
 use Moose::Meta::Method::Constructor;
 use Moose::Meta::Method::Destructor;
 
-{
-    # NOTE:
-    # the immutable version of a 
-    # particular metaclass is 
-    # really class-level data so 
-    # we don't want to regenerate 
-    # it any more than we need to
-    my $IMMUTABLE_METACLASS;
-    sub make_immutable {
-        my $self = shift;
-        
-        $IMMUTABLE_METACLASS ||= Class::MOP::Immutable->new($self, {
-            read_only   => [qw/superclasses/],
-            cannot_call => [qw/
-                add_method
-                alias_method
-                remove_method
-                add_attribute
-                remove_attribute
-                add_package_symbol
-                remove_package_symbol            
-                add_role
-            /],
-            memoize     => {
-                class_precedence_list             => 'ARRAY',
-                compute_all_applicable_attributes => 'ARRAY',            
-                get_meta_instance                 => 'SCALAR',     
-                get_method_map                    => 'SCALAR', 
-                # maybe ....
-                calculate_all_roles               => 'ARRAY',    
-            }
-        });   
-        
-        $IMMUTABLE_METACLASS->make_metaclass_immutable(
-            $self,
-            constructor_class => 'Moose::Meta::Method::Constructor',
-            destructor_class  => 'Moose::Meta::Method::Destructor',            
-            inline_destructor => 1,
-            # NOTE: 
-            # no need to do this, 
-            # Moose always does it
-            inline_accessors  => 0,
-            @_,
-        )     
-    }
+# This could be done by using SUPER and altering ->options
+# I am keeping it this way to make it more explicit.
+sub create_immutable_transformer {
+    my $self = shift;
+    my $class = Class::MOP::Immutable->new($self, {
+       read_only   => [qw/superclasses/],
+       cannot_call => [qw/
+           add_method
+           alias_method
+           remove_method
+           add_attribute
+           remove_attribute
+           add_package_symbol
+           remove_package_symbol
+           add_role
+       /],
+       memoize     => {
+           class_precedence_list             => 'ARRAY',
+           compute_all_applicable_attributes => 'ARRAY',
+           get_meta_instance                 => 'SCALAR',
+           get_method_map                    => 'SCALAR',
+           # maybe ....
+           calculate_all_roles               => 'ARRAY',
+       }
+    });
+    return $class;
+}
+
+sub make_immutable {
+    my $self = shift;
+    $self->SUPER::make_immutable
+      (
+       constructor_class => 'Moose::Meta::Method::Constructor',
+       destructor_class  => 'Moose::Meta::Method::Destructor',
+       inline_destructor => 1,
+       # NOTE:
+       # no need to do this,
+       # Moose always does it
+       inline_accessors  => 0,
+       @_,
+      );
 }
 
 1;
@@ -391,12 +387,12 @@ Moose::Meta::Class - The Moose metaclass
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Class> with Moose specific 
+This is a subclass of L<Class::MOP::Class> with Moose specific
 extensions.
 
-For the most part, the only time you will ever encounter an 
-instance of this class is if you are doing some serious deep 
-introspection. To really understand this class, you need to refer 
+For the most part, the only time you will ever encounter an
+instance of this class is if you are doing some serious deep
+introspection. To really understand this class, you need to refer
 to the L<Class::MOP::Class> documentation.
 
 =head1 METHODS
@@ -407,57 +403,64 @@ to the L<Class::MOP::Class> documentation.
 
 =item B<make_immutable>
 
+Override original to add default options for inlining destructor
+and altering the Constructor metaclass.
+
+=item B<create_immutable_transformer>
+
+Override original to lock C<add_role> and memoize C<calculate_all_roles>
+
 =item B<new_object>
 
 We override this method to support the C<trigger> attribute option.
 
 =item B<construct_instance>
 
-This provides some Moose specific extensions to this method, you 
-almost never call this method directly unless you really know what 
-you are doing. 
+This provides some Moose specific extensions to this method, you
+almost never call this method directly unless you really know what
+you are doing.
 
 This method makes sure to handle the moose weak-ref, type-constraint
-and type coercion features. 
+and type coercion features.
 
 =item B<get_method_map>
 
-This accommodates Moose::Meta::Role::Method instances, which are 
-aliased, instead of added, but still need to be counted as valid 
+This accommodates Moose::Meta::Role::Method instances, which are
+aliased, instead of added, but still need to be counted as valid
 methods.
 
 =item B<add_override_method_modifier ($name, $method)>
 
-This will create an C<override> method modifier for you, and install 
+This will create an C<override> method modifier for you, and install
 it in the package.
 
 =item B<add_augment_method_modifier ($name, $method)>
 
-This will create an C<augment> method modifier for you, and install 
+This will create an C<augment> method modifier for you, and install
 it in the package.
 
 =item B<calculate_all_roles>
 
 =item B<roles>
 
-This will return an array of C<Moose::Meta::Role> instances which are 
+This will return an array of C<Moose::Meta::Role> instances which are
 attached to this class.
 
 =item B<add_role ($role)>
 
-This takes an instance of C<Moose::Meta::Role> in C<$role>, and adds it 
+This takes an instance of C<Moose::Meta::Role> in C<$role>, and adds it
 to the list of associated roles.
 
 =item B<does_role ($role_name)>
 
-This will test if this class C<does> a given C<$role_name>. It will 
-not only check it's local roles, but ask them as well in order to 
+This will test if this class C<does> a given C<$role_name>. It will
+not only check it's local roles, but ask them as well in order to
 cascade down the role hierarchy.
 
 =item B<excludes_role ($role_name)>
 
-This will test if this class C<excludes> a given C<$role_name>. It will 
-not only check it's local roles, but ask them as well in order to 
+This will test if this class C<excludes> a given C<$role_name>. It will
+not only check it's local roles, but ask them as well in order to
 cascade down the role hierarchy.
 
 =item B<add_attribute ($attr_name, %params|$params)>
@@ -469,7 +472,7 @@ support for taking the C<$params> as a HASH ref.
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
+All complex software has bugs lurking in it, and this module is no
 exception. If you find a bug please either email me, or add the bug
 to cpan-RT.
 
@@ -484,7 +487,7 @@ Copyright 2006, 2007 by Infinity Interactive, Inc.
 L<http://www.iinteractive.com>
 
 This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself. 
+it under the same terms as Perl itself.
 
 =cut
 
index ff82f81..baef742 100644 (file)
@@ -3,11 +3,33 @@
 use strict;
 use warnings;
 
-use Test::More tests => 1;
+use Test::More tests => 6;
 use Test::Exception;
 
-BEGIN {  
+BEGIN {
     use_ok('Moose');
+    use_ok('Moose::Meta::Role');
+}
+
+{
+    package FooRole;
+    our $VERSION = '0.01';
+    sub foo { 'FooRole::foo' }
+  }
+
+{
+  package Foo;
+  use Moose;
+
+}
+
+{
+  my $foo_role = Moose::Meta::Role->initialize('FooRole');
+  my $meta = Foo->meta;
+  lives_ok{ $meta->make_immutable       } "Foo is imutable";
+  dies_ok{  $meta->add_role($foo_role)  } "Add Role is locked";
+  lives_ok{ $meta->make_mutable         } "Foo is mutable";
+  lives_ok{ $meta->add_role($foo_role)  } "Add Role is unlocked";
 }
 
 =pod