package Mouse::Meta::Role;
-use strict;
-use warnings;
-use Carp 'confess';
+use Mouse::Util qw(:meta not_supported english_list); # enables strict and warnings
-use base qw(Mouse::Meta::Module);
+use Mouse::Meta::Module;
+our @ISA = qw(Mouse::Meta::Module);
-sub _new {
+sub method_metaclass(){ 'Mouse::Meta::Role::Method' } # required for get_method()
+
+sub _construct_meta {
my $class = shift;
+
my %args = @_;
$args{methods} ||= {};
$args{required_methods} ||= [];
$args{roles} ||= [];
- bless \%args, $class;
+ my $self = bless \%args, ref($class) || $class;
+ if($class ne __PACKAGE__){
+ $self->meta->_initialize_object($self, \%args);
+ }
+
+ return $self;
+}
+
+sub create_anon_role{
+ my $self = shift;
+ return $self->create(undef, @_);
+}
+
+sub is_anon_role{
+ return exists $_[0]->{anon_serial_id};
}
sub get_roles { $_[0]->{roles} }
+sub get_required_method_list{
+ return @{ $_[0]->{required_methods} };
+}
sub add_required_methods {
- my $self = shift;
- my @methods = @_;
- push @{$self->{required_methods}}, @methods;
+ my($self, @methods) = @_;
+ my %required = map{ $_ => 1 } @{$self->{required_methods}};
+ push @{$self->{required_methods}}, grep{ !$required{$_}++ && !$self->has_method($_) } @methods;
+ return;
+}
+
+sub requires_method {
+ my($self, $name) = @_;
+ return scalar( grep{ $_ eq $name } @{ $self->{required_methods} } ) != 0;
}
sub add_attribute {
my $self = shift;
my $name = shift;
- my $spec = shift;
- $self->{attributes}->{$name} = $spec;
+
+ $self->{attributes}->{$name} = (@_ == 1) ? $_[0] : { @_ };
}
sub _check_required_methods{
- my($role, $class, $args, @other_roles) = @_;
+ my($role, $applicant, $args) = @_;
- if($class->isa('Mouse::Meta::Class')){
- my $class_name = $class->name;
+ if($args->{_to} eq 'role'){
+ $applicant->add_required_methods($role->get_required_method_list);
+ }
+ else{ # to class or instance
+ my $class_name = $applicant->name;
+ my $role_name = $role->name;
+ my @missing;
foreach my $method_name(@{$role->{required_methods}}){
- unless($class_name->can($method_name)){
- my $role_name = $role->name;
- my $has_method = 0;
-
- foreach my $another_role_spec(@other_roles){
- my $another_role_name = $another_role_spec->[0];
- if($role_name ne $another_role_name && $another_role_name->can($method_name)){
- $has_method = 1;
- last;
- }
- }
-
- confess "'$role_name' requires the method '$method_name' to be implemented by '$class_name'"
- unless $has_method;
+ if(!($class_name->can($method_name) || exists $args->{to_be_provided}{$method_name})){
+ push @missing, $method_name;
}
}
+ if(@missing){
+ $role->throw_error("'$role_name' requires the "
+ . (@missing == 1 ? 'method' : 'methods')
+ . " "
+ . english_list(map{ sprintf q{'%s'}, $_ } @missing)
+ . " to be implemented by '$class_name'");
+ }
}
return;
}
sub _apply_methods{
- my($role, $class, $args) = @_;
+ my($role, $applicant, $args) = @_;
my $role_name = $role->name;
- my $class_name = $class->name;
- my $alias = $args->{alias};
+ my $class_name = $applicant->name;
+
+ my $alias = $args->{-alias};
+ my $excludes = $args->{-excludes};
foreach my $method_name($role->get_method_list){
next if $method_name eq 'meta';
- my $code = $role_name->can($method_name);
- if(do{ no strict 'refs'; defined &{$class_name . '::' . $method_name} }){
- # XXX what's Moose's behavior?
- }
- else{
- $class->add_method($method_name => $code);
+ my $code = $role->get_method_body($method_name);
+
+ if($excludes && !exists $excludes->{$method_name}){
+ if(!$applicant->has_method($method_name)){
+ # The third argument, $role, is used in Role::Composite
+ $applicant->add_method($method_name => $code, $role);
+ }
}
if($alias && $alias->{$method_name}){
my $dstname = $alias->{$method_name};
- if(do{ no strict 'refs'; defined &{$class_name . '::' . $dstname} }){
- # XXX wat's Moose's behavior?
+
+ my $dstcode = $applicant->get_method_body($dstname);
+
+ if(defined($dstcode) && $dstcode != $code){
+ $role->throw_error("Cannot create a method alias if a local method of the same name exists");
}
else{
- $class->add_method($dstname => $code);
+ $applicant->add_method($dstname => $code, $role);
}
}
}
}
sub _apply_attributes{
- my($role, $class, $args) = @_;
+ my($role, $applicant, $args) = @_;
- if ($class->isa('Mouse::Meta::Class')) {
- # apply role to class
- for my $attr_name ($role->get_attribute_list) {
- next if $class->has_attribute($attr_name);
+ for my $attr_name ($role->get_attribute_list) {
+ next if $applicant->has_attribute($attr_name);
- my $spec = $role->get_attribute($attr_name);
-
- my $attr_metaclass = 'Mouse::Meta::Attribute';
- if ( my $metaclass_name = $spec->{metaclass} ) {
- $attr_metaclass = Mouse::Util::resolve_metaclass_alias(
- 'Attribute',
- $metaclass_name
- );
- }
-
- $attr_metaclass->create($class, $attr_name => %$spec);
- }
- } else {
- # apply role to role
- for my $attr_name ($role->get_attribute_list) {
- next if $class->has_attribute($attr_name);
-
- my $spec = $role->get_attribute($attr_name);
- $class->add_attribute($attr_name => $spec);
- }
+ $applicant->add_attribute($attr_name => $role->get_attribute($attr_name));
}
-
return;
}
sub _apply_modifiers{
- my($role, $class, $args) = @_;
+ my($role, $applicant, $args) = @_;
+
+ for my $modifier_type (qw/override before around after/) {
+ my $modifiers = $role->{"${modifier_type}_method_modifiers"}
+ or next;
- for my $modifier_type (qw/before after around override/) {
my $add_modifier = "add_${modifier_type}_method_modifier";
- my $modifiers = $role->{"${modifier_type}_method_modifiers"};
- while(my($method_name, $modifier_codes) = each %{$modifiers}){
- foreach my $code(@{$modifier_codes}){
- $class->$add_modifier($method_name => $code);
+ foreach my $method_name (keys %{$modifiers}){
+ my $modifier_codes = $modifiers->{$method_name};
+ foreach my $code(ref($modifier_codes) eq 'ARRAY' ? @{$modifier_codes} : $modifier_codes){
+ next if $applicant->{"_$modifier_type"}{$code}++; # skip applied modifiers
+ $applicant->$add_modifier($method_name => $code);
}
}
}
}
sub _append_roles{
- my($role, $class, $args) = @_;
+ my($role, $applicant, $args) = @_;
- my $roles = $class->isa('Mouse::Meta::Class') ? $class->roles : $class->get_roles;
+ my $roles = ($args->{_to} eq 'role') ? $applicant->get_roles : $applicant->roles;
foreach my $r($role, @{$role->get_roles}){
- if(!$class->does_role($r->name)){
+ if(!$applicant->does_role($r->name)){
push @{$roles}, $r;
}
}
# Moose uses Application::ToInstance, Application::ToClass, Application::ToRole
sub apply {
- my($self, $class, %args) = @_;
+ my $self = shift;
+ my $applicant = shift;
+
+ my %args = (@_ == 1) ? %{ $_[0] } : @_;
+
+ if($applicant->isa('Mouse::Meta::Class')){ # Application::ToClass
+ $args{_to} = 'class';
+ }
+ elsif($applicant->isa('Mouse::Meta::Role')){ # Application::ToRole
+ $args{_to} = 'role';
+ }
+ else{ # Appplication::ToInstance
+ $args{_to} = 'instance';
+
+ my $metaclass = $applicant->meta->create_anon_class(
+ superclasses => [ref $applicant],
+ cache => 1,
+ );
+ bless $applicant, $metaclass->name; # rebless
- if ($class->isa('Mouse::Object')) {
- Carp::croak('Mouse does not support Application::ToInstance yet');
+ $applicant = $metaclass;
}
- $self->_check_required_methods($class, \%args);
- $self->_apply_methods($class, \%args);
- $self->_apply_attributes($class, \%args);
- $self->_apply_modifiers($class, \%args);
- $self->_append_roles($class, \%args);
+ if($args{alias} && !exists $args{-alias}){
+ $args{-alias} = $args{alias};
+ }
+ if($args{excludes} && !exists $args{-excludes}){
+ $args{-excludes} = $args{excludes};
+ }
+
+ # In Moose it is called 'aliased methods'
+ $args{to_be_provided} = {};
+ if(my $alias = $args{-alias}){
+ @{$args{to_be_provided}}{ values %{$alias} } = ();
+ }
+ @{ $args{to_be_provided} }{ $self->get_method_list } = ();
+
+ if(my $excludes = $args{-excludes}){
+ $args{-excludes} = {}; # replace with a hash ref
+ if(ref $excludes){
+ %{$args{-excludes}} = (map{ $_ => undef } @{$excludes});
+ }
+ else{
+ $args{-excludes}{$excludes} = undef;
+ }
+ }
+
+ $self->_check_required_methods($applicant, \%args);
+ $self->_apply_attributes($applicant, \%args);
+ $self->_apply_methods($applicant, \%args);
+ $self->_apply_modifiers($applicant, \%args);
+ $self->_append_roles($applicant, \%args);
return;
}
-sub combine_apply {
- my(undef, $class, @roles) = @_;
- foreach my $role_spec (@roles) {
- my($role_name, $args) = @{$role_spec};
+sub combine {
+ my($role_class, @role_specs) = @_;
+
+ require 'Mouse/Meta/Role/Composite.pm'; # we don't want to create its namespace
- my $role = $role_name->meta;
+ my $composite = Mouse::Meta::Role::Composite->create_anon_role();
- $role->_check_required_methods($class, $args, @roles);
- $role->_apply_methods($class, $args);
- $role->_apply_attributes($class, $args);
- $role->_apply_modifiers($class, $args);
- $role->_append_roles($class, $args);
+ foreach my $role_spec (@role_specs) {
+ my($role_name, $args) = @{$role_spec};
+ $role_name->meta->apply($composite, %{$args});
}
- return;
+ return $composite;
}
-for my $modifier_type (qw/before after around override/) {
+for my $modifier_type (qw/before after around/) {
my $modifier = "${modifier_type}_method_modifiers";
my $add_method_modifier = sub {
*{ 'get_' . $modifier_type . '_method_modifiers' } = $get_method_modifiers;
}
+sub add_override_method_modifier{
+ my($self, $method_name, $method) = @_;
+
+ if($self->has_method($method_name)){
+ # This error happens in the override keyword or during role composition,
+ # so I added a message, "A local method of ...", only for compatibility (gfx)
+ $self->throw_error("Cannot add an override of method '$method_name' "
+ . "because there is a local version of '$method_name'"
+ . "(A local method of the same name as been found)");
+ }
+
+ $self->{override_method_modifiers}->{$method_name} = $method;
+}
+
+sub has_override_method_modifier {
+ my ($self, $method_name) = @_;
+ return exists $self->{override_method_modifiers}->{$method_name};
+}
+
+sub get_override_method_modifier {
+ my ($self, $method_name) = @_;
+ return $self->{override_method_modifiers}->{$method_name};
+}
+
+sub get_method_modifier_list {
+ my($self, $modifier_type) = @_;
+
+ return keys %{ $self->{$modifier_type . '_method_modifiers'} };
+}
+
# This is currently not passing all the Moose tests.
sub does_role {
my ($self, $role_name) = @_;
(defined $role_name)
- || confess "You must supply a role name to look for";
+ || $self->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;
1;
+__END__
+
+=head1 NAME
+
+Mouse::Meta::Role - The Mouse Role metaclass
+
+=head1 SEE ALSO
+
+L<Moose::Meta::Role>
+
+=cut
projects / gitmo/Mouse.git / blobdiff