Commit | Line | Data |
fb1e11d5 |
1 | package Moose::Meta::Role::Application::ToClass; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | use metaclass; |
6 | |
d939e016 |
7 | use Moose::Util 'english_list'; |
154a4aae |
8 | use Scalar::Util 'weaken', 'blessed'; |
fb1e11d5 |
9 | |
fb1e11d5 |
10 | use base 'Moose::Meta::Role::Application'; |
11 | |
ff9c4953 |
12 | __PACKAGE__->meta->add_attribute('role' => ( |
13 | reader => 'role', |
dc2b7cc8 |
14 | Class::MOP::_definition_context(), |
ff9c4953 |
15 | )); |
16 | |
17 | __PACKAGE__->meta->add_attribute('class' => ( |
17c594b1 |
18 | accessor => 'class', |
dc2b7cc8 |
19 | Class::MOP::_definition_context(), |
ff9c4953 |
20 | )); |
21 | |
1c9db35c |
22 | sub apply { |
d03bd989 |
23 | my ($self, $role, $class) = @_; |
ff9c4953 |
24 | |
154a4aae |
25 | # We need weak_ref in CMOP :( |
26 | weaken($self->{role} = $role); |
27 | weaken($self->{class} = $class); |
ff9c4953 |
28 | |
1c9db35c |
29 | $self->SUPER::apply($role, $class); |
a9b63d79 |
30 | |
d03bd989 |
31 | $class->add_role($role); |
a9b63d79 |
32 | $class->add_role_application($self); |
1c9db35c |
33 | } |
34 | |
35 | sub check_role_exclusions { |
36 | my ($self, $role, $class) = @_; |
37 | if ($class->excludes_role($role->name)) { |
4c0b3599 |
38 | $class->throw_error("Conflict detected: " . $class->name . " excludes role '" . $role->name . "'"); |
1c9db35c |
39 | } |
40 | foreach my $excluded_role_name ($role->get_excluded_roles_list) { |
41 | if ($class->does_role($excluded_role_name)) { |
4c0b3599 |
42 | $class->throw_error("The class " . $class->name . " does the excluded role '$excluded_role_name'"); |
1c9db35c |
43 | } |
44 | } |
45 | } |
46 | |
47 | sub check_required_methods { |
48 | my ($self, $role, $class) = @_; |
d939e016 |
49 | |
50 | my @missing; |
51 | my @is_attr; |
52 | |
1c9db35c |
53 | # NOTE: |
54 | # we might need to move this down below the |
55 | # the attributes so that we can require any |
56 | # attribute accessors. However I am thinking |
57 | # that maybe those are somehow exempt from |
58 | # the require methods stuff. |
92b7f727 |
59 | foreach my $required_method ($role->get_required_method_list) { |
60 | my $required_method_name = $required_method->name; |
1c9db35c |
61 | |
3e19778d |
62 | if (!$class->find_method_by_name($required_method_name)) { |
d03bd989 |
63 | |
3e19778d |
64 | next if $self->is_aliased_method($required_method_name); |
d939e016 |
65 | |
92b7f727 |
66 | push @missing, $required_method; |
1c9db35c |
67 | } |
1c9db35c |
68 | } |
d939e016 |
69 | |
f3e76c8f |
70 | return unless @missing; |
d939e016 |
71 | |
72 | my $error = ''; |
73 | |
bb365545 |
74 | @missing = sort { $a->name cmp $b->name } @missing; |
16d7dc8d |
75 | my @conflicts = grep { $_->isa('Moose::Meta::Role::Method::Conflicting') } @missing; |
884837f3 |
76 | |
77 | if (@conflicts) { |
78 | my $conflict = $conflicts[0]; |
e893345e |
79 | my $roles = $conflict->roles_as_english_list; |
80 | |
81 | my @same_role_conflicts = grep { $_->roles_as_english_list eq $roles } @conflicts; |
82 | |
83 | if (@same_role_conflicts == 1) { |
84 | $error |
85 | .= "Due to a method name conflict in roles " |
86 | . $roles |
87 | . ", the method '" |
88 | . $conflict->name |
89 | . "' must be implemented or excluded by '" |
90 | . $class->name |
91 | . q{'}; |
92 | } |
93 | else { |
94 | my $methods |
95 | = Moose::Util::english_list( map { q{'} . $_->name . q{'} } @same_role_conflicts ); |
96 | |
97 | $error |
98 | .= "Due to method name conflicts in roles " |
99 | . $roles |
100 | . ", the methods " |
101 | . $methods |
102 | . " must be implemented or excluded by '" |
103 | . $class->name |
104 | . q{'}; |
105 | } |
884837f3 |
106 | } |
107 | elsif (@missing) { |
d939e016 |
108 | my $noun = @missing == 1 ? 'method' : 'methods'; |
109 | |
110 | my $list |
111 | = Moose::Util::english_list( map { q{'} . $_ . q{'} } @missing ); |
112 | |
113 | $error |
114 | .= q{'} |
115 | . $role->name |
116 | . "' requires the $noun $list " |
117 | . "to be implemented by '" |
118 | . $class->name . q{'}; |
119 | } |
120 | |
d939e016 |
121 | $class->throw_error($error); |
1c9db35c |
122 | } |
123 | |
709c321c |
124 | sub check_required_attributes { |
d03bd989 |
125 | |
709c321c |
126 | } |
127 | |
1c9db35c |
128 | sub apply_attributes { |
129 | my ($self, $role, $class) = @_; |
f785aad8 |
130 | |
1c9db35c |
131 | foreach my $attribute_name ($role->get_attribute_list) { |
132 | # it if it has one already |
133 | if ($class->has_attribute($attribute_name) && |
134 | # make sure we haven't seen this one already too |
135 | $class->get_attribute($attribute_name) != $role->get_attribute($attribute_name)) { |
136 | next; |
137 | } |
138 | else { |
d7d8a8c7 |
139 | $class->add_attribute( |
3cfeb291 |
140 | $role->get_attribute($attribute_name)->attribute_for_class |
d7d8a8c7 |
141 | ); |
1c9db35c |
142 | } |
143 | } |
144 | } |
145 | |
146 | sub apply_methods { |
4a9e8ff6 |
147 | my ( $self, $role, $class ) = @_; |
148 | |
149 | foreach my $method ( $role->_get_local_methods ) { |
150 | my $method_name = $method->name; |
151 | |
ba7d613d |
152 | next if $method->isa('Class::MOP::Method::Meta'); |
d03bd989 |
153 | |
4a9e8ff6 |
154 | unless ( $self->is_method_excluded($method_name) ) { |
155 | |
156 | my $class_method = $class->get_method($method_name); |
157 | |
158 | next if $class_method && $class_method->body != $method->body; |
d03bd989 |
159 | |
87e63626 |
160 | $class->add_method( |
4a9e8ff6 |
161 | $method_name, |
162 | $method, |
163 | ); |
164 | } |
165 | |
166 | next unless $self->is_method_aliased($method_name); |
167 | |
168 | my $aliased_method_name = $self->get_method_aliases->{$method_name}; |
169 | |
170 | my $class_method = $class->get_method($aliased_method_name); |
171 | |
172 | if ( $class_method && $class_method->body != $method->body ) { |
173 | $class->throw_error( |
174 | "Cannot create a method alias if a local method of the same name exists" |
d03bd989 |
175 | ); |
176 | } |
4a9e8ff6 |
177 | |
178 | $class->add_method( |
179 | $aliased_method_name, |
180 | $method, |
181 | ); |
1c9db35c |
182 | } |
4a9e8ff6 |
183 | |
1c9db35c |
184 | # we must reset the cache here since |
185 | # we are just aliasing methods, otherwise |
186 | # the modifiers go wonky. |
d03bd989 |
187 | $class->reset_package_cache_flag; |
1c9db35c |
188 | } |
189 | |
190 | sub apply_override_method_modifiers { |
191 | my ($self, $role, $class) = @_; |
192 | foreach my $method_name ($role->get_method_modifier_list('override')) { |
193 | # it if it has one already then ... |
194 | if ($class->has_method($method_name)) { |
195 | next; |
196 | } |
197 | else { |
198 | # if this is not a role, then we need to |
199 | # find the original package of the method |
200 | # so that we can tell the class were to |
201 | # find the right super() method |
202 | my $method = $role->get_override_method_modifier($method_name); |
203 | my ($package) = Class::MOP::get_code_info($method); |
204 | # if it is a class, we just add it |
205 | $class->add_override_method_modifier($method_name, $method, $package); |
206 | } |
207 | } |
208 | } |
209 | |
210 | sub apply_method_modifiers { |
211 | my ($self, $modifier_type, $role, $class) = @_; |
212 | my $add = "add_${modifier_type}_method_modifier"; |
213 | my $get = "get_${modifier_type}_method_modifiers"; |
214 | foreach my $method_name ($role->get_method_modifier_list($modifier_type)) { |
215 | $class->$add( |
216 | $method_name, |
217 | $_ |
218 | ) foreach $role->$get($method_name); |
219 | } |
220 | } |
221 | |
fb1e11d5 |
222 | 1; |
223 | |
ad46f524 |
224 | # ABSTRACT: Compose a role into a class |
225 | |
fb1e11d5 |
226 | __END__ |
227 | |
228 | =pod |
229 | |
fb1e11d5 |
230 | =head1 DESCRIPTION |
231 | |
232 | =head2 METHODS |
233 | |
234 | =over 4 |
235 | |
236 | =item B<new> |
237 | |
238 | =item B<meta> |
239 | |
1c9db35c |
240 | =item B<apply> |
241 | |
709c321c |
242 | =item B<check_role_exclusions> |
243 | |
1c9db35c |
244 | =item B<check_required_methods> |
245 | |
709c321c |
246 | =item B<check_required_attributes> |
1c9db35c |
247 | |
248 | =item B<apply_attributes> |
249 | |
250 | =item B<apply_methods> |
251 | |
252 | =item B<apply_method_modifiers> |
253 | |
1c9db35c |
254 | =item B<apply_override_method_modifiers> |
255 | |
fb1e11d5 |
256 | =back |
257 | |
258 | =head1 BUGS |
259 | |
d4048ef3 |
260 | See L<Moose/BUGS> for details on reporting bugs. |
fb1e11d5 |
261 | |
fb1e11d5 |
262 | =cut |
263 | |