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=d0db84fb1af7aee7ad60674a4c4afbcf3bf4eeab;hpb=fa1be05839cee337e0b04b4d9426ccd8a3f9e709;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index d0db84f..caad021 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -5,91 +5,376 @@ 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.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', '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 +## big comment at the end of this file (right +## before the POD). +## - SL +## ------------------------------------------------------------------ + +my $META = __PACKAGE__->meta; + +## ------------------------------------------------------------------ +## attributes ... -our $VERSION = '0.02'; +# NOTE: +# since roles are lazy, we hold all the attributes +# of the individual role in 'statis' until which +# time when it is applied to a class. This means +# keeping a lot of things in hash maps, so we are +# using a little of that meta-programmin' magic +# here an saving lots of extra typin. 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 +# very compact solution to this normally verbose +# problem. +# - SL + +foreach my $action ( + { + name => 'excluded_roles_map', + attr_reader => 'get_excluded_roles_map' , + methods => { + add => 'add_excluded_roles', + get_keys => 'get_excluded_roles_list', + existence => 'excludes_role', + } + }, + { + name => 'required_methods', + attr_reader => 'get_required_methods_map', + methods => { + remove => 'remove_required_methods', + get_values => 'get_required_method_list', + existence => 'requires_method', + } + }, +) { + + my $attr_reader = $action->{attr_reader}; + my $methods = $action->{methods}; + + # create the attribute + $META->add_attribute($action->{name} => ( + reader => $attr_reader, + default => sub { {} } + )); + + # create some helper methods + $META->add_method($methods->{add} => sub { + my ($self, @values) = @_; + $self->$attr_reader->{$_} = undef foreach @values; + }) if exists $methods->{add}; + + $META->add_method($methods->{get_keys} => sub { + my ($self) = @_; + keys %{$self->$attr_reader}; + }) 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) = @_; + $self->$attr_reader->{$name} + }) if exists $methods->{get}; + + $META->add_method($methods->{existence} => sub { + my ($self, $name) = @_; + exists $self->$attr_reader->{$name} ? 1 : 0; + }) if exists $methods->{existence}; + + $META->add_method($methods->{remove} => sub { + my ($self, @values) = @_; + delete $self->$attr_reader->{$_} foreach @values; + }) if exists $methods->{remove}; +} -## Attributes +$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', + @_ + ); +} -## the meta for the role package +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 + ); + } -__PACKAGE__->meta->add_attribute('_role_meta' => ( - reader => '_role_meta', - init_arg => ':role_meta' -)); + return $self->SUPER::reinitialize( + $pkg, + %existing_classes, + @_, + ); +} -## roles +sub add_attribute { + my $self = shift; -__PACKAGE__->meta->add_attribute('roles' => ( - reader => 'get_roles', - default => sub { [] } -)); + 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" ); + } -## attributes + return $self->SUPER::add_attribute(@_); +} -__PACKAGE__->meta->add_attribute('attribute_map' => ( - reader => 'get_attribute_map', - default => sub { {} } -)); +sub _attach_attribute { + my ( $self, $attribute ) = @_; -## required methods + $attribute->attach_to_role($self); +} -__PACKAGE__->meta->add_attribute('required_methods' => ( - reader => 'get_required_methods_map', - default => sub { {} } -)); +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 -__PACKAGE__->meta->add_attribute('before_method_modifiers' => ( - reader => 'get_before_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); +# NOTE: +# the before/around/after method modifiers are +# stored by name, but there can be many methods +# then associated with that name. So again we have +# lots of similar functionality, so we can do some +# meta-programmin' and save some time. +# - SL + +foreach my $modifier_type (qw[ before around after ]) { + + my $attr_reader = "get_${modifier_type}_method_modifiers_map"; + + # 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}; + my $mm = $self->$attr_reader->{$method_name}; + $mm ? @$mm : (); + }); + + $META->add_method("has_${modifier_type}_method_modifiers" => sub { + my ($self, $method_name) = @_; + # NOTE: + # for now we assume that if it exists,.. + # it has at least one modifier in it + (exists $self->$attr_reader->{$method_name}) ? 1 : 0; + }); -__PACKAGE__->meta->add_attribute('after_method_modifiers' => ( - reader => 'get_after_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); + $META->add_method("add_${modifier_type}_method_modifier" => sub { + my ($self, $method_name, $method) = @_; -__PACKAGE__->meta->add_attribute('around_method_modifiers' => ( - reader => 'get_around_method_modifiers_map', - default => sub { {} } # ( => [ (CODE) ]) -)); + $self->$attr_reader->{$method_name} = [] + unless exists $self->$attr_reader->{$method_name}; + + my $modifiers = $self->$attr_reader->{$method_name}; + + # NOTE: + # check to see that we aren't adding the + # same code twice. We err in favor of the + # first on here, this may not be as expected + foreach my $modifier (@{$modifiers}) { + return if $modifier == $method; + } + + push @{$modifiers} => $method; + }); + +} + +## ------------------------------------------------------------------ +## override method mofidiers -__PACKAGE__->meta->add_attribute('override_method_modifiers' => ( +$META->add_attribute('override_method_modifiers' => ( reader => 'get_override_method_modifiers_map', - default => sub { {} } # ( => CODE) + default => sub { {} } )); -## Methods +# NOTE: +# these are a little different because there +# can only be one per name, whereas the other +# method modifiers can have multiples. +# - SL -sub new { - my $class = shift; - my %options = @_; - $options{':role_meta'} = Moose::Meta::Class->initialize( - $options{role_name}, - ':method_metaclass' => 'Moose::Meta::Role::Method' - ); - my $self = $class->meta->new_object(%options); - return $self; +sub add_override_method_modifier { + my ($self, $method_name, $method) = @_; + (!$self->has_method($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; +} + +sub has_override_method_modifier { + my ($self, $method_name) = @_; + # NOTE: + # for now we assume that if it exists,.. + # it has at least one modifier in it + (exists $self->get_override_method_modifiers_map->{$method_name}) ? 1 : 0; +} + +sub get_override_method_modifier { + my ($self, $method_name) = @_; + $self->get_override_method_modifiers_map->{$method_name}; +} + +## general list accessor ... + +sub get_method_modifier_list { + my ($self, $modifier_type) = @_; + my $accessor = "get_${modifier_type}_method_modifiers_map"; + 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 +$META->add_attribute('roles' => ( + reader => 'get_roles', + default => sub { [] } +)); + 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 { + my $self = shift; + my %seen; + grep { + !$seen{$_->name}++ + } ($self, map { + $_->calculate_all_roles + } @{ $self->get_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 @@ -99,223 +384,292 @@ sub does_role { return 0; } -## required methods +sub find_method_by_name { (shift)->get_method(@_) } -sub add_required_methods { - my ($self, @methods) = @_; - $self->get_required_methods_map->{$_} = undef foreach @methods; -} +sub alias_method { + Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); -sub get_required_method_list { - my ($self) = @_; - keys %{$self->get_required_methods_map}; -} + my $self = shift; -sub requires_method { - my ($self, $method_name) = @_; - exists $self->get_required_methods_map->{$method_name} ? 1 : 0; + $self->add_method(@_); } -## methods +## ------------------------------------------------------------------ +## role construction +## ------------------------------------------------------------------ -# NOTE: -# we delegate to some role_meta methods for convience here -# the Moose::Meta::Role is meant to be a read-only interface -# to the underlying role package, if you want to manipulate -# that, just use ->role_meta - -sub name { (shift)->_role_meta->name } -sub version { (shift)->_role_meta->version } - -sub get_method { (shift)->_role_meta->get_method(@_) } -sub has_method { (shift)->_role_meta->has_method(@_) } -sub alias_method { (shift)->_role_meta->alias_method(@_) } -sub get_method_list { - my ($self) = @_; - grep { - # NOTE: - # this is a kludge for now,... these functions - # should not be showing up in the list at all, - # but they do, so we need to switch Moose::Role - # and Moose to use Sub::Exporter to prevent this - !/^(meta|has|extends|blessed|confess|augment|inner|override|super|before|after|around|with|requires)$/ - } $self->_role_meta->get_method_list; -} +sub apply { + my ($self, $other, @args) = @_; -# ... however the items in statis (attributes & method modifiers) -# can be removed and added to through this API + (blessed($other)) + || Moose->throw_error("You must pass in an blessed instance"); -# attributes + 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; + } -sub add_attribute { - my ($self, $name, %attr_desc) = @_; - $self->get_attribute_map->{$name} = \%attr_desc; + Class::MOP::load_class($application_class); + return $application_class->new(@args)->apply($self, $other); } -sub has_attribute { - my ($self, $name) = @_; - exists $self->get_attribute_map->{$name} ? 1 : 0; -} +sub composition_class_roles { } -sub get_attribute { - my ($self, $name) = @_; - $self->get_attribute_map->{$name} -} +sub combine { + my ($class, @role_specs) = @_; -sub remove_attribute { - my ($self, $name) = @_; - delete $self->get_attribute_map->{$name} -} + require Moose::Meta::Role::Composite; -sub get_attribute_list { - my ($self) = @_; - keys %{$self->get_attribute_map}; -} + 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); -# method modifiers + my $actual_role = $requested_role->_role_for_combination($params); + push @roles => $actual_role; -# mimic the metaclass API -sub add_before_method_modifier { (shift)->_add_method_modifier('before', @_) } -sub add_around_method_modifier { (shift)->_add_method_modifier('around', @_) } -sub add_after_method_modifier { (shift)->_add_method_modifier('after', @_) } + next unless defined $params; + $role_params{$actual_role->name} = $params; + } -sub _add_method_modifier { - my ($self, $modifier_type, $method_name, $method) = @_; - my $accessor = "get_${modifier_type}_method_modifiers_map"; - $self->$accessor->{$method_name} = [] - unless exists $self->$accessor->{$method_name}; - push @{$self->$accessor->{$method_name}} => $method; + my $c = Moose::Meta::Role::Composite->new(roles => \@roles); + return $c->apply_params(\%role_params); } -sub add_override_method_modifier { - my ($self, $method_name, $method) = @_; - $self->get_override_method_modifiers_map->{$method_name} = $method; +sub _role_for_combination { + my ($self, $params) = @_; + return $self; } -sub has_before_method_modifiers { (shift)->_has_method_modifiers('before', @_) } -sub has_around_method_modifiers { (shift)->_has_method_modifiers('around', @_) } -sub has_after_method_modifiers { (shift)->_has_method_modifiers('after', @_) } +sub create { + my ( $role, $package_name, %options ) = @_; -# override just checks for one,.. -# but we can still re-use stuff -sub has_override_method_modifier { (shift)->_has_method_modifiers('override', @_) } + $options{package} = $package_name; -sub _has_method_modifiers { - my ($self, $modifier_type, $method_name) = @_; - my $accessor = "get_${modifier_type}_method_modifiers_map"; - # NOTE: - # for now we assume that if it exists,.. - # it has at least one modifier in it - (exists $self->$accessor->{$method_name}) ? 1 : 0; -} + (ref $options{attributes} eq 'HASH') + || confess "You must pass a HASH ref of attributes" + if exists $options{attributes}; -sub get_before_method_modifiers { (shift)->_get_method_modifiers('before', @_) } -sub get_around_method_modifiers { (shift)->_get_method_modifiers('around', @_) } -sub get_after_method_modifiers { (shift)->_get_method_modifiers('after', @_) } + (ref $options{methods} eq 'HASH') + || confess "You must pass a HASH ref of methods" + if exists $options{methods}; -sub _get_method_modifiers { - my ($self, $modifier_type, $method_name) = @_; - my $accessor = "get_${modifier_type}_method_modifiers_map"; - @{$self->$accessor->{$method_name}}; -} + my (%initialize_options) = %options; + delete @initialize_options{qw( + package + attributes + methods + version + authority + )}; -sub get_override_method_modifier { - my ($self, $method_name) = @_; - $self->get_override_method_modifiers_map->{$method_name}; -} + my $meta = $role->initialize( $package_name => %initialize_options ); -sub get_method_modifier_list { - my ($self, $modifier_type) = @_; - my $accessor = "get_${modifier_type}_method_modifiers_map"; - keys %{$self->$accessor}; -} + $meta->_instantiate_module( $options{version}, $options{authority} ); -## applying a role to a class ... + # FIXME totally lame + $meta->add_method('meta' => sub { + $role->initialize(ref($_[0]) || $_[0]); + }); -sub apply { - my ($self, $other) = @_; - - # NOTE: - # we might need to move this down below the - # the attributes so that we can require any - # attribute accessors. However I am thinking - # that maybe those are somehow exempt from - # the require methods stuff. - foreach my $required_method_name ($self->get_required_method_list) { - unless ($other->has_method($required_method_name)) { - if ($other->isa('Moose::Meta::Role')) { - $other->add_required_methods($required_method_name); - } - else { - confess "'" . $self->name . "' requires the method '$required_method_name' " . - "to be implemented by '" . $other->name . "'"; - } + 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} ); } - } - - foreach my $attribute_name ($self->get_attribute_list) { - # skip it if it has one already - next if $other->has_attribute($attribute_name); - # add it, although it could be overriden - $other->add_attribute( - $attribute_name, - %{$self->get_attribute($attribute_name)} - ); } - - foreach my $method_name ($self->get_method_list) { - # skip it if it has one already - next if $other->has_method($method_name); - # add it, although it could be overriden - $other->alias_method( - $method_name, - $self->get_method($method_name) - ); - } - - foreach my $method_name ($self->get_method_modifier_list('override')) { - # skip it if it has one already - next if $other->has_method($method_name); - # add it, although it could be overriden - $other->add_override_method_modifier( - $method_name, - $self->get_override_method_modifier($method_name), - $self->name - ); - } - - foreach my $method_name ($self->get_method_modifier_list('before')) { - $other->add_before_method_modifier( - $method_name, - $_ - ) foreach $self->get_before_method_modifiers($method_name); - } - - foreach my $method_name ($self->get_method_modifier_list('after')) { - $other->add_after_method_modifier( - $method_name, - $_ - ) foreach $self->get_after_method_modifiers($method_name); - } - - foreach my $method_name ($self->get_method_modifier_list('around')) { - $other->add_around_method_modifier( - $method_name, - $_ - ) foreach $self->get_around_method_modifiers($method_name); - } - - $other->add_role($self); + + 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; } -package Moose::Meta::Role::Method; +# 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; -use strict; -use warnings; + # 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 . '::'}; + } +} -our $VERSION = '0.01'; +##################################################################### +## NOTE: +## 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 => 'Array', +# reader => 'get_roles', +# isa => 'ArrayRef[Moose::Meta::Role]', +# default => sub { [] }, +# provides => { +# 'push' => 'add_role', +# } +# ); +# +# has 'excluded_roles_map' => ( +# metaclass => 'Hash', +# reader => 'get_excluded_roles_map', +# isa => 'HashRef[Str]', +# provides => { +# # Not exactly set, cause it sets multiple +# 'set' => 'add_excluded_roles', +# 'keys' => 'get_excluded_roles_list', +# 'exists' => 'excludes_role', +# } +# ); +# +# has 'required_methods' => ( +# metaclass => 'Hash', +# reader => 'get_required_methods_map', +# 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', +# } +# ); +# +# # 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 => '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 +# # ARRAY at the given key, and pushed onto +# # it. It also checks for duplicates as well +# # 'add' => 'add_before_method_modifier' +# } +# ); +# +# has 'after_method_modifiers' => ( +# 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 +# # ARRAY at the given key, and pushed onto +# # it. It also checks for duplicates as well +# # 'add' => 'add_after_method_modifier' +# } +# ); +# +# has 'around_method_modifiers' => ( +# 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 +# # ARRAY at the given key, and pushed onto +# # 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 => 'Hash', +# reader =>'get_override_method_modifiers_map', +# isa => 'HashRef[CodeRef]', +# provides => { +# 'keys' => 'get_override_method_modifier', +# 'exists' => 'has_override_method_modifier', +# 'add' => 'add_override_method_modifier', # checks for local method .. +# } +# ); +# +##################################################################### -use base 'Class::MOP::Method'; 1; @@ -329,136 +683,260 @@ Moose::Meta::Role - The Moose Role metaclass =head1 DESCRIPTION -Moose's Roles are being actively developed, please see L -for more information. +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 ], ... ) >> -=back +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. -=over 4 +The return value is a new L that +represents the combined roles. + +=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 +=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 >> + +This method is identical to the L +C method. + +=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 >> + +This returns an array reference of roles which this role does. This +list may include duplicates. + +=item B<< $metarole->calculate_all_roles >> + +This returns a I list of all roles that this role does, and +all the roles that its roles do. + +=item B<< $metarole->does_role($role) >> + +Given a role I or L object, returns true if this role +does the given role. + +=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<< $metarole->excludes_role($role_name) >> + +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 >> -=item B +Returns the method metaclass name for the role. This defaults to +L. -=item B +=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<< $metarole->find_method_by_name($name) >> + +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<< $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) >> + +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. -=item B +=back + +=head2 Method modifiers + +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 +=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<< $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 @@ -466,11 +944,11 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006-2010 by Infinity Interactive, Inc. L This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +it under the same terms as Perl itself. -=cut \ No newline at end of file +=cut