Moose::Meta::Method::Accessor:
[gitmo/Moose.git] / lib / Moose / Meta / Role.pm
index a5c47ed..c35f7cd 100644 (file)
@@ -9,19 +9,16 @@ use Carp         'confess';
 use Scalar::Util 'blessed';
 use B            'svref_2object';
 
+our $VERSION   = '0.07';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Moose::Meta::Class;
+use Moose::Meta::Role::Method;
 
-our $VERSION = '0.04';
+use base 'Class::MOP::Module';
 
 ## Attributes
 
-## the meta for the role package
-
-__PACKAGE__->meta->add_attribute('_role_meta' => (
-    reader   => '_role_meta',
-    init_arg => ':role_meta'
-));
-
 ## roles
 
 __PACKAGE__->meta->add_attribute('roles' => (
@@ -74,17 +71,7 @@ __PACKAGE__->meta->add_attribute('override_method_modifiers' => (
 
 ## Methods 
 
-sub new {
-    my $class   = shift;
-    my %options = @_;
-    $options{':role_meta'} = Moose::Meta::Class->initialize(
-        $options{role_name},
-        ':method_metaclass' => 'Moose::Meta::Role::Method'
-    ) unless defined $options{':role_meta'} && 
-             $options{':role_meta'}->isa('Moose::Meta::Class');
-    my $self = $class->meta->new_object(%options);
-    return $self;
-}
+sub method_metaclass { 'Moose::Meta::Role::Method' }
 
 ## subroles
 
@@ -163,30 +150,30 @@ sub _clean_up_required_methods {
 
 ## methods
 
-# NOTE:
-# we delegate to some role_meta methods for convience here
-# the Moose::Meta::Role is meant to be a read-only interface
-# to the underlying role package, if you want to manipulate 
-# that, just use ->role_meta
-
-sub name    { (shift)->_role_meta->name    }
-sub version { (shift)->_role_meta->version }
+# FIXME:
+# this is an UGLY hack
+sub get_method_map {    
+    my $self = shift;
+    $self->{'%!methods'} ||= {}; 
+    $self->Moose::Meta::Class::get_method_map() 
+}
 
-sub get_method      { (shift)->_role_meta->get_method(@_)   }
-sub has_method      { (shift)->_role_meta->has_method(@_)   }
-sub alias_method    { (shift)->_role_meta->alias_method(@_) }
-sub get_method_list { 
-    my ($self) = @_;
-    grep { 
-        # NOTE:
-        # this is a kludge for now,... these functions 
-        # should not be showing up in the list at all, 
-        # but they do, so we need to switch Moose::Role
-        # and Moose to use Sub::Exporter to prevent this
-        !/^(meta|has|extends|blessed|confess|augment|inner|override|super|before|after|around|with|requires)$/ 
-    } $self->_role_meta->get_method_list;
+# FIXME:
+# Yes, this is a really really UGLY hack
+# but it works, and until I can figure 
+# out a better way, this is gonna be it. 
+
+sub get_method          { (shift)->Moose::Meta::Class::get_method(@_)          }
+sub has_method          { (shift)->Moose::Meta::Class::has_method(@_)          }
+sub alias_method        { (shift)->Moose::Meta::Class::alias_method(@_)        }
+sub get_method_list     { 
+    grep {
+        !/^meta$/
+    } (shift)->Moose::Meta::Class::get_method_list(@_)     
 }
 
+sub find_method_by_name { (shift)->has_method(@_) }
+
 # ... however the items in statis (attributes & method modifiers)
 # can be removed and added to through this API
 
@@ -225,6 +212,74 @@ sub get_attribute_list {
     keys %{$self->get_attribute_map};
 }
 
+# method modifiers
+
+# mimic the metaclass API
+sub add_before_method_modifier { (shift)->_add_method_modifier('before', @_) }
+sub add_around_method_modifier { (shift)->_add_method_modifier('around', @_) }
+sub add_after_method_modifier  { (shift)->_add_method_modifier('after',  @_) }
+
+sub _add_method_modifier {
+    my ($self, $modifier_type, $method_name, $method) = @_;
+    my $accessor = "get_${modifier_type}_method_modifiers_map";
+    $self->$accessor->{$method_name} = [] 
+        unless exists $self->$accessor->{$method_name};
+    my $modifiers = $self->$accessor->{$method_name};
+    # NOTE:
+    # check to see that we aren't adding the 
+    # same code twice. We err in favor of the 
+    # first on here, this may not be as expected
+    foreach my $modifier (@{$modifiers}) {
+        return if $modifier == $method;
+    }
+    push @{$modifiers} => $method;
+}
+
+sub add_override_method_modifier {
+    my ($self, $method_name, $method) = @_;
+    (!$self->has_method($method_name))
+        || confess "Cannot add an override of method '$method_name' " . 
+                   "because there is a local version of '$method_name'";
+    $self->get_override_method_modifiers_map->{$method_name} = $method;    
+}
+
+sub has_before_method_modifiers { (shift)->_has_method_modifiers('before', @_) }
+sub has_around_method_modifiers { (shift)->_has_method_modifiers('around', @_) }
+sub has_after_method_modifiers  { (shift)->_has_method_modifiers('after',  @_) }
+
+# override just checks for one,.. 
+# but we can still re-use stuff
+sub has_override_method_modifier { (shift)->_has_method_modifiers('override',  @_) }
+
+sub _has_method_modifiers {
+    my ($self, $modifier_type, $method_name) = @_;
+    my $accessor = "get_${modifier_type}_method_modifiers_map";   
+    # NOTE:
+    # for now we assume that if it exists,.. 
+    # it has at least one modifier in it
+    (exists $self->$accessor->{$method_name}) ? 1 : 0;
+}
+
+sub get_before_method_modifiers { (shift)->_get_method_modifiers('before', @_) }
+sub get_around_method_modifiers { (shift)->_get_method_modifiers('around', @_) }
+sub get_after_method_modifiers  { (shift)->_get_method_modifiers('after',  @_) }
+
+sub _get_method_modifiers {
+    my ($self, $modifier_type, $method_name) = @_;
+    my $accessor = "get_${modifier_type}_method_modifiers_map";
+    @{$self->$accessor->{$method_name}};
+}
+
+sub get_override_method_modifier {
+    my ($self, $method_name) = @_;
+    $self->get_override_method_modifiers_map->{$method_name};    
+}
+
+sub get_method_modifier_list {
+    my ($self, $modifier_type) = @_;
+    my $accessor = "get_${modifier_type}_method_modifiers_map";    
+    keys %{$self->$accessor};
+}
 
 ## applying a role to a class ...
 
@@ -256,10 +311,7 @@ sub _check_required_methods {
     # the require methods stuff.  
     foreach my $required_method_name ($self->get_required_method_list) {
         
-        # FIXME:
-        # This should not call has_method, instead it should
-        # call find_method_by_name (to be added to Class::MOP)
-        unless ($other->has_method($required_method_name)) {
+        unless ($other->find_method_by_name($required_method_name)) {
             if ($other->isa('Moose::Meta::Role')) {
                 $other->add_required_methods($required_method_name);
             }
@@ -273,13 +325,10 @@ sub _check_required_methods {
             # we need to make sure that the method is 
             # not a method modifier, because those do 
             # not satisfy the requirements ...
-            
-            # FIXME:
-            # This should also call find_method_by_name
             my $method = $other->get_method($required_method_name);
             # check if it is an override or a generated accessor ..
             (!$method->isa('Moose::Meta::Method::Overriden') &&
-             !$method->isa('Class::MOP::Attribute::Accessor'))
+             !$method->isa('Class::MOP::Method::Accessor'))
                 || confess "'" . $self->name . "' requires the method '$required_method_name' " . 
                            "to be implemented by '" . $other->name . "', the method is only a method modifier";
             # before/after/around methods are a little trickier
@@ -291,7 +340,7 @@ sub _check_required_methods {
                     || confess "'" . $self->name . "' requires the method '$required_method_name' " . 
                                "to be implemented by '" . $other->name . "', the method is only a method modifier";            
             }
-        }
+        }        
     }    
 }
 
@@ -318,10 +367,20 @@ sub _apply_attributes {
             }
         }
         else {
-            $other->add_attribute(
-                $attribute_name,
-                $self->get_attribute($attribute_name)
-            );
+            # NOTE:
+            # this is kinda ugly ...
+            if ($other->isa('Moose::Meta::Class')) { 
+                $other->_process_attribute(
+                    $attribute_name,
+                    %{$self->get_attribute($attribute_name)}
+                );             
+            }
+            else {
+                $other->add_attribute(
+                    $attribute_name,
+                    $self->get_attribute($attribute_name)
+                );                
+            }
         }
     }    
 }
@@ -332,7 +391,7 @@ sub _apply_methods {
         # it if it has one already
         if ($other->has_method($method_name) &&
             # and if they are not the same thing ...
-            $other->get_method($method_name) != $self->get_method($method_name)) {
+            $other->get_method($method_name)->body != $self->get_method($method_name)->body) {
             # see if we are composing into a role
             if ($other->isa('Moose::Meta::Role')) { 
                 # method conflicts between roles result 
@@ -346,8 +405,8 @@ sub _apply_methods {
                 # is probably fairly safe to assume that 
                 # anon classes will only be used internally
                 # or by people who know what they are doing
-                $other->_role_meta->remove_method($method_name)
-                    if $other->_role_meta->name =~ /__ANON__/;
+                $other->Moose::Meta::Class::remove_method($method_name)
+                    if $other->name =~ /__COMPOSITE_ROLE_SANDBOX__/;
             }
             else {
                 next;
@@ -363,14 +422,114 @@ sub _apply_methods {
     }     
 }
 
+sub _apply_override_method_modifiers {
+    my ($self, $other) = @_;    
+    foreach my $method_name ($self->get_method_modifier_list('override')) {
+        # it if it has one already then ...
+        if ($other->has_method($method_name)) {
+            # if it is being composed into another role
+            # we have a conflict here, because you cannot 
+            # combine an overriden method with a locally
+            # defined one 
+            if ($other->isa('Moose::Meta::Role')) { 
+                confess "Role '" . $self->name . "' has encountered an 'override' method conflict " . 
+                        "during composition (A local method of the same name as been found). This " . 
+                        "is fatal error.";
+            }
+            else {
+                # if it is a class, then we 
+                # just ignore this here ...
+                next;
+            }
+        }
+        else {
+            # if no local method is found, then we 
+            # must check if we are a role or class
+            if ($other->isa('Moose::Meta::Role')) { 
+                # if we are a role, we need to make sure 
+                # we dont have a conflict with the role 
+                # we are composing into
+                if ($other->has_override_method_modifier($method_name) &&
+                    $other->get_override_method_modifier($method_name) != $self->get_override_method_modifier($method_name)) {
+                    confess "Role '" . $self->name . "' has encountered an 'override' method conflict " . 
+                            "during composition (Two 'override' methods of the same name encountered). " . 
+                            "This is fatal error.";
+                }
+                else {   
+                    # if there is no conflict,
+                    # just add it to the role  
+                    $other->add_override_method_modifier(
+                        $method_name, 
+                        $self->get_override_method_modifier($method_name)
+                    );                    
+                }
+            }
+            else {
+                # if this is not a role, then we need to 
+                # find the original package of the method
+                # so that we can tell the class were to 
+                # find the right super() method
+                my $method = $self->get_override_method_modifier($method_name);
+                my $package = svref_2object($method)->GV->STASH->NAME;
+                # if it is a class, we just add it
+                $other->add_override_method_modifier($method_name, $method, $package);
+            }
+        }
+    }    
+}
+
+sub _apply_method_modifiers {
+    my ($self, $modifier_type, $other) = @_;    
+    my $add = "add_${modifier_type}_method_modifier";
+    my $get = "get_${modifier_type}_method_modifiers";    
+    foreach my $method_name ($self->get_method_modifier_list($modifier_type)) {
+        $other->$add(
+            $method_name,
+            $_
+        ) foreach $self->$get($method_name);
+    }    
+}
+
+sub _apply_before_method_modifiers { (shift)->_apply_method_modifiers('before' => @_) }
+sub _apply_around_method_modifiers { (shift)->_apply_method_modifiers('around' => @_) }
+sub _apply_after_method_modifiers  { (shift)->_apply_method_modifiers('after'  => @_) }
+
+my $anon_counter = 0;
+
 sub apply {
     my ($self, $other) = @_;
     
+    unless ($other->isa('Moose::Meta::Class') || $other->isa('Moose::Meta::Role')) {
+    
+        # Runtime Role mixins
+            
+        # FIXME:
+        # We really should do this better, and 
+        # cache the results of our efforts so 
+        # that we don't need to repeat them.
+        
+        my $pkg_name = __PACKAGE__ . "::__RUNTIME_ROLE_ANON_CLASS__::" . $anon_counter++;
+        eval "package " . $pkg_name . "; our \$VERSION = '0.00';";
+        die $@ if $@;
+
+        my $object = $other;
+
+        $other = Moose::Meta::Class->initialize($pkg_name);
+        $other->superclasses(blessed($object));     
+        
+        bless $object => $pkg_name;
+    }
+    
     $self->_check_excluded_roles($other);
     $self->_check_required_methods($other);  
 
     $self->_apply_attributes($other);         
-    $self->_apply_methods($other);         
+    $self->_apply_methods($other);   
+
+    $self->_apply_override_method_modifiers($other);                  
+    $self->_apply_before_method_modifiers($other);                  
+    $self->_apply_around_method_modifiers($other);                  
+    $self->_apply_after_method_modifiers($other);          
 
     $other->add_role($self);
 }
@@ -378,9 +537,11 @@ sub apply {
 sub combine {
     my ($class, @roles) = @_;
     
-    my $combined = $class->new(
-        ':role_meta' => Moose::Meta::Class->create_anon_class()
-    );
+    my $pkg_name = __PACKAGE__ . "::__COMPOSITE_ROLE_SANDBOX__::" . $anon_counter++;
+    eval "package " . $pkg_name . "; our \$VERSION = '0.00';";
+    die $@ if $@;
+    
+    my $combined = $class->initialize($pkg_name);
     
     foreach my $role (@roles) {
         $role->apply($combined);
@@ -391,15 +552,6 @@ sub combine {
     return $combined;
 }
 
-package Moose::Meta::Role::Method;
-
-use strict;
-use warnings;
-
-our $VERSION = '0.01';
-
-use base 'Class::MOP::Method';
-
 1;
 
 __END__
@@ -412,9 +564,9 @@ Moose::Meta::Role - The Moose Role metaclass
 
 =head1 DESCRIPTION
 
-Moose's Roles are being actively developed, please see L<Moose::Role> 
-for more information. For the most part, this has no user-serviceable 
-parts inside. It's API is still subject to some change (although 
+Please see L<Moose::Role> for more information about roles. 
+For the most part, this has no user-serviceable parts inside
+this module. It's API is still subject to some change (although 
 probably not that much really).
 
 =head1 METHODS
@@ -467,6 +619,10 @@ probably not that much really).
 
 =over 4
 
+=item B<method_metaclass>
+
+=item B<find_method_by_name>
+
 =item B<get_method>
 
 =item B<has_method>
@@ -475,6 +631,8 @@ probably not that much really).
 
 =item B<get_method_list>
 
+=item B<get_method_map>
+
 =back
 
 =over 4
@@ -569,7 +727,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006, 2007 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>