1 package Moose::Meta::Role::Application::RoleSummation;
7 use Scalar::Util 'blessed';
9 use Moose::Meta::Role::Composite;
11 use base 'Moose::Meta::Role::Application';
13 __PACKAGE__->meta->add_attribute('role_params' => (
14 reader => 'role_params',
15 default => sub { {} },
16 Class::MOP::_definition_context(),
19 sub get_exclusions_for_role {
20 my ($self, $role) = @_;
21 $role = $role->name if blessed $role;
22 my $excludes_key = exists $self->role_params->{$role}->{'-excludes'} ?
23 '-excludes' : 'excludes';
24 if ($self->role_params->{$role} && defined $self->role_params->{$role}->{$excludes_key}) {
25 if (ref $self->role_params->{$role}->{$excludes_key} eq 'ARRAY') {
26 return $self->role_params->{$role}->{$excludes_key};
28 return [ $self->role_params->{$role}->{$excludes_key} ];
33 sub get_method_aliases_for_role {
34 my ($self, $role) = @_;
35 $role = $role->name if blessed $role;
36 my $alias_key = exists $self->role_params->{$role}->{'-alias'} ?
38 if ($self->role_params->{$role} && defined $self->role_params->{$role}->{$alias_key}) {
39 return $self->role_params->{$role}->{$alias_key};
44 sub is_method_excluded {
45 my ($self, $role, $method_name) = @_;
46 foreach ($self->get_exclusions_for_role($role->name)) {
47 return 1 if $_ eq $method_name;
52 sub is_method_aliased {
53 my ($self, $role, $method_name) = @_;
54 exists $self->get_method_aliases_for_role($role->name)->{$method_name} ? 1 : 0
57 sub is_aliased_method {
58 my ($self, $role, $method_name) = @_;
59 my %aliased_names = reverse %{$self->get_method_aliases_for_role($role->name)};
60 exists $aliased_names{$method_name} ? 1 : 0;
63 sub check_role_exclusions {
67 for my $role (@{ $c->get_roles }) {
68 my $name = $role->name;
70 for my $excluded ($role->get_excluded_roles_list) {
71 push @{ $excluded_roles{$excluded} }, $name;
75 foreach my $role (@{$c->get_roles}) {
76 foreach my $excluded (keys %excluded_roles) {
77 next unless $role->does_role($excluded);
79 my @excluding = @{ $excluded_roles{$excluded} };
82 Moose->throw_error(sprintf "Conflict detected: Role%s %s exclude%s role '%s'", (@excluding == 1 ? '' : 's'), join(', ', @excluding), (@excluding == 1 ? 's' : ''), $excluded);
86 $c->add_excluded_roles(keys %excluded_roles);
89 sub check_required_methods {
92 my %all_required_methods =
93 map { $_->name => $_ }
94 map { $_->get_required_method_list }
97 foreach my $role (@{$c->get_roles}) {
98 foreach my $required (keys %all_required_methods) {
100 delete $all_required_methods{$required}
101 if $role->has_method($required)
102 || $self->is_aliased_method($role, $required);
106 $c->add_required_methods(values %all_required_methods);
109 sub check_required_attributes {
113 sub apply_attributes {
118 for my $role ( @{ $c->get_roles } ) {
119 push @all_attributes,
120 map { $role->get_attribute($_) } $role->get_attribute_list;
124 foreach my $attr (@all_attributes) {
125 my $name = $attr->name;
127 if ( exists $seen{$name} ) {
128 next if $seen{$name}->is_same_as($attr);
130 my $role1 = $seen{$name}->associated_role->name;
131 my $role2 = $attr->associated_role->name;
135 "We have encountered an attribute conflict with '$name' "
136 . "during role composition. "
137 . " This attribute is defined in both $role1 and $role2."
138 . " This is a fatal error and cannot be disambiguated." );
141 $seen{$name} = $attr;
144 foreach my $attr (@all_attributes) {
145 $c->add_attribute( $attr->clone );
152 my @all_methods = map {
154 my $aliases = $self->get_method_aliases_for_role($role);
155 my %excludes = map { $_ => undef } @{ $self->get_exclusions_for_role($role) };
158 exists $excludes{$_} ? () :
162 method => $role->get_method($_),
165 grep { !$_->isa('Class::MOP::Method::Meta') }
166 $role->_get_local_methods),
170 name => $aliases->{$_},
171 method => $role->get_method($_),
177 my (%seen, %conflicts, %method_map);
178 foreach my $method (@all_methods) {
179 next if $conflicts{$method->{name}};
180 my $seen = $seen{$method->{name}};
183 if ($seen->{method}->body != $method->{method}->body) {
184 $c->add_conflicting_method(
185 name => $method->{name},
186 roles => [$method->{role}->name, $seen->{role}->name],
189 delete $method_map{$method->{name}};
190 $conflicts{$method->{name}} = 1;
195 $seen{$method->{name}} = $method;
196 $method_map{$method->{name}} = $method->{method};
199 $c->add_method($_ => $method_map{$_}) for keys %method_map;
202 sub apply_override_method_modifiers {
205 my @all_overrides = map {
210 method => $role->get_override_method_modifier($_),
212 } $role->get_method_modifier_list('override');
216 foreach my $override (@all_overrides) {
217 if ( $c->has_method($override->{name}) ){
219 Moose->throw_error( "Role '" . $c->name . "' has encountered an 'override' method conflict " .
220 "during composition (A local method of the same name as been found). This " .
223 if (exists $seen{$override->{name}}) {
224 if ( $seen{$override->{name}} != $override->{method} ) {
226 Moose->throw_error( "We have encountered an 'override' method conflict during " .
227 "composition (Two 'override' methods of the same name encountered). " .
228 "This is fatal error.")
231 $seen{$override->{name}} = $override->{method};
234 $c->add_override_method_modifier(
235 $_->{name}, $_->{method}
236 ) for @all_overrides;
240 sub apply_method_modifiers {
241 my ($self, $modifier_type, $c) = @_;
242 my $add = "add_${modifier_type}_method_modifier";
243 my $get = "get_${modifier_type}_method_modifiers";
244 foreach my $role (@{$c->get_roles}) {
245 foreach my $method_name ($role->get_method_modifier_list($modifier_type)) {
249 ) foreach $role->$get($method_name);
256 # ABSTRACT: Combine two or more roles
264 Summation composes two traits, forming the union of non-conflicting
265 bindings and 'disabling' the conflicting bindings
277 =item B<get_exclusions_for_role>
279 =item B<get_method_aliases_for_role>
281 =item B<is_aliased_method>
283 =item B<is_method_aliased>
285 =item B<is_method_excluded>
289 =item B<check_role_exclusions>
291 =item B<check_required_methods>
293 =item B<check_required_attributes>
295 =item B<apply_attributes>
297 =item B<apply_methods>
299 =item B<apply_method_modifiers>
301 =item B<apply_override_method_modifiers>
307 See L<Moose/BUGS> for details on reporting bugs.