Commit | Line | Data |
b1eebd55 |
1 | package Moo; |
6c74d087 |
2 | |
3 | use strictures 1; |
b1eebd55 |
4 | use Moo::_Utils; |
e0e12d16 |
5 | use B 'perlstring'; |
6c74d087 |
6 | |
b00cb034 |
7 | our $VERSION = '0.009011'; # 0.9.11 |
6d71fae7 |
8 | $VERSION = eval $VERSION; |
9 | |
14f32032 |
10 | our %MAKERS; |
11 | |
6c74d087 |
12 | sub import { |
13 | my $target = caller; |
a16d301e |
14 | my $class = shift; |
de3d4906 |
15 | strictures->import; |
1ba11455 |
16 | return if $MAKERS{$target}; # already exported into this package |
6c74d087 |
17 | *{_getglob("${target}::extends")} = sub { |
fb5074f6 |
18 | _load_module($_) for @_; |
786e5ba0 |
19 | # Can't do *{...} = \@_ or 5.10.0's mro.pm stops seeing @ISA |
20 | @{*{_getglob("${target}::ISA")}{ARRAY}} = @_; |
6c74d087 |
21 | }; |
22 | *{_getglob("${target}::with")} = sub { |
59812c87 |
23 | { local $@; require Moo::Role; } |
6c74d087 |
24 | die "Only one role supported at a time by with" if @_ > 1; |
369a4c50 |
25 | Moo::Role->apply_role_to_package($target, $_[0]); |
6c74d087 |
26 | }; |
a16d301e |
27 | $MAKERS{$target} = {}; |
14f32032 |
28 | *{_getglob("${target}::has")} = sub { |
29 | my ($name, %spec) = @_; |
30 | ($MAKERS{$target}{accessor} ||= do { |
59812c87 |
31 | { local $@; require Method::Generate::Accessor; } |
14f32032 |
32 | Method::Generate::Accessor->new |
33 | })->generate_method($target, $name, \%spec); |
a16d301e |
34 | $class->_constructor_maker_for($target) |
35 | ->register_attribute_specs($name, \%spec); |
14f32032 |
36 | }; |
6c74d087 |
37 | foreach my $type (qw(before after around)) { |
38 | *{_getglob "${target}::${type}"} = sub { |
59812c87 |
39 | { local $@; require Class::Method::Modifiers; } |
6c74d087 |
40 | _install_modifier($target, $type, @_); |
41 | }; |
42 | } |
43 | { |
44 | no strict 'refs'; |
45 | @{"${target}::ISA"} = do { |
59812c87 |
46 | {; local $@; require Moo::Object; } ('Moo::Object'); |
6c74d087 |
47 | } unless @{"${target}::ISA"}; |
48 | } |
49 | } |
50 | |
a16d301e |
51 | sub _constructor_maker_for { |
c4570291 |
52 | my ($class, $target, $select_super) = @_; |
a16d301e |
53 | return unless $MAKERS{$target}; |
54 | $MAKERS{$target}{constructor} ||= do { |
59812c87 |
55 | { |
56 | local $@; |
57 | require Method::Generate::Constructor; |
58 | require Sub::Defer; |
59 | } |
c4570291 |
60 | my ($moo_constructor, $con); |
de5c0e53 |
61 | |
c4570291 |
62 | if ($select_super && $MAKERS{$select_super}) { |
63 | $moo_constructor = 1; |
64 | $con = $MAKERS{$select_super}{constructor}; |
65 | } else { |
de5c0e53 |
66 | my $t_new = $target->can('new'); |
c4570291 |
67 | if ($t_new) { |
68 | if ($t_new == Moo::Object->can('new')) { |
69 | $moo_constructor = 1; |
70 | } elsif (my $defer_target = (Sub::Defer::defer_info($t_new)||[])->[0]) { |
71 | my ($pkg) = ($defer_target =~ /^(.*)::[^:]+$/); |
72 | if ($MAKERS{$pkg}) { |
73 | $moo_constructor = 1; |
74 | $con = $MAKERS{$pkg}{constructor}; |
75 | } |
76 | } |
77 | } else { |
78 | $moo_constructor = 1; # no other constructor, make a Moo one |
79 | } |
de5c0e53 |
80 | }; |
a16d301e |
81 | Method::Generate::Constructor |
82 | ->new( |
83 | package => $target, |
84 | accessor_generator => do { |
59812c87 |
85 | { local $@; require Method::Generate::Accessor; } |
a16d301e |
86 | Method::Generate::Accessor->new; |
de5c0e53 |
87 | }, |
53875e2c |
88 | construction_string => ( |
89 | $moo_constructor |
90 | ? ($con ? $con->construction_string : undef) |
91 | : ('$class->'.$target.'::SUPER::new(@_)') |
e0e12d16 |
92 | ), |
93 | subconstructor_generator => ( |
94 | $class.'->_constructor_maker_for($class,'.perlstring($target).')' |
95 | ), |
a16d301e |
96 | ) |
97 | ->install_delayed |
de5c0e53 |
98 | ->register_attribute_specs(%{$con?$con->all_attribute_specs:{}}) |
a16d301e |
99 | } |
100 | } |
101 | |
6c74d087 |
102 | 1; |
a17be455 |
103 | =pod |
104 | |
105 | =encoding utf-8 |
8146585e |
106 | |
505f8b7a |
107 | =head1 NAME |
108 | |
109 | Moo - Minimalist Object Orientation (with Moose compatiblity) |
110 | |
8146585e |
111 | =head1 SYNOPSIS |
112 | |
113 | package Cat::Food; |
114 | |
115 | use Moo; |
116 | use Sub::Quote; |
117 | |
118 | sub feed_lion { |
119 | my $self = shift; |
120 | my $amount = shift || 1; |
121 | |
122 | $self->pounds( $self->pounds - $amount ); |
123 | } |
124 | |
125 | has taste => ( |
126 | is => 'ro', |
127 | ); |
128 | |
129 | has brand => ( |
130 | is => 'ro', |
131 | isa => sub { |
132 | die "Only SWEET-TREATZ supported!" unless $_[0] eq 'SWEET-TREATZ' |
133 | }, |
134 | ); |
135 | |
136 | has pounds => ( |
137 | is => 'rw', |
138 | isa => quote_sub q{ die "$_[0] is too much cat food!" unless $_[0] < 15 }, |
139 | ); |
140 | |
141 | 1; |
142 | |
143 | and else where |
144 | |
145 | my $full = Cat::Food->new( |
146 | taste => 'DELICIOUS.', |
147 | brand => 'SWEET-TREATZ', |
148 | pounds => 10, |
149 | ); |
150 | |
151 | $full->feed_lion; |
152 | |
153 | say $full->pounds; |
154 | |
155 | =head1 DESCRIPTION |
156 | |
157 | This module is an extremely light-weight, high-performance L<Moose> replacement. |
158 | It also avoids depending on any XS modules to allow simple deployments. The |
159 | name C<Moo> is based on the idea that it provides almost -but not quite- two |
160 | thirds of L<Moose>. |
161 | |
162 | Unlike C<Mouse> this module does not aim at full L<Moose> compatibility. See |
163 | L</INCOMPATIBILITIES> for more details. |
164 | |
5d5bb71d |
165 | =head1 WHY MOO EXISTS |
166 | |
167 | If you want a full object system with a rich Metaprotocol, L<Moose> is |
168 | already wonderful. |
169 | |
170 | I've tried several times to use L<Mouse> but it's 3x the size of Moo and |
171 | takes longer to load than most of my Moo based CGI scripts take to run. |
172 | |
173 | If you don't want L<Moose>, you don't want "less metaprotocol" like L<Mouse>, |
174 | you want "as little as possible" - which means "no metaprotocol", which is |
175 | what Moo provides. |
176 | |
177 | By Moo 1.0 I intend to have Moo's equivalent of L<Any::Moose> built in - |
178 | if Moose gets loaded, any Moo class or role will act as a Moose equivalent |
179 | if treated as such. |
180 | |
181 | Hence - Moo exists as its name - Minimal Object Orientation - with a pledge |
182 | to make it smooth to upgrade to L<Moose> when you need more than minimal |
183 | features. |
184 | |
8146585e |
185 | =head1 IMPORTED METHODS |
186 | |
187 | =head2 new |
188 | |
189 | Foo::Bar->new( attr1 => 3 ); |
190 | |
191 | or |
192 | |
193 | Foo::Bar->new({ attr1 => 3 }); |
194 | |
2e575bcd |
195 | =head2 BUILDARGS |
196 | |
a17be455 |
197 | around BUILDARGS => sub { |
198 | my $orig = shift; |
199 | my ( $class, @args ) = @_; |
200 | |
201 | unshift @args, "attr1" if @args % 2 == 1; |
202 | |
203 | return $class->$orig(@args); |
204 | }; |
205 | |
206 | Foo::Bar->new( 3 ); |
207 | |
208 | The default implementation of this method accepts a hash or hash reference of |
209 | named parameters. If it receives a single argument that isn't a hash reference |
210 | it throws an error. |
211 | |
212 | You can override this method in your class to handle other types of options |
213 | passed to the constructor. |
214 | |
215 | This method should always return a hash reference of named options. |
2e575bcd |
216 | |
8146585e |
217 | =head2 BUILDALL |
218 | |
219 | Don't override (or probably even call) this method. Instead, you can define |
220 | a C<BUILD> method on your class and the constructor will automatically call the |
221 | C<BUILD> method from parent down to child after the object has been |
222 | instantiated. Typically this is used for object validation or possibly logging. |
223 | |
c2cc003f |
224 | =head2 DESTROY |
225 | |
debb3fcd |
226 | If you have a C<DEMOLISH> method anywhere in your inheritance hierarchy, |
227 | a C<DESTROY> method is created on first object construction which will call |
c2cc003f |
228 | C<< $instance->DEMOLISH($in_global_destruction) >> for each C<DEMOLISH> |
debb3fcd |
229 | method from child upwards to parents. |
230 | |
231 | Note that the C<DESTROY> method is created on first construction of an object |
232 | of your class in order to not add overhead to classes without C<DEMOLISH> |
233 | methods; this may prove slightly surprising if you try and define your own. |
c2cc003f |
234 | |
8146585e |
235 | =head2 does |
236 | |
237 | if ($foo->does('Some::Role1')) { |
238 | ... |
239 | } |
240 | |
241 | Returns true if the object composes in the passed role. |
242 | |
243 | =head1 IMPORTED SUBROUTINES |
244 | |
245 | =head2 extends |
246 | |
247 | extends 'Parent::Class'; |
248 | |
2e575bcd |
249 | Declares base class. Multiple superclasses can be passed for multiple |
250 | inheritance (but please use roles instead). |
251 | |
252 | Calling extends more than once will REPLACE your superclasses, not add to |
253 | them like 'use base' would. |
8146585e |
254 | |
255 | =head2 with |
256 | |
257 | with 'Some::Role1'; |
258 | with 'Some::Role2'; |
259 | |
260 | Composes a L<Role::Tiny> into current class. Only one role may be composed in |
261 | at a time to allow the code to remain as simple as possible. |
262 | |
263 | =head2 has |
264 | |
265 | has attr => ( |
266 | is => 'ro', |
267 | ); |
268 | |
269 | Declares an attribute for the class. |
270 | |
271 | The options for C<has> are as follows: |
272 | |
273 | =over 2 |
274 | |
275 | =item * is |
276 | |
277 | B<required>, must be C<ro> or C<rw>. Unsurprisingly, C<ro> generates an |
0654a8fa |
278 | accessor that will not respond to arguments; to be clear: a getter only. C<rw> |
8146585e |
279 | will create a perlish getter/setter. |
280 | |
281 | =item * isa |
282 | |
283 | Takes a coderef which is meant to validate the attribute. Unlike L<Moose> Moo |
284 | does not include a basic type system, so instead of doing C<< isa => 'Num' >>, |
285 | one should do |
286 | |
287 | isa => quote_sub q{ |
288 | die "$_[0] is not a number!" unless looks_like_number $_[0] |
289 | }, |
290 | |
291 | L<Sub::Quote aware|/SUB QUOTE AWARE> |
292 | |
293 | =item * coerce |
294 | |
295 | Takes a coderef which is meant to coerce the attribute. The basic idea is to |
296 | do something like the following: |
297 | |
298 | coerce => quote_sub q{ |
299 | $_[0] + 1 unless $_[0] % 2 |
300 | }, |
301 | |
23a3e34e |
302 | Coerce does not require C<isa> to be defined. |
8146585e |
303 | |
23a3e34e |
304 | L<Sub::Quote aware|/SUB QUOTE AWARE> |
2e575bcd |
305 | |
8146585e |
306 | =item * trigger |
307 | |
308 | Takes a coderef which will get called any time the attribute is set. Coderef |
309 | will be invoked against the object with the new value as an argument. |
310 | |
2e575bcd |
311 | Note that Moose also passes the old value, if any; this feature is not yet |
312 | supported. |
313 | |
8146585e |
314 | L<Sub::Quote aware|/SUB QUOTE AWARE> |
315 | |
316 | =item * default |
317 | |
2e575bcd |
318 | Takes a coderef which will get called with $self as its only argument |
319 | to populate an attribute if no value is supplied to the constructor - or |
320 | if the attribute is lazy, when the attribute is first retrieved if no |
321 | value has yet been provided. |
322 | |
323 | Note that if your default is fired during new() there is no guarantee that |
324 | other attributes have been populated yet so you should not rely on their |
325 | existence. |
8146585e |
326 | |
327 | L<Sub::Quote aware|/SUB QUOTE AWARE> |
328 | |
329 | =item * predicate |
330 | |
2e575bcd |
331 | Takes a method name which will return true if an attribute has a value. |
8146585e |
332 | |
333 | A common example of this would be to call it C<has_$foo>, implying that the |
334 | object has a C<$foo> set. |
335 | |
336 | =item * builder |
337 | |
2e575bcd |
338 | Takes a method name which will be called to create the attribute - functions |
339 | exactly like default except that instead of calling |
340 | |
341 | $default->($self); |
342 | |
343 | Moo will call |
344 | |
345 | $self->$builder; |
8146585e |
346 | |
347 | =item * clearer |
348 | |
349 | Takes a method name which will clear the attribute. |
350 | |
351 | =item * lazy |
352 | |
353 | B<Boolean>. Set this if you want values for the attribute to be grabbed |
354 | lazily. This is usually a good idea if you have a L</builder> which requires |
355 | another attribute to be set. |
356 | |
357 | =item * required |
358 | |
359 | B<Boolean>. Set this if the attribute must be passed on instantiation. |
360 | |
1eba910c |
361 | =item * reader |
362 | |
363 | The value of this attribute will be the name of the method to get the value of |
364 | the attribute. If you like Java style methods, you might set this to |
365 | C<get_foo> |
366 | |
367 | =item * writer |
368 | |
369 | The value of this attribute will be the name of the method to set the value of |
370 | the attribute. If you like Java style methods, you might set this to |
371 | C<set_foo> |
372 | |
8146585e |
373 | =item * weak_ref |
374 | |
375 | B<Boolean>. Set this if you want the reference that the attribute contains to |
376 | be weakened; use this when circular references are possible, which will cause |
377 | leaks. |
378 | |
379 | =item * init_arg |
380 | |
381 | Takes the name of the key to look for at instantiation time of the object. A |
382 | common use of this is to make an underscored attribute have a non-underscored |
383 | initialization name. C<undef> means that passing the value in on instantiation |
384 | |
385 | =back |
386 | |
387 | =head2 before |
388 | |
389 | before foo => sub { ... }; |
390 | |
391 | See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full |
392 | documentation. |
393 | |
394 | =head2 around |
395 | |
396 | around foo => sub { ... }; |
397 | |
398 | See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full |
399 | documentation. |
400 | |
401 | =head2 after |
402 | |
403 | after foo => sub { ... }; |
404 | |
405 | See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full |
406 | documentation. |
407 | |
8146585e |
408 | =head1 SUB QUOTE AWARE |
409 | |
410 | L<Sub::Quote/quote_sub> allows us to create coderefs that are "inlineable," |
411 | giving us a handy, XS-free speed boost. Any option that is L<Sub::Quote> |
412 | aware can take advantage of this. |
413 | |
2e575bcd |
414 | =head1 INCOMPATIBILITIES WITH MOOSE |
8146585e |
415 | |
416 | You can only compose one role at a time. If your application is large or |
417 | complex enough to warrant complex composition, you wanted L<Moose>. |
418 | |
419 | There is no complex type system. C<isa> is verified with a coderef, if you |
420 | need complex types, just make a library of coderefs, or better yet, functions |
421 | that return quoted subs. |
422 | |
2e575bcd |
423 | C<initializer> is not supported in core since the author considers it to be a |
424 | bad idea but may be supported by an extension in future. |
8146585e |
425 | |
426 | There is no meta object. If you need this level of complexity you wanted |
2e575bcd |
427 | L<Moose> - Moo succeeds at being small because it explicitly does not |
428 | provide a metaprotocol. |
8146585e |
429 | |
2e575bcd |
430 | No support for C<super>, C<override>, C<inner>, or C<augment> - override can |
431 | be handled by around albeit with a little more typing, and the author considers |
432 | augment to be a bad idea. |
8146585e |
433 | |
434 | L</default> only supports coderefs, because doing otherwise is usually a |
435 | mistake anyway. |
436 | |
437 | C<lazy_build> is not supported per se, but of course it will work if you |
438 | manually set all the options it implies. |
439 | |
2e575bcd |
440 | C<auto_deref> is not supported since the author considers it a bad idea. |
8146585e |
441 | |
2e575bcd |
442 | C<documentation> is not supported since it's a very poor replacement for POD. |
40f3e3aa |
443 | |
444 | =head1 AUTHOR |
445 | |
446 | mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk> |
447 | |
448 | =head1 CONTRIBUTORS |
449 | |
5da684a2 |
450 | dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx> |
451 | |
452 | frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com> |
453 | |
454 | hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org> |
455 | |
456 | jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com> |
457 | |
458 | ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org> |
40f3e3aa |
459 | |
11f7a042 |
460 | chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com> |
461 | |
a17be455 |
462 | ajgb - Alex J. G. Burzyński (cpan:AJGB) <ajgb@cpan.org> |
463 | |
7b8177f8 |
464 | doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net> |
465 | |
40f3e3aa |
466 | =head1 COPYRIGHT |
467 | |
a958e36d |
468 | Copyright (c) 2010-2011 the Moo L</AUTHOR> and L</CONTRIBUTORS> |
40f3e3aa |
469 | as listed above. |
470 | |
471 | =head1 LICENSE |
472 | |
473 | This library is free software and may be distributed under the same terms |
474 | as perl itself. |
475 | |
476 | =cut |