Commit | Line | Data |
a2227e71 |
1 | package Mouse::Meta::Role; |
bc69ee88 |
2 | use Mouse::Util qw(:meta not_supported english_list); # enables strict and warnings |
74be9f76 |
3 | |
6d28c5cf |
4 | use Mouse::Meta::Module; |
f3bb863f |
5 | our @ISA = qw(Mouse::Meta::Module); |
a2227e71 |
6 | |
6cfa1e5e |
7 | sub method_metaclass(){ 'Mouse::Meta::Role::Method' } # required for get_method() |
8 | |
8e64d0fa |
9 | sub _construct_meta { |
acf0f643 |
10 | my $class = shift; |
7a50b450 |
11 | |
acf0f643 |
12 | my %args = @_; |
13 | |
3a63a2e7 |
14 | $args{methods} ||= {}; |
59089ec3 |
15 | $args{attributes} ||= {}; |
16 | $args{required_methods} ||= []; |
47f36c05 |
17 | $args{roles} ||= []; |
274b6cce |
18 | |
9009aca1 |
19 | my $self = bless \%args, ref($class) || $class; |
20 | if($class ne __PACKAGE__){ |
21 | $self->meta->_initialize_object($self, \%args); |
22 | } |
7a50b450 |
23 | |
9009aca1 |
24 | return $self; |
7a50b450 |
25 | } |
26 | |
27 | sub create_anon_role{ |
28 | my $self = shift; |
29 | return $self->create(undef, @_); |
30 | } |
31 | |
32 | sub is_anon_role{ |
33 | return exists $_[0]->{anon_serial_id}; |
acf0f643 |
34 | } |
a2227e71 |
35 | |
afc73948 |
36 | sub get_roles { $_[0]->{roles} } |
37 | |
6cfa1e5e |
38 | sub get_required_method_list{ |
39 | return @{ $_[0]->{required_methods} }; |
40 | } |
afc73948 |
41 | |
59089ec3 |
42 | sub add_required_methods { |
ea249879 |
43 | my($self, @methods) = @_; |
71e7b544 |
44 | my %required = map{ $_ => 1 } @{$self->{required_methods}}; |
45 | push @{$self->{required_methods}}, grep{ !$required{$_}++ && !$self->has_method($_) } @methods; |
46 | return; |
59089ec3 |
47 | } |
48 | |
6cfa1e5e |
49 | sub requires_method { |
50 | my($self, $name) = @_; |
51 | return scalar( grep{ $_ eq $name } @{ $self->{required_methods} } ) != 0; |
52 | } |
53 | |
274b6cce |
54 | sub add_attribute { |
55 | my $self = shift; |
56 | my $name = shift; |
6cfa1e5e |
57 | |
58 | $self->{attributes}->{$name} = (@_ == 1) ? $_[0] : { @_ }; |
da0c885d |
59 | } |
60 | |
3a63a2e7 |
61 | sub _check_required_methods{ |
71e7b544 |
62 | my($role, $applicant, $args) = @_; |
3a63a2e7 |
63 | |
71e7b544 |
64 | if($args->{_to} eq 'role'){ |
65 | $applicant->add_required_methods($role->get_required_method_list); |
66 | } |
67 | else{ # to class or instance |
2d2e77f9 |
68 | my $applicant_class_name = $applicant->name; |
69 | |
7a50b450 |
70 | my @missing; |
3a63a2e7 |
71 | foreach my $method_name(@{$role->{required_methods}}){ |
2d2e77f9 |
72 | next if exists $args->{aliased_methods}{$method_name}; |
73 | next if exists $role->{methods}{$method_name}; |
74 | next if $applicant_class_name->can($method_name); |
75 | |
76 | push @missing, $method_name; |
3a63a2e7 |
77 | } |
7a50b450 |
78 | if(@missing){ |
2d2e77f9 |
79 | $role->throw_error(sprintf "'%s' requires the method%s %s to be implemented by '%s'", |
80 | $role->name, |
81 | (@missing == 1 ? '' : 's'), # method or methods |
82 | english_list(map{ sprintf q{'%s'}, $_ } @missing), |
83 | $applicant_class_name); |
7a50b450 |
84 | } |
85 | } |
2e92bb89 |
86 | |
3a63a2e7 |
87 | return; |
2e92bb89 |
88 | } |
89 | |
3a63a2e7 |
90 | sub _apply_methods{ |
71e7b544 |
91 | my($role, $applicant, $args) = @_; |
da0c885d |
92 | |
7a50b450 |
93 | my $alias = $args->{-alias}; |
94 | my $excludes = $args->{-excludes}; |
e0b163e1 |
95 | |
3a63a2e7 |
96 | foreach my $method_name($role->get_method_list){ |
97 | next if $method_name eq 'meta'; |
98 | |
71e7b544 |
99 | my $code = $role->get_method_body($method_name); |
6cfa1e5e |
100 | |
2d2e77f9 |
101 | if(!exists $excludes->{$method_name}){ |
71e7b544 |
102 | if(!$applicant->has_method($method_name)){ |
2d2e77f9 |
103 | # The third argument $role is used in Role::Composite |
71e7b544 |
104 | $applicant->add_method($method_name => $code, $role); |
6cfa1e5e |
105 | } |
2e92bb89 |
106 | } |
2e92bb89 |
107 | |
2d2e77f9 |
108 | if(exists $alias->{$method_name}){ |
3a63a2e7 |
109 | my $dstname = $alias->{$method_name}; |
6cfa1e5e |
110 | |
71e7b544 |
111 | my $dstcode = $applicant->get_method_body($dstname); |
7a50b450 |
112 | |
113 | if(defined($dstcode) && $dstcode != $code){ |
71e7b544 |
114 | $role->throw_error("Cannot create a method alias if a local method of the same name exists"); |
21498b08 |
115 | } |
3a63a2e7 |
116 | else{ |
71e7b544 |
117 | $applicant->add_method($dstname => $code, $role); |
2e92bb89 |
118 | } |
59089ec3 |
119 | } |
120 | } |
121 | |
3a63a2e7 |
122 | return; |
123 | } |
124 | |
125 | sub _apply_attributes{ |
71e7b544 |
126 | my($role, $applicant, $args) = @_; |
3a63a2e7 |
127 | |
71e7b544 |
128 | for my $attr_name ($role->get_attribute_list) { |
129 | next if $applicant->has_attribute($attr_name); |
3a63a2e7 |
130 | |
71e7b544 |
131 | $applicant->add_attribute($attr_name => $role->get_attribute($attr_name)); |
da0c885d |
132 | } |
3a63a2e7 |
133 | return; |
134 | } |
135 | |
136 | sub _apply_modifiers{ |
71e7b544 |
137 | my($role, $applicant, $args) = @_; |
3a63a2e7 |
138 | |
2d2e77f9 |
139 | if(my $modifiers = $role->{override_method_modifiers}){ |
140 | foreach my $method_name (keys %{$modifiers}){ |
141 | $applicant->add_override_method_modifier($method_name => $modifiers->{$method_name}); |
142 | } |
143 | } |
144 | |
145 | for my $modifier_type (qw/before around after/) { |
71e7b544 |
146 | my $modifiers = $role->{"${modifier_type}_method_modifiers"} |
147 | or next; |
148 | |
3a63a2e7 |
149 | my $add_modifier = "add_${modifier_type}_method_modifier"; |
d99db7b6 |
150 | |
71e7b544 |
151 | foreach my $method_name (keys %{$modifiers}){ |
2d2e77f9 |
152 | foreach my $code(@{ $modifiers->{$method_name} }){ |
153 | next if $applicant->{"_applied_$modifier_type"}{$method_name, $code}++; # skip applied modifiers |
71e7b544 |
154 | $applicant->$add_modifier($method_name => $code); |
d99db7b6 |
155 | } |
156 | } |
157 | } |
3a63a2e7 |
158 | return; |
da0c885d |
159 | } |
0fc8adbc |
160 | |
3a63a2e7 |
161 | sub _append_roles{ |
71e7b544 |
162 | my($role, $applicant, $args) = @_; |
21498b08 |
163 | |
71e7b544 |
164 | my $roles = ($args->{_to} eq 'role') ? $applicant->get_roles : $applicant->roles; |
3a63a2e7 |
165 | |
166 | foreach my $r($role, @{$role->get_roles}){ |
71e7b544 |
167 | if(!$applicant->does_role($r->name)){ |
3a63a2e7 |
168 | push @{$roles}, $r; |
21498b08 |
169 | } |
170 | } |
3a63a2e7 |
171 | return; |
172 | } |
21498b08 |
173 | |
3a63a2e7 |
174 | # Moose uses Application::ToInstance, Application::ToClass, Application::ToRole |
175 | sub apply { |
7a50b450 |
176 | my $self = shift; |
177 | my $applicant = shift; |
7a50b450 |
178 | |
71e7b544 |
179 | my %args = (@_ == 1) ? %{ $_[0] } : @_; |
60b5c3be |
180 | |
71e7b544 |
181 | if($applicant->isa('Mouse::Meta::Class')){ # Application::ToClass |
182 | $args{_to} = 'class'; |
183 | } |
184 | elsif($applicant->isa('Mouse::Meta::Role')){ # Application::ToRole |
185 | $args{_to} = 'role'; |
186 | } |
187 | else{ # Appplication::ToInstance |
188 | $args{_to} = 'instance'; |
60b5c3be |
189 | |
71e7b544 |
190 | my $metaclass = $applicant->meta->create_anon_class( |
191 | superclasses => [ref $applicant], |
192 | cache => 1, |
193 | ); |
194 | bless $applicant, $metaclass->name; # rebless |
60b5c3be |
195 | |
71e7b544 |
196 | $applicant = $metaclass; |
197 | } |
60b5c3be |
198 | |
71e7b544 |
199 | if($args{alias} && !exists $args{-alias}){ |
200 | $args{-alias} = $args{alias}; |
201 | } |
202 | if($args{excludes} && !exists $args{-excludes}){ |
203 | $args{-excludes} = $args{excludes}; |
204 | } |
60b5c3be |
205 | |
2d2e77f9 |
206 | $args{aliased_methods} = {}; |
71e7b544 |
207 | if(my $alias = $args{-alias}){ |
2d2e77f9 |
208 | @{$args{aliased_methods}}{ values %{$alias} } = (); |
60b5c3be |
209 | } |
71e7b544 |
210 | |
211 | if(my $excludes = $args{-excludes}){ |
212 | $args{-excludes} = {}; # replace with a hash ref |
213 | if(ref $excludes){ |
214 | %{$args{-excludes}} = (map{ $_ => undef } @{$excludes}); |
60b5c3be |
215 | } |
216 | else{ |
71e7b544 |
217 | $args{-excludes}{$excludes} = undef; |
60b5c3be |
218 | } |
219 | } |
220 | |
71e7b544 |
221 | $self->_check_required_methods($applicant, \%args); |
222 | $self->_apply_attributes($applicant, \%args); |
223 | $self->_apply_methods($applicant, \%args); |
224 | $self->_apply_modifiers($applicant, \%args); |
225 | $self->_append_roles($applicant, \%args); |
226 | return; |
227 | } |
228 | |
21498b08 |
229 | |
71e7b544 |
230 | sub combine { |
231 | my($role_class, @role_specs) = @_; |
21498b08 |
232 | |
71e7b544 |
233 | require 'Mouse/Meta/Role/Composite.pm'; # we don't want to create its namespace |
7a50b450 |
234 | |
71e7b544 |
235 | my $composite = Mouse::Meta::Role::Composite->create_anon_role(); |
236 | |
237 | foreach my $role_spec (@role_specs) { |
238 | my($role_name, $args) = @{$role_spec}; |
239 | $role_name->meta->apply($composite, %{$args}); |
21498b08 |
240 | } |
71e7b544 |
241 | return $composite; |
21498b08 |
242 | } |
243 | |
6cfa1e5e |
244 | for my $modifier_type (qw/before after around/) { |
3a63a2e7 |
245 | |
246 | my $modifier = "${modifier_type}_method_modifiers"; |
247 | my $add_method_modifier = sub { |
fc0e0bbd |
248 | my ($self, $method_name, $method) = @_; |
249 | |
3a63a2e7 |
250 | push @{ $self->{$modifier}->{$method_name} ||= [] }, $method; |
251 | return; |
fc0e0bbd |
252 | }; |
3370794f |
253 | my $has_method_modifiers = sub{ |
254 | my($self, $method_name) = @_; |
255 | my $m = $self->{$modifier}->{$method_name}; |
256 | return $m && @{$m} != 0; |
257 | }; |
3a63a2e7 |
258 | my $get_method_modifiers = sub { |
259 | my ($self, $method_name) = @_; |
260 | return @{ $self->{$modifier}->{$method_name} ||= [] } |
c2f128e7 |
261 | }; |
c2f128e7 |
262 | |
3a63a2e7 |
263 | no strict 'refs'; |
264 | *{ 'add_' . $modifier_type . '_method_modifier' } = $add_method_modifier; |
3370794f |
265 | *{ 'has_' . $modifier_type . '_method_modifiers' } = $has_method_modifiers; |
3a63a2e7 |
266 | *{ 'get_' . $modifier_type . '_method_modifiers' } = $get_method_modifiers; |
267 | } |
47f36c05 |
268 | |
6cfa1e5e |
269 | sub add_override_method_modifier{ |
270 | my($self, $method_name, $method) = @_; |
271 | |
60b5c3be |
272 | if($self->has_method($method_name)){ |
273 | # This error happens in the override keyword or during role composition, |
274 | # so I added a message, "A local method of ...", only for compatibility (gfx) |
8e64d0fa |
275 | $self->throw_error("Cannot add an override of method '$method_name' " |
60b5c3be |
276 | . "because there is a local version of '$method_name'" |
277 | . "(A local method of the same name as been found)"); |
278 | } |
6cfa1e5e |
279 | |
280 | $self->{override_method_modifiers}->{$method_name} = $method; |
281 | } |
282 | |
8e64d0fa |
283 | sub has_override_method_modifier { |
284 | my ($self, $method_name) = @_; |
285 | return exists $self->{override_method_modifiers}->{$method_name}; |
286 | } |
287 | |
288 | sub get_override_method_modifier { |
289 | my ($self, $method_name) = @_; |
290 | return $self->{override_method_modifiers}->{$method_name}; |
6cfa1e5e |
291 | } |
292 | |
293 | sub get_method_modifier_list { |
294 | my($self, $modifier_type) = @_; |
295 | |
296 | return keys %{ $self->{$modifier_type . '_method_modifiers'} }; |
297 | } |
298 | |
67199842 |
299 | # This is currently not passing all the Moose tests. |
300 | sub does_role { |
301 | my ($self, $role_name) = @_; |
302 | |
303 | (defined $role_name) |
fce211ae |
304 | || $self->throw_error("You must supply a role name to look for"); |
67199842 |
305 | |
306 | # if we are it,.. then return true |
307 | return 1 if $role_name eq $self->name; |
3a63a2e7 |
308 | # otherwise.. check our children |
309 | for my $role (@{ $self->get_roles }) { |
67199842 |
310 | return 1 if $role->does_role($role_name); |
311 | } |
312 | return 0; |
313 | } |
314 | |
315 | |
a2227e71 |
316 | 1; |
317 | |
1820fffe |
318 | __END__ |
319 | |
320 | =head1 NAME |
321 | |
322 | Mouse::Meta::Role - The Mouse Role metaclass |
323 | |
324 | =head1 SEE ALSO |
325 | |
326 | L<Moose::Meta::Role> |
327 | |
328 | =cut |