X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FRole.pm;h=2039b122a08b80dd313c0080cba80403c83794b2;hb=8bb7da15189945c1ea1f33a7e2c966cb002e526f;hp=c604a3051ec937311b8061a2d19f63c1e5ae5b54;hpb=79592a54119aa4dffe1e429c00e3b1ed91550265;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Role.pm b/lib/Moose/Meta/Role.pm index c604a30..2039b12 100644 --- a/lib/Moose/Meta/Role.pm +++ b/lib/Moose/Meta/Role.pm @@ -5,182 +5,513 @@ use strict; use warnings; use metaclass; -use Carp 'confess'; +use Sub::Name 'subname'; +use Carp 'confess'; +use Scalar::Util 'blessed', 'reftype'; -our $VERSION = '0.01'; +our $VERSION = '0.12'; +our $AUTHORITY = 'cpan:STEVAN'; -__PACKAGE__->meta->add_attribute('role_meta' => ( - reader => 'role_meta' -)); +use Moose::Meta::Class; +use Moose::Meta::Role::Method; +use Moose::Meta::Role::Method::Required; -__PACKAGE__->meta->add_attribute('attribute_map' => ( - reader => 'get_attribute_map', - default => sub { {} } -)); +use base 'Class::MOP::Module'; -__PACKAGE__->meta->add_attribute('method_modifier_map' => ( - reader => 'get_method_modifier_map', - default => sub { - return { - before => {}, - after => {}, - around => {}, - override => {} - }; - } -)); +## ------------------------------------------------------------------ +## 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 +## ------------------------------------------------------------------ -sub new { - my $class = shift; - my %options = @_; - $options{role_meta} = Class::MOP::Class->initialize( - $options{role_name}, - ':method_metaclass' => 'Moose::Meta::Role::Method' - ); - my $self = $class->meta->new_object(%options); - return $self; +my $META = __PACKAGE__->meta; + +## ------------------------------------------------------------------ +## attributes ... + +# 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_list => 'get_excluded_roles_list', + existence => 'excludes_role', + } + }, + { + name => 'required_methods', + attr_reader => 'get_required_methods_map', + methods => { + add => 'add_required_methods', + remove => 'remove_required_methods', + get_list => 'get_required_method_list', + existence => 'requires_method', + } + }, + { + name => 'attribute_map', + attr_reader => 'get_attribute_map', + methods => { + get => 'get_attribute', + get_list => 'get_attribute_list', + existence => 'has_attribute', + remove => 'remove_attribute', + } + } +) { + + 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_list} => sub { + my ($self) = @_; + keys %{$self->$attr_reader}; + }) if exists $methods->{get_list}; + + $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}; } -sub apply { - my ($self, $other) = @_; - - 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)} - ); +## some things don't always fit, so they go here ... + +sub add_attribute { + my $self = shift; + my $name = shift; + my $attr_desc; + if (scalar @_ == 1 && ref($_[0]) eq 'HASH') { + $attr_desc = $_[0]; } - - 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_method_modifier('override' => $method_name), - $self->name - ); - } - - foreach my $method_name ($self->get_method_modifier_list('before')) { - $other->add_before_method_modifier( - $method_name, - $self->get_method_modifier('before' => $method_name) - ); - } - - foreach my $method_name ($self->get_method_modifier_list('after')) { - $other->add_after_method_modifier( - $method_name, - $self->get_method_modifier('after' => $method_name) - ); - } - - foreach my $method_name ($self->get_method_modifier_list('around')) { - $other->add_around_method_modifier( - $method_name, - $self->get_method_modifier('around' => $method_name) - ); - } - + else { + $attr_desc = { @_ }; + } + $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 + # 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 get_method_list { - my ($self) = @_; - # meta is not applicable in this context, - # if you want to see it use the ->role_meta - grep { !/^meta$/ } $self->role_meta->get_method_list; +# 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}; + @{$self->$attr_reader->{$method_name}}; + }); + + $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; + }); + + $META->add_method("add_${modifier_type}_method_modifier" => sub { + my ($self, $method_name, $method) = @_; + + $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; + }); + } -# ... however the items in statis (attributes & method modifiers) -# can be removed and added to through this API +## ------------------------------------------------------------------ +## override method mofidiers -# attributes +$META->add_attribute('override_method_modifiers' => ( + reader => 'get_override_method_modifiers_map', + default => sub { {} } +)); -sub add_attribute { - my ($self, $name, %attr_desc) = @_; - $self->get_attribute_map->{$name} = \%attr_desc; +# NOTE: +# these are a little different because there +# can only be one per name, whereas the other +# method modifiers can have multiples. +# - SL + +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'"; + $self->get_override_method_modifiers_map->{$method_name} = $method; } -sub has_attribute { - my ($self, $name) = @_; - exists $self->get_attribute_map->{$name} ? 1 : 0; +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_attribute { - my ($self, $name) = @_; - $self->get_attribute_map->{$name} +sub get_override_method_modifier { + my ($self, $method_name) = @_; + $self->get_override_method_modifiers_map->{$method_name}; } -sub remove_attribute { - my ($self, $name) = @_; - delete $self->get_attribute_map->{$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 get_attribute_list { - my ($self) = @_; - keys %{$self->get_attribute_map}; +## ------------------------------------------------------------------ +## subroles + +__PACKAGE__->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"; + push @{$self->get_roles} => $role; } -# method modifiers +sub calculate_all_roles { + my $self = shift; + my %seen; + grep { + !$seen{$_->name}++ + } ($self, map { + $_->calculate_all_roles + } @{ $self->get_roles }); +} -sub add_method_modifier { - my ($self, $modifier_type, $method_name, $method) = @_; - $self->get_method_modifier_map->{$modifier_type}->{$method_name} = $method; +sub does_role { + my ($self, $role_name) = @_; + (defined $role_name) + || confess "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 + foreach my $role (@{$self->get_roles}) { + return 1 if $role->does_role($role_name); + } + return 0; } -sub has_method_modifier { - my ($self, $modifier_type, $method_name) = @_; - exists $self->get_method_modifier_map->{$modifier_type}->{$method_name} ? 1 : 0 +## ------------------------------------------------------------------ +## methods + +sub method_metaclass { 'Moose::Meta::Role::Method' } + +sub get_method_map { + my $self = shift; + my $map = {}; + + my $role_name = $self->name; + my $method_metaclass = $self->method_metaclass; + + foreach my $symbol ($self->list_all_package_symbols('CODE')) { + + my $code = $self->get_package_symbol('&' . $symbol); + + my ($pkg, $name) = Class::MOP::get_code_info($code); + + 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) } + && $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__'; + } + + $map->{$symbol} = $method_metaclass->wrap($code); + } + + return $map; } -sub get_method_modifier { - my ($self, $modifier_type, $method_name) = @_; - $self->get_method_modifier_map->{$modifier_type}->{$method_name}; +sub get_method { + my ($self, $name) = @_; + $self->get_method_map->{$name}; } -sub remove_method_modifier { - my ($self, $modifier_type, $method_name) = @_; - delete $self->get_method_modifier_map->{$modifier_type}->{$method_name}; +sub has_method { + my ($self, $name) = @_; + exists $self->get_method_map->{$name} ? 1 : 0 } -sub get_method_modifier_list { - my ($self, $modifier_type) = @_; - keys %{$self->get_method_modifier_map->{$modifier_type}}; +sub find_method_by_name { (shift)->get_method(@_) } + +sub get_method_list { + my $self = shift; + grep { !/^meta$/ } keys %{$self->get_method_map}; } -package Moose::Meta::Role::Method; +sub alias_method { + my ($self, $method_name, $method) = @_; + (defined $method_name && $method_name) + || confess "You must define a method name"; -use strict; -use warnings; + my $body = (blessed($method) ? $method->body : $method); + ('CODE' eq (reftype($body) || '')) + || confess "Your code block must be a CODE reference"; + + $self->add_package_symbol("&${method_name}" => $body); +} + +## ------------------------------------------------------------------ +## role construction +## ------------------------------------------------------------------ + +sub apply { + my ($self, $other, @args) = @_; + + (blessed($other)) + || confess "You must pass in an blessed instance"; + + if ($other->isa('Moose::Meta::Role')) { + require Moose::Meta::Role::Application::ToRole; + return Moose::Meta::Role::Application::ToRole->new(@args)->apply($self, $other); + } + elsif ($other->isa('Moose::Meta::Class')) { + require Moose::Meta::Role::Application::ToClass; + return Moose::Meta::Role::Application::ToClass->new(@args)->apply($self, $other); + } + else { + require Moose::Meta::Role::Application::ToInstance; + return Moose::Meta::Role::Application::ToInstance->new(@args)->apply($self, $other); + } +} + +sub combine { + my ($class, @role_specs) = @_; + + require Moose::Meta::Role::Application::RoleSummation; + require Moose::Meta::Role::Composite; + + my @roles = map { $_->[0]->meta } @role_specs; + + my %params; + # how do I do this ... + + my $c = Moose::Meta::Role::Composite->new(roles => \@roles); + Moose::Meta::Role::Application::RoleSummation->new( + %params + )->apply($c); + return $c; +} -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 => 'Collection::Array', +# reader => 'get_roles', +# isa => 'ArrayRef[Moose::Meta::Roles]', +# default => sub { [] }, +# provides => { +# 'push' => 'add_role', +# } +# ); +# +# has 'excluded_roles_map' => ( +# metaclass => 'Collection::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 'attribute_map' => ( +# metaclass => 'Collection::Hash', +# reader => 'get_attribute_map', +# isa => 'HashRef[Str]', +# provides => { +# # 'set' => 'add_attribute' # has some special crap in it +# 'get' => 'get_attribute', +# 'keys' => 'get_attribute_list', +# 'exists' => 'has_attribute', +# # Not exactly delete, cause it sets multiple +# 'delete' => 'remove_attribute', +# } +# ); +# +# has 'required_methods' => ( +# metaclass => 'Collection::Hash', +# reader => 'get_required_methods_map', +# isa => 'HashRef[Str]', +# 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 => 'Collection::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 => 'Collection::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 => 'Collection::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 => 'Collection::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; @@ -194,8 +525,10 @@ Moose::Meta::Role - The Moose Role metaclass =head1 DESCRIPTION -Moose's Roles are being actively developed, please see L -for more information. +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). =head1 METHODS @@ -207,6 +540,8 @@ for more information. =item B +=item B + =back =over 4 @@ -221,12 +556,48 @@ for more information. =over 4 +=item B + +=item B + +=item B + +=back + +=over 4 + +=item B + +=item B + +=item B + +=item B + +=item B + +=back + +=over 4 + +=item B + +=item B + =item B =item B +=item B + =item B +=item B + +=item B + +=item B + =back =over 4 @@ -247,23 +618,71 @@ for more information. =over 4 -=item B +=item B + +=item B + +=item B + +=item B + +=item B + +=back + +=over 4 + +=item B + +=item B + +=item B + +=item B + +=over 4 + +=back + +=item B + +=item B -=item B +=item B -=item B +=item B + +=over 4 + +=back + +=item B + +=item B + +=item B =item B -=item B +=over 4 + +=back + +=item B + +=item B + +=item B + +=item B -=item B +=item B =back =head1 BUGS -All complex software has bugs lurking in it, and this module is no +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. @@ -273,11 +692,11 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006-2008 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