X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=9145fbff94524b42ef374c0109197d20f9cec33e;hb=d176529034afe200340fc7764a0021405f0152b8;hp=60a972789cefb904ea8d1cc8658630ec24c5a924;hpb=fb1e11d526a7d3608132ba484525980e9fafcc4f;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 60a9727..9145fbf 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -5,11 +5,11 @@ use strict; use warnings; use metaclass; -use Sub::Name 'subname'; +use Scalar::Util 'blessed'; use Carp 'confess'; -use Scalar::Util 'blessed', 'reftype'; -our $VERSION = '0.12'; +our $VERSION = '0.61'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use Moose::Meta::Class; @@ -68,7 +68,7 @@ foreach my $action ( get_list => 'get_required_method_list', existence => 'requires_method', } - }, + }, { name => 'attribute_map', attr_reader => 'get_attribute_map', @@ -122,6 +122,8 @@ foreach my $action ( sub add_attribute { my $self = shift; my $name = shift; + (defined $name && $name) + || Moose->throw_error("You must provide a name for the attribute"); my $attr_desc; if (scalar @_ == 1 && ref($_[0]) eq 'HASH') { $attr_desc = $_[0]; @@ -132,13 +134,14 @@ sub add_attribute { $self->get_attribute_map->{$name} = $attr_desc; } -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); - } -} +# 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); +# } +# } ## ------------------------------------------------------------------ ## method modifiers @@ -214,8 +217,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,6 +243,14 @@ 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 @@ -251,8 +262,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 { @@ -268,7 +280,7 @@ sub calculate_all_roles { sub does_role { my ($self, $role_name) = @_; (defined $role_name) - || confess "You must supply a role name to look for"; + || Moose->throw_error("You must supply a role name to look for"); # if we are it,.. then return true return 1 if $role_name eq $self->name; # otherwise.. check our children @@ -285,14 +297,28 @@ sub method_metaclass { 'Moose::Meta::Role::Method' } sub get_method_map { my $self = shift; - my $map = {}; + + 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; - foreach my $symbol ($self->list_all_package_symbols('CODE')) { + my %all_code = $self->get_all_package_symbols('CODE'); + + foreach my $symbol (keys %all_code) { + my $code = $all_code{$symbol}; - my $code = $self->get_package_symbol('&' . $symbol); + next if exists $map->{$symbol} && + defined $map->{$symbol} && + $map->{$symbol}->body == $code; my ($pkg, $name) = Class::MOP::get_code_info($code); @@ -304,17 +330,30 @@ sub get_method_map { # loudly (in the case of Curses.pm) so we # just be a little overly cautious here. # - SL - && eval { no warnings; blessed($pkg->meta) } + && 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 { - next if ($pkg || '') ne $role_name && - ($name || '') ne '__ANON__'; + # 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); + + $map->{$symbol} = $method_metaclass->wrap( + $code, + package_name => $role_name, + name => $name + ); } return $map; @@ -322,7 +361,7 @@ sub get_method_map { sub get_method { my ($self, $name) = @_; - $self->get_method_map->{$name} + $self->get_method_map->{$name}; } sub has_method { @@ -330,6 +369,53 @@ sub has_method { 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 }, + Class::MOP::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 { @@ -338,298 +424,170 @@ sub get_method_list { } sub alias_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; - - my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq (reftype($body) || '')) - || confess "Your code block must be a CODE reference"; + my $self = shift; - $self->add_package_symbol("&${method_name}" => $body); + $self->add_method(@_); } -sub reset_package_cache_flag { () } -sub update_package_cache_flag { () } - ## ------------------------------------------------------------------ ## role construction ## ------------------------------------------------------------------ -my $anon_counter = 0; - sub apply { - my ($self, $other) = @_; - - unless ($other->isa('Moose::Meta::Class') || $other->isa('Moose::Meta::Role')) { - - # Runtime Role mixins - - # FIXME: - # We really should do this better, and - # cache the results of our efforts so - # that we don't need to repeat them. - - my $pkg_name = __PACKAGE__ . "::__RUNTIME_ROLE_ANON_CLASS__::" . $anon_counter++; - eval "package " . $pkg_name . "; our \$VERSION = '0.00';"; - die $@ if $@; - - my $object = $other; - - $other = Moose::Meta::Class->initialize($pkg_name); - $other->superclasses(blessed($object)); - - bless $object => $pkg_name; + my ($self, $other, @args) = @_; + + (blessed($other)) + || Moose->throw_error("You must pass in an blessed instance"); + + if ($other->isa('Moose::Meta::Role')) { + require Moose::Meta::Role::Application::ToRole; + return Moose::Meta::Role::Application::ToRole->new(@args)->apply($self, $other); } - - $self->_check_excluded_roles($other); - $self->_check_required_methods($other); - - $self->_apply_attributes($other); - $self->_apply_methods($other); - - # NOTE: - # we need a clear cache flag too ... - $other->reset_package_cache_flag; - - $self->_apply_override_method_modifiers($other); - - $self->_apply_before_method_modifiers($other); - $self->_apply_around_method_modifiers($other); - $self->_apply_after_method_modifiers($other); - - $other->add_role($self); + 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, @roles) = @_; + 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; + next unless defined $params; + $role_params{$role} = $params; + } my $c = Moose::Meta::Role::Composite->new(roles => \@roles); - Moose::Meta::Role::Application::RoleSummation->new->apply($c); + Moose::Meta::Role::Application::RoleSummation->new( + role_params => \%role_params + )->apply($c); + return $c; } -## ------------------------------------------------------------------ +sub create { + my ( $role, $package_name, %options ) = @_; -## applying a role to a class ... + $options{package} = $package_name; -sub _check_excluded_roles { - my ($self, $other) = @_; - if ($other->excludes_role($self->name)) { - confess "Conflict detected: " . $other->name . " excludes role '" . $self->name . "'"; - } - foreach my $excluded_role_name ($self->get_excluded_roles_list) { - if ($other->does_role($excluded_role_name)) { - confess "The class " . $other->name . " does the excluded role '$excluded_role_name'"; - } - else { - if ($other->isa('Moose::Meta::Role')) { - $other->add_excluded_roles($excluded_role_name); - } - # else -> ignore it :) - } - } -} + (ref $options{attributes} eq 'HASH') + || confess "You must pass a HASH ref of attributes" + if exists $options{attributes}; -sub _check_required_methods { - 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->find_method_by_name($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 . "'"; - } - } - else { - # NOTE: - # we need to make sure that the method is - # not a method modifier, because those do - # not satisfy the requirements ... - my $method = $other->find_method_by_name($required_method_name); + (ref $options{methods} eq 'HASH') + || confess "You must pass a HASH ref of methods" + if exists $options{methods}; - # check if it is a generated accessor ... - (!$method->isa('Class::MOP::Method::Accessor')) - || confess "'" . $self->name . "' requires the method '$required_method_name' " . - "to be implemented by '" . $other->name . "', the method is only an attribute accessor"; + $role->SUPER::create(%options); - # NOTE: - # All other tests here have been removed, they were tests - # for overriden methods and before/after/around modifiers. - # But we realized that for classes any overriden or modified - # methods would be backed by a real method of that name - # (and therefore meet the requirement). And for roles, the - # overriden and modified methods are "in statis" and so would - # not show up in this test anyway (and as a side-effect they - # would not fufill the requirement, which is exactly what we - # want them to do anyway). - # - SL + my (%initialize_options) = %options; + delete @initialize_options{qw( + package + attributes + methods + version + authority + )}; + + my $meta = $role->initialize( $package_name => %initialize_options ); + + # 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 => $attr); } } -} -sub _apply_attributes { - my ($self, $other) = @_; - foreach my $attribute_name ($self->get_attribute_list) { - # it if it has one already - if ($other->has_attribute($attribute_name) && - # make sure we haven't seen this one already too - $other->get_attribute($attribute_name) != $self->get_attribute($attribute_name)) { - # see if we are being composed - # into a role or not - if ($other->isa('Moose::Meta::Role')) { - # all attribute conflicts between roles - # result in an immediate fatal error - confess "Role '" . $self->name . "' has encountered an attribute conflict " . - "during composition. This is fatal error and cannot be disambiguated."; - } - else { - # but if this is a class, we - # can safely skip adding the - # attribute to the class - next; - } - } - else { - # NOTE: - # this is kinda ugly ... - if ($other->isa('Moose::Meta::Class')) { - $other->_process_attribute( - $attribute_name, - %{$self->get_attribute($attribute_name)} - ); - } - else { - $other->add_attribute( - $attribute_name, - $self->get_attribute($attribute_name) - ); - } + 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; } -sub _apply_methods { - my ($self, $other) = @_; - foreach my $method_name ($self->get_method_list) { - # it if it has one already - if ($other->has_method($method_name) && - # and if they are not the same thing ... - $other->get_method($method_name)->body != $self->get_method($method_name)->body) { - # see if we are composing into a role - if ($other->isa('Moose::Meta::Role')) { - # method conflicts between roles result - # in the method becoming a requirement - $other->add_required_methods($method_name); - # NOTE: - # we have to remove the method from our - # role, if this is being called from combine() - # which means the meta is an anon class - # this *may* cause problems later, but it - # is probably fairly safe to assume that - # anon classes will only be used internally - # or by people who know what they are doing - $other->Moose::Meta::Class::remove_method($method_name) - if $other->name =~ /__COMPOSITE_ROLE_SANDBOX__/; - } - else { - next; - } - } - else { - # add it, although it could be overriden - $other->alias_method( - $method_name, - $self->get_method($method_name) - ); - } +# 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 _apply_override_method_modifiers { - my ($self, $other) = @_; - foreach my $method_name ($self->get_method_modifier_list('override')) { - # it if it has one already then ... - if ($other->has_method($method_name)) { - # if it is being composed into another role - # we have a conflict here, because you cannot - # combine an overriden method with a locally - # defined one - if ($other->isa('Moose::Meta::Role')) { - confess "Role '" . $self->name . "' has encountered an 'override' method conflict " . - "during composition (A local method of the same name as been found). This " . - "is fatal error."; - } - else { - # if it is a class, then we - # just ignore this here ... - next; - } - } - else { - # if no local method is found, then we - # must check if we are a role or class - if ($other->isa('Moose::Meta::Role')) { - # if we are a role, we need to make sure - # we dont have a conflict with the role - # we are composing into - if ($other->has_override_method_modifier($method_name) && - $other->get_override_method_modifier($method_name) != $self->get_override_method_modifier($method_name)) { - confess "Role '" . $self->name . "' has encountered an 'override' method conflict " . - "during composition (Two 'override' methods of the same name encountered). " . - "This is fatal error."; - } - else { - # if there is no conflict, - # just add it to the role - $other->add_override_method_modifier( - $method_name, - $self->get_override_method_modifier($method_name) - ); - } - } - else { - # if this is not a role, then we need to - # find the original package of the method - # so that we can tell the class were to - # find the right super() method - my $method = $self->get_override_method_modifier($method_name); - my ($package) = Class::MOP::get_code_info($method); - # if it is a class, we just add it - $other->add_override_method_modifier($method_name, $method, $package); - } - } + sub create_anon_role { + my ($role, %options) = @_; + my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL; + return $role->create($package_name, %options); } -} -sub _apply_method_modifiers { - my ($self, $modifier_type, $other) = @_; - my $add = "add_${modifier_type}_method_modifier"; - my $get = "get_${modifier_type}_method_modifiers"; - foreach my $method_name ($self->get_method_modifier_list($modifier_type)) { - $other->$add( - $method_name, - $_ - ) foreach $self->$get($method_name); + # 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 Class::MOP::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 . '::'}; } } -sub _apply_before_method_modifiers { (shift)->_apply_method_modifiers('before' => @_) } -sub _apply_around_method_modifiers { (shift)->_apply_method_modifiers('around' => @_) } -sub _apply_after_method_modifiers { (shift)->_apply_method_modifiers('after' => @_) } - ##################################################################### ## NOTE: ## This is Moose::Meta::Role as defined by Moose (plus the use of @@ -778,6 +736,8 @@ probably not that much really). =item B +=item B + =item B =back @@ -826,6 +786,10 @@ probably not that much really). =item B +=item B + +=item B + =item B =item B @@ -918,6 +882,16 @@ probably not that much really). =back +=over 4 + +=item B + +=item B + +=item B + +=back + =head1 BUGS All complex software has bugs lurking in it, and this module is no @@ -930,7 +904,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006, 2007 by Infinity Interactive, Inc. +Copyright 2006-2008 by Infinity Interactive, Inc. L