X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FMeta%2FRole.pm;h=e1f3f7187ff679a6afab8a9e7db594452c003a9c;hp=35bc9ea5f0a4a4107e02ba6a898f54ecda14ea37;hb=cb60d0b55962e6ff8cdc07e51e59f7dd5feafd43;hpb=3370794fc5ea58f40c7e4f7f89c4f4960e28f9d7 diff --git a/lib/Mouse/Meta/Role.pm b/lib/Mouse/Meta/Role.pm index 35bc9ea..e1f3f71 100644 --- a/lib/Mouse/Meta/Role.pm +++ b/lib/Mouse/Meta/Role.pm @@ -1,85 +1,92 @@ package Mouse::Meta::Role; -use strict; -use warnings; -use Carp 'confess'; +use Mouse::Util qw(:meta not_supported); # enables strict and warnings -use base qw(Mouse::Meta::Module); +use Mouse::Meta::Module; +our @ISA = qw(Mouse::Meta::Module); -do { - my %METACLASS_CACHE; +sub method_metaclass; - # because Mouse doesn't introspect existing classes, we're forced to - # only pay attention to other Mouse classes - sub _metaclass_cache { - my $class = shift; - my $name = shift; - return $METACLASS_CACHE{$name}; - } +sub _construct_meta { + my $class = shift; - sub initialize { - my($class, $package_name, @args) = @_; + my %args = @_; - ($package_name && !ref($package_name)) - || confess("You must pass a package name and it cannot be blessed"); + $args{methods} = {}; + $args{attributes} = {}; + $args{required_methods} = []; + $args{roles} = []; - return $METACLASS_CACHE{$package_name} - ||= $class->_new(package => $package_name, @args); + my $self = bless \%args, ref($class) || $class; + if($class ne __PACKAGE__){ + $self->meta->_initialize_object($self, \%args); } -}; - -sub _new { - my $class = shift; - my %args = @_; - $args{methods} ||= {}; - $args{attributes} ||= {}; - $args{required_methods} ||= []; - $args{roles} ||= []; + return $self; +} - bless \%args, $class; +sub create_anon_role{ + my $self = shift; + return $self->create(undef, @_); } -sub get_roles { $_[0]->{roles} } +sub is_anon_role; +sub get_roles; -sub add_required_methods { +sub calculate_all_roles { my $self = shift; - my @methods = @_; - push @{$self->{required_methods}}, @methods; + my %seen; + return grep { !$seen{ $_->name }++ } + ($self, map { $_->calculate_all_roles } @{ $self->get_roles }); +} + +sub get_required_method_list{ + return @{ $_[0]->{required_methods} }; +} + +sub add_required_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; -} -sub has_attribute { exists $_[0]->{attributes}->{$_[1]} } -sub get_attribute_list { keys %{ $_[0]->{attributes} } } -sub get_attribute { $_[0]->{attributes}->{$_[1]} } + $self->{attributes}->{$name} = (@_ == 1) ? $_[0] : { @_ }; + return; +} sub _check_required_methods{ - my($role, $class, $args, @other_roles) = @_; + my($role, $consumer, $args) = @_; + + if($args->{_to} eq 'role'){ + $consumer->add_required_methods($role->get_required_method_list); + } + else{ # to class or instance + my $consumer_class_name = $consumer->name; - if($class->isa('Mouse::Meta::Class')){ - my $class_name = $class->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; - } + next if exists $args->{aliased_methods}{$method_name}; + next if exists $role->{methods}{$method_name}; + next if $consumer_class_name->can($method_name); + + push @missing, $method_name; + } + if(@missing){ + $role->throw_error(sprintf "'%s' requires the method%s %s to be implemented by '%s'", + $role->name, + (@missing == 1 ? '' : 's'), # method or methods + Mouse::Util::quoted_english_list(@missing), + $consumer_class_name); } } @@ -87,30 +94,33 @@ sub _check_required_methods{ } sub _apply_methods{ - my($role, $class, $args) = @_; + my($role, $consumer, $args) = @_; - my $role_name = $role->name; - my $class_name = $class->name; - my $alias = $args->{alias}; + 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(!exists $excludes->{$method_name}){ + if(!$consumer->has_method($method_name)){ + # The third argument $role is used in Role::Composite + $consumer->add_method($method_name => $code, $role); + } } - if($alias && $alias->{$method_name}){ + if(exists $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 = $consumer->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); + $consumer->add_method($dstname => $code, $role); } } } @@ -119,48 +129,35 @@ sub _apply_methods{ } sub _apply_attributes{ - my($role, $class, $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); + my($role, $consumer, $args) = @_; - 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 - ); - } + for my $attr_name ($role->get_attribute_list) { + next if $consumer->has_attribute($attr_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); - } + $consumer->add_attribute($attr_name => $role->get_attribute($attr_name)); } - return; } sub _apply_modifiers{ - my($role, $class, $args) = @_; + my($role, $consumer, $args) = @_; + + if(my $modifiers = $role->{override_method_modifiers}){ + foreach my $method_name (keys %{$modifiers}){ + $consumer->add_override_method_modifier($method_name => $modifiers->{$method_name}); + } + } + + for my $modifier_type (qw/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}){ + foreach my $code(@{ $modifiers->{$method_name} }){ + next if $consumer->{"_applied_$modifier_type"}{$method_name, $code}++; # skip applied modifiers + $consumer->$add_modifier($method_name => $code); } } } @@ -168,12 +165,12 @@ sub _apply_modifiers{ } sub _append_roles{ - my($role, $class, $args) = @_; + my($role, $consumer, $args) = @_; - my $roles = $class->isa('Mouse::Meta::Class') ? $class->roles : $class->get_roles; + my $roles = ($args->{_to} eq 'role') ? $consumer->get_roles : $consumer->roles; foreach my $r($role, @{$role->get_roles}){ - if(!$class->does_role($r->name)){ + if(!$consumer->does_role($r->name)){ push @{$roles}, $r; } } @@ -182,68 +179,114 @@ sub _append_roles{ # Moose uses Application::ToInstance, Application::ToClass, Application::ToRole sub apply { - my($self, $class, %args) = @_; + my $self = shift; + my $consumer = shift; + + my %args = (@_ == 1) ? %{ $_[0] } : @_; + + my $instance; + + if(Mouse::Util::is_a_metaclass($consumer)){ # Application::ToClass + $args{_to} = 'class'; + } + elsif(Mouse::Util::is_a_metarole($consumer)){ # Application::ToRole + $args{_to} = 'role'; + } + else{ # Appplication::ToInstance + $args{_to} = 'instance'; + $instance = $consumer; + + $consumer = (Mouse::Util::class_of($instance) || 'Mouse::Meta::Class')->create_anon_class( + superclasses => [ref $instance], + cache => 1, + ); + } + + if($args{alias} && !exists $args{-alias}){ + $args{-alias} = $args{alias}; + } + if($args{excludes} && !exists $args{-excludes}){ + $args{-excludes} = $args{excludes}; + } + + $args{aliased_methods} = {}; + if(my $alias = $args{-alias}){ + @{$args{aliased_methods}}{ values %{$alias} } = (); + } + + 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($consumer, \%args); + $self->_apply_attributes($consumer, \%args); + $self->_apply_methods($consumer, \%args); + $self->_apply_modifiers($consumer, \%args); + $self->_append_roles($consumer, \%args); + - if ($class->isa('Mouse::Object')) { - Carp::croak('Mouse does not support Application::ToInstance yet'); + if(defined $instance){ # Application::ToInstance + # rebless instance + bless $instance, $consumer->name; + $consumer->_initialize_object($instance, $instance); } - $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); return; } -sub combine_apply { - my(undef, $class, @roles) = @_; - foreach my $role_spec (@roles) { +sub combine { + my($role_class, @role_specs) = @_; + + require 'Mouse/Meta/Role/Composite.pm'; # we don't want to create its namespace + + my $composite = Mouse::Meta::Role::Composite->create_anon_role(); + + foreach my $role_spec (@role_specs) { my($role_name, $args) = @{$role_spec}; + $role_name->meta->apply($composite, %{$args}); + } + return $composite; +} + +sub add_before_method_modifier; +sub add_around_method_modifier; +sub add_after_method_modifier; + +sub get_before_method_modifiers; +sub get_around_method_modifiers; +sub get_after_method_modifiers; - my $role = $role_name->meta; +sub add_override_method_modifier{ + my($self, $method_name, $method) = @_; - $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); + 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)"); } - return; + + $self->{override_method_modifiers}->{$method_name} = $method; } -for my $modifier_type (qw/before after around override/) { - - my $modifier = "${modifier_type}_method_modifiers"; - my $add_method_modifier = sub { - my ($self, $method_name, $method) = @_; - - push @{ $self->{$modifier}->{$method_name} ||= [] }, $method; - return; - }; - my $has_method_modifiers = sub{ - my($self, $method_name) = @_; - my $m = $self->{$modifier}->{$method_name}; - return $m && @{$m} != 0; - }; - my $get_method_modifiers = sub { - my ($self, $method_name) = @_; - return @{ $self->{$modifier}->{$method_name} ||= [] } - }; - - no strict 'refs'; - *{ 'add_' . $modifier_type . '_method_modifier' } = $add_method_modifier; - *{ 'has_' . $modifier_type . '_method_modifiers' } = $has_method_modifiers; - *{ 'get_' . $modifier_type . '_method_modifiers' } = $get_method_modifiers; +sub get_override_method_modifier { + my ($self, $method_name) = @_; + return $self->{override_method_modifiers}->{$method_name}; } -# 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; @@ -254,6 +297,19 @@ sub does_role { return 0; } - 1; +__END__ + +=head1 NAME + +Mouse::Meta::Role - The Mouse Role metaclass + +=head1 VERSION + +This document describes Mouse version 0.50_03 + +=head1 SEE ALSO + +L +=cut