X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=5ec4f18824de9b19615d60d126db249fc99ecefc;hb=b7d4b35d8beb17c48cf3f08c386cf863d973a7db;hp=8e5ef6295e2f4e6aff1ea1ee98dcce4092251ba9;hpb=12d8c847e0189d0708f9fa3bedd7ec2ebe6e506b;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 8e5ef62..5ec4f18 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -1,25 +1,28 @@ - package Moose::Meta::Role; use strict; use warnings; use metaclass; +use Class::Load qw(load_class); use Scalar::Util 'blessed'; use Carp 'confess'; -use Sub::Name 'subname'; use Devel::GlobalDestruction 'in_global_destruction'; -our $VERSION = '0.89_02'; -$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::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: @@ -40,7 +43,7 @@ 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 @@ -71,16 +74,6 @@ foreach my $action ( existence => 'requires_method', } }, - { - name => 'attribute_map', - attr_reader => 'get_attribute_map', - methods => { - get => 'get_attribute', - get_keys => 'get_attribute_list', - existence => 'has_attribute', - remove => 'remove_attribute', - } - } ) { my $attr_reader = $action->{attr_reader}; @@ -89,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 @@ -128,61 +122,135 @@ $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( - 'composition_class_roles', - reader => 'composition_class_roles', - predicate => 'has_composition_class_roles', + 'applied_attribute_metaclass', + reader => 'applied_attribute_metaclass', + default => 'Moose::Meta::Attribute', + Class::MOP::_definition_context(), ); -## some things don't always fit, so they go here ... +# 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 + ); + } -sub add_attribute { + 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 $name = shift; - unless ( defined $name ) { - require Moose; - Moose->throw_error("You must provide a name for the attribute"); + 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); } - my $attr_desc; - if (scalar @_ == 1 && ref($_[0]) eq 'HASH') { - $attr_desc = $_[0]; +} + +sub add_attribute { + my $self = shift; + + 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(@_); +} + +sub _attach_attribute { + my ( $self, $attribute ) = @_; + + $attribute->attach_to_role($self); } sub add_required_methods { @@ -231,7 +299,8 @@ foreach my $modifier_type (qw[ before around after ]) { # 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 ... @@ -276,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: @@ -314,20 +384,15 @@ 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 $META->add_attribute('roles' => ( reader => 'get_roles', - default => sub { [] } + default => sub { [] }, + Class::MOP::_definition_context(), )); sub add_role { @@ -349,9 +414,10 @@ sub calculate_all_roles { } sub does_role { - my ($self, $role_name) = @_; - (defined $role_name) + 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 @@ -361,143 +427,14 @@ sub does_role { return 0; } -## ------------------------------------------------------------------ -## methods - -sub get_method_map { - my $self = shift; - - my $current = Class::MOP::check_package_cache_flag($self->name); - - if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) { - return $self->{'methods'} ||= {}; - } - - $self->{_package_cache_flag} = $current; - - my $map = $self->{'methods'} ||= {}; - - 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}; - - next if exists $map->{$symbol} && - defined $map->{$symbol} && - $map->{$symbol}->body == $code; - - my ($pkg, $name) = Class::MOP::get_code_info($code); - my $meta = Class::MOP::class_of($pkg); - - if ($meta && $meta->isa('Moose::Meta::Role')) { - my $role = $meta->name; - next unless $self->does_role($role); - } - else { - # NOTE: - # in 5.10 constant.pm the constants show up - # 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 -} - -# FIXME this is copy-pasted from Class::MOP::Class -# refactor to inherit from some common base -sub wrap_method_body { - my ( $self, %args ) = @_; - - ('CODE' eq ref $args{body}) - || Moose->throw_error("Your code block must be a CODE reference"); - - $self->method_metaclass->wrap( - package_name => $self->name, - %args, - ); -} - -sub add_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || Moose->throw_error("You must define a method name"); - - my $body; - if (blessed($method)) { - $body = $method->body; - if ($method->package_name ne $self->name) { - $method = $method->clone( - package_name => $self->name, - name => $method_name - ) if $method->can('clone'); - } - } - 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; - - my $full_method_name = ($self->name . '::' . $method_name); - $self->add_package_symbol( - { sigil => '&', type => 'CODE', name => $method_name }, - subname($full_method_name => $body) - ); - - $self->update_package_cache_flag; # still valid, since we just added the method to the map, and if it was invalid before that then get_method_map updated it -} - 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 { - Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); - - my $self = shift; - - $self->add_method(@_); -} - ## ------------------------------------------------------------------ ## role construction ## ------------------------------------------------------------------ sub apply { - my ($self, $other, @args) = @_; + my ($self, $other, %args) = @_; (blessed($other)) || Moose->throw_error("You must pass in an blessed instance"); @@ -513,10 +450,22 @@ sub apply { $application_class = $self->application_to_instance_class; } - Class::MOP::load_class($application_class); - return $application_class->new(@args)->apply($self, $other); + load_class($application_class); + + if ( exists $args{'-excludes'} ) { + # I wish we had coercion here :) + $args{'-excludes'} = ( + ref $args{'-excludes'} eq 'ARRAY' + ? $args{'-excludes'} + : [ $args{'-excludes'} ] + ); + } + + return $application_class->new(%args)->apply($self, $other, \%args); } +sub composition_class_roles { } + sub combine { my ($class, @role_specs) = @_; @@ -524,8 +473,11 @@ sub combine { my (@roles, %role_params); while (@role_specs) { - my ($role_name, $params) = @{ splice @role_specs, 0, 1 }; - my $requested_role = Class::MOP::class_of($role_name); + my ($role, $params) = @{ splice @role_specs, 0, 1 }; + my $requested_role + = blessed $role + ? $role + : Class::MOP::class_of($role); my $actual_role = $requested_role->_role_for_combination($params); push @roles => $actual_role; @@ -544,9 +496,11 @@ sub _role_for_combination { } sub create { - my ( $role, $package_name, %options ) = @_; + my $class = shift; + my @args = @_; - $options{package} = $package_name; + unshift @args, 'package' if @args % 2 == 1; + my %options = @args; (ref $options{attributes} eq 'HASH') || confess "You must pass a HASH ref of attributes" @@ -556,104 +510,110 @@ sub create { || 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 - )}; + (ref $options{roles} eq 'ARRAY') + || confess "You must pass an ARRAY ref of roles" + if exists $options{roles}; - my $meta = $role->initialize( $package_name => %initialize_options ); + 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'; - $meta->_instantiate_module( $options{version}, $options{authority} ); + my $meta = $class->SUPER::create($package => %options); - # FIXME totally lame - $meta->add_method('meta' => sub { - $role->initialize(ref($_[0]) || $_[0]); - }); + $meta->_add_meta_method($meta_name) + if defined $meta_name; - if (exists $options{attributes}) { - foreach my $attribute_name (keys %{$options{attributes}}) { - my $attr = $options{attributes}->{$attribute_name}; - $meta->add_attribute($attribute_name => $attr); + if (defined $attributes) { + foreach my $attribute_name (keys %{$attributes}) { + my $attr = $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}); + if (defined $methods) { + foreach my $method_name (keys %{$methods}) { + $meta->add_method($method_name, $methods->{$method_name}); } } - Class::MOP::weaken_metaclass($meta->name) - if $meta->is_anon_role; + if ($roles) { + Moose::Util::apply_all_roles($meta, @$roles); + } 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 consumers { + my $self = shift; + 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 create_anon_role { - my ($role, %options) = @_; - my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL; - return $role->create($package_name, %options); - } +# XXX: something more intelligent here? +sub _anon_package_prefix { 'Moose::Meta::Role::__ANON__::SERIAL::' } - # 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}; +sub create_anon_role { shift->create_anon(@_) } +sub is_anon_role { shift->is_anon(@_) } + +sub _anon_cache_key { + my $class = shift; + my %options = @_; + + # 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' }, + }); + + 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) . '>'; } - delete ${'main::' . $ANON_ROLE_PREFIX}{$serial_id . '::'}; + + push @role_keys, $key; } + + # Makes something like Role|Role::1 + return join('|', sort @role_keys); } ##################################################################### @@ -686,20 +646,6 @@ sub create { # } # ); # -# has 'attribute_map' => ( -# metaclass => '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 => 'Hash', # reader => 'get_required_methods_map', @@ -779,20 +725,18 @@ sub create { 1; +# ABSTRACT: The Moose Role metaclass + __END__ =pod -=head1 NAME - -Moose::Meta::Role - The Moose Role metaclass - =head1 DESCRIPTION This class is a subclass of L that provides additional Moose-specific functionality. -It's API looks a lot like L, but internally it +Its API looks a lot like L, but internally it implements many things differently. This may change in the future. =head1 INHERITANCE @@ -812,13 +756,21 @@ This method creates a new role object with the provided name. =item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >> This method accepts a list of array references. Each array reference -should contain a role name as its first element. The second element is +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. 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<< Moose::Meta::Role->create($name, %options) >> This method is identical to the L C @@ -833,6 +785,10 @@ C method. Returns true if the role is an anonymous role. +=item B<< $metarole->consumers >> + +Returns a list of names of classes and roles which consume this role. + =back =head2 Role application @@ -868,10 +824,10 @@ list may include duplicates. 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_name) >> +=item B<< $metarole->does_role($role) >> -Given a role I, returns true if this role does the given -role. +Given a role I or L object, returns true if this role +does the given role. =item B<< $metarole->add_role($role) >> @@ -914,12 +870,10 @@ L. =item B<< $metarole->get_method_list >> -=item B<< $metarole->get_method_map >> - =item B<< $metarole->find_method_by_name($name) >> These methods are all identical to the methods of the same name in -L +L =back @@ -942,8 +896,6 @@ This is quite likely to change in the future. =item B<< $metarole->has_attribute($attribute_name) >> -=item B<< $metarole->get_attribute_map >> - =item B<< $metarole->get_attribute_list >> =item B<< $metarole->add_attribute($name, %options) >> @@ -952,6 +904,31 @@ This is quite likely to change in the future. =back +=head2 Overload introspection and creation + +The methods for dealing with a role's overloads are all identical in API +and behavior to the same methods in L. Note that these are +not particularly useful (yet), because overloads do not participate in role +composition. + +=over 4 + +=item B<< $metarole->is_overloaded >> + +=item B<< $metarole->get_overloaded_operator($op) >> + +=item B<< $metarole->has_overloaded_operator($op) >> + +=item B<< $metarole->get_overload_list >> + +=item B<< $metarole->get_all_overloaded_operators >> + +=item B<< $metarole->add_overloaded_operator($op, $impl) >> + +=item B<< $metarole->remove_overloaded_operator($op) >> + +=back + =head2 Required methods =over 4 @@ -981,7 +958,7 @@ object, then add it to the required method list. =head2 Method modifiers -These methods act like their counterparts in L and +These methods act like their counterparts in L and L. However, method modifiers are simply stored internally, and are not @@ -1038,21 +1015,6 @@ This will return a L instance for this class. =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. - -=head1 AUTHOR - -Stevan Little Estevan@iinteractive.comE - -=head1 COPYRIGHT AND LICENSE - -Copyright 2006-2009 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. +See L for details on reporting bugs. =cut