X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=0f96d22fed667690dff8ac55b9d568cc7472493f;hb=5d9d20f3e1445861792fbff00f8e37396ce7c8ed;hp=13034ce3802b616822b7c42c18aee99ea965c86c;hpb=e606ae5f848070d889472329819c95f5ba763ca3;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 13034ce..0f96d22 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -1,30 +1,36 @@ - package Moose::Meta::Role; use strict; use warnings; use metaclass; -use Carp 'confess'; +use Class::Load qw(load_class); use Scalar::Util 'blessed'; - -our $VERSION = '0.57'; -$VERSION = eval $VERSION; -our $AUTHORITY = 'cpan:STEVAN'; +use Carp 'confess'; +use Devel::GlobalDestruction 'in_global_destruction'; 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::Meta::Method::Meta; +use Moose::Util qw( ensure_all_roles ); +use Class::MOP::MiniTrait; + +use base 'Class::MOP::Module', + 'Class::MOP::Mixin::HasAttributes', + 'Class::MOP::Mixin::HasMethods'; -use base 'Class::MOP::Module'; +Class::MOP::MiniTrait::apply(__PACKAGE__, 'Moose::Meta::Object::Trait'); ## ------------------------------------------------------------------ ## 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 @@ -37,11 +43,11 @@ my $META = __PACKAGE__->meta; # NOTE: # since roles are lazy, we hold all the attributes -# of the individual role in 'statis' until which +# of the individual role in 'stasis' 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. 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 +61,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,22 +69,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}; @@ -87,7 +82,8 @@ foreach my $action ( # create the attribute $META->add_attribute($action->{name} => ( reader => $attr_reader, - default => sub { {} } + default => sub { {} }, + Class::MOP::_definition_context(), )); # create some helper methods @@ -96,10 +92,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,29 +118,168 @@ 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', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'required_method_metaclass', + reader => 'required_method_metaclass', + default => 'Moose::Meta::Role::Method::Required', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'conflicting_method_metaclass', + reader => 'conflicting_method_metaclass', + default => 'Moose::Meta::Role::Method::Conflicting', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'application_to_class_class', + reader => 'application_to_class_class', + default => 'Moose::Meta::Role::Application::ToClass', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'application_to_role_class', + reader => 'application_to_role_class', + default => 'Moose::Meta::Role::Application::ToRole', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'application_to_instance_class', + reader => 'application_to_instance_class', + default => 'Moose::Meta::Role::Application::ToInstance', + Class::MOP::_definition_context(), +); + +$META->add_attribute( + 'applied_attribute_metaclass', + reader => 'applied_attribute_metaclass', + default => 'Moose::Meta::Attribute', + Class::MOP::_definition_context(), +); + +# More or less copied from Moose::Meta::Class +sub initialize { + my $class = shift; + my @args = @_; + unshift @args, 'package' if @args % 2; + my %opts = @args; + my $package = delete $opts{package}; + return Class::MOP::get_metaclass_by_name($package) + || $class->SUPER::initialize($package, + 'attribute_metaclass' => 'Moose::Meta::Role::Attribute', + %opts, + ); +} + +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 + applied_attribute_metaclass + ); + } + + my %options = @_; + $options{weaken} = Class::MOP::metaclass_is_weak($meta->name) + if !exists $options{weaken} + && blessed($meta) + && $meta->isa('Moose::Meta::Role'); + + # don't need to remove generated metaobjects here yet, since we don't + # yet generate anything in roles. this may change in the future though... + # keep an eye on that + my $new_meta = $self->SUPER::reinitialize( + $pkg, + %existing_classes, + %options, + ); + $new_meta->_restore_metaobjects_from($meta) + if $meta && $meta->isa('Moose::Meta::Role'); + return $new_meta; +} + +sub _restore_metaobjects_from { + my $self = shift; + my ($old_meta) = @_; + + $self->_restore_metamethods_from($old_meta); + $self->_restore_metaattributes_from($old_meta); + + for my $role ( @{ $old_meta->get_roles } ) { + $self->add_role($role); + } +} 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 = { @_ }; + elsif (!blessed($_[0]) && defined($_[0]) && $_[0] =~ /^\+(.*)/) { + Moose->throw_error( "has '+attr' is not supported in roles" ); } - $self->get_attribute_map->{$name} = $attr_desc; + + return $self->SUPER::add_attribute(@_); } -# 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 _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; + } +} + +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 @@ -155,18 +295,20 @@ 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 { {} } - )); + default => sub { {} }, + Class::MOP::_definition_context(), + )); # 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 { @@ -203,7 +345,8 @@ foreach my $modifier_type (qw[ before around after ]) { $META->add_attribute('override_method_modifiers' => ( reader => 'get_override_method_modifiers_map', - default => sub { {} } + default => sub { {} }, + Class::MOP::_definition_context(), )); # NOTE: @@ -215,8 +358,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; } @@ -241,26 +384,21 @@ 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); -} - - +sub _meta_method_class { 'Moose::Meta::Method::Meta' } ## ------------------------------------------------------------------ ## subroles -__PACKAGE__->meta->add_attribute('roles' => ( +$META->add_attribute('roles' => ( reader => 'get_roles', - default => sub { [] } + default => sub { [] }, + Class::MOP::_definition_context(), )); 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; } @@ -276,9 +414,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 @@ -288,226 +427,215 @@ sub does_role { return 0; } -## ------------------------------------------------------------------ -## methods +sub find_method_by_name { (shift)->get_method(@_) } -sub method_metaclass { 'Moose::Meta::Role::Method' } +## ------------------------------------------------------------------ +## role construction +## ------------------------------------------------------------------ -sub get_method_map { - my $self = shift; +sub apply { + my ($self, $other, %args) = @_; - my $current = Class::MOP::check_package_cache_flag($self->name); + (blessed($other)) + || Moose->throw_error("You must pass in an blessed instance"); - if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) { - return $self->{'methods'} ||= {}; + my $application_class; + if ($other->isa('Moose::Meta::Role')) { + $application_class = $self->application_to_role_class; + } + elsif ($other->isa('Moose::Meta::Class')) { + $application_class = $self->application_to_class_class; + } + else { + $application_class = $self->application_to_instance_class; } - $self->{_package_cache_flag} = $current; + load_class($application_class); - my $map = $self->{'methods'} ||= {}; + if ( exists $args{'-excludes'} ) { + # I wish we had coercion here :) + $args{'-excludes'} = ( + ref $args{'-excludes'} eq 'ARRAY' + ? $args{'-excludes'} + : [ $args{'-excludes'} ] + ); + } - my $role_name = $self->name; - my $method_metaclass = $self->method_metaclass; + return $application_class->new(%args)->apply($self, $other, \%args); +} - my %all_code = $self->get_all_package_symbols('CODE'); +sub composition_class_roles { } - foreach my $symbol (keys %all_code) { - my $code = $all_code{$symbol}; +sub combine { + my ($class, @role_specs) = @_; - next if exists $map->{$symbol} && - defined $map->{$symbol} && - $map->{$symbol}->body == $code; + require Moose::Meta::Role::Composite; - my ($pkg, $name) = Class::MOP::get_code_info($code); + my (@roles, %role_params); + while (@role_specs) { + my ($role, $params) = @{ splice @role_specs, 0, 1 }; + my $requested_role + = blessed $role + ? $role + : Class::MOP::class_of($role); - 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; - 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 - ); + my $actual_role = $requested_role->_role_for_combination($params); + push @roles => $actual_role; + + next unless defined $params; + $role_params{$actual_role->name} = $params; } - return $map; + my $c = Moose::Meta::Role::Composite->new(roles => \@roles); + return $c->apply_params(\%role_params); } -sub get_method { - my ($self, $name) = @_; - $self->get_method_map->{$name}; +sub _role_for_combination { + my ($self, $params) = @_; + return $self; } -sub has_method { - my ($self, $name) = @_; - exists $self->get_method_map->{$name} ? 1 : 0 -} +sub create { + my $class = shift; + my @args = @_; -# FIXME this is copypasated from Class::MOP::Class -# refactor to inherit from some common base -sub wrap_method_body { - my ( $self, %args ) = @_; + unshift @args, 'package' if @args % 2 == 1; + my %options = @args; - my $body = delete $args{body}; # delete is for compat + (ref $options{attributes} eq 'HASH') + || confess "You must pass a HASH ref of attributes" + if exists $options{attributes}; - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; + (ref $options{methods} eq 'HASH') + || confess "You must pass a HASH ref of methods" + if exists $options{methods}; - $self->method_metaclass->wrap( $body => ( - package_name => $self->name, - %args, - )); -} + (ref $options{roles} eq 'ARRAY') + || confess "You must pass an ARRAY ref of roles" + if exists $options{roles}; -sub add_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; - - my $body; - if (blessed($method)) { - $body = $method->body; - if ($method->package_name ne $self->name && - $method->name ne $method_name) { - warn "Hello there, got something for you." - . " Method says " . $method->package_name . " " . $method->name - . " Class says " . $self->name . " " . $method_name; - $method = $method->clone( - package_name => $self->name, - name => $method_name - ) if $method->can('clone'); + my $package = delete $options{package}; + my $roles = delete $options{roles}; + my $attributes = delete $options{attributes}; + my $methods = delete $options{methods}; + my $meta_name = exists $options{meta_name} + ? delete $options{meta_name} + : 'meta'; + + my $meta = $class->SUPER::create($package => %options); + + $meta->_add_meta_method($meta_name) + if defined $meta_name; + + if (defined $attributes) { + foreach my $attribute_name (keys %{$attributes}) { + my $attr = $attributes->{$attribute_name}; + $meta->add_attribute( + $attribute_name => blessed $attr ? $attr : %{$attr} ); } } - else { - $body = $method; - $method = $self->wrap_method_body( body => $body, name => $method_name ); - } - - $method->attach_to_class($self); - $self->get_method_map->{$method_name} = $method; + if (defined $methods) { + foreach my $method_name (keys %{$methods}) { + $meta->add_method($method_name, $methods->{$method_name}); + } + } - 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) - ); + if ($roles) { + Moose::Util::apply_all_roles($meta, @$roles); + } - $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 + return $meta; } -sub find_method_by_name { (shift)->get_method(@_) } - -sub get_method_list { +sub consumers { my $self = shift; - grep { !/^meta$/ } keys %{$self->get_method_map}; + my @consumers; + for my $meta (Class::MOP::get_all_metaclass_instances) { + next if $meta->name eq $self->name; + next unless $meta->isa('Moose::Meta::Class') + || $meta->isa('Moose::Meta::Role'); + push @consumers, $meta->name + if $meta->does_role($self->name); + } + return @consumers; } -sub alias_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; +# XXX: something more intelligent here? +sub _anon_package_prefix { 'Moose::Meta::Role::__ANON__::SERIAL::' } - my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; +sub create_anon_role { shift->create_anon(@_) } +sub is_anon_role { shift->is_anon(@_) } - $self->add_package_symbol( - { sigil => '&', type => 'CODE', name => $method_name }, - $body - ); -} +sub _anon_cache_key { + my $class = shift; + my %options = @_; -## ------------------------------------------------------------------ -## role construction -## ------------------------------------------------------------------ + # XXX fix this duplication (see MMC::_anon_cache_key + my $roles = Data::OptList::mkopt(($options{roles} || []), { + moniker => 'role', + val_test => sub { ref($_[0]) eq 'HASH' }, + }); -sub apply { - my ($self, $other, @args) = @_; + my @role_keys; + for my $role_spec (@$roles) { + my ($role, $params) = @$role_spec; + $params = { %$params }; + + my $key = blessed($role) ? $role->name : $role; + + if ($params && %$params) { + my $alias = delete $params->{'-alias'} + || delete $params->{'alias'} + || {}; + my $excludes = delete $params->{'-excludes'} + || delete $params->{'excludes'} + || []; + $excludes = [$excludes] unless ref($excludes) eq 'ARRAY'; + + if (%$params) { + warn "Roles with parameters cannot be cached. Consider " + . "applying the parameters before calling " + . "create_anon_class, or using 'weaken => 0' instead"; + return; + } + + my $alias_key = join('%', + map { $_ => $alias->{$_} } sort keys %$alias + ); + my $excludes_key = join('%', + sort @$excludes + ); + $key .= '<' . join('+', 'a', $alias_key, 'e', $excludes_key) . '>'; + } - (blessed($other)) - || confess "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); + push @role_keys, $key; } - 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); - } -} -sub combine { - my ($class, @role_specs) = @_; - - require Moose::Meta::Role::Application::RoleSummation; - require Moose::Meta::Role::Composite; - - my (@roles, %role_params); - while (@role_specs) { - my ($role, $params) = @{ splice @role_specs, 0, 1 }; - push @roles => $role->meta; - next unless defined $params; - $role_params{$role} = $params; - } - - my $c = Moose::Meta::Role::Composite->new(roles => \@roles); - Moose::Meta::Role::Application::RoleSummation->new( - role_params => \%role_params - )->apply($c); - - return $c; + # Makes something like Role|Role::1 + return join('|', sort @role_keys); } ##################################################################### ## 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 => { @@ -517,288 +645,351 @@ 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 .. # } # ); -# +# ##################################################################### 1; +# ABSTRACT: The Moose Role metaclass + __END__ =pod -=head1 NAME +=head1 DESCRIPTION -Moose::Meta::Role - The Moose Role metaclass +This class is a subclass of L that provides +additional Moose-specific functionality. -=head1 DESCRIPTION +Its API looks a lot like L, but internally it +implements many things differently. This may change in the future. + +=head1 INHERITANCE -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). +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. -=item B +The return value is a new L that +represents the combined roles. -=back +=item B<< $metarole->composition_class_roles >> -=over 4 +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 +=item B<< Moose::Meta::Role->create($name, %options) >> -=item B +This method is identical to the L C +method. -=item B +=item B<< Moose::Meta::Role->create_anon_role >> -=back +This method is identical to the L +C method. -=over 4 +=item B<< $metarole->is_anon_role >> -=item B +Returns true if the role is an anonymous role. -=item B +=item B<< $metarole->consumers >> -=item B +Returns a list of names of classes and roles which consume this role. =back -=over 4 +=head2 Role application -=item B +=over 4 -=item B +=item B<< $metarole->apply( $thing, @options ) >> -=item B +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 >> + +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) >> -=item B +Given a role I or L object, returns true if this role +does the given role. -=item B +=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<< $metarole->add_excluded_roles(@role_names) >> + +Given one or more role names, adds those roles to the list of excluded +roles. =back +=head2 Methods + +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 +=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) >> -=item B +Instantiate the parameters as a L +object, then add it to the required method list. + +=back + +=head2 Method modifiers + +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 +=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) >> -=back +=item B<< $metarole->get_before_method_modifiers($method_name) >> -=head1 BUGS +Given a method name, returns a list of the appropriate modifiers for +that method. -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. +=item B<< $metarole->get_override_method_modifier($method_name) >> -=head1 AUTHOR +Given a method name, returns the override method modifier for that +method, if it has one. -Stevan Little Estevan@iinteractive.comE +=back -=head1 COPYRIGHT AND LICENSE +=head2 Introspection -Copyright 2006-2008 by Infinity Interactive, Inc. +=over 4 -L +=item B<< Moose::Meta::Role->meta >> + +This will return a L instance for this class. + +=back + +=head1 BUGS -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L for details on reporting bugs. =cut