7 our $VERSION = '0.009014'; # 0.9.13
8 $VERSION = eval $VERSION;
10 require Moo::sification;
18 return if $MAKERS{$target}; # already exported into this package
19 *{_getglob("${target}::extends")} = sub {
20 _load_module($_) for @_;
21 # Can't do *{...} = \@_ or 5.10.0's mro.pm stops seeing @ISA
22 @{*{_getglob("${target}::ISA")}{ARRAY}} = @_;
24 *{_getglob("${target}::with")} = sub {
26 Moo::Role->apply_roles_to_package($target, $_[0]);
28 $MAKERS{$target} = {};
29 *{_getglob("${target}::has")} = sub {
30 my ($name, %spec) = @_;
31 ($MAKERS{$target}{accessor} ||= do {
32 require Method::Generate::Accessor;
33 Method::Generate::Accessor->new
34 })->generate_method($target, $name, \%spec);
35 $class->_constructor_maker_for($target)
36 ->register_attribute_specs($name, \%spec);
38 foreach my $type (qw(before after around)) {
39 *{_getglob "${target}::${type}"} = sub {
40 require Class::Method::Modifiers;
41 _install_modifier($target, $type, @_);
46 @{"${target}::ISA"} = do {
47 require Moo::Object; ('Moo::Object');
48 } unless @{"${target}::ISA"};
50 if ($INC{'Moo/HandleMoose.pm'}) {
51 Moo::HandleMoose::inject_fake_metaclass_for($target);
55 sub _constructor_maker_for {
56 my ($class, $target, $select_super) = @_;
57 return unless $MAKERS{$target};
58 $MAKERS{$target}{constructor} ||= do {
59 require Method::Generate::Constructor;
61 my ($moo_constructor, $con);
63 if ($select_super && $MAKERS{$select_super}) {
65 $con = $MAKERS{$select_super}{constructor};
67 my $t_new = $target->can('new');
69 if ($t_new == Moo::Object->can('new')) {
71 } elsif (my $defer_target = (Sub::Defer::defer_info($t_new)||[])->[0]) {
72 my ($pkg) = ($defer_target =~ /^(.*)::[^:]+$/);
75 $con = $MAKERS{$pkg}{constructor};
79 $moo_constructor = 1; # no other constructor, make a Moo one
82 Method::Generate::Constructor
85 accessor_generator => do {
86 require Method::Generate::Accessor;
87 Method::Generate::Accessor->new;
89 construction_string => (
91 ? ($con ? $con->construction_string : undef)
92 : ('$class->'.$target.'::SUPER::new(@_)')
94 subconstructor_generator => (
95 $class.'->_constructor_maker_for($class,'.perlstring($target).')'
99 ->register_attribute_specs(%{$con?$con->all_attribute_specs:{}})
110 Moo - Minimalist Object Orientation (with Moose compatiblity)
121 my $amount = shift || 1;
123 $self->pounds( $self->pounds - $amount );
133 die "Only SWEET-TREATZ supported!" unless $_[0] eq 'SWEET-TREATZ'
139 isa => quote_sub q{ die "$_[0] is too much cat food!" unless $_[0] < 15 },
146 my $full = Cat::Food->new(
147 taste => 'DELICIOUS.',
148 brand => 'SWEET-TREATZ',
158 This module is an extremely light-weight, high-performance L<Moose> replacement.
159 It also avoids depending on any XS modules to allow simple deployments. The
160 name C<Moo> is based on the idea that it provides almost -but not quite- two
163 Unlike C<Mouse> this module does not aim at full L<Moose> compatibility. See
164 L</INCOMPATIBILITIES> for more details.
166 =head1 WHY MOO EXISTS
168 If you want a full object system with a rich Metaprotocol, L<Moose> is
171 I've tried several times to use L<Mouse> but it's 3x the size of Moo and
172 takes longer to load than most of my Moo based CGI scripts take to run.
174 If you don't want L<Moose>, you don't want "less metaprotocol" like L<Mouse>,
175 you want "as little as possible" - which means "no metaprotocol", which is
178 By Moo 1.0 I intend to have Moo's equivalent of L<Any::Moose> built in -
179 if Moose gets loaded, any Moo class or role will act as a Moose equivalent
182 Hence - Moo exists as its name - Minimal Object Orientation - with a pledge
183 to make it smooth to upgrade to L<Moose> when you need more than minimal
186 =head1 IMPORTED METHODS
190 Foo::Bar->new( attr1 => 3 );
194 Foo::Bar->new({ attr1 => 3 });
198 around BUILDARGS => sub {
200 my ( $class, @args ) = @_;
202 unshift @args, "attr1" if @args % 2 == 1;
204 return $class->$orig(@args);
209 The default implementation of this method accepts a hash or hash reference of
210 named parameters. If it receives a single argument that isn't a hash reference
213 You can override this method in your class to handle other types of options
214 passed to the constructor.
216 This method should always return a hash reference of named options.
220 Define a C<BUILD> method on your class and the constructor will automatically
221 call the C<BUILD> method from parent down to child after the object has
222 been instantiated. Typically this is used for object validation or possibly
227 If you have a C<DEMOLISH> method anywhere in your inheritance hierarchy,
228 a C<DESTROY> method is created on first object construction which will call
229 C<< $instance->DEMOLISH($in_global_destruction) >> for each C<DEMOLISH>
230 method from child upwards to parents.
232 Note that the C<DESTROY> method is created on first construction of an object
233 of your class in order to not add overhead to classes without C<DEMOLISH>
234 methods; this may prove slightly surprising if you try and define your own.
238 if ($foo->does('Some::Role1')) {
242 Returns true if the object composes in the passed role.
244 =head1 IMPORTED SUBROUTINES
248 extends 'Parent::Class';
250 Declares base class. Multiple superclasses can be passed for multiple
251 inheritance (but please use roles instead).
253 Calling extends more than once will REPLACE your superclasses, not add to
254 them like 'use base' would.
261 Composes a L<Role::Tiny> into current class. Only one role may be composed in
262 at a time to allow the code to remain as simple as possible.
270 Declares an attribute for the class.
272 The options for C<has> are as follows:
278 B<required>, must be C<ro> or C<rw>. Unsurprisingly, C<ro> generates an
279 accessor that will not respond to arguments; to be clear: a getter only. C<rw>
280 will create a perlish getter/setter.
284 Takes a coderef which is meant to validate the attribute. Unlike L<Moose> Moo
285 does not include a basic type system, so instead of doing C<< isa => 'Num' >>,
289 die "$_[0] is not a number!" unless looks_like_number $_[0]
292 L<Sub::Quote aware|/SUB QUOTE AWARE>
296 Takes a coderef which is meant to coerce the attribute. The basic idea is to
297 do something like the following:
299 coerce => quote_sub q{
300 $_[0] + 1 unless $_[0] % 2
303 Coerce does not require C<isa> to be defined.
305 L<Sub::Quote aware|/SUB QUOTE AWARE>
311 handles => 'RobotRole'
313 Where C<RobotRole> is a role (L<Moo::Role>) that defines an interface which
314 becomes the list of methods to handle.
316 Takes a list of methods
318 handles => [ qw( one two ) ]
328 Takes a coderef which will get called any time the attribute is set. Coderef
329 will be invoked against the object with the new value as an argument.
331 Note that Moose also passes the old value, if any; this feature is not yet
334 L<Sub::Quote aware|/SUB QUOTE AWARE>
338 Takes a coderef which will get called with $self as its only argument
339 to populate an attribute if no value is supplied to the constructor - or
340 if the attribute is lazy, when the attribute is first retrieved if no
341 value has yet been provided.
343 Note that if your default is fired during new() there is no guarantee that
344 other attributes have been populated yet so you should not rely on their
347 L<Sub::Quote aware|/SUB QUOTE AWARE>
351 Takes a method name which will return true if an attribute has a value.
353 A common example of this would be to call it C<has_$foo>, implying that the
354 object has a C<$foo> set.
358 Takes a method name which will be called to create the attribute - functions
359 exactly like default except that instead of calling
369 Takes a method name which will clear the attribute.
373 B<Boolean>. Set this if you want values for the attribute to be grabbed
374 lazily. This is usually a good idea if you have a L</builder> which requires
375 another attribute to be set.
379 B<Boolean>. Set this if the attribute must be passed on instantiation.
383 The value of this attribute will be the name of the method to get the value of
384 the attribute. If you like Java style methods, you might set this to
389 The value of this attribute will be the name of the method to set the value of
390 the attribute. If you like Java style methods, you might set this to
395 B<Boolean>. Set this if you want the reference that the attribute contains to
396 be weakened; use this when circular references are possible, which will cause
401 Takes the name of the key to look for at instantiation time of the object. A
402 common use of this is to make an underscored attribute have a non-underscored
403 initialization name. C<undef> means that passing the value in on instantiation
409 before foo => sub { ... };
411 See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
416 around foo => sub { ... };
418 See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
423 after foo => sub { ... };
425 See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
428 =head1 SUB QUOTE AWARE
430 L<Sub::Quote/quote_sub> allows us to create coderefs that are "inlineable,"
431 giving us a handy, XS-free speed boost. Any option that is L<Sub::Quote>
432 aware can take advantage of this.
434 =head1 INCOMPATIBILITIES WITH MOOSE
436 You can only compose one role at a time. If your application is large or
437 complex enough to warrant complex composition, you wanted L<Moose>. Note that
438 this does not mean you can only compose one role per class -
443 is absolutely fine, there's just currently no equivalent of Moose's
445 with 'FirstRole', 'SecondRole';
447 which composes the two roles together, and then applies them.
449 There is no built in type system. C<isa> is verified with a coderef, if you
450 need complex types, just make a library of coderefs, or better yet, functions
451 that return quoted subs. L<MooX::Types::MooseLike> provides a similar API
452 to L<MooseX::Types::Moose> so that you can write
454 has days_to_live => (is => 'ro', isa => Int);
456 and have it work with both; it is hoped that providing only subrefs as an
457 API will encourage the use of other type systems as well, since it's
458 probably the weakest part of Moose design-wise.
460 C<initializer> is not supported in core since the author considers it to be a
461 bad idea but may be supported by an extension in future.
463 There is no meta object. If you need this level of complexity you wanted
464 L<Moose> - Moo succeeds at being small because it explicitly does not
465 provide a metaprotocol.
467 No support for C<super>, C<override>, C<inner>, or C<augment> - override can
468 be handled by around albeit with a little more typing, and the author considers
469 augment to be a bad idea.
471 The C<dump> method is not provided by default. The author suggests loading
472 L<Devel::Dwarn> into C<main::> (via C<perl -MDevel::Dwarn ...> for example) and
473 using C<$obj-E<gt>$::Dwarn()> instead.
475 L</default> only supports coderefs, because doing otherwise is usually a
478 C<lazy_build> is not supported per se, but of course it will work if you
479 manually set all the options it implies.
481 C<auto_deref> is not supported since the author considers it a bad idea.
483 C<documentation> is not supported since it's a very poor replacement for POD.
485 Handling of warnings: when you C<use Moo> we enable FATAL warnings. The nearest
486 similar invocation for L<Moose> would be:
489 use warnings FATAL => "all";
491 Additionally, L<Moo> supports a set of attribute option shortcuts intended to
492 reduce common boilerplate. The set of shortcuts is the same as in the L<Moose>
493 module L<MooseX::AttributeShortcuts>. So if you:
498 The nearest L<Moose> invocation would be:
503 use warnings FATAL => "all";
504 use MooseX::AttributeShortcuts;
506 or, if you're inheriting from a non-Moose class,
511 use MooseX::NonMoose;
512 use warnings FATAL => "all";
513 use MooseX::AttributeShortcuts;
515 Finally, Moose requires you to call
517 __PACKAGE__->meta->make_immutable;
519 at the end of your class to get an inlined (i.e. not horribly slow)
520 constructor. Moo does it automatically the first time ->new is called
525 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
529 dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx>
531 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
533 hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org>
535 jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com>
537 ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org>
539 chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com>
541 ajgb - Alex J. G. BurzyĆski (cpan:AJGB) <ajgb@cpan.org>
543 doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net>
545 perigrin - Chris Prather (cpan:PERIGRIN) <chris@prather.org>
549 Copyright (c) 2010-2011 the Moo L</AUTHOR> and L</CONTRIBUTORS>
554 This library is free software and may be distributed under the same terms