X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=caad02188be2c43cf336dd9b58802affd4dc7074;hb=870d0f1a40aafaeab1155cae153ac60c47cd12ec;hp=547dabb964965f365a1a05bd3546dd31f000d2bd;hpb=eaa35e6e0f9132abf6ed0cec60515dd7259ce704;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 547dabb..caad021 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -5,25 +5,30 @@ use strict; use warnings; use metaclass; -use Carp 'confess'; use Scalar::Util 'blessed'; +use Carp 'confess'; +use Devel::GlobalDestruction 'in_global_destruction'; -our $VERSION = '0.50'; +our $VERSION = '0.94'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use Moose::Meta::Class; +use Moose::Meta::Role::Attribute; use Moose::Meta::Role::Method; use Moose::Meta::Role::Method::Required; +use Moose::Meta::Role::Method::Conflicting; +use Moose::Util qw( ensure_all_roles ); -use base 'Class::MOP::Module'; +use base 'Class::MOP::Module', 'Class::MOP::Mixin::HasAttributes'; ## ------------------------------------------------------------------ ## 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. 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 @@ -40,7 +45,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 @@ -54,7 +59,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', } }, @@ -62,22 +67,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', - methods => { - get => 'get_attribute', - get_list => 'get_attribute_list', - existence => 'has_attribute', - remove => 'remove_attribute', + remove => 'remove_required_methods', + get_values => 'get_required_method_list', + existence => 'requires_method', } - } + }, ) { my $attr_reader = $action->{attr_reader}; @@ -95,10 +89,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) = @_; @@ -116,29 +115,125 @@ foreach my $action ( }) if exists $methods->{remove}; } -## some things don't always fit, so they go here ... +$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', +); + +# More or less copied from Moose::Meta::Class +sub initialize { + my $class = shift; + my $pkg = shift; + return Class::MOP::get_metaclass_by_name($pkg) + || $class->SUPER::initialize( + $pkg, + 'attribute_metaclass' => 'Moose::Meta::Role::Attribute', + @_ + ); +} + +sub reinitialize { + my $self = shift; + my $pkg = shift; + + my $meta = blessed $pkg ? $pkg : Class::MOP::class_of($pkg); + + my %existing_classes; + if ($meta) { + %existing_classes = map { $_ => $meta->$_() } qw( + attribute_metaclass + method_metaclass + wrapped_method_metaclass + required_method_metaclass + conflicting_method_metaclass + application_to_class_class + application_to_role_class + application_to_instance_class + ); + } + + return $self->SUPER::reinitialize( + $pkg, + %existing_classes, + @_, + ); +} sub add_attribute { my $self = shift; - my $name = shift; - my $attr_desc; - if (scalar @_ == 1 && ref($_[0]) eq 'HASH') { - $attr_desc = $_[0]; + + if (blessed $_[0] && ! $_[0]->isa('Moose::Meta::Role::Attribute') ) { + my $class = ref $_[0]; + Moose->throw_error( "Cannot add a $class as an attribute to a role" ); } - else { - $attr_desc = { @_ }; + + return $self->SUPER::add_attribute(@_); +} + +sub _attach_attribute { + my ( $self, $attribute ) = @_; + + $attribute->attach_to_role($self); +} + +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; } - $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_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 @@ -154,18 +249,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 { @@ -214,8 +310,8 @@ $META->add_attribute('override_method_modifiers' => ( 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'"; + || Moose->throw_error("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; } @@ -240,10 +336,18 @@ sub get_method_modifier_list { keys %{$self->$accessor}; } +sub reset_package_cache_flag { (shift)->{'_package_cache_flag'} = undef } +sub update_package_cache_flag { + my $self = shift; + $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name); +} + + + ## ------------------------------------------------------------------ ## subroles -__PACKAGE__->meta->add_attribute('roles' => ( +$META->add_attribute('roles' => ( reader => 'get_roles', default => sub { [] } )); @@ -251,8 +355,9 @@ __PACKAGE__->meta->add_attribute('roles' => ( sub add_role { my ($self, $role) = @_; (blessed($role) && $role->isa('Moose::Meta::Role')) - || confess "Roles must be instances of Moose::Meta::Role"; + || Moose->throw_error("Roles must be instances of Moose::Meta::Role"); push @{$self->get_roles} => $role; + $self->reset_package_cache_flag; } sub calculate_all_roles { @@ -266,9 +371,10 @@ sub calculate_all_roles { } sub does_role { - my ($self, $role_name) = @_; - (defined $role_name) - || confess "You must supply a role name to look for"; + my ($self, $role) = @_; + (defined $role) + || Moose->throw_error("You must supply a role name to look for"); + my $role_name = blessed $role ? $role->name : $role; # if we are it,.. then return true return 1 if $role_name eq $self->name; # otherwise.. check our children @@ -278,92 +384,14 @@ sub does_role { return 0; } -## ------------------------------------------------------------------ -## methods - -sub method_metaclass { 'Moose::Meta::Role::Method' } - -sub get_method_map { - my $self = shift; - my $map = {}; - - my $role_name = $self->name; - my $method_metaclass = $self->method_metaclass; - - my %all_code = $self->get_all_package_symbols('CODE'); - - foreach my $symbol (keys %all_code) { - my $code = $all_code{$symbol}; - - my ($pkg, $name) = Class::MOP::get_code_info($code); - - 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) } - && $pkg->meta->isa('Moose::Meta::Role')) { - my $role = $pkg->meta->name; - next unless $self->does_role($role); - } - else { - # NOTE: - # 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 - # 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 - ); - } - - return $map; -} - -sub get_method { - my ($self, $name) = @_; - $self->get_method_map->{$name}; -} - -sub has_method { - my ($self, $name) = @_; - exists $self->get_method_map->{$name} ? 1 : 0 -} - sub find_method_by_name { (shift)->get_method(@_) } -sub get_method_list { - my $self = shift; - grep { !/^meta$/ } keys %{$self->get_method_map}; -} - sub alias_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; + Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); - my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; + my $self = shift; - $self->add_package_symbol( - { sigil => '&', type => 'CODE', name => $method_name }, - $body - ); + $self->add_method(@_); } ## ------------------------------------------------------------------ @@ -374,64 +402,188 @@ sub apply { my ($self, $other, @args) = @_; (blessed($other)) - || confess "You must pass in an blessed instance"; - + || 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 composition_class_roles { } + 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 $requested_role + = blessed $role + ? $role + : Class::MOP::class_of($role); + + 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; + return $c->apply_params(\%role_params); +} + +sub _role_for_combination { + my ($self, $params) = @_; + return $self; +} + +sub create { + my ( $role, $package_name, %options ) = @_; + + $options{package} = $package_name; + + (ref $options{attributes} eq 'HASH') + || confess "You must pass a HASH ref of attributes" + if exists $options{attributes}; + + (ref $options{methods} eq 'HASH') + || confess "You must pass a HASH ref of methods" + if exists $options{methods}; + + my (%initialize_options) = %options; + delete @initialize_options{qw( + package + attributes + methods + version + authority + )}; + + 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]); + }); + + if (exists $options{attributes}) { + foreach my $attribute_name (keys %{$options{attributes}}) { + my $attr = $options{attributes}->{$attribute_name}; + $meta->add_attribute( + $attribute_name => blessed $attr ? $attr : %{$attr} ); + } + } + + if (exists $options{methods}) { + foreach my $method_name (keys %{$options{methods}}) { + $meta->add_method($method_name, $options{methods}->{$method_name}); + } + } + + Class::MOP::weaken_metaclass($meta->name) + if $meta->is_anon_role; + + return $meta; +} + +# anonymous roles. most of it is copied straight out of Class::MOP::Class. +# an intrepid hacker might find great riches if he unifies this code with that +# code in Class::MOP::Module or Class::MOP::Package +{ + # NOTE: + # this should be sufficient, if you have a + # use case where it is not, write a test and + # I will change it. + my $ANON_ROLE_SERIAL = 0; + + # NOTE: + # we need a sufficiently annoying prefix + # this should suffice for now, this is + # used in a couple of places below, so + # need to put it up here for now. + my $ANON_ROLE_PREFIX = 'Moose::Meta::Role::__ANON__::SERIAL::'; + + sub is_anon_role { + my $self = shift; + no warnings 'uninitialized'; + $self->name =~ /^$ANON_ROLE_PREFIX/; + } + + sub create_anon_role { + my ($role, %options) = @_; + my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL; + return $role->create($package_name, %options); + } + + # NOTE: + # this will only get called for + # anon-roles, all other calls + # are assumed to occur during + # global destruction and so don't + # really need to be handled explicitly + sub DESTROY { + my $self = shift; + + 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/; + + # XXX: is this necessary for us? I don't understand what it's doing + # -sartak + + # Moose does a weird thing where it replaces the metaclass for + # class when fixing metaclass incompatibility. In that case, + # we don't want to clean out the namespace now. We can detect + # that because Moose will explicitly update the singleton + # cache in Class::MOP. + #my $current_meta = Class::MOP::get_metaclass_by_name($self->name); + #return if $current_meta ne $self; + + my ($serial_id) = ($self->name =~ /^$ANON_ROLE_PREFIX(\d+)/); + no strict 'refs'; + foreach my $key (keys %{$ANON_ROLE_PREFIX . $serial_id}) { + delete ${$ANON_ROLE_PREFIX . $serial_id}{$key}; + } + delete ${'main::' . $ANON_ROLE_PREFIX}{$serial_id . '::'}; + } } ##################################################################### ## 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 ##################################################################### # # has 'roles' => ( -# metaclass => 'Collection::Array', +# metaclass => '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', +# metaclass => 'Hash', # reader => 'get_excluded_roles_map', # isa => 'HashRef[Str]', # provides => { @@ -441,95 +593,81 @@ sub combine { # 'exists' => 'excludes_role', # } # ); -# -# has 'attribute_map' => ( -# metaclass => 'Collection::Hash', -# reader => 'get_attribute_map', -# 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', -# } -# ); -# +# # has 'required_methods' => ( -# metaclass => 'Collection::Hash', +# metaclass => '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 => '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 => '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 => '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 => '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 .. # } # ); -# +# ##################################################################### @@ -545,166 +683,260 @@ 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 or L object as its first element. The second element is +an optional hash reference. The hash reference can contain C<-excludes> +and C<-alias> keys to control how methods are composed from the role. -=back +The return value is a new L that +represents the combined roles. -=over 4 +=item B<< $metarole->composition_class_roles >> + +When combining multiple roles using C, this method is used to obtain a +list of role names to be applied to the L +instance returned by C. The default implementation returns an empty +list. Extensions that need to hook into role combination may wrap this method +to return additional role names. + +=item B<< Moose::Meta::Role->create($name, %options) >> + +This method is identical to the L C +method. -=item B +=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 >> + +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) >> -=back +Given a role I or L object, 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 -=back +The methods for dealing with a role's methods are all identical in API +and behavior to the same methods in L. =over 4 -=item B +=item B<< $metarole->method_metaclass >> + +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->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_list >> -=item B +=item B<< $metarole->add_attribute($name, %options) >> -=item B +=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 from the role's list of required methods. -=item B +=item B<< $metarole->add_conflicting_method(%params) >> + +Instantiate the parameters as a L +object, then add it to the required method list. + +=back -=item B +=head2 Method modifiers -=item B +These methods act like their counterparts in L and +L. + +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<< $metarole->get_around_method_modifiers($method_name) >> + +=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 + +=head2 Introspection + +=over 4 -=item B +=item B<< Moose::Meta::Role->meta >> -=item B +This will return a L instance for this class. =back =head1 BUGS -All complex software has bugs lurking in it, and this module is no -exception. If you find a bug please either email me, or add the bug -to cpan-RT. +See L for details on reporting bugs. =head1 AUTHOR @@ -712,7 +944,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2010 by Infinity Interactive, Inc. L