X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=19c2a4e814ec04ea965abbfaee992073de84f242;hb=c9d7e3969b1695246e82f8d4260222216d2aa722;hp=463951b638111a0bc2a502cbde9c1dbe9aab0a4e;hpb=82750a8aa67b0f6cd139537bef64162d7a7c4d52;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 463951b..19c2a4e 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -7,8 +7,10 @@ use metaclass; use Scalar::Util 'blessed'; use Carp 'confess'; +use Sub::Name 'subname'; +use Devel::GlobalDestruction 'in_global_destruction'; -our $VERSION = '0.62_01'; +our $VERSION = '0.79'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -23,8 +25,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 +43,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 @@ -63,12 +65,11 @@ 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', } - }, + }, { name => 'attribute_map', attr_reader => 'get_attribute_map', @@ -117,13 +118,27 @@ 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', +); + ## some things don't always fit, so they go here ... sub add_attribute { my $self = shift; my $name = shift; - (defined $name && $name) - || Moose->throw_error("You must provide a name for the attribute"); + unless ( defined $name && $name ) { + require Moose; + Moose->throw_error("You must provide a name for the attribute"); + } my $attr_desc; if (scalar @_ == 1 && ref($_[0]) eq 'HASH') { $attr_desc = $_[0]; @@ -134,14 +149,19 @@ 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; + } +} ## ------------------------------------------------------------------ ## method modifiers @@ -157,12 +177,12 @@ 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 { @@ -254,7 +274,7 @@ sub update_package_cache_flag { ## ------------------------------------------------------------------ ## subroles -__PACKAGE__->meta->add_attribute('roles' => ( +$META->add_attribute('roles' => ( reader => 'get_roles', default => sub { [] } )); @@ -293,8 +313,6 @@ sub does_role { ## ------------------------------------------------------------------ ## methods -sub method_metaclass { 'Moose::Meta::Role::Method' } - sub get_method_map { my $self = shift; @@ -311,55 +329,47 @@ sub get_method_map { my $role_name = $self->name; my $method_metaclass = $self->method_metaclass; - my %all_code = $self->get_all_package_symbols('CODE'); + my $all_code = $self->get_all_package_symbols('CODE'); - foreach my $symbol (keys %all_code) { - my $code = $all_code{$symbol}; + foreach my $symbol (keys %{ $all_code }) { + my $code = $all_code->{$symbol}; next if exists $map->{$symbol} && defined $map->{$symbol} && $map->{$symbol}->body == $code; my ($pkg, $name) = Class::MOP::get_code_info($code); + my $meta = Class::MOP::class_of($pkg); - if ($pkg->can('meta') - # NOTE: - # we don't know what ->meta we are calling - # here, so we need to be careful cause it - # just might blow up at us, or just complain - # loudly (in the case of Curses.pm) so we - # just be a little overly cautious here. - # - SL - && eval { no warnings; blessed($pkg->meta) } # FIXME calls meta - && $pkg->meta->isa('Moose::Meta::Role')) { - my $role = $pkg->meta->name; + if ($meta && $meta->isa('Moose::Meta::Role')) { + my $role = $meta->name; next unless $self->does_role($role); } 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}; } @@ -394,7 +404,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'); } } @@ -410,7 +420,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 @@ -424,6 +434,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(@_); @@ -438,7 +450,7 @@ sub apply { (blessed($other)) || Moose->throw_error("You must pass in an blessed instance"); - + if ($other->isa('Moose::Meta::Role')) { require Moose::Meta::Role::Application::ToRole; return Moose::Meta::Role::Application::ToRole->new(@args)->apply($self, $other); @@ -446,35 +458,44 @@ sub apply { elsif ($other->isa('Moose::Meta::Class')) { require Moose::Meta::Role::Application::ToClass; return Moose::Meta::Role::Application::ToClass->new(@args)->apply($self, $other); - } + } else { require Moose::Meta::Role::Application::ToInstance; - return Moose::Meta::Role::Application::ToInstance->new(@args)->apply($self, $other); - } + return Moose::Meta::Role::Application::ToInstance->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 ) = @_; @@ -488,8 +509,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 @@ -501,6 +520,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]); @@ -563,7 +584,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/; @@ -590,8 +611,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 ##################################################################### @@ -605,7 +626,7 @@ sub create { # 'push' => 'add_role', # } # ); -# +# # has 'excluded_roles_map' => ( # metaclass => 'Collection::Hash', # reader => 'get_excluded_roles_map', @@ -617,95 +638,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 +# 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 .. # } # ); -# +# ##################################################################### @@ -721,174 +742,245 @@ Moose::Meta::Role - The Moose Role metaclass =head1 DESCRIPTION -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). +This class is a subclass of L that provides +additional Moose-specific functionality. + +It's API looks a lot like L, but internally it +implements many things differently. This may change in the future. + +=head1 INHERITANCE + +C is a subclass of L. =head1 METHODS +=head2 Construction + =over 4 -=item B +=item B<< Moose::Meta::Role->initialize($role_name) >> -=item B +This method creates a new role object with the provided name. -=item B +=item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >> -=item B +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. -=item B +The return value is a new L that +represents the combined roles. -=back +=item B<< Moose::Meta::Role->create($name, %options) >> -=over 4 +This method is identical to the L C +method. + +=item B<< Moose::Meta::Role->create_anon_role >> -=item B +This method is identical to the L +C method. -=item B +=item B<< $metarole->is_anon_role >> -=item B +Returns true if the role is an anonymous role. =back +=head2 Role application + =over 4 -=item B +=item B<< $metarole->apply( $thing, @options ) >> + +This method applies a role to the given C<$thing>. That can be another +L, object, a L object, or a +(non-meta) object instance. -=item B +The options are passed directly to the constructor for the appropriate +L subclass. -=item B +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 + =over 4 -=item B +=item B<< $metarole->get_roles >> -=item B +This returns an array reference of roles which this role does. This +list may include duplicates. -=item B +=item B<< $metarole->calculate_all_roles >> -=item B +This returns a I list of all roles that this role does, and +all the roles that its roles do. -=item B +=item B<< $metarole->does_role($role_name) >> -=back +Given a role I, returns true if this role does the given +role. -=over 4 +=item B<< $metarole->add_role($role) >> -=item B +Given a L object, this adds the role to the list of +roles that the role does. -=item B +=item B<< $metarole->get_excluded_roles_list >> -=item B +Returns a list of role names which this role excludes. -=item B +=item B<< $metarole->excludes_role($role_name) >> -=item B +Given a role I, returns true if this role excludes the named +role. -=item B +=item B<< $metarole->add_excluded_roles(@role_names) >> -=item B +Given one or more role names, adds those roles to the list of excluded +roles. -=item B +=back -=item B +=head2 Methods -=item B +The methods for dealing with a role's methods are all identical in API +and behavior to the same methods in L. -=item B +=over 4 -=back +=item B<< $metarole->method_metaclass >> -=over 4 +Returns the method metaclass name for the role. This defaults to +L. + +=item B<< $metarole->get_method($name) >> -=item B +=item B<< $metarole->has_method($name) >> -=item B +=item B<< $metarole->add_method( $name, $body ) >> -=item B +=item B<< $metarole->get_method_list >> -=item B +=item B<< $metarole->get_method_map >> -=item B +=item B<< $metarole->find_method_by_name($name) >> -=item B +These methods are all identical to the methods of the same name in +L =back +=head2 Attributes + +As with methods, the methods for dealing with a role's attribute are +all identical in API and behavior to the same methods in +L. + +However, attributes stored in this class are I stored as +objects. Rather, the attribute definition is stored as a hash +reference. When a role is composed into a class, this hash reference +is passed directly to the metaclass's C method. + +This is quite likely to change in the future. + =over 4 -=item B +=item B<< $metarole->get_attribute($attribute_name) >> -=item B +=item B<< $metarole->has_attribute($attribute_name) >> -=item B +=item B<< $metarole->get_attribute_map >> -=item B +=item B<< $metarole->get_attribute_list >> -=item B +=item B<< $metarole->add_attribute($name, %options) >> + +=item B<< $metarole->remove_attribute($attribute_name) >> =back +=head2 Required methods + =over 4 -=item B +=item B<< $metarole->get_required_method_list >> -=item B +Returns the list of methods required by the role. -=item B +=item B<< $metarole->requires_method($name) >> -=item B +Returns true if the role requires the named method. -=over 4 +=item B<< $metarole->add_required_methods(@names) >> -=back +Adds the named methods to the role's list of required methods. + +=item B<< $metarole->remove_required_methods(@names) >> -=item B +Removes the named methods to the role's list of required methods. -=item B +=back + +=head2 Method modifiers -=item B +These methods act like their counterparts in L and +L. -=item B +However, method modifiers are simply stored internally, and are not +applied until the role itself is applied to a class. =over 4 -=back +=item B<< $metarole->add_after_method_modifier($method_name, $method) >> -=item B +=item B<< $metarole->add_around_method_modifier($method_name, $method) >> -=item B +=item B<< $metarole->add_before_method_modifier($method_name, $method) >> -=item B +=item B<< $metarole->add_override_method_modifier($method_name, $method) >> -=item B +These methods all add an appropriate modifier to the internal list of +modifiers. -=over 4 +=item B<< $metarole->has_after_method_modifiers >> -=back +=item B<< $metarole->has_around_method_modifiers >> + +=item B<< $metarole->has_before_method_modifiers >> -=item B +=item B<< $metarole->has_override_method_modifier >> -=item B +Return true if the role has any modifiers of the given type. -=item B +=item B<< $metarole->get_after_method_modifiers($method_name) >> -=item B +=item B<< $metarole->get_around_method_modifiers($method_name) >> -=item B +=item B<< $metarole->get_before_method_modifiers($method_name) >> + +Given a method name, returns a list of the appropriate modifiers for +that method. + +=item B<< $metarole->get_override_method_modifier($method_name) >> + +Given a method name, returns the override method modifier for that +method, if it has one. =back -=over 4 +=head2 Introspection -=item B +=over 4 -=item B +=item B<< Moose::Meta::Role->meta >> -=item B +This will return a L instance for this class. =back @@ -904,7 +996,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L