X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=4506c902cf75afd2b86e2d7bdfcdc4dbc6eb8239;hb=97e11ef507470a5854419d6edffd2b1e8f8118c3;hp=bfacbc4cddb127d135dd2fb56a184d7f894a4b3e;hpb=40e89659fa6d83f48031befe226aa1f3143afbd1;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index bfacbc4..4506c90 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -9,70 +9,239 @@ use Carp 'confess'; use Scalar::Util 'blessed'; use B 'svref_2object'; -use Moose::Meta::Class; +our $VERSION = '0.10'; +our $AUTHORITY = 'cpan:STEVAN'; -our $VERSION = '0.04'; +use Moose::Meta::Class; +use Moose::Meta::Role::Method; +use Moose::Meta::Role::Method::Required; use base 'Class::MOP::Module'; -## Attributes -## roles +# NOTE: +# I normally don't do this, but I am doing +# a whole bunch of meta-programmin in this +# module, so it just makes sense. +# - SL -__PACKAGE__->meta->add_attribute('roles' => ( - reader => 'get_roles', - default => sub { [] } -)); +my $META = __PACKAGE__->meta; -## excluded roles +## ------------------------------------------------------------------ +## attributes ... -__PACKAGE__->meta->add_attribute('excluded_roles_map' => ( - reader => 'get_excluded_roles_map', +# NOTE: +# since roles are lazy, we hold all the attributes +# of the individual role in 'statis' until which +# time when it is applied to a class. This means +# keeping a lot of things in hash maps, so we are +# using a little of that meta-programmin' magic +# here an saving lots of extra typin. +# - SL + +$META->add_attribute($_->{name} => ( + reader => $_->{reader}, default => sub { {} } -)); +)) for ( + { name => 'excluded_roles_map', reader => 'get_excluded_roles_map' }, + { name => 'attribute_map', reader => 'get_attribute_map' }, + { name => 'required_methods', reader => 'get_required_methods_map' }, +); + +# NOTE: +# many of these attributes above require similar +# functionality to support them, so we again use +# the wonders of meta-programmin' to deliver a +# very compact solution to this normally verbose +# problem. +# - SL + +foreach my $action ( + { + attr_reader => 'get_excluded_roles_map' , + methods => { + add => 'add_excluded_roles', + get_list => 'get_excluded_roles_list', + existence => 'excludes_role', + } + }, + { + attr_reader => 'get_required_methods_map', + methods => { + add => 'add_required_methods', + remove => 'remove_required_methods', + get_list => 'get_required_method_list', + existence => 'requires_method', + } + }, + { + attr_reader => 'get_attribute_map', + methods => { + get => 'get_attribute', + get_list => 'get_attribute_list', + existence => 'has_attribute', + remove => 'remove_attribute', + } + } +) { + + my $attr_reader = $action->{attr_reader}; + my $methods = $action->{methods}; + + $META->add_method($methods->{add} => sub { + my ($self, @values) = @_; + $self->$attr_reader->{$_} = undef foreach @values; + }) if exists $methods->{add}; + + $META->add_method($methods->{get_list} => sub { + my ($self) = @_; + keys %{$self->$attr_reader}; + }) if exists $methods->{get_list}; + + $META->add_method($methods->{get} => sub { + my ($self, $name) = @_; + $self->$attr_reader->{$name} + }) if exists $methods->{get}; + + $META->add_method($methods->{existence} => sub { + my ($self, $name) = @_; + exists $self->$attr_reader->{$name} ? 1 : 0; + }) if exists $methods->{existence}; + + $META->add_method($methods->{remove} => sub { + my ($self, @values) = @_; + delete $self->$attr_reader->{$_} foreach @values; + }) if exists $methods->{remove}; +} -## attributes +## some things don't always fit, so they go here ... -__PACKAGE__->meta->add_attribute('attribute_map' => ( - reader => 'get_attribute_map', - default => sub { {} } -)); +sub add_attribute { + 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; +} -## required methods +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); + } +} -__PACKAGE__->meta->add_attribute('required_methods' => ( - reader => 'get_required_methods_map', +## ------------------------------------------------------------------ +## method modifiers + +$META->add_attribute($_->{name} => ( + reader => $_->{reader}, default => sub { {} } -)); +)) for ( + { name => 'before_method_modifiers', reader => 'get_before_method_modifiers_map' }, + { name => 'after_method_modifiers', reader => 'get_after_method_modifiers_map' }, + { name => 'around_method_modifiers', reader => 'get_around_method_modifiers_map' }, + { name => 'override_method_modifiers', reader => 'get_override_method_modifiers_map' }, +); + +# NOTE: +# the before/around/after method modifiers are +# stored by name, but there can be many methods +# then associated with that name. So again we have +# lots of similar functionality, so we can do some +# meta-programmin' and save some time. +# - SL + +foreach my $modifier_type (qw[ before around after ]) { + + my $attr_reader = "get_${modifier_type}_method_modifiers_map"; + + $META->add_method("get_${modifier_type}_method_modifiers" => sub { + my ($self, $method_name) = @_; + @{$self->$attr_reader->{$method_name}}; + }); + + $META->add_method("has_${modifier_type}_method_modifiers" => sub { + my ($self, $method_name) = @_; + # NOTE: + # for now we assume that if it exists,.. + # it has at least one modifier in it + (exists $self->$attr_reader->{$method_name}) ? 1 : 0; + }); + + $META->add_method("add_${modifier_type}_method_modifier" => sub { + my ($self, $method_name, $method) = @_; + + $self->$attr_reader->{$method_name} = [] + unless exists $self->$attr_reader->{$method_name}; + + my $modifiers = $self->$attr_reader->{$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; + }); + +} -## method modifiers +## ------------------------------------------------------------------ +## override method mofidiers -__PACKAGE__->meta->add_attribute('before_method_modifiers' => ( - reader => 'get_before_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); +# NOTE: +# these are a little different because there +# can only be one per name, whereas the other +# method modifiers can have multiples. +# - SL -__PACKAGE__->meta->add_attribute('after_method_modifiers' => ( - reader => 'get_after_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); +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; +} -__PACKAGE__->meta->add_attribute('around_method_modifiers' => ( - reader => 'get_around_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); +sub has_override_method_modifier { + my ($self, $method_name) = @_; + # NOTE: + # for now we assume that if it exists,.. + # it has at least one modifier in it + (exists $self->get_override_method_modifiers_map->{$method_name}) ? 1 : 0; +} -__PACKAGE__->meta->add_attribute('override_method_modifiers' => ( - reader => 'get_override_method_modifiers_map', - default => sub { {} } # ( => CODE) -)); +sub get_override_method_modifier { + my ($self, $method_name) = @_; + $self->get_override_method_modifiers_map->{$method_name}; +} -## Methods +## general list accessor ... -sub method_metaclass { 'Moose::Meta::Role::Method' } +sub get_method_modifier_list { + my ($self, $modifier_type) = @_; + my $accessor = "get_${modifier_type}_method_modifiers_map"; + keys %{$self->$accessor}; +} +## ------------------------------------------------------------------ ## subroles +__PACKAGE__->meta->add_attribute('roles' => ( + reader => 'get_roles', + default => sub { [] } +)); + sub add_role { my ($self, $role) = @_; (blessed($role) && $role->isa('Moose::Meta::Role')) @@ -83,7 +252,12 @@ sub add_role { sub calculate_all_roles { my $self = shift; my %seen; - grep { !$seen{$_->name}++ } $self, map { $_->calculate_all_roles } @{ $self->get_roles }; + grep { + !$seen{$_->name}++ + } ($self, + map { + $_->calculate_all_roles + } @{ $self->get_roles }); } sub does_role { @@ -99,182 +273,98 @@ 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; -} +## ------------------------------------------------------------------ +## methods -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 { - my ($self, @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}; -} - -sub requires_method { - my ($self, $method_name) = @_; - exists $self->get_required_methods_map->{$method_name} ? 1 : 0; -} +sub method_metaclass { 'Moose::Meta::Role::Method' } -sub _clean_up_required_methods { +# FIXME: +# this is an UGLY hack +sub get_method_map { my $self = shift; - foreach my $method ($self->get_required_method_list) { - $self->remove_required_methods($method) - if $self->has_method($method); - } + $self->{'%!methods'} ||= {}; + $self->Moose::Meta::Class::get_method_map() } -## methods - # 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 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 { - # 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->Moose::Meta::Class::get_method_list; +sub get_method_list { + grep { + !/^meta$/ + } (shift)->Moose::Meta::Class::get_method_list(@_) } -# ... however the items in statis (attributes & method modifiers) -# can be removed and added to through this API +sub find_method_by_name { (shift)->get_method(@_) } -# attributes +## ------------------------------------------------------------------ +## role construction +## ------------------------------------------------------------------ -sub add_attribute { - 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 { - my ($self, $name) = @_; - exists $self->get_attribute_map->{$name} ? 1 : 0; -} - -sub get_attribute { - my ($self, $name) = @_; - $self->get_attribute_map->{$name} -} - -sub remove_attribute { - my ($self, $name) = @_; - delete $self->get_attribute_map->{$name} -} - -sub get_attribute_list { - my ($self) = @_; - keys %{$self->get_attribute_map}; -} +my $anon_counter = 0; -# method modifiers +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 $@; -# 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', @_) } + my $object = $other; -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; + $other = Moose::Meta::Class->initialize($pkg_name); + $other->superclasses(blessed($object)); + + bless $object => $pkg_name; } - 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', @_) } + + $self->_check_excluded_roles($other); + $self->_check_required_methods($other); -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; -} + $self->_apply_attributes($other); + $self->_apply_methods($other); -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', @_) } + $self->_apply_override_method_modifiers($other); + $self->_apply_before_method_modifiers($other); + $self->_apply_around_method_modifiers($other); + $self->_apply_after_method_modifiers($other); -sub _get_method_modifiers { - my ($self, $modifier_type, $method_name) = @_; - my $accessor = "get_${modifier_type}_method_modifiers_map"; - @{$self->$accessor->{$method_name}}; + $other->add_role($self); } -sub get_override_method_modifier { - my ($self, $method_name) = @_; - $self->get_override_method_modifiers_map->{$method_name}; +sub combine { + my ($class, @roles) = @_; + + 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); + } + + $combined->_clean_up_required_methods; + + return $combined; } -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 ... @@ -320,21 +410,24 @@ sub _check_required_methods { # we need to make sure that the method is # not a method modifier, because those do # not satisfy the requirements ... - 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')) + my $method = $other->find_method_by_name($required_method_name); + + # check if it is a generated 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 - # since we wrap the original local method (if applicable) - # so we need to check if the original wrapped method is - # from the same package, and not a wrap of the super method - if ($method->isa('Class::MOP::Method::Wrapped')) { - ($method->get_original_method->package_name eq $other->name) - || confess "'" . $self->name . "' requires the method '$required_method_name' " . - "to be implemented by '" . $other->name . "', the method is only a method modifier"; - } + "to be implemented by '" . $other->name . "', the method is only an attribute accessor"; + + # NOTE: + # All other tests here have been removed, they were tests + # for overriden methods and before/after/around modifiers. + # But we realized that for classes any overriden or modified + # methods would be backed by a real method of that name + # (and therefore meet the requirement). And for roles, the + # overriden and modified methods are "in statis" and so would + # not show up in this test anyway (and as a side-effect they + # would not fufill the requirement, which is exactly what we + # want them to do anyway). + # - SL } } } @@ -362,10 +455,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) + ); + } } } } @@ -376,7 +479,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 @@ -479,55 +582,6 @@ 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' => @_) } -sub apply { - my ($self, $other) = @_; - - ($other->isa('Moose::Meta::Class') || $other->isa('Moose::Meta::Role')) - || confess "You must apply a role to a metaclass, not ($other)"; - - $self->_check_excluded_roles($other); - $self->_check_required_methods($other); - - $self->_apply_attributes($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); -} - -my $anon_counter = 0; - -sub combine { - my ($class, @roles) = @_; - - 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); - } - - $combined->_clean_up_required_methods; - - return $combined; -} - -package Moose::Meta::Role::Method; - -use strict; -use warnings; - -our $VERSION = '0.01'; - -use base 'Class::MOP::Method'; - 1; __END__ @@ -540,9 +594,9 @@ Moose::Meta::Role - The Moose Role metaclass =head1 DESCRIPTION -Moose's Roles are being actively developed, please see L -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 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 @@ -607,6 +661,8 @@ probably not that much really). =item B +=item B + =back =over 4 @@ -701,7 +757,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006, 2007 by Infinity Interactive, Inc. L