X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=a01a8dba57cfc4ab0f1ccf73db8a10fa4b5968ea;hb=c8b8d92f366e6d9c09c0bb2a54b4f1942fc665ef;hp=a6ff920d41703a6987a10dd2a172f1d1b09a4ed3;hpb=e55d4727fa8c75821d64420d327ebdb8e5980631;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index a6ff920..a01a8db 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -7,14 +7,17 @@ use metaclass; use Scalar::Util 'blessed'; use Carp 'confess'; +use Sub::Name 'subname'; +use Devel::GlobalDestruction 'in_global_destruction'; -our $VERSION = '0.73'; +our $VERSION = '0.89'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use Moose::Meta::Class; use Moose::Meta::Role::Method; use Moose::Meta::Role::Method::Required; +use Moose::Meta::Role::Method::Conflicting; use base 'Class::MOP::Module'; @@ -23,8 +26,8 @@ use base 'Class::MOP::Module'; ## I normally don't do this, but I am doing ## a whole bunch of meta-programmin in this ## module, so it just makes sense. For a clearer -## picture of what is going on in the next -## several lines of code, look at the really +## picture of what is going on in the next +## several lines of code, look at the really ## big comment at the end of this file (right ## before the POD). ## - SL @@ -41,7 +44,7 @@ my $META = __PACKAGE__->meta; # 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. And since +# here an saving lots of extra typin. And since # many of these attributes above require similar # functionality to support them, so we again use # the wonders of meta-programmin' to deliver a @@ -55,7 +58,7 @@ foreach my $action ( attr_reader => 'get_excluded_roles_map' , methods => { add => 'add_excluded_roles', - get_list => 'get_excluded_roles_list', + get_keys => 'get_excluded_roles_list', existence => 'excludes_role', } }, @@ -63,18 +66,17 @@ foreach my $action ( name => 'required_methods', attr_reader => 'get_required_methods_map', methods => { - add => 'add_required_methods', - remove => 'remove_required_methods', - get_list => 'get_required_method_list', - existence => 'requires_method', + remove => 'remove_required_methods', + get_values => 'get_required_method_list', + existence => 'requires_method', } - }, + }, { name => 'attribute_map', attr_reader => 'get_attribute_map', methods => { get => 'get_attribute', - get_list => 'get_attribute_list', + get_keys => 'get_attribute_list', existence => 'has_attribute', remove => 'remove_attribute', } @@ -96,10 +98,15 @@ foreach my $action ( $self->$attr_reader->{$_} = undef foreach @values; }) if exists $methods->{add}; - $META->add_method($methods->{get_list} => sub { + $META->add_method($methods->{get_keys} => sub { my ($self) = @_; keys %{$self->$attr_reader}; - }) if exists $methods->{get_list}; + }) if exists $methods->{get_keys}; + + $META->add_method($methods->{get_values} => sub { + my ($self) = @_; + values %{$self->$attr_reader}; + }) if exists $methods->{get_values}; $META->add_method($methods->{get} => sub { my ($self, $name) = @_; @@ -117,12 +124,48 @@ foreach my $action ( }) if exists $methods->{remove}; } +$META->add_attribute( + 'method_metaclass', + reader => 'method_metaclass', + default => 'Moose::Meta::Role::Method', +); + +$META->add_attribute( + 'required_method_metaclass', + reader => 'required_method_metaclass', + default => 'Moose::Meta::Role::Method::Required', +); + +$META->add_attribute( + 'conflicting_method_metaclass', + reader => 'conflicting_method_metaclass', + default => 'Moose::Meta::Role::Method::Conflicting', +); + +$META->add_attribute( + 'application_to_class_class', + reader => 'application_to_class_class', + default => 'Moose::Meta::Role::Application::ToClass', +); + +$META->add_attribute( + 'application_to_role_class', + reader => 'application_to_role_class', + default => 'Moose::Meta::Role::Application::ToRole', +); + +$META->add_attribute( + 'application_to_instance_class', + reader => 'application_to_instance_class', + default => 'Moose::Meta::Role::Application::ToInstance', +); + ## some things don't always fit, so they go here ... sub add_attribute { my $self = shift; my $name = shift; - unless ( defined $name && $name ) { + unless ( defined $name ) { require Moose; Moose->throw_error("You must provide a name for the attribute"); } @@ -136,14 +179,33 @@ sub add_attribute { $self->get_attribute_map->{$name} = $attr_desc; } -# DEPRECATED -# 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 add_required_methods { + my $self = shift; + + for (@_) { + my $method = $_; + if (!blessed($method)) { + $method = $self->required_method_metaclass->new( + name => $method, + ); + } + $self->get_required_methods_map->{$method->name} = $method; + } +} + +sub add_conflicting_method { + my $self = shift; + + my $method; + if (@_ == 1 && blessed($_[0])) { + $method = shift; + } + else { + $method = $self->conflicting_method_metaclass->new(@_); + } + + $self->add_required_methods($method); +} ## ------------------------------------------------------------------ ## method modifiers @@ -159,18 +221,19 @@ sub add_attribute { foreach my $modifier_type (qw[ before around after ]) { my $attr_reader = "get_${modifier_type}_method_modifiers_map"; - + # create the attribute ... $META->add_attribute("${modifier_type}_method_modifiers" => ( reader => $attr_reader, default => sub { {} } - )); + )); # and some helper methods ... $META->add_method("get_${modifier_type}_method_modifiers" => sub { my ($self, $method_name) = @_; #return () unless exists $self->$attr_reader->{$method_name}; - @{$self->$attr_reader->{$method_name}}; + my $mm = $self->$attr_reader->{$method_name}; + $mm ? @$mm : (); }); $META->add_method("has_${modifier_type}_method_modifiers" => sub { @@ -295,8 +358,6 @@ sub does_role { ## ------------------------------------------------------------------ ## methods -sub method_metaclass { 'Moose::Meta::Role::Method' } - sub get_method_map { my $self = shift; @@ -331,29 +392,29 @@ sub get_method_map { } else { # NOTE: - # in 5.10 constant.pm the constants show up + # in 5.10 constant.pm the constants show up # as being in the right package, but in pre-5.10 - # they show up as constant::__ANON__ so we + # they show up as constant::__ANON__ so we # make an exception here to be sure that things # work as expected in both. # - SL unless ($pkg eq 'constant' && $name eq '__ANON__') { next if ($pkg || '') ne $role_name || (($name || '') ne '__ANON__' && ($pkg || '') ne $role_name); - } + } } - + $map->{$symbol} = $method_metaclass->wrap( $code, package_name => $role_name, - name => $name + name => $name ); } - return $map; + return $map; } -sub get_method { +sub get_method { my ($self, $name) = @_; $self->get_method_map->{$name}; } @@ -388,7 +449,7 @@ sub add_method { if ($method->package_name ne $self->name) { $method = $method->clone( package_name => $self->name, - name => $method_name + name => $method_name ) if $method->can('clone'); } } @@ -404,7 +465,7 @@ sub add_method { my $full_method_name = ($self->name . '::' . $method_name); $self->add_package_symbol( { sigil => '&', type => 'CODE', name => $method_name }, - Class::MOP::subname($full_method_name => $body) + subname($full_method_name => $body) ); $self->update_package_cache_flag; # still valid, since we just added the method to the map, and if it was invalid before that then get_method_map updated it @@ -418,6 +479,8 @@ sub get_method_list { } sub alias_method { + Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); + my $self = shift; $self->add_method(@_); @@ -432,43 +495,53 @@ sub apply { (blessed($other)) || Moose->throw_error("You must pass in an blessed instance"); - + + my $application_class; if ($other->isa('Moose::Meta::Role')) { - require Moose::Meta::Role::Application::ToRole; - return Moose::Meta::Role::Application::ToRole->new(@args)->apply($self, $other); + $application_class = $self->application_to_role_class; } elsif ($other->isa('Moose::Meta::Class')) { - require Moose::Meta::Role::Application::ToClass; - return Moose::Meta::Role::Application::ToClass->new(@args)->apply($self, $other); - } + $application_class = $self->application_to_class_class; + } else { - require Moose::Meta::Role::Application::ToInstance; - return Moose::Meta::Role::Application::ToInstance->new(@args)->apply($self, $other); - } + $application_class = $self->application_to_instance_class; + } + + Class::MOP::load_class($application_class); + return $application_class->new(@args)->apply($self, $other); } sub combine { my ($class, @role_specs) = @_; - + require Moose::Meta::Role::Application::RoleSummation; - require Moose::Meta::Role::Composite; - + require Moose::Meta::Role::Composite; + my (@roles, %role_params); while (@role_specs) { - my ($role, $params) = @{ splice @role_specs, 0, 1 }; - push @roles => $role->meta; + my ($role_name, $params) = @{ splice @role_specs, 0, 1 }; + my $requested_role = Class::MOP::class_of($role_name); + + my $actual_role = $requested_role->_role_for_combination($params); + push @roles => $actual_role; + next unless defined $params; - $role_params{$role} = $params; + $role_params{$actual_role->name} = $params; } - + my $c = Moose::Meta::Role::Composite->new(roles => \@roles); Moose::Meta::Role::Application::RoleSummation->new( role_params => \%role_params )->apply($c); - + return $c; } +sub _role_for_combination { + my ($self, $params) = @_; + return $self; +} + sub create { my ( $role, $package_name, %options ) = @_; @@ -482,8 +555,6 @@ sub create { || confess "You must pass a HASH ref of methods" if exists $options{methods}; - $role->SUPER::create(%options); - my (%initialize_options) = %options; delete @initialize_options{qw( package @@ -495,6 +566,8 @@ sub create { my $meta = $role->initialize( $package_name => %initialize_options ); + $meta->_instantiate_module( $options{version}, $options{authority} ); + # FIXME totally lame $meta->add_method('meta' => sub { $role->initialize(ref($_[0]) || $_[0]); @@ -557,7 +630,7 @@ sub create { sub DESTROY { my $self = shift; - return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated + return if in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated no warnings 'uninitialized'; return unless $self->name =~ /^$ANON_ROLE_PREFIX/; @@ -584,8 +657,8 @@ sub create { ##################################################################### ## NOTE: -## This is Moose::Meta::Role as defined by Moose (plus the use of -## MooseX::AttributeHelpers module). It is here as a reference to +## This is Moose::Meta::Role as defined by Moose (plus the use of +## MooseX::AttributeHelpers module). It is here as a reference to ## make it easier to see what is happening above with all the meta ## programming. - SL ##################################################################### @@ -593,13 +666,13 @@ sub create { # has 'roles' => ( # metaclass => 'Collection::Array', # reader => 'get_roles', -# isa => 'ArrayRef[Moose::Meta::Roles]', +# isa => 'ArrayRef[Moose::Meta::Role]', # default => sub { [] }, # provides => { # 'push' => 'add_role', # } # ); -# +# # has 'excluded_roles_map' => ( # metaclass => 'Collection::Hash', # reader => 'get_excluded_roles_map', @@ -611,95 +684,95 @@ sub create { # 'exists' => 'excludes_role', # } # ); -# +# # has 'attribute_map' => ( # metaclass => 'Collection::Hash', # reader => 'get_attribute_map', -# isa => 'HashRef[Str]', +# isa => 'HashRef[Str]', # provides => { # # 'set' => 'add_attribute' # has some special crap in it # 'get' => 'get_attribute', # 'keys' => 'get_attribute_list', # 'exists' => 'has_attribute', # # Not exactly delete, cause it sets multiple -# 'delete' => 'remove_attribute', +# 'delete' => 'remove_attribute', # } # ); -# +# # has 'required_methods' => ( # metaclass => 'Collection::Hash', # reader => 'get_required_methods_map', -# isa => 'HashRef[Str]', -# provides => { -# # not exactly set, or delete since it works for multiple +# isa => 'HashRef[Moose::Meta::Role::Method::Required]', +# provides => { +# # not exactly set, or delete since it works for multiple # 'set' => 'add_required_methods', # 'delete' => 'remove_required_methods', # 'keys' => 'get_required_method_list', -# 'exists' => 'requires_method', +# 'exists' => 'requires_method', # } # ); -# -# # the before, around and after modifiers are -# # HASH keyed by method-name, with ARRAY of +# +# # the before, around and after modifiers are +# # HASH keyed by method-name, with ARRAY of # # CODE refs to apply in that order -# +# # has 'before_method_modifiers' => ( -# metaclass => 'Collection::Hash', +# metaclass => 'Collection::Hash', # reader => 'get_before_method_modifiers_map', # isa => 'HashRef[ArrayRef[CodeRef]]', # provides => { # 'keys' => 'get_before_method_modifiers', -# 'exists' => 'has_before_method_modifiers', -# # This actually makes sure there is an +# 'exists' => 'has_before_method_modifiers', +# # This actually makes sure there is an # # ARRAY at the given key, and pushed onto # # it. It also checks for duplicates as well -# # 'add' => 'add_before_method_modifier' -# } +# # 'add' => 'add_before_method_modifier' +# } # ); -# +# # has 'after_method_modifiers' => ( -# metaclass => 'Collection::Hash', +# metaclass => 'Collection::Hash', # reader =>'get_after_method_modifiers_map', # isa => 'HashRef[ArrayRef[CodeRef]]', # provides => { # 'keys' => 'get_after_method_modifiers', -# 'exists' => 'has_after_method_modifiers', -# # This actually makes sure there is an +# 'exists' => 'has_after_method_modifiers', +# # This actually makes sure there is an # # ARRAY at the given key, and pushed onto -# # it. It also checks for duplicates as well -# # 'add' => 'add_after_method_modifier' -# } +# # it. It also checks for duplicates as well +# # 'add' => 'add_after_method_modifier' +# } # ); -# +# # has 'around_method_modifiers' => ( -# metaclass => 'Collection::Hash', +# metaclass => 'Collection::Hash', # reader =>'get_around_method_modifiers_map', # isa => 'HashRef[ArrayRef[CodeRef]]', # provides => { # 'keys' => 'get_around_method_modifiers', -# 'exists' => 'has_around_method_modifiers', -# # This actually makes sure there is an +# 'exists' => 'has_around_method_modifiers', +# # This actually makes sure there is an # # ARRAY at the given key, and pushed onto -# # it. It also checks for duplicates as well -# # 'add' => 'add_around_method_modifier' -# } +# # it. It also checks for duplicates as well +# # 'add' => 'add_around_method_modifier' +# } # ); -# +# # # override is similar to the other modifiers # # except that it is not an ARRAY of code refs # # but instead just a single name->code mapping -# +# # has 'override_method_modifiers' => ( -# metaclass => 'Collection::Hash', +# metaclass => 'Collection::Hash', # reader =>'get_override_method_modifiers_map', -# isa => 'HashRef[CodeRef]', +# isa => 'HashRef[CodeRef]', # provides => { # 'keys' => 'get_override_method_modifier', -# 'exists' => 'has_override_method_modifier', -# 'add' => 'add_override_method_modifier', # checks for local method .. +# 'exists' => 'has_override_method_modifier', +# 'add' => 'add_override_method_modifier', # checks for local method .. # } # ); -# +# ##################################################################### @@ -739,8 +812,8 @@ This method creates a new role object with the provided name. This method accepts a list of array references. Each array reference should contain a role name as its first element. The second element is -an optional hash reference. The hash reference can contain C -and C keys to control how methods are composed from the role. +an optional hash reference. The hash reference can contain C<-excludes> +and C<-alias> keys to control how methods are composed from the role. The return value is a new L that represents the combined roles. @@ -774,6 +847,10 @@ L, object, a L object, or a The options are passed directly to the constructor for the appropriate L subclass. +Note that this will apply the role even if the C<$thing> in question already +C this role. L is a convenient wrapper for +finding out if role application is necessary. + =back =head2 Roles and other roles @@ -886,13 +963,18 @@ Returns the list of methods required by the role. Returns true if the role requires the named method. -=item B<< $metarole->add_required_methods(@names >> +=item B<< $metarole->add_required_methods(@names) >> -Adds the named methods to the roles list of required methods. +Adds the named methods to the role's list of required methods. =item B<< $metarole->remove_required_methods(@names) >> -Removes the named methods to the roles list of required methods. +Removes the named methods from the role's list of required methods. + +=item B<< $metarole->add_conflicting_method(%params) >> + +Instantiate the parameters as a L +object, then add it to the required method list. =back