X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=9c00815950106a9a9c98b492610aa551db8d219c;hb=f6bee6fe1d579dc3d2ed2952cce9a1556040c8e5;hp=4ff959d4aaf198659f4786ebd246c6125f779cc8;hpb=3d24a30e079d69e9f605c0c98c8041dcb3119a62;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index 4ff959d..9c00815 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -5,10 +5,10 @@ use strict; use warnings; use metaclass; -use Carp 'confess'; use Scalar::Util 'blessed'; +use Carp 'confess'; -our $VERSION = '0.56'; +our $VERSION = '0.75_01'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -117,11 +117,21 @@ foreach my $action ( }) if exists $methods->{remove}; } +$META->add_attribute( + 'method_metaclass', + reader => 'method_metaclass', + default => 'Moose::Meta::Role::Method', +); + ## some things don't always fit, so they go here ... sub add_attribute { my $self = shift; my $name = shift; + unless ( defined $name && $name ) { + require Moose; + 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,15 +142,6 @@ sub add_attribute { $self->get_attribute_map->{$name} = $attr_desc; } -# DEPRECATED -# sub _clean_up_required_methods { -# my $self = shift; -# foreach my $method ($self->get_required_method_list) { -# $self->remove_required_methods($method) -# if $self->has_method($method); -# } -# } - ## ------------------------------------------------------------------ ## method modifiers @@ -215,8 +216,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; } @@ -252,7 +253,7 @@ sub update_package_cache_flag { ## ------------------------------------------------------------------ ## subroles -__PACKAGE__->meta->add_attribute('roles' => ( +$META->add_attribute('roles' => ( reader => 'get_roles', default => sub { [] } )); @@ -260,7 +261,7 @@ __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; } @@ -278,7 +279,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 @@ -291,8 +292,6 @@ sub does_role { ## ------------------------------------------------------------------ ## methods -sub method_metaclass { 'Moose::Meta::Role::Method' } - sub get_method_map { my $self = shift; @@ -309,28 +308,20 @@ sub get_method_map { my $role_name = $self->name; my $method_metaclass = $self->method_metaclass; - my %all_code = $self->get_all_package_symbols('CODE'); + my $all_code = $self->get_all_package_symbols('CODE'); - foreach my $symbol (keys %all_code) { - my $code = $all_code{$symbol}; + 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 ($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; + if ($meta && $meta->isa('Moose::Meta::Role')) { + my $role = $meta->name; next unless $self->does_role($role); } else { @@ -367,38 +358,32 @@ sub has_method { exists $self->get_method_map->{$name} ? 1 : 0 } -# FIXME this is copypasated from Class::MOP::Class +# FIXME this is copy-pasted from Class::MOP::Class # refactor to inherit from some common base sub wrap_method_body { my ( $self, %args ) = @_; - my $body = delete $args{body}; # delete is for compat + ('CODE' eq ref $args{body}) + || Moose->throw_error("Your code block must be a CODE reference"); - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; - - $self->method_metaclass->wrap( $body => ( + $self->method_metaclass->wrap( package_name => $self->name, %args, - )); + ); } sub add_method { my ($self, $method_name, $method) = @_; (defined $method_name && $method_name) - || confess "You must define a 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->name ne $method_name) { - warn "Hello there, got something for you." - . " Method says " . $method->package_name . " " . $method->name - . " Class says " . $self->name . " " . $method_name; + if ($method->package_name ne $self->name) { $method = $method->clone( package_name => $self->name, - name => $method_name + name => $method_name ) if $method->can('clone'); } } @@ -428,18 +413,11 @@ sub get_method_list { } sub alias_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; + Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); - my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; + my $self = shift; - $self->add_package_symbol( - { sigil => '&', type => 'CODE', name => $method_name }, - $body - ); + $self->add_method(@_); } ## ------------------------------------------------------------------ @@ -450,7 +428,7 @@ sub apply { my ($self, $other, @args) = @_; (blessed($other)) - || confess "You must pass in an blessed instance"; + || Moose->throw_error("You must pass in an blessed instance"); if ($other->isa('Moose::Meta::Role')) { require Moose::Meta::Role::Application::ToRole; @@ -475,7 +453,7 @@ sub combine { my (@roles, %role_params); while (@role_specs) { my ($role, $params) = @{ splice @role_specs, 0, 1 }; - push @roles => $role->meta; + push @roles => Class::MOP::class_of($role); next unless defined $params; $role_params{$role} = $params; } @@ -488,6 +466,119 @@ sub combine { return $c; } +sub create { + my ( $role, $package_name, %options ) = @_; + + $options{package} = $package_name; + + (ref $options{attributes} eq 'HASH') + || confess "You must pass a HASH ref of attributes" + if exists $options{attributes}; + + (ref $options{methods} eq 'HASH') + || confess "You must pass a HASH ref of methods" + if exists $options{methods}; + + my (%initialize_options) = %options; + delete @initialize_options{qw( + package + attributes + methods + version + authority + )}; + + my $meta = $role->initialize( $package_name => %initialize_options ); + + $meta->_instantiate_module( $options{version}, $options{authority} ); + + # FIXME totally lame + $meta->add_method('meta' => sub { + $role->initialize(ref($_[0]) || $_[0]); + }); + + if (exists $options{attributes}) { + foreach my $attribute_name (keys %{$options{attributes}}) { + my $attr = $options{attributes}->{$attribute_name}; + $meta->add_attribute($attribute_name => $attr); + } + } + + if (exists $options{methods}) { + foreach my $method_name (keys %{$options{methods}}) { + $meta->add_method($method_name, $options{methods}->{$method_name}); + } + } + + Class::MOP::weaken_metaclass($meta->name) + if $meta->is_anon_role; + + return $meta; +} + +# anonymous roles. most of it is copied straight out of Class::MOP::Class. +# an intrepid hacker might find great riches if he unifies this code with that +# code in Class::MOP::Module or Class::MOP::Package +{ + # NOTE: + # this should be sufficient, if you have a + # use case where it is not, write a test and + # I will change it. + my $ANON_ROLE_SERIAL = 0; + + # NOTE: + # we need a sufficiently annoying prefix + # this should suffice for now, this is + # used in a couple of places below, so + # need to put it up here for now. + my $ANON_ROLE_PREFIX = 'Moose::Meta::Role::__ANON__::SERIAL::'; + + sub is_anon_role { + my $self = shift; + no warnings 'uninitialized'; + $self->name =~ /^$ANON_ROLE_PREFIX/; + } + + sub create_anon_role { + my ($role, %options) = @_; + my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL; + return $role->create($package_name, %options); + } + + # NOTE: + # this will only get called for + # anon-roles, all other calls + # are assumed to occur during + # global destruction and so don't + # really need to be handled explicitly + sub DESTROY { + my $self = shift; + + return if 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 . '::'}; + } +} + ##################################################################### ## NOTE: ## This is Moose::Meta::Role as defined by Moose (plus the use of @@ -621,164 +712,245 @@ Moose::Meta::Role - The Moose Role metaclass =head1 DESCRIPTION -Please see L for more information about roles. -For the most part, this has no user-serviceable parts inside -this module. It's API is still subject to some change (although -probably not that much really). +This class is a subclass of L that provides +additional Moose-specific functionality. + +It's API looks a lot like L, but internally it +implements many things differently. This may change in the future. + +=head1 INHERITANCE + +C is a subclass of L. =head1 METHODS +=head2 Construction + =over 4 -=item B +=item B<< Moose::Meta::Role->initialize($role_name) >> -=item B +This method creates a new role object with the provided name. -=item B +=item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >> -=item B +This method accepts a list of array references. Each array reference +should contain a role name as its first element. The second element is +an optional hash reference. The hash reference can contain C +and C 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<< Moose::Meta::Role->create($name, %options) >> -=over 4 +This method is identical to the L C +method. + +=item B<< Moose::Meta::Role->create_anon_role >> -=item B +This method is identical to the L +C method. -=item B +=item B<< $metarole->is_anon_role >> -=item B +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_name) >> + +Given a role I, returns true if this role does the given +role. + +=item B<< $metarole->add_role($role) >> + +Given a L object, this adds the role to the list of +roles that the role does. + +=item B<< $metarole->get_excluded_roles_list >> -=item B +Returns a list of role names which this role excludes. -=item B +=item B<< $metarole->excludes_role($role_name) >> -=item B +Given a role I, returns true if this role excludes the named +role. -=item B +=item B<< $metarole->add_excluded_roles(@role_names) >> + +Given one or more role names, adds those roles to the list of excluded +roles. =back -=over 4 +=head2 Methods -=item B +The methods for dealing with a role's methods are all identical in API +and behavior to the same methods in L. -=item B +=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 +=item B<< $metarole->get_method_map >> -=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_map >> -=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. -=item B +=item B<< $metarole->add_required_methods(@names >> -=back +Adds the named methods to the roles list of required methods. -=over 4 +=item B<< $metarole->remove_required_methods(@names) >> + +Removes the named methods to the roles list of required methods. -=item B +=back -=item B +=head2 Method modifiers -=item B +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 +=item B<< $metarole->get_after_method_modifiers($method_name) >> -=over 4 +=item B<< $metarole->get_around_method_modifiers($method_name) >> -=back +=item B<< $metarole->get_before_method_modifiers($method_name) >> -=item B +Given a method name, returns a list of the appropriate modifiers for +that method. -=item B +=item B<< $metarole->get_override_method_modifier($method_name) >> -=item B +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 @@ -794,7 +966,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L