use warnings;
use metaclass;
-use Carp 'confess';
use Scalar::Util 'blessed';
-use B 'svref_2object';
+use Carp 'confess';
-our $VERSION = '0.05';
+our $VERSION = '0.75_01';
+$VERSION = eval $VERSION;
+our $AUTHORITY = 'cpan:STEVAN';
use Moose::Meta::Class;
use Moose::Meta::Role::Method;
+use Moose::Meta::Role::Method::Required;
use base 'Class::MOP::Module';
-## Attributes
+## ------------------------------------------------------------------
+## 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
+## ------------------------------------------------------------------
+
+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',
+ }
+ }
+) {
-## roles
+ my $attr_reader = $action->{attr_reader};
+ my $methods = $action->{methods};
-__PACKAGE__->meta->add_attribute('roles' => (
- reader => 'get_roles',
- default => sub { [] }
-));
+ # create the attribute
+ $META->add_attribute($action->{name} => (
+ reader => $attr_reader,
+ default => sub { {} }
+ ));
-## excluded roles
+ # create some helper methods
+ $META->add_method($methods->{add} => sub {
+ my ($self, @values) = @_;
+ $self->$attr_reader->{$_} = undef foreach @values;
+ }) if exists $methods->{add};
-__PACKAGE__->meta->add_attribute('excluded_roles_map' => (
- reader => 'get_excluded_roles_map',
- default => sub { {} }
-));
+ $META->add_method($methods->{get_list} => sub {
+ my ($self) = @_;
+ keys %{$self->$attr_reader};
+ }) if exists $methods->{get_list};
-## attributes
+ $META->add_method($methods->{get} => sub {
+ my ($self, $name) = @_;
+ $self->$attr_reader->{$name}
+ }) if exists $methods->{get};
-__PACKAGE__->meta->add_attribute('attribute_map' => (
- reader => 'get_attribute_map',
- default => sub { {} }
-));
+ $META->add_method($methods->{existence} => sub {
+ my ($self, $name) = @_;
+ exists $self->$attr_reader->{$name} ? 1 : 0;
+ }) if exists $methods->{existence};
-## required methods
+ $META->add_method($methods->{remove} => sub {
+ my ($self, @values) = @_;
+ delete $self->$attr_reader->{$_} foreach @values;
+ }) if exists $methods->{remove};
+}
-__PACKAGE__->meta->add_attribute('required_methods' => (
- reader => 'get_required_methods_map',
- default => sub { {} }
-));
+$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];
+ }
+ else {
+ $attr_desc = { @_ };
+ }
+ $self->get_attribute_map->{$name} = $attr_desc;
+}
+## ------------------------------------------------------------------
## method modifiers
-__PACKAGE__->meta->add_attribute('before_method_modifiers' => (
- reader => 'get_before_method_modifiers_map',
- default => sub { {} } # (<name> => [ (CODE) ])
-));
+# NOTE:
+# 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
-__PACKAGE__->meta->add_attribute('after_method_modifiers' => (
- reader => 'get_after_method_modifiers_map',
- default => sub { {} } # (<name> => [ (CODE) ])
-));
+foreach my $modifier_type (qw[ before around after ]) {
-__PACKAGE__->meta->add_attribute('around_method_modifiers' => (
- reader => 'get_around_method_modifiers_map',
- default => sub { {} } # (<name> => [ (CODE) ])
-));
+ 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;
+ });
+
+}
-__PACKAGE__->meta->add_attribute('override_method_modifiers' => (
+## ------------------------------------------------------------------
+## override method mofidiers
+
+$META->add_attribute('override_method_modifiers' => (
reader => 'get_override_method_modifiers_map',
- default => sub { {} } # (<name> => CODE)
+ default => sub { {} }
));
-## Methods
+# 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))
+ || 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;
+}
+
+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 method_metaclass { 'Moose::Meta::Role::Method' }
+sub get_override_method_modifier {
+ my ($self, $method_name) = @_;
+ $self->get_override_method_modifiers_map->{$method_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 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
+$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";
+ || 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 {
my $self = shift;
my %seen;
- grep { !$seen{$_->name}++ } $self, map { $_->calculate_all_roles } @{ $self->get_roles };
+ grep {
+ !$seen{$_->name}++
+ } ($self, map {
+ $_->calculate_all_roles
+ } @{ $self->get_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
return 0;
}
-## excluded roles
-
-sub add_excluded_roles {
- my ($self, @excluded_role_names) = @_;
- $self->get_excluded_roles_map->{$_} = undef foreach @excluded_role_names;
-}
-
-sub get_excluded_roles_list {
- my ($self) = @_;
- keys %{$self->get_excluded_roles_map};
-}
+## ------------------------------------------------------------------
+## methods
-sub excludes_role {
- my ($self, $role_name) = @_;
- exists $self->get_excluded_roles_map->{$role_name} ? 1 : 0;
-}
+sub get_method_map {
+ my $self = shift;
-## required methods
+ my $current = Class::MOP::check_package_cache_flag($self->name);
-sub add_required_methods {
- my ($self, @methods) = @_;
- $self->get_required_methods_map->{$_} = undef foreach @methods;
-}
+ if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
+ return $self->{'methods'} ||= {};
+ }
-sub remove_required_methods {
- my ($self, @methods) = @_;
- delete $self->get_required_methods_map->{$_} foreach @methods;
-}
+ $self->{_package_cache_flag} = $current;
-sub get_required_method_list {
- my ($self) = @_;
- keys %{$self->get_required_methods_map};
-}
+ my $map = $self->{'methods'} ||= {};
-sub requires_method {
- my ($self, $method_name) = @_;
- exists $self->get_required_methods_map->{$method_name} ? 1 : 0;
-}
+ my $role_name = $self->name;
+ my $method_metaclass = $self->method_metaclass;
-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);
- }
-}
+ my $all_code = $self->get_all_package_symbols('CODE');
-## methods
+ foreach my $symbol (keys %{ $all_code }) {
+ my $code = $all_code->{$symbol};
-# FIXME:
-# this is an UGLY hack
-sub get_method_map {
- my $self = shift;
- $self->{'%!methods'} ||= {};
- $self->Moose::Meta::Class::get_method_map()
-}
+ next if exists $map->{$symbol} &&
+ defined $map->{$symbol} &&
+ $map->{$symbol}->body == $code;
-# FIXME:
-# Yes, this is a really really UGLY hack
-# but it works, and until I can figure
-# out a better way, this is gonna be it.
+ my ($pkg, $name) = Class::MOP::get_code_info($code);
+ my $meta = Class::MOP::class_of($pkg);
-sub get_method { (shift)->Moose::Meta::Class::get_method(@_) }
-sub has_method { (shift)->Moose::Meta::Class::has_method(@_) }
-sub alias_method { (shift)->Moose::Meta::Class::alias_method(@_) }
-sub get_method_list {
- grep {
- !/^meta$/
- } (shift)->Moose::Meta::Class::get_method_list(@_)
-}
-
-sub find_method_by_name { (shift)->has_method(@_) }
-
-# ... however the items in statis (attributes & method modifiers)
-# can be removed and added to through this API
-
-# attributes
-
-sub add_attribute {
- my $self = shift;
- my $name = shift;
- my $attr_desc;
- if (scalar @_ == 1 && ref($_[0]) eq 'HASH') {
- $attr_desc = $_[0];
- }
- else {
- $attr_desc = { @_ };
+ 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
+ );
}
- $self->get_attribute_map->{$name} = $attr_desc;
-}
-sub has_attribute {
- my ($self, $name) = @_;
- exists $self->get_attribute_map->{$name} ? 1 : 0;
+ return $map;
}
-sub get_attribute {
+sub get_method {
my ($self, $name) = @_;
- $self->get_attribute_map->{$name}
+ $self->get_method_map->{$name};
}
-sub remove_attribute {
+sub has_method {
my ($self, $name) = @_;
- delete $self->get_attribute_map->{$name}
+ exists $self->get_method_map->{$name} ? 1 : 0
}
-sub get_attribute_list {
- my ($self) = @_;
- keys %{$self->get_attribute_map};
-}
-
-# method modifiers
+# FIXME this is copy-pasted from Class::MOP::Class
+# refactor to inherit from some common base
+sub wrap_method_body {
+ my ( $self, %args ) = @_;
-# mimic the metaclass API
-sub add_before_method_modifier { (shift)->_add_method_modifier('before', @_) }
-sub add_around_method_modifier { (shift)->_add_method_modifier('around', @_) }
-sub add_after_method_modifier { (shift)->_add_method_modifier('after', @_) }
+ ('CODE' eq ref $args{body})
+ || Moose->throw_error("Your code block must be a CODE reference");
-sub _add_method_modifier {
- my ($self, $modifier_type, $method_name, $method) = @_;
- my $accessor = "get_${modifier_type}_method_modifiers_map";
- $self->$accessor->{$method_name} = []
- unless exists $self->$accessor->{$method_name};
- my $modifiers = $self->$accessor->{$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;
+ $self->method_metaclass->wrap(
+ package_name => $self->name,
+ %args,
+ );
}
-sub add_override_method_modifier {
+sub add_method {
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;
-}
+ (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 );
+ }
-sub has_before_method_modifiers { (shift)->_has_method_modifiers('before', @_) }
-sub has_around_method_modifiers { (shift)->_has_method_modifiers('around', @_) }
-sub has_after_method_modifiers { (shift)->_has_method_modifiers('after', @_) }
+ $method->attach_to_class($self);
-# override just checks for one,..
-# but we can still re-use stuff
-sub has_override_method_modifier { (shift)->_has_method_modifiers('override', @_) }
+ $self->get_method_map->{$method_name} = $method;
-sub _has_method_modifiers {
- my ($self, $modifier_type, $method_name) = @_;
- my $accessor = "get_${modifier_type}_method_modifiers_map";
- # NOTE:
- # for now we assume that if it exists,..
- # it has at least one modifier in it
- (exists $self->$accessor->{$method_name}) ? 1 : 0;
+ 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 get_before_method_modifiers { (shift)->_get_method_modifiers('before', @_) }
-sub get_around_method_modifiers { (shift)->_get_method_modifiers('around', @_) }
-sub get_after_method_modifiers { (shift)->_get_method_modifiers('after', @_) }
+sub find_method_by_name { (shift)->get_method(@_) }
-sub _get_method_modifiers {
- my ($self, $modifier_type, $method_name) = @_;
- my $accessor = "get_${modifier_type}_method_modifiers_map";
- @{$self->$accessor->{$method_name}};
+sub get_method_list {
+ my $self = shift;
+ grep { !/^meta$/ } keys %{$self->get_method_map};
}
-sub get_override_method_modifier {
- my ($self, $method_name) = @_;
- $self->get_override_method_modifiers_map->{$method_name};
-}
+sub alias_method {
+ Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n");
-sub get_method_modifier_list {
- my ($self, $modifier_type) = @_;
- my $accessor = "get_${modifier_type}_method_modifiers_map";
- keys %{$self->$accessor};
+ my $self = shift;
+
+ $self->add_method(@_);
}
-## applying a role to a class ...
+## ------------------------------------------------------------------
+## role construction
+## ------------------------------------------------------------------
-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 :)
- }
- }
-}
+sub apply {
+ my ($self, $other, @args) = @_;
-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) {
+ (blessed($other))
+ || Moose->throw_error("You must pass in an blessed instance");
- 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->get_method($required_method_name);
- # check if it is an override or a generated accessor ..
- (!$method->isa('Moose::Meta::Method::Overriden') &&
- !$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 a method modifier";
- # before/after/around methods are a little trickier
- # since we wrap the original local method (if applicable)
- # so we need to check if the original wrapped method is
- # from the same package, and not a wrap of the super method
- if ($method->isa('Class::MOP::Method::Wrapped')) {
- ($method->get_original_method->package_name eq $other->name)
- || confess "'" . $self->name . "' requires the method '$required_method_name' " .
- "to be implemented by '" . $other->name . "', the method is only a method modifier";
- }
- }
- }
+ 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 _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 {
- $other->add_attribute(
- $attribute_name,
- $self->get_attribute($attribute_name)
- );
- }
- }
+sub combine {
+ my ($class, @role_specs) = @_;
+
+ require Moose::Meta::Role::Application::RoleSummation;
+ 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);
+ next unless defined $params;
+ $role_params{$role} = $params;
+ }
+
+ my $c = Moose::Meta::Role::Composite->new(roles => \@roles);
+ Moose::Meta::Role::Application::RoleSummation->new(
+ role_params => \%role_params
+ )->apply($c);
+
+ return $c;
}
-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)
- );
- }
- }
-}
+sub create {
+ my ( $role, $package_name, %options ) = @_;
-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 = svref_2object($method)->GV->STASH->NAME;
- # if it is a class, we just add it
- $other->add_override_method_modifier($method_name, $method, $package);
- }
- }
- }
-}
+ $options{package} = $package_name;
-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);
- }
-}
+ (ref $options{attributes} eq 'HASH')
+ || confess "You must pass a HASH ref of attributes"
+ if exists $options{attributes};
-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' => @_) }
+ (ref $options{methods} eq 'HASH')
+ || confess "You must pass a HASH ref of methods"
+ if exists $options{methods};
-my $anon_counter = 0;
+ my (%initialize_options) = %options;
+ delete @initialize_options{qw(
+ package
+ attributes
+ methods
+ version
+ authority
+ )};
-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 $meta = $role->initialize( $package_name => %initialize_options );
- my $object = $other;
+ $meta->_instantiate_module( $options{version}, $options{authority} );
- $other = Moose::Meta::Class->initialize($pkg_name);
- $other->superclasses(blessed($object));
-
- bless $object => $pkg_name;
+ # 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);
+ }
}
-
- $self->_check_excluded_roles($other);
- $self->_check_required_methods($other);
- $self->_apply_attributes($other);
- $self->_apply_methods($other);
+ if (exists $options{methods}) {
+ foreach my $method_name (keys %{$options{methods}}) {
+ $meta->add_method($method_name, $options{methods}->{$method_name});
+ }
+ }
- $self->_apply_override_method_modifiers($other);
- $self->_apply_before_method_modifiers($other);
- $self->_apply_around_method_modifiers($other);
- $self->_apply_after_method_modifiers($other);
+ Class::MOP::weaken_metaclass($meta->name)
+ if $meta->is_anon_role;
- $other->add_role($self);
+ return $meta;
}
-sub combine {
- my ($class, @roles) = @_;
-
- my $pkg_name = __PACKAGE__ . "::__COMPOSITE_ROLE_SANDBOX__::" . $anon_counter++;
- eval "package " . $pkg_name . "; our \$VERSION = '0.00';";
- die $@ if $@;
-
- my $combined = $class->initialize($pkg_name);
-
- foreach my $role (@roles) {
- $role->apply($combined);
+# 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 . '::'};
}
-
- $combined->_clean_up_required_methods;
-
- return $combined;
}
+#####################################################################
+## 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 ..
+# }
+# );
+#
+#####################################################################
+
+
1;
__END__
=head1 DESCRIPTION
-Moose's Roles are being actively developed, please see L<Moose::Role>
-for more information. For the most part, this has no user-serviceable
-parts inside. It's API is still subject to some change (although
-probably not that much really).
+This class is a subclass of L<Class::MOP::Module> that provides
+additional Moose-specific functionality.
+
+It's API looks a lot like L<Moose::Meta::Class>, but internally it
+implements many things differently. This may change in the future.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::Role> is a subclass of L<Class::MOP::Module>.
=head1 METHODS
+=head2 Construction
+
=over 4
-=item B<meta>
+=item B<< Moose::Meta::Role->initialize($role_name) >>
-=item B<new>
+This method creates a new role object with the provided name.
-=item B<apply>
+=item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >>
-=item B<combine>
+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.
-=back
+The return value is a new L<Moose::Meta::Role::Composite> that
+represents the combined roles.
-=over 4
+=item B<< Moose::Meta::Role->create($name, %options) >>
+
+This method is identical to the L<Moose::Meta::Class> C<create>
+method.
-=item B<name>
+=item B<< Moose::Meta::Role->create_anon_role >>
-=item B<version>
+This method is identical to the L<Moose::Meta::Class>
+C<create_anon_class> method.
-=item B<role_meta>
+=item B<< $metarole->is_anon_role >>
+
+Returns true if the role is an anonymous role.
=back
+=head2 Role application
+
=over 4
-=item B<get_roles>
+=item B<< $metarole->apply( $thing, @options ) >>
-=item B<add_role>
+This method applies a role to the given C<$thing>. That can be another
+L<Moose::Meta::Role>, object, a L<Moose::Meta::Class> object, or a
+(non-meta) object instance.
-=item B<does_role>
+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
+
=over 4
-=item B<add_excluded_roles>
+=item B<< $metarole->get_roles >>
-=item B<excludes_role>
+This returns an array reference of roles which this role does. This
+list may include duplicates.
-=item B<get_excluded_roles_list>
+=item B<< $metarole->calculate_all_roles >>
-=item B<get_excluded_roles_map>
+This returns a I<unique> list of all roles that this role does, and
+all the roles that its roles do.
-=item B<calculate_all_roles>
+=item B<< $metarole->does_role($role_name) >>
-=back
+Given a role I<name>, returns true if this role does the given
+role.
-=over 4
+=item B<< $metarole->add_role($role) >>
-=item B<method_metaclass>
+Given a L<Moose::Meta::Role> object, this adds the role to the list of
+roles that the role does.
-=item B<find_method_by_name>
+=item B<< $metarole->get_excluded_roles_list >>
-=item B<get_method>
+Returns a list of role names which this role excludes.
-=item B<has_method>
+=item B<< $metarole->excludes_role($role_name) >>
-=item B<alias_method>
+Given a role I<name>, returns true if this role excludes the named
+role.
-=item B<get_method_list>
+=item B<< $metarole->add_excluded_roles(@role_names) >>
-=item B<get_method_map>
+Given one or more role names, adds those roles to the list of excluded
+roles.
=back
+=head2 Methods
+
+The methods for dealing with a role's methods are all identical in API
+and behavior to the same methods in L<Class::MOP::Class>.
+
=over 4
-=item B<add_attribute>
+=item B<< $metarole->method_metaclass >>
+
+Returns the method metaclass name for the role. This defaults to
+L<Moose::Meta::Role::Method>.
+
+=item B<< $metarole->get_method($name) >>
+
+=item B<< $metarole->has_method($name) >>
-=item B<has_attribute>
+=item B<< $metarole->add_method( $name, $body ) >>
-=item B<get_attribute>
+=item B<< $metarole->get_method_list >>
-=item B<get_attribute_list>
+=item B<< $metarole->get_method_map >>
-=item B<get_attribute_map>
+=item B<< $metarole->find_method_by_name($name) >>
-=item B<remove_attribute>
+These methods are all identical to the methods of the same name in
+L<Class::MOP::Class>
=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<Class::MOP::Class>.
+
+However, attributes stored in this class are I<not> 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<add_attribute> method.
+
+This is quite likely to change in the future.
+
=over 4
-=item B<add_required_methods>
+=item B<< $metarole->get_attribute($attribute_name) >>
-=item B<remove_required_methods>
+=item B<< $metarole->has_attribute($attribute_name) >>
-=item B<get_required_method_list>
+=item B<< $metarole->get_attribute_map >>
-=item B<get_required_methods_map>
+=item B<< $metarole->get_attribute_list >>
-=item B<requires_method>
+=item B<< $metarole->add_attribute($name, %options) >>
+
+=item B<< $metarole->remove_attribute($attribute_name) >>
=back
+=head2 Required methods
+
=over 4
-=item B<add_after_method_modifier>
+=item B<< $metarole->get_required_method_list >>
-=item B<add_around_method_modifier>
+Returns the list of methods required by the role.
-=item B<add_before_method_modifier>
+=item B<< $metarole->requires_method($name) >>
-=item B<add_override_method_modifier>
+Returns true if the role requires the named method.
-=over 4
+=item B<< $metarole->add_required_methods(@names >>
-=back
+Adds the named methods to the roles list of required methods.
-=item B<has_after_method_modifiers>
+=item B<< $metarole->remove_required_methods(@names) >>
+
+Removes the named methods to the roles list of required methods.
+
+=back
-=item B<has_around_method_modifiers>
+=head2 Method modifiers
-=item B<has_before_method_modifiers>
+These methods act like their counterparts in L<Class::Mop::Class> and
+L<Moose::Meta::Class>.
-=item B<has_override_method_modifier>
+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<get_after_method_modifiers>
+=item B<< $metarole->add_around_method_modifier($method_name, $method) >>
-=item B<get_around_method_modifiers>
+=item B<< $metarole->add_before_method_modifier($method_name, $method) >>
-=item B<get_before_method_modifiers>
+=item B<< $metarole->add_override_method_modifier($method_name, $method) >>
-=item B<get_method_modifier_list>
+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<< $metarole->has_before_method_modifiers >>
+
+=item B<< $metarole->has_override_method_modifier >>
+
+Return true if the role has any modifiers of the given type.
+
+=item B<< $metarole->get_after_method_modifiers($method_name) >>
-=item B<get_override_method_modifier>
+=item B<< $metarole->get_around_method_modifiers($method_name) >>
-=item B<get_after_method_modifiers_map>
+=item B<< $metarole->get_before_method_modifiers($method_name) >>
-=item B<get_around_method_modifiers_map>
+Given a method name, returns a list of the appropriate modifiers for
+that method.
+
+=item B<< $metarole->get_override_method_modifier($method_name) >>
+
+Given a method name, returns the override method modifier for that
+method, if it has one.
+
+=back
+
+=head2 Introspection
+
+=over 4
-=item B<get_before_method_modifiers_map>
+=item B<< Moose::Meta::Role->meta >>
-=item B<get_override_method_modifiers_map>
+This will return a L<Class::MOP::Class> instance for this class.
=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.
=head1 COPYRIGHT AND LICENSE
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
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
projects / gitmo/Moose.git / blobdiff