Commit | Line | Data |
fcd84ca9 |
1 | |
2 | package Moose; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
1b55c340 |
7 | our $VERSION = '0.45'; |
d44714be |
8 | our $AUTHORITY = 'cpan:STEVAN'; |
fcd84ca9 |
9 | |
cc65ead0 |
10 | use Scalar::Util 'blessed', 'reftype'; |
c0b37457 |
11 | use Carp 'confess', 'croak', 'cluck'; |
fcd84ca9 |
12 | |
2d562421 |
13 | use Sub::Exporter; |
7f18097c |
14 | |
3f9e4b0a |
15 | use MRO::Compat; |
1b2aea39 |
16 | use Class::MOP 0.56; |
ef1d5f4b |
17 | |
c0e30cf5 |
18 | use Moose::Meta::Class; |
7415b2cb |
19 | use Moose::Meta::TypeConstraint; |
7c13858b |
20 | use Moose::Meta::TypeCoercion; |
78cd1d3b |
21 | use Moose::Meta::Attribute; |
ddd0ec20 |
22 | use Moose::Meta::Instance; |
c0e30cf5 |
23 | |
d67145ed |
24 | use Moose::Meta::Role; |
25 | |
fcd84ca9 |
26 | use Moose::Object; |
7415b2cb |
27 | use Moose::Util::TypeConstraints; |
d7d8a8c7 |
28 | use Moose::Util (); |
a15dff8d |
29 | |
a3c7e2fe |
30 | { |
be33e4f3 |
31 | my $CALLER; |
9bcfbab1 |
32 | |
33 | sub init_meta { |
34 | my ( $class, $base_class, $metaclass ) = @_; |
688fcdda |
35 | $base_class = 'Moose::Object' unless defined $base_class; |
36 | $metaclass = 'Moose::Meta::Class' unless defined $metaclass; |
9bcfbab1 |
37 | |
38 | confess |
97e11ef5 |
39 | "The Metaclass $metaclass must be a subclass of Moose::Meta::Class." |
40 | unless $metaclass->isa('Moose::Meta::Class'); |
a3c7e2fe |
41 | |
a3c7e2fe |
42 | # make a subtype for each Moose class |
3fef8ce8 |
43 | class_type($class) |
44 | unless find_type_constraint($class); |
a3c7e2fe |
45 | |
46 | my $meta; |
9bcfbab1 |
47 | if ( $class->can('meta') ) { |
fcec2383 |
48 | # NOTE: |
9bcfbab1 |
49 | # this is the case where the metaclass pragma |
50 | # was used before the 'use Moose' statement to |
fcec2383 |
51 | # override a specific class |
a3c7e2fe |
52 | $meta = $class->meta(); |
9bcfbab1 |
53 | ( blessed($meta) && $meta->isa('Moose::Meta::Class') ) |
1edfdf1c |
54 | || confess "You already have a &meta function, but it does not return a Moose::Meta::Class"; |
a3c7e2fe |
55 | } |
56 | else { |
fcec2383 |
57 | # NOTE: |
9bcfbab1 |
58 | # this is broken currently, we actually need |
59 | # to allow the possiblity of an inherited |
60 | # meta, which will not be visible until the |
61 | # user 'extends' first. This needs to have |
62 | # more intelligence to it |
63 | $meta = $metaclass->initialize($class); |
64 | $meta->add_method( |
65 | 'meta' => sub { |
9bcfbab1 |
66 | # re-initialize so it inherits properly |
67 | $metaclass->initialize( blessed( $_[0] ) || $_[0] ); |
68 | } |
69 | ); |
a3c7e2fe |
70 | } |
71 | |
72 | # make sure they inherit from Moose::Object |
72bbc189 |
73 | $meta->superclasses($base_class) |
9bcfbab1 |
74 | unless $meta->superclasses(); |
688fcdda |
75 | |
76 | return $meta; |
a3c7e2fe |
77 | } |
78 | |
79 | my %exports = ( |
80 | extends => sub { |
be33e4f3 |
81 | my $class = $CALLER; |
1b2aea39 |
82 | return Class::MOP::subname('Moose::extends' => sub (@) { |
68117c45 |
83 | confess "Must derive at least one class" unless @_; |
9c10b5ad |
84 | |
85 | my @supers = @_; |
86 | foreach my $super (@supers) { |
87 | Class::MOP::load_class($super); |
88 | } |
9bcfbab1 |
89 | |
90 | # this checks the metaclass to make sure |
91 | # it is correct, sometimes it can get out |
1341f10c |
92 | # of sync when the classes are being built |
9c10b5ad |
93 | my $meta = $class->meta->_fix_metaclass_incompatability(@supers); |
94 | $meta->superclasses(@supers); |
1b2aea39 |
95 | }); |
a3c7e2fe |
96 | }, |
97 | with => sub { |
be33e4f3 |
98 | my $class = $CALLER; |
1b2aea39 |
99 | return Class::MOP::subname('Moose::with' => sub (@) { |
d7d8a8c7 |
100 | Moose::Util::apply_all_roles($class->meta, @_) |
1b2aea39 |
101 | }); |
a3c7e2fe |
102 | }, |
103 | has => sub { |
be33e4f3 |
104 | my $class = $CALLER; |
1b2aea39 |
105 | return Class::MOP::subname('Moose::has' => sub ($;%) { |
a28fe77b |
106 | my $name = shift; |
547dda77 |
107 | croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1; |
a28fe77b |
108 | my %options = @_; |
9bcfbab1 |
109 | my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; |
d7d8a8c7 |
110 | $class->meta->add_attribute( $_, %options ) for @$attrs; |
1b2aea39 |
111 | }); |
a3c7e2fe |
112 | }, |
113 | before => sub { |
be33e4f3 |
114 | my $class = $CALLER; |
1b2aea39 |
115 | return Class::MOP::subname('Moose::before' => sub (@&) { |
a3c7e2fe |
116 | my $code = pop @_; |
be33e4f3 |
117 | my $meta = $class->meta; |
9bcfbab1 |
118 | $meta->add_before_method_modifier( $_, $code ) for @_; |
1b2aea39 |
119 | }); |
a3c7e2fe |
120 | }, |
121 | after => sub { |
be33e4f3 |
122 | my $class = $CALLER; |
1b2aea39 |
123 | return Class::MOP::subname('Moose::after' => sub (@&) { |
a3c7e2fe |
124 | my $code = pop @_; |
be33e4f3 |
125 | my $meta = $class->meta; |
9bcfbab1 |
126 | $meta->add_after_method_modifier( $_, $code ) for @_; |
1b2aea39 |
127 | }); |
a3c7e2fe |
128 | }, |
129 | around => sub { |
9bcfbab1 |
130 | my $class = $CALLER; |
1b2aea39 |
131 | return Class::MOP::subname('Moose::around' => sub (@&) { |
a3c7e2fe |
132 | my $code = pop @_; |
be33e4f3 |
133 | my $meta = $class->meta; |
9bcfbab1 |
134 | $meta->add_around_method_modifier( $_, $code ) for @_; |
1b2aea39 |
135 | }); |
a3c7e2fe |
136 | }, |
137 | super => sub { |
3f9e4b0a |
138 | # FIXME can be made into goto, might break caller() for existing code |
1b2aea39 |
139 | return Class::MOP::subname('Moose::super' => sub { return unless our $SUPER_BODY; $SUPER_BODY->(our @SUPER_ARGS) }) |
a3c7e2fe |
140 | }, |
3f9e4b0a |
141 | #next => sub { |
142 | # return subname 'Moose::next' => sub { @_ = our @SUPER_ARGS; goto \&next::method }; |
143 | #}, |
a3c7e2fe |
144 | override => sub { |
be33e4f3 |
145 | my $class = $CALLER; |
1b2aea39 |
146 | return Class::MOP::subname('Moose::override' => sub ($&) { |
9bcfbab1 |
147 | my ( $name, $method ) = @_; |
148 | $class->meta->add_override_method_modifier( $name => $method ); |
1b2aea39 |
149 | }); |
a3c7e2fe |
150 | }, |
151 | inner => sub { |
1b2aea39 |
152 | return Class::MOP::subname('Moose::inner' => sub { |
3f9e4b0a |
153 | my $pkg = caller(); |
154 | our ( %INNER_BODY, %INNER_ARGS ); |
155 | |
156 | if ( my $body = $INNER_BODY{$pkg} ) { |
157 | my @args = @{ $INNER_ARGS{$pkg} }; |
158 | local $INNER_ARGS{$pkg}; |
159 | local $INNER_BODY{$pkg}; |
160 | return $body->(@args); |
161 | } else { |
162 | return; |
163 | } |
1b2aea39 |
164 | }); |
a3c7e2fe |
165 | }, |
166 | augment => sub { |
be33e4f3 |
167 | my $class = $CALLER; |
1b2aea39 |
168 | return Class::MOP::subname('Moose::augment' => sub (@&) { |
9bcfbab1 |
169 | my ( $name, $method ) = @_; |
170 | $class->meta->add_augment_method_modifier( $name => $method ); |
1b2aea39 |
171 | }); |
a3c7e2fe |
172 | }, |
2a5e59d0 |
173 | make_immutable => sub { |
174 | my $class = $CALLER; |
1b2aea39 |
175 | return Class::MOP::subname('Moose::make_immutable' => sub { |
c0b37457 |
176 | cluck "The make_immutable keyword has been deprecated, " . |
177 | "please go back to __PACKAGE__->meta->make_immutable\n"; |
e902b1a5 |
178 | $class->meta->make_immutable(@_); |
1b2aea39 |
179 | }); |
2a5e59d0 |
180 | }, |
a3c7e2fe |
181 | confess => sub { |
182 | return \&Carp::confess; |
183 | }, |
184 | blessed => sub { |
185 | return \&Scalar::Util::blessed; |
66bcefc1 |
186 | }, |
a3c7e2fe |
187 | ); |
3d544ed5 |
188 | |
9bcfbab1 |
189 | my $exporter = Sub::Exporter::build_exporter( |
190 | { |
191 | exports => \%exports, |
192 | groups => { default => [':all'] } |
a3c7e2fe |
193 | } |
9bcfbab1 |
194 | ); |
195 | |
c92c1205 |
196 | # 1 extra level because it's called by import so there's a layer of indirection |
197 | sub _get_caller{ |
198 | my $offset = 1; |
26fbace8 |
199 | return |
c92c1205 |
200 | ref $_[1] && defined $_[1]->{into} |
201 | ? $_[1]->{into} |
202 | : ref $_[1] && defined $_[1]->{into_level} |
203 | ? caller($offset + $_[1]->{into_level}) |
204 | : caller($offset); |
205 | } |
5bee491d |
206 | |
207 | sub import { |
c92c1205 |
208 | $CALLER = _get_caller(@_); |
26fbace8 |
209 | |
86dd5d11 |
210 | # this works because both pragmas set $^H (see perldoc perlvar) |
211 | # which affects the current compilation - i.e. the file who use'd |
212 | # us - which is why we don't need to do anything special to make |
213 | # it affect that file rather than this one (which is already compiled) |
214 | |
c235cd98 |
215 | strict->import; |
9bcfbab1 |
216 | warnings->import; |
a3c7e2fe |
217 | |
218 | # we should never export to main |
219 | return if $CALLER eq 'main'; |
9bcfbab1 |
220 | |
221 | init_meta( $CALLER, 'Moose::Object' ); |
222 | |
a3c7e2fe |
223 | goto $exporter; |
fcb7afc2 |
224 | } |
9bcfbab1 |
225 | |
31f8ec72 |
226 | sub unimport { |
9bcfbab1 |
227 | no strict 'refs'; |
c92c1205 |
228 | my $class = _get_caller(@_); |
9bcfbab1 |
229 | |
31f8ec72 |
230 | # loop through the exports ... |
9bcfbab1 |
231 | foreach my $name ( keys %exports ) { |
232 | |
31f8ec72 |
233 | # if we find one ... |
9bcfbab1 |
234 | if ( defined &{ $class . '::' . $name } ) { |
235 | my $keyword = \&{ $class . '::' . $name }; |
236 | |
31f8ec72 |
237 | # make sure it is from Moose |
53dd42d8 |
238 | my ($pkg_name) = Class::MOP::get_code_info($keyword); |
31f8ec72 |
239 | next if $pkg_name ne 'Moose'; |
9bcfbab1 |
240 | |
31f8ec72 |
241 | # and if it is from Moose then undef the slot |
9bcfbab1 |
242 | delete ${ $class . '::' }{$name}; |
31f8ec72 |
243 | } |
244 | } |
245 | } |
9bcfbab1 |
246 | |
fcd84ca9 |
247 | } |
248 | |
8ecb1fa0 |
249 | ## make 'em all immutable |
250 | |
251 | $_->meta->make_immutable( |
252 | inline_constructor => 0, |
77a18c28 |
253 | inline_accessors => 1, # these are Class::MOP accessors, so they need inlining |
9bcfbab1 |
254 | ) |
255 | for ( |
8ecb1fa0 |
256 | 'Moose::Meta::Attribute', |
257 | 'Moose::Meta::Class', |
258 | 'Moose::Meta::Instance', |
259 | |
260 | 'Moose::Meta::TypeConstraint', |
261 | 'Moose::Meta::TypeConstraint::Union', |
0fbd4b0a |
262 | 'Moose::Meta::TypeConstraint::Parameterized', |
8ecb1fa0 |
263 | 'Moose::Meta::TypeCoercion', |
264 | |
265 | 'Moose::Meta::Method', |
266 | 'Moose::Meta::Method::Accessor', |
267 | 'Moose::Meta::Method::Constructor', |
9bcfbab1 |
268 | 'Moose::Meta::Method::Destructor', |
8ecb1fa0 |
269 | 'Moose::Meta::Method::Overriden', |
d67145ed |
270 | |
271 | 'Moose::Meta::Role', |
9bcfbab1 |
272 | 'Moose::Meta::Role::Method', |
273 | 'Moose::Meta::Role::Method::Required', |
274 | ); |
8ecb1fa0 |
275 | |
fcd84ca9 |
276 | 1; |
277 | |
278 | __END__ |
279 | |
280 | =pod |
281 | |
282 | =head1 NAME |
283 | |
8bdc7f13 |
284 | Moose - A postmodern object system for Perl 5 |
fcd84ca9 |
285 | |
286 | =head1 SYNOPSIS |
e522431d |
287 | |
288 | package Point; |
1cd45431 |
289 | use Moose; # automatically turns on strict and warnings |
26fbace8 |
290 | |
43d599e5 |
291 | has 'x' => (is => 'rw', isa => 'Int'); |
292 | has 'y' => (is => 'rw', isa => 'Int'); |
26fbace8 |
293 | |
e522431d |
294 | sub clear { |
295 | my $self = shift; |
296 | $self->x(0); |
26fbace8 |
297 | $self->y(0); |
e522431d |
298 | } |
26fbace8 |
299 | |
e522431d |
300 | package Point3D; |
301 | use Moose; |
26fbace8 |
302 | |
e522431d |
303 | extends 'Point'; |
26fbace8 |
304 | |
43d599e5 |
305 | has 'z' => (is => 'rw', isa => 'Int'); |
26fbace8 |
306 | |
e522431d |
307 | after 'clear' => sub { |
308 | my $self = shift; |
43d599e5 |
309 | $self->z(0); |
26fbace8 |
310 | }; |
2c0cbef7 |
311 | |
fcd84ca9 |
312 | =head1 DESCRIPTION |
313 | |
26fbace8 |
314 | Moose is an extension of the Perl 5 object system. |
e522431d |
315 | |
316 | =head2 Another object system!?!? |
fcd84ca9 |
317 | |
26fbace8 |
318 | Yes, I know there has been an explosion recently of new ways to |
3a0c064a |
319 | build objects in Perl 5, most of them based on inside-out objects |
26fbace8 |
320 | and other such things. Moose is different because it is not a new |
321 | object system for Perl 5, but instead an extension of the existing |
e522431d |
322 | object system. |
3c7278fb |
323 | |
26fbace8 |
324 | Moose is built on top of L<Class::MOP>, which is a metaclass system |
325 | for Perl 5. This means that Moose not only makes building normal |
326 | Perl 5 objects better, but it also provides the power of metaclass |
505c6fac |
327 | programming. |
e522431d |
328 | |
734d1752 |
329 | =head2 Is this for real? Or is this just an experiment? |
e522431d |
330 | |
2c0cbef7 |
331 | Moose is I<based> on the prototypes and experiments I did for the Perl 6 |
26fbace8 |
332 | meta-model. However, Moose is B<NOT> an experiment/prototype; it is for B<real>. |
734d1752 |
333 | |
26fbace8 |
334 | =head2 Is this ready for use in production? |
d44714be |
335 | |
26fbace8 |
336 | Yes, I believe that it is. |
734d1752 |
337 | |
26fbace8 |
338 | Moose has been used successfully in production environemnts by several people |
339 | and companies (including the one I work for). There are Moose applications |
8bdc7f13 |
340 | which have been in production with little or no issue now for well over a year. |
26fbace8 |
341 | I consider it highly stable and we are commited to keeping it stable. |
e522431d |
342 | |
26fbace8 |
343 | Of course, in the end, you need to make this call yourself. If you have |
344 | any questions or concerns, please feel free to email me, or even the list |
d44714be |
345 | or just stop by #moose and ask away. |
346 | |
43d599e5 |
347 | =head2 Is Moose just Perl 6 in Perl 5? |
e522431d |
348 | |
68efb014 |
349 | No. While Moose is very much inspired by Perl 6, it is not itself Perl 6. |
1cd45431 |
350 | Instead, it is an OO system for Perl 5. I built Moose because I was tired of |
68efb014 |
351 | writing the same old boring Perl 5 OO code, and drooling over Perl 6 OO. So |
352 | instead of switching to Ruby, I wrote Moose :) |
3c7278fb |
353 | |
8bdc7f13 |
354 | =head2 Wait, I<post> modern, I thought it was just I<modern>? |
355 | |
356 | So I was reading Larry Wall's talk from the 1999 Linux World entitled |
357 | "Perl, the first postmodern computer language" in which he talks about how |
358 | he picked the features for Perl because he thought they were cool and he |
359 | threw out the ones that he thought sucked. This got me thinking about how |
360 | we have done the same thing in Moose. For Moose, we have "borrowed" features |
361 | from Perl 6, CLOS (LISP), Smalltalk, Java, BETA, OCaml, Ruby and more, and |
362 | the bits we didn't like (cause they sucked) we tossed aside. So for this |
363 | reason (and a few others) I have re-dubbed Moose a I<postmodern> object system. |
364 | |
365 | Nuff Said. |
366 | |
28669f89 |
367 | =head2 Moose Extensions |
368 | |
369 | The L<MooseX::> namespace is the official place to find Moose extensions. |
0b26305c |
370 | There are a number of these modules out on CPAN right now the best way to |
371 | find them is to search for MooseX:: on search.cpan.org. |
28669f89 |
372 | |
6ba6d68c |
373 | =head1 BUILDING CLASSES WITH MOOSE |
374 | |
68efb014 |
375 | Moose makes every attempt to provide as much convenience as possible during |
376 | class construction/definition, but still stay out of your way if you want it |
377 | to. Here are a few items to note when building classes with Moose. |
6ba6d68c |
378 | |
26fbace8 |
379 | Unless specified with C<extends>, any class which uses Moose will |
6ba6d68c |
380 | inherit from L<Moose::Object>. |
381 | |
1cd45431 |
382 | Moose will also manage all attributes (including inherited ones) that are |
383 | defined with C<has>. And (assuming you call C<new>, which is inherited from |
384 | L<Moose::Object>) this includes properly initializing all instance slots, |
385 | setting defaults where appropriate, and performing any type constraint checking |
386 | or coercion. |
6ba6d68c |
387 | |
004222dc |
388 | =head1 PROVIDED METHODS |
6ba6d68c |
389 | |
004222dc |
390 | Moose provides a number of methods to all your classes, mostly through the |
391 | inheritance of L<Moose::Object>. There is however, one exception. |
6ba6d68c |
392 | |
393 | =over 4 |
394 | |
395 | =item B<meta> |
396 | |
397 | This is a method which provides access to the current class's metaclass. |
398 | |
004222dc |
399 | =back |
400 | |
401 | =head1 EXPORTED FUNCTIONS |
402 | |
403 | Moose will export a number of functions into the class's namespace which |
404 | may then be used to set up the class. These functions all work directly |
405 | on the current class. |
406 | |
407 | =over 4 |
408 | |
6ba6d68c |
409 | =item B<extends (@superclasses)> |
410 | |
411 | This function will set the superclass(es) for the current class. |
412 | |
26fbace8 |
413 | This approach is recommended instead of C<use base>, because C<use base> |
414 | actually C<push>es onto the class's C<@ISA>, whereas C<extends> will |
415 | replace it. This is important to ensure that classes which do not have |
68efb014 |
416 | superclasses still properly inherit from L<Moose::Object>. |
6ba6d68c |
417 | |
43d599e5 |
418 | =item B<with (@roles)> |
e9ec68d6 |
419 | |
004222dc |
420 | This will apply a given set of C<@roles> to the local class. |
e9ec68d6 |
421 | |
cd7eeaf5 |
422 | =item B<has $name =E<gt> %options> |
6ba6d68c |
423 | |
26fbace8 |
424 | This will install an attribute of a given C<$name> into the current class. |
425 | The C<%options> are the same as those provided by |
426 | L<Class::MOP::Attribute>, in addition to the list below which are provided |
43d599e5 |
427 | by Moose (L<Moose::Meta::Attribute> to be more specific): |
6ba6d68c |
428 | |
429 | =over 4 |
430 | |
076c81ed |
431 | =item I<is =E<gt> 'rw'|'ro'> |
6ba6d68c |
432 | |
26fbace8 |
433 | The I<is> option accepts either I<rw> (for read/write) or I<ro> (for read |
434 | only). These will create either a read/write accessor or a read-only |
6ba6d68c |
435 | accessor respectively, using the same name as the C<$name> of the attribute. |
436 | |
1cd45431 |
437 | If you need more control over how your accessors are named, you can use the |
438 | I<reader>, I<writer> and I<accessor> options inherited from |
004222dc |
439 | L<Class::MOP::Attribute>, however if you use those, you won't need the I<is> |
440 | option. |
6ba6d68c |
441 | |
076c81ed |
442 | =item I<isa =E<gt> $type_name> |
6ba6d68c |
443 | |
26fbace8 |
444 | The I<isa> option uses Moose's type constraint facilities to set up runtime |
445 | type checking for this attribute. Moose will perform the checks during class |
446 | construction, and within any accessors. The C<$type_name> argument must be a |
447 | string. The string may be either a class name or a type defined using |
9cca2e9e |
448 | Moose's type definition features. (Refer to L<Moose::Util::TypeConstraints> |
c2a69ef1 |
449 | for information on how to define a new type, and how to retrieve type meta-data). |
6ba6d68c |
450 | |
daea75c9 |
451 | =item I<coerce =E<gt> (1|0)> |
452 | |
26fbace8 |
453 | This will attempt to use coercion with the supplied type constraint to change |
454 | the value passed into any accessors or constructors. You B<must> have supplied |
daea75c9 |
455 | a type constraint in order for this to work. See L<Moose::Cookbook::Recipe5> |
1cd45431 |
456 | for an example. |
daea75c9 |
457 | |
458 | =item I<does =E<gt> $role_name> |
459 | |
26fbace8 |
460 | This will accept the name of a role which the value stored in this attribute |
daea75c9 |
461 | is expected to have consumed. |
462 | |
463 | =item I<required =E<gt> (1|0)> |
464 | |
26fbace8 |
465 | This marks the attribute as being required. This means a I<defined> value must be |
466 | supplied during class construction, and the attribute may never be set to |
467 | C<undef> with an accessor. |
daea75c9 |
468 | |
469 | =item I<weak_ref =E<gt> (1|0)> |
470 | |
68efb014 |
471 | This will tell the class to store the value of this attribute as a weakened |
472 | reference. If an attribute is a weakened reference, it B<cannot> also be |
473 | coerced. |
daea75c9 |
474 | |
475 | =item I<lazy =E<gt> (1|0)> |
476 | |
26fbace8 |
477 | This will tell the class to not create this slot until absolutely necessary. |
daea75c9 |
478 | If an attribute is marked as lazy it B<must> have a default supplied. |
479 | |
9e93dd19 |
480 | =item I<auto_deref =E<gt> (1|0)> |
481 | |
26fbace8 |
482 | This tells the accessor whether to automatically dereference the value returned. |
1cd45431 |
483 | This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>. |
9e93dd19 |
484 | |
daea75c9 |
485 | =item I<trigger =E<gt> $code> |
486 | |
1cd45431 |
487 | The I<trigger> option is a CODE reference which will be called after the value of |
488 | the attribute is set. The CODE ref will be passed the instance itself, the |
daea75c9 |
489 | updated value and the attribute meta-object (this is for more advanced fiddling |
1cd45431 |
490 | and can typically be ignored). You B<cannot> have a trigger on a read-only |
491 | attribute. |
daea75c9 |
492 | |
c84f324f |
493 | =item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE> |
2c0cbef7 |
494 | |
26fbace8 |
495 | The I<handles> option provides Moose classes with automated delegation features. |
496 | This is a pretty complex and powerful option. It accepts many different option |
497 | formats, each with its own benefits and drawbacks. |
38e3283b |
498 | |
1cd45431 |
499 | B<NOTE:> The class being delegated to does not need to be a Moose based class, |
500 | which is why this feature is especially useful when wrapping non-Moose classes. |
38e3283b |
501 | |
1cd45431 |
502 | All I<handles> option formats share the following traits: |
38e3283b |
503 | |
1cd45431 |
504 | You cannot override a locally defined method with a delegated method; an |
505 | exception will be thrown if you try. That is to say, if you define C<foo> in |
506 | your class, you cannot override it with a delegated C<foo>. This is almost never |
507 | something you would want to do, and if it is, you should do it by hand and not |
508 | use Moose. |
38e3283b |
509 | |
1cd45431 |
510 | You cannot override any of the methods found in Moose::Object, or the C<BUILD> |
511 | and C<DEMOLISH> methods. These will not throw an exception, but will silently |
512 | move on to the next method in the list. My reasoning for this is that you would |
513 | almost never want to do this, since it usually breaks your class. As with |
514 | overriding locally defined methods, if you do want to do this, you should do it |
515 | manually, not with Moose. |
38e3283b |
516 | |
f3c4e20e |
517 | You do not I<need> to have a reader (or accessor) for the attribute in order |
518 | to delegate to it. Moose will create a means of accessing the value for you, |
519 | however this will be several times B<less> efficient then if you had given |
520 | the attribute a reader (or accessor) to use. |
521 | |
38e3283b |
522 | Below is the documentation for each option format: |
523 | |
524 | =over 4 |
525 | |
526 | =item C<ARRAY> |
527 | |
26fbace8 |
528 | This is the most common usage for I<handles>. You basically pass a list of |
529 | method names to be delegated, and Moose will install a delegation method |
1cd45431 |
530 | for each one. |
38e3283b |
531 | |
532 | =item C<HASH> |
533 | |
26fbace8 |
534 | This is the second most common usage for I<handles>. Instead of a list of |
535 | method names, you pass a HASH ref where each key is the method name you |
536 | want installed locally, and its value is the name of the original method |
537 | in the class being delegated to. |
fd595040 |
538 | |
26fbace8 |
539 | This can be very useful for recursive classes like trees. Here is a |
fd595040 |
540 | quick example (soon to be expanded into a Moose::Cookbook::Recipe): |
38e3283b |
541 | |
1cd45431 |
542 | package Tree; |
38e3283b |
543 | use Moose; |
26fbace8 |
544 | |
38e3283b |
545 | has 'node' => (is => 'rw', isa => 'Any'); |
26fbace8 |
546 | |
38e3283b |
547 | has 'children' => ( |
548 | is => 'ro', |
549 | isa => 'ArrayRef', |
550 | default => sub { [] } |
551 | ); |
26fbace8 |
552 | |
38e3283b |
553 | has 'parent' => ( |
554 | is => 'rw', |
555 | isa => 'Tree', |
a4e516f6 |
556 | weak_ref => 1, |
38e3283b |
557 | handles => { |
558 | parent_node => 'node', |
26fbace8 |
559 | siblings => 'children', |
38e3283b |
560 | } |
561 | ); |
562 | |
1cd45431 |
563 | In this example, the Tree package gets C<parent_node> and C<siblings> methods, |
564 | which delegate to the C<node> and C<children> methods (respectively) of the Tree |
26fbace8 |
565 | instance stored in the C<parent> slot. |
38e3283b |
566 | |
567 | =item C<REGEXP> |
568 | |
26fbace8 |
569 | The regexp option works very similar to the ARRAY option, except that it builds |
570 | the list of methods for you. It starts by collecting all possible methods of the |
571 | class being delegated to, then filters that list using the regexp supplied here. |
38e3283b |
572 | |
26fbace8 |
573 | B<NOTE:> An I<isa> option is required when using the regexp option format. This |
574 | is so that we can determine (at compile time) the method list from the class. |
38e3283b |
575 | Without an I<isa> this is just not possible. |
576 | |
c84f324f |
577 | =item C<ROLE> |
578 | |
26fbace8 |
579 | With the role option, you specify the name of a role whose "interface" then |
580 | becomes the list of methods to handle. The "interface" can be defined as; the |
581 | methods of the role and any required methods of the role. It should be noted |
582 | that this does B<not> include any method modifiers or generated attribute |
c84f324f |
583 | methods (which is consistent with role composition). |
584 | |
38e3283b |
585 | =item C<CODE> |
586 | |
1cd45431 |
587 | This is the option to use when you really want to do something funky. You should |
588 | only use it if you really know what you are doing, as it involves manual |
589 | metaclass twiddling. |
38e3283b |
590 | |
1cd45431 |
591 | This takes a code reference, which should expect two arguments. The first is the |
592 | attribute meta-object this I<handles> is attached to. The second is the |
593 | metaclass of the class being delegated to. It expects you to return a hash (not |
26fbace8 |
594 | a HASH ref) of the methods you want mapped. |
38e3283b |
595 | |
596 | =back |
2c0cbef7 |
597 | |
004222dc |
598 | =item I<metaclass =E<gt> $metaclass_name> |
599 | |
600 | This tells the class to use a custom attribute metaclass for this particular |
601 | attribute. Custom attribute metaclasses are useful for extending the |
602 | capabilities of the I<has> keyword: they are the simplest way to extend the MOP, |
603 | but they are still a fairly advanced topic and too much to cover here, see |
604 | L<Moose::Cookbook::Recipe11> for more information. |
605 | |
606 | The default behavior here is to just load C<$metaclass_name>; however, we also |
607 | have a way to alias to a shorter name. This will first look to see if |
608 | B<Moose::Meta::Attribute::Custom::$metaclass_name> exists. If it does, Moose |
609 | will then check to see if that has the method C<register_implementation>, which |
610 | should return the actual name of the custom attribute metaclass. If there is no |
611 | C<register_implementation> method, it will fall back to using |
612 | B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name. |
613 | |
614 | =item I<traits =E<gt> [ @role_names ]> |
615 | |
616 | This tells Moose to take the list of C<@role_names> and apply them to the |
617 | attribute meta-object. This is very similar to the I<metaclass> option, but |
618 | allows you to use more than one extension at a time. This too is an advanced |
619 | topic, we don't yet have a cookbook for it though. |
620 | |
621 | As with I<metaclass>, the default behavior is to just load C<$role_name>; however, |
622 | we also have a way to alias to a shorter name. This will first look to see if |
623 | B<Moose::Meta::Attribute::Custom::Trait::$role_name> exists. If it does, Moose |
624 | will then check to see if that has the method C<register_implementation>, which |
625 | should return the actual name of the custom attribute trait. If there is no |
626 | C<register_implementation> method, it will fall back to using |
627 | B<Moose::Meta::Attribute::Custom::Trait::$metaclass_name> as the trait name. |
628 | |
6ba6d68c |
629 | =back |
630 | |
cd7eeaf5 |
631 | =item B<has +$name =E<gt> %options> |
632 | |
26fbace8 |
633 | This is variation on the normal attibute creator C<has> which allows you to |
8d62bf6d |
634 | clone and extend an attribute from a superclass or from a role. Here is an |
635 | example of the superclass usage: |
cd7eeaf5 |
636 | |
637 | package Foo; |
638 | use Moose; |
26fbace8 |
639 | |
cd7eeaf5 |
640 | has 'message' => ( |
26fbace8 |
641 | is => 'rw', |
cd7eeaf5 |
642 | isa => 'Str', |
643 | default => 'Hello, I am a Foo' |
644 | ); |
26fbace8 |
645 | |
cd7eeaf5 |
646 | package My::Foo; |
647 | use Moose; |
26fbace8 |
648 | |
cd7eeaf5 |
649 | extends 'Foo'; |
26fbace8 |
650 | |
cd7eeaf5 |
651 | has '+message' => (default => 'Hello I am My::Foo'); |
652 | |
1cd45431 |
653 | What is happening here is that B<My::Foo> is cloning the C<message> attribute |
654 | from its parent class B<Foo>, retaining the C<is =E<gt> 'rw'> and C<isa =E<gt> |
655 | 'Str'> characteristics, but changing the value in C<default>. |
cd7eeaf5 |
656 | |
8d62bf6d |
657 | Here is another example, but within the context of a role: |
658 | |
659 | package Foo::Role; |
660 | use Moose::Role; |
661 | |
662 | has 'message' => ( |
663 | is => 'rw', |
664 | isa => 'Str', |
665 | default => 'Hello, I am a Foo' |
666 | ); |
667 | |
668 | package My::Foo; |
669 | use Moose; |
670 | |
671 | with 'Foo::Role'; |
672 | |
673 | has '+message' => (default => 'Hello I am My::Foo'); |
674 | |
675 | In this case, we are basically taking the attribute which the role supplied |
4032c9bb |
676 | and altering it within the bounds of this feature. |
8d62bf6d |
677 | |
4032c9bb |
678 | Aside from where the attributes come from (one from superclass, the other |
679 | from a role), this feature works exactly the same. This feature is restricted |
680 | somewhat, so as to try and force at least I<some> sanity into it. You are only |
681 | allowed to change the following attributes: |
cd7eeaf5 |
682 | |
683 | =over 4 |
684 | |
26fbace8 |
685 | =item I<default> |
cd7eeaf5 |
686 | |
687 | Change the default value of an attribute. |
688 | |
26fbace8 |
689 | =item I<coerce> |
cd7eeaf5 |
690 | |
691 | Change whether the attribute attempts to coerce a value passed to it. |
692 | |
26fbace8 |
693 | =item I<required> |
cd7eeaf5 |
694 | |
695 | Change if the attribute is required to have a value. |
696 | |
697 | =item I<documentation> |
698 | |
699 | Change the documentation string associated with the attribute. |
700 | |
83cc9094 |
701 | =item I<lazy> |
702 | |
703 | Change if the attribute lazily initializes the slot. |
704 | |
cd7eeaf5 |
705 | =item I<isa> |
706 | |
aed87761 |
707 | You I<are> allowed to change the type without restriction. |
708 | |
709 | It is recommended that you use this freedom with caution. We used to |
710 | only allow for extension only if the type was a subtype of the parent's |
711 | type, but we felt that was too restrictive and is better left as a |
712 | policy descision. |
cd7eeaf5 |
713 | |
83cc9094 |
714 | =item I<handles> |
715 | |
26fbace8 |
716 | You are allowed to B<add> a new C<handles> definition, but you are B<not> |
717 | allowed to I<change> one. |
83cc9094 |
718 | |
8d62bf6d |
719 | =item I<builder> |
720 | |
721 | You are allowed to B<add> a new C<builder> definition, but you are B<not> |
722 | allowed to I<change> one. |
723 | |
13284479 |
724 | =item I<metaclass> |
725 | |
726 | You are allowed to B<add> a new C<metaclass> definition, but you are |
727 | B<not> allowed to I<change> one. |
728 | |
729 | =item I<traits> |
730 | |
731 | You are allowed to B<add> additional traits to the C<traits> definition. |
732 | These traits will be composed into the attribute, but pre-existing traits |
733 | B<are not> overridden, or removed. |
734 | |
cd7eeaf5 |
735 | =back |
736 | |
076c81ed |
737 | =item B<before $name|@names =E<gt> sub { ... }> |
6ba6d68c |
738 | |
076c81ed |
739 | =item B<after $name|@names =E<gt> sub { ... }> |
6ba6d68c |
740 | |
076c81ed |
741 | =item B<around $name|@names =E<gt> sub { ... }> |
6ba6d68c |
742 | |
d8af92ae |
743 | This three items are syntactic sugar for the before, after, and around method |
744 | modifier features that L<Class::MOP> provides. More information on these may be |
745 | found in the L<Class::MOP::Class documentation|Class::MOP::Class/"Method |
746 | Modifiers"> for now. |
6ba6d68c |
747 | |
159da176 |
748 | =item B<super> |
749 | |
26fbace8 |
750 | The keyword C<super> is a no-op when called outside of an C<override> method. In |
751 | the context of an C<override> method, it will call the next most appropriate |
159da176 |
752 | superclass method with the same arguments as the original method. |
753 | |
754 | =item B<override ($name, &sub)> |
755 | |
26fbace8 |
756 | An C<override> method is a way of explicitly saying "I am overriding this |
757 | method from my superclass". You can call C<super> within this method, and |
758 | it will work as expected. The same thing I<can> be accomplished with a normal |
759 | method call and the C<SUPER::> pseudo-package; it is really your choice. |
159da176 |
760 | |
761 | =item B<inner> |
762 | |
26fbace8 |
763 | The keyword C<inner>, much like C<super>, is a no-op outside of the context of |
764 | an C<augment> method. You can think of C<inner> as being the inverse of |
68efb014 |
765 | C<super>; the details of how C<inner> and C<augment> work is best described in |
004222dc |
766 | the L<Moose::Cookbook::Recipe7>. |
159da176 |
767 | |
768 | =item B<augment ($name, &sub)> |
769 | |
26fbace8 |
770 | An C<augment> method, is a way of explicitly saying "I am augmenting this |
771 | method from my superclass". Once again, the details of how C<inner> and |
004222dc |
772 | C<augment> work is best described in the L<Moose::Cookbook::Recipe7>. |
159da176 |
773 | |
6ba6d68c |
774 | =item B<confess> |
775 | |
68efb014 |
776 | This is the C<Carp::confess> function, and exported here because I use it |
004222dc |
777 | all the time. |
6ba6d68c |
778 | |
779 | =item B<blessed> |
780 | |
1cd45431 |
781 | This is the C<Scalar::Util::blessed> function, it is exported here because I |
26fbace8 |
782 | use it all the time. It is highly recommended that this is used instead of |
6ba6d68c |
783 | C<ref> anywhere you need to test for an object's class name. |
784 | |
785 | =back |
786 | |
1cd45431 |
787 | =head1 UNIMPORTING FUNCTIONS |
31f8ec72 |
788 | |
789 | =head2 B<unimport> |
790 | |
1cd45431 |
791 | Moose offers a way to remove the keywords it exports, through the C<unimport> |
31f8ec72 |
792 | method. You simply have to say C<no Moose> at the bottom of your code for this |
793 | to work. Here is an example: |
794 | |
795 | package Person; |
796 | use Moose; |
797 | |
798 | has 'first_name' => (is => 'rw', isa => 'Str'); |
799 | has 'last_name' => (is => 'rw', isa => 'Str'); |
26fbace8 |
800 | |
801 | sub full_name { |
31f8ec72 |
802 | my $self = shift; |
26fbace8 |
803 | $self->first_name . ' ' . $self->last_name |
31f8ec72 |
804 | } |
26fbace8 |
805 | |
806 | no Moose; # keywords are removed from the Person package |
31f8ec72 |
807 | |
9bcfbab1 |
808 | =head1 EXTENDING AND EMBEDDING MOOSE |
809 | |
26fbace8 |
810 | Moose also offers some options for extending or embedding it into your own |
9bcfbab1 |
811 | framework. The basic premise is to have something that sets up your class' |
26fbace8 |
812 | metaclass and export the moose declarators (C<has>, C<with>, C<extends>,...). |
9bcfbab1 |
813 | Here is an example: |
814 | |
815 | package MyFramework; |
816 | use Moose; |
26fbace8 |
817 | |
9bcfbab1 |
818 | sub import { |
819 | my $CALLER = caller(); |
820 | |
821 | strict->import; |
822 | warnings->import; |
823 | |
824 | # we should never export to main |
825 | return if $CALLER eq 'main'; |
826 | Moose::init_meta( $CALLER, 'MyFramework::Base' ); |
827 | Moose->import({into => $CALLER}); |
828 | |
829 | # Do my custom framework stuff |
26fbace8 |
830 | |
9bcfbab1 |
831 | return 1; |
832 | } |
26fbace8 |
833 | |
9bcfbab1 |
834 | =head2 B<import> |
835 | |
77a18c28 |
836 | Moose's C<import> method supports the L<Sub::Exporter> form of C<{into =E<gt> $pkg}> |
9bcfbab1 |
837 | and C<{into_level =E<gt> 1}> |
838 | |
839 | =head2 B<init_meta ($class, $baseclass, $metaclass)> |
840 | |
26fbace8 |
841 | Moose does some boot strapping: it creates a metaclass object for your class, |
842 | and then injects a C<meta> accessor into your class to retrieve it. Then it |
843 | sets your baseclass to Moose::Object or the value you pass in unless you already |
844 | have one. This is all done via C<init_meta> which takes the name of your class |
2bbba362 |
845 | and optionally a baseclass and a metaclass as arguments. |
26fbace8 |
846 | |
05d9eaf6 |
847 | =head1 CAVEATS |
848 | |
849 | =over 4 |
850 | |
851 | =item * |
852 | |
1cd45431 |
853 | It should be noted that C<super> and C<inner> B<cannot> be used in the same |
854 | method. However, they may be combined within the same class hierarchy; see |
855 | F<t/014_override_augment_inner_super.t> for an example. |
05d9eaf6 |
856 | |
26fbace8 |
857 | The reason for this is that C<super> is only valid within a method |
858 | with the C<override> modifier, and C<inner> will never be valid within an |
859 | C<override> method. In fact, C<augment> will skip over any C<override> methods |
68efb014 |
860 | when searching for its appropriate C<inner>. |
05d9eaf6 |
861 | |
1cd45431 |
862 | This might seem like a restriction, but I am of the opinion that keeping these |
863 | two features separate (yet interoperable) actually makes them easy to use, since |
864 | their behavior is then easier to predict. Time will tell whether I am right or |
c84f324f |
865 | not (UPDATE: so far so good). |
05d9eaf6 |
866 | |
004222dc |
867 | =item * |
868 | |
869 | It is important to note that we currently have no simple way of combining |
870 | multiple extended versions of Moose (see L<EXTENDING AND EMBEDDING MOOSE> above), |
871 | and that in many cases they will conflict with one another. We are working on |
872 | developing a way around this issue, but in the meantime, you have been warned. |
873 | |
05d9eaf6 |
874 | =back |
875 | |
5569c072 |
876 | =head1 ACKNOWLEDGEMENTS |
877 | |
878 | =over 4 |
879 | |
54c189df |
880 | =item I blame Sam Vilain for introducing me to the insanity that is meta-models. |
5569c072 |
881 | |
54c189df |
882 | =item I blame Audrey Tang for then encouraging my meta-model habit in #perl6. |
5569c072 |
883 | |
26fbace8 |
884 | =item Without Yuval "nothingmuch" Kogman this module would not be possible, |
54c189df |
885 | and it certainly wouldn't have this name ;P |
5569c072 |
886 | |
26fbace8 |
887 | =item The basis of the TypeContraints module was Rob Kinyon's idea |
5569c072 |
888 | originally, I just ran with it. |
889 | |
638585e1 |
890 | =item Thanks to mst & chansen and the whole #moose posse for all the |
c84f324f |
891 | early ideas/feature-requests/encouragement/bug-finding. |
d46a48f3 |
892 | |
68efb014 |
893 | =item Thanks to David "Theory" Wheeler for meta-discussions and spelling fixes. |
894 | |
5569c072 |
895 | =back |
896 | |
e90c03d0 |
897 | =head1 SEE ALSO |
898 | |
899 | =over 4 |
900 | |
c84f324f |
901 | =item L<http://www.iinteractive.com/moose> |
902 | |
903 | This is the official web home of Moose, it contains links to our public SVN repo |
26fbace8 |
904 | as well as links to a number of talks and articles on Moose and Moose related |
905 | technologies. |
c84f324f |
906 | |
6ba6d68c |
907 | =item L<Class::MOP> documentation |
908 | |
909 | =item The #moose channel on irc.perl.org |
910 | |
e67a0fca |
911 | =item The Moose mailing list - moose@perl.org |
912 | |
9e0361e1 |
913 | =item Moose stats on ohloh.net - L<http://www.ohloh.net/projects/moose> |
c84f324f |
914 | |
28669f89 |
915 | =item Several Moose extension modules in the L<MooseX::> namespace. |
916 | |
c84f324f |
917 | =back |
918 | |
004222dc |
919 | =head2 Books |
920 | |
921 | =over 4 |
922 | |
923 | =item The Art of the MetaObject Protocol |
924 | |
925 | I mention this in the L<Class::MOP> docs too, this book was critical in |
926 | the development of both modules and is highly recommended. |
927 | |
928 | =back |
929 | |
26fbace8 |
930 | =head2 Papers |
c84f324f |
931 | |
932 | =over 4 |
e90c03d0 |
933 | |
159da176 |
934 | =item L<http://www.cs.utah.edu/plt/publications/oopsla04-gff.pdf> |
935 | |
26fbace8 |
936 | This paper (suggested by lbr on #moose) was what lead to the implementation |
937 | of the C<super>/C<override> and C<inner>/C<augment> features. If you really |
1cd45431 |
938 | want to understand them, I suggest you read this. |
159da176 |
939 | |
e90c03d0 |
940 | =back |
941 | |
fcd84ca9 |
942 | =head1 BUGS |
943 | |
26fbace8 |
944 | All complex software has bugs lurking in it, and this module is no |
fcd84ca9 |
945 | exception. If you find a bug please either email me, or add the bug |
946 | to cpan-RT. |
947 | |
fcd84ca9 |
948 | =head1 AUTHOR |
949 | |
950 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
951 | |
9af1d28b |
952 | B<with contributions from:> |
db1ab48d |
953 | |
9af1d28b |
954 | Aankhen |
955 | |
956 | Adam (Alias) Kennedy |
957 | |
958 | Anders (Debolaz) Nor Berle |
959 | |
5868294f |
960 | Nathan (kolibre) Gray |
961 | |
9af1d28b |
962 | Christian (chansen) Hansen |
963 | |
e7f8d0c2 |
964 | Hans Dieter (confound) Pearcey |
965 | |
9af1d28b |
966 | Eric (ewilhelm) Wilhelm |
967 | |
968 | Guillermo (groditi) Roditi |
969 | |
970 | Jess (castaway) Robinson |
971 | |
972 | Matt (mst) Trout |
973 | |
974 | Robert (phaylon) Sedlacek |
975 | |
976 | Robert (rlb3) Boone |
977 | |
978 | Scott (konobi) McWhirter |
979 | |
f44ae52f |
980 | Shlomi (rindolf) Fish |
981 | |
9af1d28b |
982 | Yuval (nothingmuch) Kogman |
983 | |
cbe25729 |
984 | Chris (perigrin) Prather |
985 | |
e46f5cc2 |
986 | Jonathan (jrockway) Rockway |
987 | |
3ccdc84a |
988 | Piotr (dexter) Roszatycki |
989 | |
26fbace8 |
990 | Sam (mugwump) Vilain |
f1917f58 |
991 | |
ac211120 |
992 | Shawn (sartak) Moore |
993 | |
9af1d28b |
994 | ... and many other #moose folks |
98aae381 |
995 | |
fcd84ca9 |
996 | =head1 COPYRIGHT AND LICENSE |
997 | |
778db3ac |
998 | Copyright 2006-2008 by Infinity Interactive, Inc. |
fcd84ca9 |
999 | |
1000 | L<http://www.iinteractive.com> |
1001 | |
1002 | This library is free software; you can redistribute it and/or modify |
26fbace8 |
1003 | it under the same terms as Perl itself. |
fcd84ca9 |
1004 | |
ddd0ec20 |
1005 | =cut |