no more _role_meta crapsvk status!
[gitmo/Moose.git] / lib / Moose / Meta / Role.pm
index d0db84f..3669b87 100644 (file)
@@ -7,19 +7,15 @@ use metaclass;
 
 use Carp         'confess';
 use Scalar::Util 'blessed';
+use B            'svref_2object';
 
 use Moose::Meta::Class;
 
-our $VERSION = '0.02';
+our $VERSION = '0.04';
 
-## Attributes
-
-## the meta for the role package
+use base 'Class::MOP::Module';
 
-__PACKAGE__->meta->add_attribute('_role_meta' => (
-    reader   => '_role_meta',
-    init_arg => ':role_meta'
-));
+## Attributes
 
 ## roles
 
@@ -28,6 +24,13 @@ __PACKAGE__->meta->add_attribute('roles' => (
     default => sub { [] }
 ));
 
+## excluded roles
+
+__PACKAGE__->meta->add_attribute('excluded_roles_map' => (
+    reader  => 'get_excluded_roles_map',
+    default => sub { {} }
+));
+
 ## attributes
 
 __PACKAGE__->meta->add_attribute('attribute_map' => (
@@ -42,40 +45,9 @@ __PACKAGE__->meta->add_attribute('required_methods' => (
     default => sub { {} }
 ));
 
-## method modifiers
-
-__PACKAGE__->meta->add_attribute('before_method_modifiers' => (
-    reader  => 'get_before_method_modifiers_map',
-    default => sub { {} } # (<name> => [ (CODE) ])
-));
-
-__PACKAGE__->meta->add_attribute('after_method_modifiers' => (
-    reader  => 'get_after_method_modifiers_map',
-    default => sub { {} } # (<name> => [ (CODE) ])
-));
-
-__PACKAGE__->meta->add_attribute('around_method_modifiers' => (
-    reader  => 'get_around_method_modifiers_map',
-    default => sub { {} } # (<name> => [ (CODE) ])
-));
-
-__PACKAGE__->meta->add_attribute('override_method_modifiers' => (
-    reader  => 'get_override_method_modifiers_map',
-    default => sub { {} } # (<name> => CODE) 
-));
-
 ## Methods 
 
-sub new {
-    my $class   = shift;
-    my %options = @_;
-    $options{':role_meta'} = Moose::Meta::Class->initialize(
-        $options{role_name},
-        ':method_metaclass' => 'Moose::Meta::Role::Method'
-    );
-    my $self = $class->meta->new_object(%options);
-    return $self;
-}
+sub method_metaclass { 'Moose::Meta::Role::Method' }
 
 ## subroles
 
@@ -86,6 +58,12 @@ sub add_role {
     push @{$self->get_roles} => $role;
 }
 
+sub calculate_all_roles {
+    my $self = shift;
+    my %seen;
+    grep { !$seen{$_->name}++ } $self, map { $_->calculate_all_roles } @{ $self->get_roles };
+}
+
 sub does_role {
     my ($self, $role_name) = @_;
     (defined $role_name)
@@ -99,6 +77,23 @@ sub does_role {
     return 0;
 }
 
+## excluded roles
+
+sub add_excluded_roles {
+    my ($self, @excluded_role_names) = @_;
+    $self->get_excluded_roles_map->{$_} = undef foreach @excluded_role_names;
+}
+
+sub get_excluded_roles_list {
+    my ($self) = @_;
+    keys %{$self->get_excluded_roles_map};
+}
+
+sub excludes_role {
+    my ($self, $role_name) = @_;
+    exists $self->get_excluded_roles_map->{$role_name} ? 1 : 0;
+}
+
 ## required methods
 
 sub add_required_methods {
@@ -106,6 +101,11 @@ sub add_required_methods {
     $self->get_required_methods_map->{$_} = undef foreach @methods;
 }
 
+sub remove_required_methods {
+    my ($self, @methods) = @_;
+    delete $self->get_required_methods_map->{$_} foreach @methods;
+}
+
 sub get_required_method_list {
     my ($self) = @_;
     keys %{$self->get_required_methods_map};
@@ -116,20 +116,20 @@ sub requires_method {
     exists $self->get_required_methods_map->{$method_name} ? 1 : 0;
 }
 
-## 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 _clean_up_required_methods {
+    my $self = shift;
+    foreach my $method ($self->get_required_method_list) {
+        $self->remove_required_methods($method)
+            if $self->has_method($method);
+    } 
+}
 
-sub name    { (shift)->_role_meta->name    }
-sub version { (shift)->_role_meta->version }
+## methods
 
-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          { (shift)->Moose::Meta::Class::get_method(@_)          }
+sub find_method_by_name { (shift)->Moose::Meta::Class::find_method_by_name(@_) }
+sub has_method          { (shift)->Moose::Meta::Class::has_method(@_)          }
+sub alias_method        { (shift)->Moose::Meta::Class::alias_method(@_)        }
 sub get_method_list { 
     my ($self) = @_;
     grep { 
@@ -139,7 +139,7 @@ sub get_method_list {
         # 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;
+    } $self->Moose::Meta::Class::get_method_list;
 }
 
 # ... however the items in statis (attributes & method modifiers)
@@ -148,8 +148,16 @@ sub get_method_list {
 # attributes
 
 sub add_attribute {
-    my ($self, $name, %attr_desc) = @_;
-    $self->get_attribute_map->{$name} = \%attr_desc;
+    my $self = shift;
+    my $name = shift;
+    my $attr_desc;
+    if (scalar @_ == 1 && ref($_[0]) eq 'HASH') {
+        $attr_desc = $_[0];
+    }
+    else {
+        $attr_desc = { @_ };
+    }
+    $self->get_attribute_map->{$name} = $attr_desc;
 }
 
 sub has_attribute {
@@ -172,69 +180,29 @@ 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};
-    push @{$self->$accessor->{$method_name}} => $method;
-}
-
-sub add_override_method_modifier {
-    my ($self, $method_name, $method) = @_;
-    $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};    
-}
+## applying a role to a class ...
 
-sub get_method_modifier_list {
-    my ($self, $modifier_type) = @_;
-    my $accessor = "get_${modifier_type}_method_modifiers_map";    
-    keys %{$self->$accessor};
+sub _check_excluded_roles {
+    my ($self, $other) = @_;
+    if ($other->excludes_role($self->name)) {
+        confess "Conflict detected: " . $other->name . " excludes role '" . $self->name . "'";
+    }
+    foreach my $excluded_role_name ($self->get_excluded_roles_list) {
+        if ($other->does_role($excluded_role_name)) { 
+            confess "The class " . $other->name . " does the excluded role '$excluded_role_name'";
+        }
+        else {
+            if ($other->isa('Moose::Meta::Role')) {
+                $other->add_excluded_roles($excluded_role_name);
+            }
+            # else -> ignore it :) 
+        }
+    }    
 }
 
-## applying a role to a class ...
-
-sub apply {
+sub _check_required_methods {
     my ($self, $other) = @_;
-    
     # NOTE:
     # we might need to move this down below the 
     # the attributes so that we can require any 
@@ -242,7 +210,8 @@ sub apply {
     # that maybe those are somehow exempt from 
     # the require methods stuff.  
     foreach my $required_method_name ($self->get_required_method_list) {
-        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);
             }
@@ -252,60 +221,109 @@ sub apply {
             }
         }
     }    
-    
+}
+
+sub _apply_attributes {
+    my ($self, $other) = @_;    
     foreach my $attribute_name ($self->get_attribute_list) {
-        # skip it if it has one already
-        next if $other->has_attribute($attribute_name);
-        # add it, although it could be overriden 
-        $other->add_attribute(
-            $attribute_name,
-            %{$self->get_attribute($attribute_name)}
-        );
-    }
-    
-    foreach my $method_name ($self->get_method_list) {
-        # skip it if it has one already
-        next if $other->has_method($method_name);
-        # add it, although it could be overriden 
-        $other->alias_method(
-            $method_name,
-            $self->get_method($method_name)
-        );
+        # it if it has one already
+        if ($other->has_attribute($attribute_name) &&
+            # make sure we haven't seen this one already too
+            $other->get_attribute($attribute_name) != $self->get_attribute($attribute_name)) {
+            # see if we are being composed  
+            # into a role or not
+            if ($other->isa('Moose::Meta::Role')) {                
+                # all attribute conflicts between roles 
+                # result in an immediate fatal error 
+                confess "Role '" . $self->name . "' has encountered an attribute conflict " . 
+                        "during composition. This is fatal error and cannot be disambiguated.";
+            }
+            else {
+                # but if this is a class, we 
+                # can safely skip adding the 
+                # attribute to the class
+                next;
+            }
+        }
+        else {
+            $other->add_attribute(
+                $attribute_name,
+                $self->get_attribute($attribute_name)
+            );
+        }
     }    
+}
+
+sub _apply_methods {
+    my ($self, $other) = @_;   
+    foreach my $method_name ($self->get_method_list) {
+        # 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)) {
+            # see if we are composing into a role
+            if ($other->isa('Moose::Meta::Role')) { 
+                # method conflicts between roles result 
+                # in the method becoming a requirement
+                $other->add_required_methods($method_name);
+                # NOTE:
+                # we have to remove the method from our 
+                # role, if this is being called from combine()
+                # which means the meta is an anon class
+                # this *may* cause problems later, but it 
+                # is probably fairly safe to assume that 
+                # anon classes will only be used internally
+                # or by people who know what they are doing
+                $other->Moose::Meta::Class::remove_method($method_name)
+                    if $other->name =~ /__ANON__/;
+            }
+            else {
+                next;
+            }
+        }
+        else {
+            # add it, although it could be overriden 
+            $other->alias_method(
+                $method_name,
+                $self->get_method($method_name)
+            );
+        }
+    }     
+}
+
+sub apply {
+    my ($self, $other) = @_;
     
-    foreach my $method_name ($self->get_method_modifier_list('override')) {
-        # skip it if it has one already
-        next if $other->has_method($method_name);
-        # add it, although it could be overriden 
-        $other->add_override_method_modifier(
-            $method_name,
-            $self->get_override_method_modifier($method_name),
-            $self->name
-        );
-    }    
+    ($other->isa('Moose::Meta::Class') || $other->isa('Moose::Meta::Role'))
+        || confess "You must apply a role to a metaclass, not ($other)";
     
-    foreach my $method_name ($self->get_method_modifier_list('before')) {
-        $other->add_before_method_modifier(
-            $method_name,
-            $_
-        ) foreach $self->get_before_method_modifiers($method_name);
-    }    
+    $self->_check_excluded_roles($other);
+    $self->_check_required_methods($other);  
+
+    $self->_apply_attributes($other);         
+    $self->_apply_methods($other);         
+
+    $other->add_role($self);
+}
+
+my $anon_counter = 0;
+
+sub combine {
+    my ($class, @roles) = @_;
     
-    foreach my $method_name ($self->get_method_modifier_list('after')) {
-        $other->add_after_method_modifier(
-            $method_name,
-            $_
-        ) foreach $self->get_after_method_modifiers($method_name);
-    }    
+    my $pkg_name = __PACKAGE__ . "::__ANON__::" . $anon_counter++;
+    eval "package " . $pkg_name . "; our \$VERSION = '0.00';";
+    die $@ if $@;
     
-    foreach my $method_name ($self->get_method_modifier_list('around')) {
-        $other->add_around_method_modifier(
-            $method_name,
-            $_
-        ) foreach $self->get_around_method_modifiers($method_name);
-    }    
+    my $combined = $class->initialize($pkg_name);
     
-    $other->add_role($self);
+    foreach my $role (@roles) {
+        $role->apply($combined);
+    }
+    
+    $combined->_clean_up_required_methods;   
+    
+    return $combined;
 }
 
 package Moose::Meta::Role::Method;
@@ -330,7 +348,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 more information. For the most part, this has no user-serviceable 
+parts inside. It's API is still subject to some change (although 
+probably not that much really).
 
 =head1 METHODS
 
@@ -342,6 +362,8 @@ for more information.
 
 =item B<apply>
 
+=item B<combine>
+
 =back
 
 =over 4
@@ -366,6 +388,24 @@ for more information.
 
 =over 4
 
+=item B<add_excluded_roles>
+
+=item B<excludes_role>
+
+=item B<get_excluded_roles_list>
+
+=item B<get_excluded_roles_map>
+
+=item B<calculate_all_roles>
+
+=back
+
+=over 4
+
+=item B<method_metaclass>
+
+=item B<find_method_by_name>
+
 =item B<get_method>
 
 =item B<has_method>
@@ -396,6 +436,8 @@ for more information.
 
 =item B<add_required_methods>
 
+=item B<remove_required_methods>
+
 =item B<get_required_method_list>
 
 =item B<get_required_methods_map>
@@ -404,56 +446,6 @@ for more information.
 
 =back
 
-=over 4
-
-=item B<add_after_method_modifier>
-
-=item B<add_around_method_modifier>
-
-=item B<add_before_method_modifier>
-
-=item B<add_override_method_modifier>
-
-=over 4
-
-=back
-
-=item B<has_after_method_modifiers>
-
-=item B<has_around_method_modifiers>
-
-=item B<has_before_method_modifiers>
-
-=item B<has_override_method_modifier>
-
-=over 4
-
-=back
-
-=item B<get_after_method_modifiers>
-
-=item B<get_around_method_modifiers>
-
-=item B<get_before_method_modifiers>
-
-=item B<get_method_modifier_list>
-
-=over 4
-
-=back
-
-=item B<get_override_method_modifier>
-
-=item B<get_after_method_modifiers_map>
-
-=item B<get_around_method_modifiers_map>
-
-=item B<get_before_method_modifiers_map>
-
-=item B<get_override_method_modifiers_map>
-
-=back
-
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no 
@@ -473,4 +465,4 @@ 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. 
 
-=cut
\ No newline at end of file
+=cut