Commit | Line | Data |
963a69a5 |
1 | package Class::Accessor::Grouped; |
2 | use strict; |
3 | use warnings; |
a0bce8bc |
4 | use Carp (); |
331e820d |
5 | use Class::Inspector (); |
a0bce8bc |
6 | use Scalar::Util (); |
8787799c |
7 | use MRO::Compat; |
331e820d |
8 | |
826625b0 |
9 | our $VERSION = '0.08003'; |
963a69a5 |
10 | |
11 | =head1 NAME |
12 | |
1ad8d8c6 |
13 | Class::Accessor::Grouped - Lets you build groups of accessors |
963a69a5 |
14 | |
15 | =head1 SYNOPSIS |
16 | |
17 | =head1 DESCRIPTION |
18 | |
19 | This class lets you build groups of accessors that will call different |
20 | getters and setters. |
21 | |
22 | =head1 METHODS |
23 | |
24 | =head2 mk_group_accessors |
25 | |
26 | =over 4 |
27 | |
28 | =item Arguments: $group, @fieldspec |
29 | |
30 | Returns: none |
31 | |
32 | =back |
33 | |
34 | Creates a set of accessors in a given group. |
35 | |
36 | $group is the name of the accessor group for the generated accessors; they |
37 | will call get_$group($field) on get and set_$group($field, $value) on set. |
38 | |
22fa6720 |
39 | If you want to mimic Class::Accessor's mk_accessors $group has to be 'simple' |
40 | to tell Class::Accessor::Grouped to use its own get_simple and set_simple |
41 | methods. |
42 | |
963a69a5 |
43 | @fieldspec is a list of field/accessor names; if a fieldspec is a scalar |
44 | this is used as both field and accessor name, if a listref it is expected to |
45 | be of the form [ $accessor, $field ]. |
46 | |
47 | =cut |
48 | |
49 | sub mk_group_accessors { |
50 | my ($self, $group, @fields) = @_; |
51 | |
52 | $self->_mk_group_accessors('make_group_accessor', $group, @fields); |
53 | return; |
54 | } |
55 | |
56 | |
57 | { |
58 | no strict 'refs'; |
59 | no warnings 'redefine'; |
60 | |
61 | sub _mk_group_accessors { |
62 | my($self, $maker, $group, @fields) = @_; |
a0bce8bc |
63 | my $class = Scalar::Util::blessed $self || $self; |
963a69a5 |
64 | |
65 | # So we don't have to do lots of lookups inside the loop. |
66 | $maker = $self->can($maker) unless ref $maker; |
67 | |
68 | foreach my $field (@fields) { |
69 | if( $field eq 'DESTROY' ) { |
a0bce8bc |
70 | Carp::carp("Having a data accessor named DESTROY in ". |
963a69a5 |
71 | "'$class' is unwise."); |
72 | } |
73 | |
74 | my $name = $field; |
75 | |
76 | ($name, $field) = @$field if ref $field; |
77 | |
78 | my $accessor = $self->$maker($group, $field); |
79 | my $alias = "_${name}_accessor"; |
80 | |
963a69a5 |
81 | *{$class."\:\:$name"} = $accessor; |
82 | #unless defined &{$class."\:\:$field"} |
83 | |
84 | *{$class."\:\:$alias"} = $accessor; |
85 | #unless defined &{$class."\:\:$alias"} |
86 | } |
87 | } |
88 | } |
89 | |
90 | =head2 mk_group_ro_accessors |
91 | |
92 | =over 4 |
93 | |
94 | =item Arguments: $group, @fieldspec |
95 | |
96 | Returns: none |
97 | |
98 | =back |
99 | |
100 | Creates a set of read only accessors in a given group. Identical to |
101 | <L:/mk_group_accessors> but accessors will throw an error if passed a value |
102 | rather than setting the value. |
103 | |
104 | =cut |
105 | |
106 | sub mk_group_ro_accessors { |
107 | my($self, $group, @fields) = @_; |
108 | |
109 | $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); |
110 | } |
111 | |
112 | =head2 mk_group_wo_accessors |
113 | |
114 | =over 4 |
115 | |
116 | =item Arguments: $group, @fieldspec |
117 | |
118 | Returns: none |
119 | |
120 | =back |
121 | |
122 | Creates a set of write only accessors in a given group. Identical to |
123 | <L:/mk_group_accessors> but accessors will throw an error if not passed a |
124 | value rather than getting the value. |
125 | |
126 | =cut |
127 | |
128 | sub mk_group_wo_accessors { |
129 | my($self, $group, @fields) = @_; |
130 | |
131 | $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); |
132 | } |
133 | |
134 | =head2 make_group_accessor |
135 | |
136 | =over 4 |
137 | |
138 | =item Arguments: $group, $field |
139 | |
140 | Returns: $sub (\CODE) |
141 | |
142 | =back |
143 | |
144 | Returns a single accessor in a given group; called by mk_group_accessors |
145 | for each entry in @fieldspec. |
146 | |
147 | =cut |
148 | |
149 | sub make_group_accessor { |
150 | my ($class, $group, $field) = @_; |
151 | |
152 | my $set = "set_$group"; |
153 | my $get = "get_$group"; |
154 | |
a0bce8bc |
155 | # eval for faster fastiness |
156 | return eval "sub { |
157 | if(\@_ > 1) { |
158 | return shift->$set('$field', \@_); |
963a69a5 |
159 | } |
160 | else { |
a0bce8bc |
161 | return shift->$get('$field'); |
963a69a5 |
162 | } |
a0bce8bc |
163 | };" |
963a69a5 |
164 | } |
165 | |
166 | =head2 make_group_ro_accessor |
167 | |
168 | =over 4 |
169 | |
170 | =item Arguments: $group, $field |
171 | |
172 | Returns: $sub (\CODE) |
173 | |
174 | =back |
175 | |
176 | Returns a single read-only accessor in a given group; called by |
177 | mk_group_ro_accessors for each entry in @fieldspec. |
178 | |
179 | =cut |
180 | |
181 | sub make_group_ro_accessor { |
182 | my($class, $group, $field) = @_; |
183 | |
184 | my $get = "get_$group"; |
185 | |
a0bce8bc |
186 | return eval "sub { |
187 | if(\@_ > 1) { |
188 | my \$caller = caller; |
189 | Carp::croak(\"'\$caller' cannot alter the value of '$field' on \". |
190 | \"objects of class '$class'\"); |
963a69a5 |
191 | } |
192 | else { |
a0bce8bc |
193 | return shift->$get('$field'); |
963a69a5 |
194 | } |
a0bce8bc |
195 | };" |
963a69a5 |
196 | } |
197 | |
198 | =head2 make_group_wo_accessor |
199 | |
200 | =over 4 |
201 | |
202 | =item Arguments: $group, $field |
203 | |
204 | Returns: $sub (\CODE) |
205 | |
206 | =back |
207 | |
208 | Returns a single write-only accessor in a given group; called by |
209 | mk_group_wo_accessors for each entry in @fieldspec. |
210 | |
211 | =cut |
212 | |
213 | sub make_group_wo_accessor { |
214 | my($class, $group, $field) = @_; |
215 | |
216 | my $set = "set_$group"; |
217 | |
a0bce8bc |
218 | return eval "sub { |
219 | unless (\@_ > 1) { |
220 | my \$caller = caller; |
221 | Carp::croak(\"'\$caller' cannot access the value of '$field' on \". |
222 | \"objects of class '$class'\"); |
963a69a5 |
223 | } |
224 | else { |
a0bce8bc |
225 | return shift->$set('$field', \@_); |
963a69a5 |
226 | } |
a0bce8bc |
227 | };" |
963a69a5 |
228 | } |
229 | |
230 | =head2 get_simple |
231 | |
232 | =over 4 |
233 | |
234 | =item Arguments: $field |
235 | |
236 | Returns: $value |
237 | |
238 | =back |
239 | |
240 | Simple getter for hash-based objects which returns the value for the field |
241 | name passed as an argument. |
242 | |
243 | =cut |
244 | |
245 | sub get_simple { |
a0bce8bc |
246 | return $_[0]->{$_[1]}; |
963a69a5 |
247 | } |
248 | |
249 | =head2 set_simple |
250 | |
251 | =over 4 |
252 | |
253 | =item Arguments: $field, $new_value |
254 | |
255 | Returns: $new_value |
256 | |
257 | =back |
258 | |
259 | Simple setter for hash-based objects which sets and then returns the value |
260 | for the field name passed as an argument. |
261 | |
262 | =cut |
263 | |
264 | sub set_simple { |
a0bce8bc |
265 | return $_[0]->{$_[1]} = $_[2]; |
963a69a5 |
266 | } |
267 | |
e6f2a0fd |
268 | |
269 | =head2 get_inherited |
270 | |
271 | =over 4 |
272 | |
273 | =item Arguments: $field |
274 | |
275 | Returns: $value |
276 | |
277 | =back |
278 | |
331e820d |
279 | Simple getter for Classes and hash-based objects which returns the value for |
280 | the field name passed as an argument. This behaves much like |
281 | L<Class::Data::Accessor> where the field can be set in a base class, |
282 | inherited and changed in subclasses, and inherited and changed for object |
283 | instances. |
e6f2a0fd |
284 | |
285 | =cut |
286 | |
287 | sub get_inherited { |
a49c32d9 |
288 | my $class; |
e6f2a0fd |
289 | |
a0bce8bc |
290 | if (Scalar::Util::blessed $_[0]) { |
291 | my $reftype = Scalar::Util::reftype $_[0]; |
292 | $class = ref $_[0]; |
a49c32d9 |
293 | |
a0bce8bc |
294 | if ($reftype eq 'HASH' && exists $_[0]->{$_[1]}) { |
295 | return $_[0]->{$_[1]}; |
a49c32d9 |
296 | } elsif ($reftype ne 'HASH') { |
a0bce8bc |
297 | Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); |
e6f2a0fd |
298 | }; |
a49c32d9 |
299 | } else { |
a0bce8bc |
300 | $class = $_[0]; |
e6f2a0fd |
301 | }; |
302 | |
303 | no strict 'refs'; |
fe63d727 |
304 | no warnings qw/uninitialized/; |
a0bce8bc |
305 | return ${$class.'::__cag_'.$_[1]} if defined(${$class.'::__cag_'.$_[1]}); |
e6f2a0fd |
306 | |
4f8ce9da |
307 | # we need to be smarter about recalculation, as @ISA (thus supers) can very well change in-flight |
308 | my $pkg_gen = mro::get_pkg_gen ($class); |
fe63d727 |
309 | if ( ${$class.'::__cag_pkg_gen'} != $pkg_gen ) { |
a0bce8bc |
310 | @{$class.'::__cag_supers'} = $_[0]->get_super_paths; |
4f8ce9da |
311 | ${$class.'::__cag_pkg_gen'} = $pkg_gen; |
a49c32d9 |
312 | }; |
313 | |
314 | foreach (@{$class.'::__cag_supers'}) { |
a0bce8bc |
315 | return ${$_.'::__cag_'.$_[1]} if defined(${$_.'::__cag_'.$_[1]}); |
e6f2a0fd |
316 | }; |
c46050d3 |
317 | |
9c3d5179 |
318 | return undef; |
e6f2a0fd |
319 | } |
320 | |
321 | =head2 set_inherited |
322 | |
323 | =over 4 |
324 | |
325 | =item Arguments: $field, $new_value |
326 | |
327 | Returns: $new_value |
328 | |
329 | =back |
330 | |
331e820d |
331 | Simple setter for Classes and hash-based objects which sets and then returns |
332 | the value for the field name passed as an argument. When called on a hash-based |
333 | object it will set the appropriate hash key value. When called on a class, it |
334 | will set a class level variable. |
e6f2a0fd |
335 | |
331e820d |
336 | B<Note:>: This method will die if you try to set an object variable on a non |
337 | hash-based object. |
e6f2a0fd |
338 | |
339 | =cut |
340 | |
341 | sub set_inherited { |
a0bce8bc |
342 | if (Scalar::Util::blessed $_[0]) { |
343 | if (Scalar::Util::reftype $_[0] eq 'HASH') { |
344 | return $_[0]->{$_[1]} = $_[2]; |
e6f2a0fd |
345 | } else { |
a0bce8bc |
346 | Carp::croak('Cannot set inherited value on an object instance that is not hash-based'); |
e6f2a0fd |
347 | }; |
348 | } else { |
349 | no strict 'refs'; |
350 | |
a0bce8bc |
351 | return ${$_[0].'::__cag_'.$_[1]} = $_[2]; |
e6f2a0fd |
352 | }; |
353 | } |
354 | |
331e820d |
355 | =head2 get_component_class |
356 | |
357 | =over 4 |
358 | |
359 | =item Arguments: $field |
360 | |
361 | Returns: $value |
362 | |
363 | =back |
364 | |
365 | Gets the value of the specified component class. |
366 | |
367 | __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); |
97d76fb4 |
368 | |
331e820d |
369 | $self->result_class->method(); |
97d76fb4 |
370 | |
331e820d |
371 | ## same as |
372 | $self->get_component_class('result_class')->method(); |
373 | |
374 | =cut |
375 | |
376 | sub get_component_class { |
a0bce8bc |
377 | return $_[0]->get_inherited($_[1]); |
331e820d |
378 | }; |
379 | |
380 | =head2 set_component_class |
381 | |
382 | =over 4 |
383 | |
384 | =item Arguments: $field, $class |
385 | |
386 | Returns: $new_value |
387 | |
388 | =back |
389 | |
390 | Inherited accessor that automatically loads the specified class before setting |
391 | it. This method will die if the specified class could not be loaded. |
392 | |
393 | __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); |
394 | __PACKAGE__->result_class('MyClass'); |
97d76fb4 |
395 | |
331e820d |
396 | $self->result_class->method(); |
397 | |
398 | =cut |
399 | |
400 | sub set_component_class { |
a0bce8bc |
401 | if ($_[2]) { |
bce7bdf8 |
402 | local $^W = 0; |
a0bce8bc |
403 | if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) { |
404 | eval "use $_[2]"; |
331e820d |
405 | |
a0bce8bc |
406 | Carp::croak("Could not load $_[1] '$_[2]': ", $@) if $@; |
331e820d |
407 | }; |
408 | }; |
409 | |
a0bce8bc |
410 | return $_[0]->set_inherited($_[1], $_[2]); |
331e820d |
411 | }; |
412 | |
a49c32d9 |
413 | =head2 get_super_paths |
414 | |
415 | Returns a list of 'parent' or 'super' class names that the current class inherited from. |
416 | |
417 | =cut |
418 | |
419 | sub get_super_paths { |
a0bce8bc |
420 | my $class = Scalar::Util::blessed $_[0] || $_[0]; |
a49c32d9 |
421 | |
8787799c |
422 | return @{mro::get_linear_isa($class)}; |
a49c32d9 |
423 | }; |
424 | |
963a69a5 |
425 | 1; |
426 | |
427 | =head1 AUTHORS |
428 | |
429 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
97972dcb |
430 | Christopher H. Laco <claco@chrislaco.com> |
963a69a5 |
431 | |
432 | =head1 LICENSE |
433 | |
434 | You may distribute this code under the same terms as Perl itself. |
435 | |
436 | =cut |
437 | |