use Scalar::Util 'blessed';
use Carp 'confess';
+use Devel::GlobalDestruction 'in_global_destruction';
-our $VERSION = '0.73';
+our $VERSION = '1.05';
$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';
+use base 'Class::MOP::Module',
+ 'Class::MOP::Mixin::HasAttributes',
+ 'Class::MOP::Mixin::HasMethods';
## ------------------------------------------------------------------
## 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
+## 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
# 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
+# 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
attr_reader => 'get_excluded_roles_map' ,
methods => {
add => 'add_excluded_roles',
- get_list => 'get_excluded_roles_list',
+ get_keys => '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',
+ remove => 'remove_required_methods',
+ get_values => '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};
$self->$attr_reader->{$_} = undef foreach @values;
}) if exists $methods->{add};
- $META->add_method($methods->{get_list} => sub {
+ $META->add_method($methods->{get_keys} => sub {
my ($self) = @_;
keys %{$self->$attr_reader};
- }) if exists $methods->{get_list};
+ }) 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) = @_;
}) if exists $methods->{remove};
}
-## some things don't always fit, so they go here ...
+$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',
+ @_
+ );
+}
+
+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
+ );
+ }
+
+ return $self->SUPER::reinitialize(
+ $pkg,
+ %existing_classes,
+ @_,
+ );
+}
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");
+
+ 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" );
}
- my $attr_desc;
- if (scalar @_ == 1 && ref($_[0]) eq 'HASH') {
- $attr_desc = $_[0];
+ elsif (!blessed($_[0]) && defined($_[0]) && $_[0] =~ /^\+(.*)/) {
+ Moose->throw_error( "has '+attr' is not supported in roles" );
}
- else {
- $attr_desc = { @_ };
+
+ return $self->SUPER::add_attribute(@_);
+}
+
+sub _attach_attribute {
+ my ( $self, $attribute ) = @_;
+
+ $attribute->attach_to_role($self);
+}
+
+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;
}
- $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);
-# }
-# }
+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
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}};
+ my $mm = $self->$attr_reader->{$method_name};
+ $mm ? @$mm : ();
});
$META->add_method("has_${modifier_type}_method_modifiers" => sub {
}
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
return 0;
}
-## ------------------------------------------------------------------
-## methods
-
-sub method_metaclass { 'Moose::Meta::Role::Method' }
-
-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 },
- 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 {
- 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(@_);
## ------------------------------------------------------------------
sub apply {
- my ($self, $other, @args) = @_;
+ my ($self, $other, %args) = @_;
(blessed($other))
|| Moose->throw_error("You must pass in an blessed instance");
-
+
+ my $application_class;
if ($other->isa('Moose::Meta::Role')) {
- require Moose::Meta::Role::Application::ToRole;
- return Moose::Meta::Role::Application::ToRole->new(@args)->apply($self, $other);
+ $application_class = $self->application_to_role_class;
}
elsif ($other->isa('Moose::Meta::Class')) {
- require Moose::Meta::Role::Application::ToClass;
- return Moose::Meta::Role::Application::ToClass->new(@args)->apply($self, $other);
- }
+ $application_class = $self->application_to_class_class;
+ }
else {
- require Moose::Meta::Role::Application::ToInstance;
- return Moose::Meta::Role::Application::ToInstance->new(@args)->apply($self, $other);
- }
+ $application_class = $self->application_to_instance_class;
+ }
+
+ Class::MOP::load_class($application_class);
+ return $application_class->new(%args)->apply($self, $other, \%args);
}
+sub composition_class_roles { }
+
sub combine {
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 => Class::MOP::class_of($role);
+ my $requested_role
+ = blessed $role
+ ? $role
+ : Class::MOP::class_of($role);
+
+ my $actual_role = $requested_role->_role_for_combination($params);
+ push @roles => $actual_role;
+
next unless defined $params;
- $role_params{$role} = $params;
+ $role_params{$actual_role->name} = $params;
}
-
+
my $c = Moose::Meta::Role::Composite->new(roles => \@roles);
- Moose::Meta::Role::Application::RoleSummation->new(
- role_params => \%role_params
- )->apply($c);
-
- return $c;
+ return $c->apply_params(\%role_params);
+}
+
+sub _role_for_combination {
+ my ($self, $params) = @_;
+ return $self;
}
sub create {
|| confess "You must pass a HASH ref of methods"
if exists $options{methods};
- $role->SUPER::create(%options);
-
my (%initialize_options) = %options;
delete @initialize_options{qw(
package
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);
+ $meta->add_attribute(
+ $attribute_name => blessed $attr ? $attr : %{$attr} );
}
}
return $meta;
}
+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;
+}
+
# 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
sub DESTROY {
my $self = shift;
- return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated
+ 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/;
#####################################################################
## NOTE:
-## This is Moose::Meta::Role as defined by Moose (plus the use of
-## MooseX::AttributeHelpers module). It is here as a reference to
+## 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',
+# metaclass => 'Array',
# reader => 'get_roles',
-# isa => 'ArrayRef[Moose::Meta::Roles]',
+# isa => 'ArrayRef[Moose::Meta::Role]',
# default => sub { [] },
# provides => {
# 'push' => 'add_role',
# }
# );
-#
+#
# has 'excluded_roles_map' => (
-# metaclass => 'Collection::Hash',
+# metaclass => 'Hash',
# reader => 'get_excluded_roles_map',
# isa => 'HashRef[Str]',
# provides => {
# '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',
+# metaclass => 'Hash',
# reader => 'get_required_methods_map',
-# isa => 'HashRef[Str]',
-# provides => {
-# # not exactly set, or delete since it works for multiple
+# 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',
+# 'exists' => 'requires_method',
# }
# );
-#
-# # the before, around and after modifiers are
-# # HASH keyed by method-name, with ARRAY of
+#
+# # 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',
+# 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
+# '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'
-# }
+# # 'add' => 'add_before_method_modifier'
+# }
# );
-#
+#
# has 'after_method_modifiers' => (
-# metaclass => 'Collection::Hash',
+# 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
+# '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'
-# }
+# # it. It also checks for duplicates as well
+# # 'add' => 'add_after_method_modifier'
+# }
# );
-#
+#
# has 'around_method_modifiers' => (
-# metaclass => 'Collection::Hash',
+# 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
+# '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'
-# }
+# # 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',
+# metaclass => 'Hash',
# reader =>'get_override_method_modifiers_map',
-# isa => 'HashRef[CodeRef]',
+# isa => 'HashRef[CodeRef]',
# provides => {
# 'keys' => 'get_override_method_modifier',
-# 'exists' => 'has_override_method_modifier',
-# 'add' => 'add_override_method_modifier', # checks for local method ..
+# 'exists' => 'has_override_method_modifier',
+# 'add' => 'add_override_method_modifier', # checks for local method ..
# }
# );
-#
+#
#####################################################################
=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
-an optional hash reference. The hash reference can contain C<exclude>
-and C<alias> keys to control how methods are composed from the role.
+should contain a role name or L<Moose::Meta::Role> 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<Moose::Meta::Role::Composite> that
represents the combined roles.
+=item B<< $metarole->composition_class_roles >>
+
+When combining multiple roles using C<combine>, this method is used to obtain a
+list of role names to be applied to the L<Moose::Meta::Role::Composite>
+instance returned by C<combine>. 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<Moose::Meta::Class> C<create>
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
The options are passed directly to the constructor for the appropriate
L<Moose::Meta::Role::Application> subclass.
+Note that this will apply the role even if the C<$thing> in question already
+C<does> this role. L<Moose::Util/does_role> is a convenient wrapper for
+finding out if role application is necessary.
+
=back
=head2 Roles and other roles
This returns a I<unique> 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<name>, returns true if this role does the given
-role.
+Given a role I<name> or L<Moose::Meta::Role> object, returns true if this role
+does the given role.
=item B<< $metarole->add_role($role) >>
=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<Class::MOP::Class>
+L<Class::MOP::Package>
=back
=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) >>
Returns true if the role requires the named method.
-=item B<< $metarole->add_required_methods(@names >>
+=item B<< $metarole->add_required_methods(@names) >>
-Adds the named methods to the roles list of required methods.
+Adds the named methods to the role's list of required methods.
=item B<< $metarole->remove_required_methods(@names) >>
-Removes the named methods to the roles list of required methods.
+Removes the named methods from the role's list of required methods.
+
+=item B<< $metarole->add_conflicting_method(%params) >>
+
+Instantiate the parameters as a L<Moose::Meta::Role::Method::Conflicting>
+object, then add it to the required method list.
=back
=head2 Method modifiers
-These methods act like their counterparts in L<Class::Mop::Class> and
+These methods act like their counterparts in L<Class::MOP::Class> and
L<Moose::Meta::Class>.
However, method modifiers are simply stored internally, and are not
=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<Moose/BUGS> for details on reporting bugs.
=head1 AUTHOR
=head1 COPYRIGHT AND LICENSE
-Copyright 2006-2009 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Moose.git / blobdiff