added documtentation for attributes overloading
[gitmo/Moo.git] / lib / Moo.pm
1 package Moo;
2
3 use strictures 1;
4 use Moo::_Utils;
5 use B 'perlstring';
6 use Sub::Defer ();
7
8 our $VERSION = '1.000008'; # 1.0.8
9 $VERSION = eval $VERSION;
10
11 require Moo::sification;
12
13 our %MAKERS;
14
15 sub _install_tracked {
16   my ($target, $name, $code) = @_;
17   $MAKERS{$target}{exports}{$name} = $code;
18   _install_coderef "${target}::${name}" => "Moo::${name}" => $code;
19 }
20
21 sub import {
22   my $target = caller;
23   my $class = shift;
24   strictures->import;
25   if ($Moo::Role::INFO{$target} and $Moo::Role::INFO{$target}{is_role}) {
26     die "Cannot import Moo into a role";
27   }
28   $MAKERS{$target} ||= {};
29   _install_tracked $target => extends => sub {
30     $class->_set_superclasses($target, @_);
31     $class->_maybe_reset_handlemoose($target);
32     return;
33   };
34   _install_tracked $target => with => sub {
35     require Moo::Role;
36     Moo::Role->apply_roles_to_package($target, @_);
37     $class->_maybe_reset_handlemoose($target);
38   };
39   _install_tracked $target => has => sub {
40     my ($name_proto, %spec) = @_;
41     my $name_isref = ref $name_proto eq 'ARRAY';
42     foreach my $name ($name_isref ? @$name_proto : $name_proto) {
43       # Note that when $name_proto is an arrayref, each attribute
44       # needs a separate \%specs hashref
45       my $spec_ref = $name_isref ? +{%spec} : \%spec;
46       $class->_constructor_maker_for($target)
47             ->register_attribute_specs($name, $spec_ref);
48       $class->_accessor_maker_for($target)
49             ->generate_method($target, $name, $spec_ref);
50       $class->_maybe_reset_handlemoose($target);
51     }
52     return;
53   };
54   foreach my $type (qw(before after around)) {
55     _install_tracked $target => $type => sub {
56       require Class::Method::Modifiers;
57       _install_modifier($target, $type, @_);
58       return;
59     };
60   }
61   return if $MAKERS{$target}{is_class}; # already exported into this package
62   $MAKERS{$target}{is_class} = 1;
63   {
64     no strict 'refs';
65     @{"${target}::ISA"} = do {
66       require Moo::Object; ('Moo::Object');
67     } unless @{"${target}::ISA"};
68   }
69   if ($INC{'Moo/HandleMoose.pm'}) {
70     Moo::HandleMoose::inject_fake_metaclass_for($target);
71   }
72 }
73
74 sub unimport {
75   my $target = caller;
76   _unimport_coderefs($target, $MAKERS{$target});
77 }
78
79 sub _set_superclasses {
80   my $class = shift;
81   my $target = shift;
82   foreach my $superclass (@_) {
83     _load_module($superclass);
84     if ($INC{"Role/Tiny.pm"} && $Role::Tiny::INFO{$superclass}) {
85       require Carp;
86       Carp::croak("Can't extend role '$superclass'");
87     }
88   }
89   # Can't do *{...} = \@_ or 5.10.0's mro.pm stops seeing @ISA
90   @{*{_getglob("${target}::ISA")}{ARRAY}} = @_;
91   if (my $old = delete $Moo::MAKERS{$target}{constructor}) {
92     delete _getstash($target)->{new};
93     Moo->_constructor_maker_for($target)
94        ->register_attribute_specs(%{$old->all_attribute_specs});
95   }
96   no warnings 'once'; # piss off. -- mst
97   $Moo::HandleMoose::MOUSE{$target} = [
98     grep defined, map Mouse::Util::find_meta($_), @_
99   ] if Mouse::Util->can('find_meta');
100 }
101
102 sub _maybe_reset_handlemoose {
103   my ($class, $target) = @_;
104   if ($INC{"Moo/HandleMoose.pm"}) {
105     Moo::HandleMoose::maybe_reinject_fake_metaclass_for($target);
106   }
107 }
108
109 sub _accessor_maker_for {
110   my ($class, $target) = @_;
111   return unless $MAKERS{$target};
112   $MAKERS{$target}{accessor} ||= do {
113     my $maker_class = do {
114       if (my $m = do {
115             if (my $defer_target = 
116                   (Sub::Defer::defer_info($target->can('new'))||[])->[0]
117               ) {
118               my ($pkg) = ($defer_target =~ /^(.*)::[^:]+$/);
119               $MAKERS{$pkg} && $MAKERS{$pkg}{accessor};
120             } else {
121               undef;
122             }
123           }) {
124         ref($m);
125       } else {
126         require Method::Generate::Accessor;
127         'Method::Generate::Accessor'
128       }
129     };
130     $maker_class->new;
131   }
132 }
133
134 sub _constructor_maker_for {
135   my ($class, $target, $select_super) = @_;
136   return unless $MAKERS{$target};
137   $MAKERS{$target}{constructor} ||= do {
138     require Method::Generate::Constructor;
139     require Sub::Defer;
140     my ($moo_constructor, $con);
141
142     if ($select_super && $MAKERS{$select_super}) {
143       $moo_constructor = 1;
144       $con = $MAKERS{$select_super}{constructor};
145     } else {
146       my $t_new = $target->can('new');
147       if ($t_new) {
148         if ($t_new == Moo::Object->can('new')) {
149           $moo_constructor = 1;
150         } elsif (my $defer_target = (Sub::Defer::defer_info($t_new)||[])->[0]) {
151           my ($pkg) = ($defer_target =~ /^(.*)::[^:]+$/);
152           if ($MAKERS{$pkg}) {
153             $moo_constructor = 1;
154             $con = $MAKERS{$pkg}{constructor};
155           }
156         }
157       } else {
158         $moo_constructor = 1; # no other constructor, make a Moo one
159       }
160     };
161     ($con ? ref($con) : 'Method::Generate::Constructor')
162       ->new(
163         package => $target,
164         accessor_generator => $class->_accessor_maker_for($target),
165         construction_string => (
166           $moo_constructor
167             ? ($con ? $con->construction_string : undef)
168             : ('$class->'.$target.'::SUPER::new($class->can(q[FOREIGNBUILDARGS]) ? $class->FOREIGNBUILDARGS(@_) : @_)')
169         ),
170         subconstructor_handler => (
171           '      if ($Moo::MAKERS{$class}) {'."\n"
172           .'        '.$class.'->_constructor_maker_for($class,'.perlstring($target).');'."\n"
173           .'        return $class->new(@_)'.";\n"
174           .'      } elsif ($INC{"Moose.pm"} and my $meta = Class::MOP::get_metaclass_by_name($class)) {'."\n"
175           .'        return $meta->new_object($class->BUILDARGS(@_));'."\n"
176           .'      }'."\n"
177         ),
178       )
179       ->install_delayed
180       ->register_attribute_specs(%{$con?$con->all_attribute_specs:{}})
181   }
182 }
183
184 1;
185 =pod
186
187 =encoding utf-8
188
189 =head1 NAME
190
191 Moo - Minimalist Object Orientation (with Moose compatiblity)
192
193 =head1 SYNOPSIS
194
195  package Cat::Food;
196
197  use Moo;
198
199  sub feed_lion {
200    my $self = shift;
201    my $amount = shift || 1;
202
203    $self->pounds( $self->pounds - $amount );
204  }
205
206  has taste => (
207    is => 'ro',
208  );
209
210  has brand => (
211    is  => 'ro',
212    isa => sub {
213      die "Only SWEET-TREATZ supported!" unless $_[0] eq 'SWEET-TREATZ'
214    },
215  );
216
217  has pounds => (
218    is  => 'rw',
219    isa => sub { die "$_[0] is too much cat food!" unless $_[0] < 15 },
220  );
221
222  1;
223
224 And elsewhere:
225
226  my $full = Cat::Food->new(
227     taste  => 'DELICIOUS.',
228     brand  => 'SWEET-TREATZ',
229     pounds => 10,
230  );
231
232  $full->feed_lion;
233
234  say $full->pounds;
235
236 =head1 DESCRIPTION
237
238 This module is an extremely light-weight subset of L<Moose> optimised for
239 rapid startup and "pay only for what you use".
240
241 It also avoids depending on any XS modules to allow simple deployments.  The
242 name C<Moo> is based on the idea that it provides almost -- but not quite -- two
243 thirds of L<Moose>.
244
245 Unlike L<Mouse> this module does not aim at full compatibility with
246 L<Moose>'s surface syntax, preferring instead of provide full interoperability
247 via the metaclass inflation capabilities described in L</MOO AND MOOSE>.
248
249 For a full list of the minor differences between L<Moose> and L<Moo>'s surface
250 syntax, see L</INCOMPATIBILITIES WITH MOOSE>.
251
252 =head1 WHY MOO EXISTS
253
254 If you want a full object system with a rich Metaprotocol, L<Moose> is
255 already wonderful.
256
257 However, sometimes you're writing a command line script or a CGI script
258 where fast startup is essential, or code designed to be deployed as a single
259 file via L<App::FatPacker>, or you're writing a CPAN module and you want it
260 to be usable by people with those constraints.
261
262 I've tried several times to use L<Mouse> but it's 3x the size of Moo and
263 takes longer to load than most of my Moo based CGI scripts take to run.
264
265 If you don't want L<Moose>, you don't want "less metaprotocol" like L<Mouse>,
266 you want "as little as possible" -- which means "no metaprotocol", which is
267 what Moo provides.
268
269 Better still, if you install and load L<Moose>, we set up metaclasses for your
270 L<Moo> classes and L<Moo::Role> roles, so you can use them in L<Moose> code
271 without ever noticing that some of your codebase is using L<Moo>.
272
273 Hence, Moo exists as its name -- Minimal Object Orientation -- with a pledge
274 to make it smooth to upgrade to L<Moose> when you need more than minimal
275 features.
276
277 =head1 MOO AND MOOSE
278
279 If L<Moo> detects L<Moose> being loaded, it will automatically register
280 metaclasses for your L<Moo> and L<Moo::Role> packages, so you should be able
281 to use them in L<Moose> code without anybody ever noticing you aren't using
282 L<Moose> everywhere.
283
284 Extending a L<Moose> class or consuming a L<Moose::Role> will also work.
285
286 So will extending a L<Mouse> class or consuming a L<Mouse::Role> - but note
287 that we don't provide L<Mouse> metaclasses or metaroles so the other way
288 around doesn't work. This feature exists for L<Any::Moose> users porting to
289 L<Moo>; enabling L<Mouse> users to use L<Moo> classes is not a priority for us.
290
291 This means that there is no need for anything like L<Any::Moose> for Moo
292 code - Moo and Moose code should simply interoperate without problem. To
293 handle L<Mouse> code, you'll likely need an empty Moo role or class consuming
294 or extending the L<Mouse> stuff since it doesn't register true L<Moose>
295 metaclasses like L<Moo> does.
296
297 If you want types to be upgraded to the L<Moose> types, use
298 L<MooX::Types::MooseLike> and install the L<MooseX::Types> library to
299 match the L<MooX::Types::MooseLike> library you're using - L<Moo> will
300 load the L<MooseX::Types> library and use that type for the newly created
301 metaclass.
302
303 If you need to disable the metaclass creation, add:
304
305   no Moo::sification;
306
307 to your code before Moose is loaded, but bear in mind that this switch is
308 currently global and turns the mechanism off entirely so don't put this
309 in library code.
310
311 =head1 MOO VERSUS ANY::MOOSE
312
313 L<Any::Moose> will load L<Mouse> normally, and L<Moose> in a program using
314 L<Moose> - which theoretically allows you to get the startup time of L<Mouse>
315 without disadvantaging L<Moose> users.
316
317 Sadly, this doesn't entirely work, since the selection is load order dependent
318 - L<Moo>'s metaclass inflation system explained above in L</MOO AND MOOSE> is
319 significantly more reliable.
320
321 So if you want to write a CPAN module that loads fast or has only pure perl
322 dependencies but is also fully usable by L<Moose> users, you should be using
323 L<Moo>.
324
325 For a full explanation, see the article
326 L<http://shadow.cat/blog/matt-s-trout/moo-versus-any-moose> which explains
327 the differing strategies in more detail and provides a direct example of
328 where L<Moo> succeeds and L<Any::Moose> fails.
329
330 =head1 IMPORTED METHODS
331
332 =head2 new
333
334  Foo::Bar->new( attr1 => 3 );
335
336 or
337
338  Foo::Bar->new({ attr1 => 3 });
339
340 =head2 BUILDARGS
341
342  sub BUILDARGS {
343    my ( $class, @args ) = @_;
344
345    unshift @args, "attr1" if @args % 2 == 1;
346
347    return { @args };
348  };
349
350  Foo::Bar->new( 3 );
351
352 The default implementation of this method accepts a hash or hash reference of
353 named parameters. If it receives a single argument that isn't a hash reference
354 it throws an error.
355
356 You can override this method in your class to handle other types of options
357 passed to the constructor.
358
359 This method should always return a hash reference of named options.
360
361 =head2 BUILD
362
363 Define a C<BUILD> method on your class and the constructor will automatically
364 call the C<BUILD> method from parent down to child after the object has
365 been instantiated.  Typically this is used for object validation or possibly
366 logging.
367
368 =head2 DEMOLISH
369
370 If you have a C<DEMOLISH> method anywhere in your inheritance hierarchy,
371 a C<DESTROY> method is created on first object construction which will call
372 C<< $instance->DEMOLISH($in_global_destruction) >> for each C<DEMOLISH>
373 method from child upwards to parents.
374
375 Note that the C<DESTROY> method is created on first construction of an object
376 of your class in order to not add overhead to classes without C<DEMOLISH>
377 methods; this may prove slightly surprising if you try and define your own.
378
379 =head2 does
380
381  if ($foo->does('Some::Role1')) {
382    ...
383  }
384
385 Returns true if the object composes in the passed role.
386
387 =head1 IMPORTED SUBROUTINES
388
389 =head2 extends
390
391  extends 'Parent::Class';
392
393 Declares base class. Multiple superclasses can be passed for multiple
394 inheritance (but please use roles instead).
395
396 Calling extends more than once will REPLACE your superclasses, not add to
397 them like 'use base' would.
398
399 =head2 with
400
401  with 'Some::Role1';
402
403 or
404
405  with 'Some::Role1', 'Some::Role2';
406
407 Composes one or more L<Moo::Role> (or L<Role::Tiny>) roles into the current
408 class.  An error will be raised if these roles have conflicting methods.
409
410 =head2 has
411
412  has attr => (
413    is => 'ro',
414  );
415
416 Declares an attribute for the class.
417
418  package Bar;
419  extends 'Foo'; # Foo has an 'attr' attribute
420
421  has '+attr' => (
422    default => sub { "blah" },
423  );
424
425 Using the C<+> notation, it's possible to override an attribute.
426
427 The options for C<has> are as follows:
428
429 =over 2
430
431 =item * is
432
433 B<required>, may be C<ro>, C<lazy>, C<rwp> or C<rw>.
434
435 C<ro> generates an accessor that dies if you attempt to write to it - i.e.
436 a getter only - by defaulting C<reader> to the name of the attribute.
437
438 C<lazy> generates a reader like C<ro>, but also sets C<lazy> to 1 and
439 C<builder> to C<_build_${attribute_name}> to allow on-demand generated
440 attributes.  This feature was my attempt to fix my incompetence when
441 originally designing C<lazy_build>, and is also implemented by
442 L<MooseX::AttributeShortcuts>. There is, however, nothing to stop you
443 using C<lazy> and C<builder> yourself with C<rwp> or C<rw> - it's just that
444 this isn't generally a good idea so we don't provide a shortcut for it.
445
446 C<rwp> generates a reader like C<ro>, but also sets C<writer> to
447 C<_set_${attribute_name}> for attributes that are designed to be written
448 from inside of the class, but read-only from outside.
449 This feature comes from L<MooseX::AttributeShortcuts>.
450
451 C<rw> generates a normal getter/setter by defaulting C<accessor> to the
452 name of the attribute.
453
454 =item * isa
455
456 Takes a coderef which is meant to validate the attribute.  Unlike L<Moose>, Moo
457 does not include a basic type system, so instead of doing C<< isa => 'Num' >>,
458 one should do
459
460  isa => sub {
461    die "$_[0] is not a number!" unless looks_like_number $_[0]
462  },
463
464 L<Sub::Quote aware|/SUB QUOTE AWARE>
465
466 Since L<Moo> does B<not> run the C<isa> check before C<coerce> if a coercion
467 subroutine has been supplied, C<isa> checks are not structural to your code
468 and can, if desired, be omitted on non-debug builds (although if this results
469 in an uncaught bug causing your program to break, the L<Moo> authors guarantee
470 nothing except that you get to keep both halves).
471
472 If you want L<MooseX::Types> style named types, look at
473 L<MooX::Types::MooseLike>.
474
475 To cause your C<isa> entries to be automatically mapped to named
476 L<Moose::Meta::TypeConstraint> objects (rather than the default behaviour
477 of creating an anonymous type), set:
478
479   $Moo::HandleMoose::TYPE_MAP{$isa_coderef} = sub {
480     require MooseX::Types::Something;
481     return MooseX::Types::Something::TypeName();
482   };
483
484 Note that this example is purely illustrative; anything that returns a
485 L<Moose::Meta::TypeConstraint> object or something similar enough to it to
486 make L<Moose> happy is fine.
487
488 =item * coerce
489
490 Takes a coderef which is meant to coerce the attribute.  The basic idea is to
491 do something like the following:
492
493  coerce => sub {
494    $_[0] + 1 unless $_[0] % 2
495  },
496
497 Note that L<Moo> will always fire your coercion: this is to permit
498 C<isa> entries to be used purely for bug trapping, whereas coercions are
499 always structural to your code. We do, however, apply any supplied C<isa>
500 check after the coercion has run to ensure that it returned a valid value.
501
502 L<Sub::Quote aware|/SUB QUOTE AWARE>
503
504 =item * handles
505
506 Takes a string
507
508   handles => 'RobotRole'
509
510 Where C<RobotRole> is a role (L<Moo::Role>) that defines an interface which
511 becomes the list of methods to handle.
512
513 Takes a list of methods
514
515  handles => [ qw( one two ) ]
516
517 Takes a hashref
518
519  handles => {
520    un => 'one',
521  }
522
523 =item * C<trigger>
524
525 Takes a coderef which will get called any time the attribute is set. This
526 includes the constructor, but not default or built values. Coderef will be
527 invoked against the object with the new value as an argument.
528
529 If you set this to just C<1>, it generates a trigger which calls the
530 C<_trigger_${attr_name}> method on C<$self>. This feature comes from
531 L<MooseX::AttributeShortcuts>.
532
533 Note that Moose also passes the old value, if any; this feature is not yet
534 supported.
535
536 L<Sub::Quote aware|/SUB QUOTE AWARE>
537
538 =item * C<default>
539
540 Takes a coderef which will get called with $self as its only argument
541 to populate an attribute if no value is supplied to the constructor - or
542 if the attribute is lazy, when the attribute is first retrieved if no
543 value has yet been provided.
544
545 Note that if your default is fired during new() there is no guarantee that
546 other attributes have been populated yet so you should not rely on their
547 existence.
548
549 L<Sub::Quote aware|/SUB QUOTE AWARE>
550
551 =item * C<predicate>
552
553 Takes a method name which will return true if an attribute has a value.
554
555 If you set this to just C<1>, the predicate is automatically named
556 C<has_${attr_name}> if your attribute's name does not start with an
557 underscore, or <_has_${attr_name_without_the_underscore}> if it does.
558 This feature comes from L<MooseX::AttributeShortcuts>.
559
560 =item * C<builder>
561
562 Takes a method name which will be called to create the attribute - functions
563 exactly like default except that instead of calling
564
565   $default->($self);
566
567 Moo will call
568
569   $self->$builder;
570
571 The following features come from L<MooseX::AttributeShortcuts>:
572
573 If you set this to just C<1>, the builder is automatically named
574 C<_build_${attr_name}>.
575
576 If you set this to a coderef or code-convertible object, that variable will be
577 installed under C<$class::_build_${attr_name}> and the builder set to the same
578 name.
579
580 =item * C<clearer>
581
582 Takes a method name which will clear the attribute.
583
584 If you set this to just C<1>, the clearer is automatically named
585 C<clear_${attr_name}> if your attribute's name does not start with an
586 underscore, or <_clear_${attr_name_without_the_underscore}> if it does.
587 This feature comes from L<MooseX::AttributeShortcuts>.
588
589 =item * C<lazy>
590
591 B<Boolean>.  Set this if you want values for the attribute to be grabbed
592 lazily.  This is usually a good idea if you have a L</builder> which requires
593 another attribute to be set.
594
595 =item * C<required>
596
597 B<Boolean>.  Set this if the attribute must be passed on instantiation.
598
599 =item * C<reader>
600
601 The value of this attribute will be the name of the method to get the value of
602 the attribute.  If you like Java style methods, you might set this to
603 C<get_foo>
604
605 =item * C<writer>
606
607 The value of this attribute will be the name of the method to set the value of
608 the attribute.  If you like Java style methods, you might set this to
609 C<set_foo>.
610
611 =item * C<weak_ref>
612
613 B<Boolean>.  Set this if you want the reference that the attribute contains to
614 be weakened; use this when circular references are possible, which will cause
615 leaks.
616
617 =item * C<init_arg>
618
619 Takes the name of the key to look for at instantiation time of the object.  A
620 common use of this is to make an underscored attribute have a non-underscored
621 initialization name. C<undef> means that passing the value in on instantiation
622 is ignored.
623
624 =back
625
626 =head2 before
627
628  before foo => sub { ... };
629
630 See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
631 documentation.
632
633 =head2 around
634
635  around foo => sub { ... };
636
637 See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
638 documentation.
639
640 =head2 after
641
642  after foo => sub { ... };
643
644 See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
645 documentation.
646
647 =head1 SUB QUOTE AWARE
648
649 L<Sub::Quote/quote_sub> allows us to create coderefs that are "inlineable,"
650 giving us a handy, XS-free speed boost.  Any option that is L<Sub::Quote>
651 aware can take advantage of this.
652
653 To do this, you can write
654
655   use Moo;
656   use Sub::Quote;
657
658   has foo => (
659     is => 'ro',
660     isa => quote_sub(q{ die "Not <3" unless $_[0] < 3 })
661   );
662
663 which will be inlined as
664
665   do {
666     local @_ = ($_[0]->{foo});
667     die "Not <3" unless $_[0] < 3;
668   }
669
670 or to avoid localizing @_,
671
672   has foo => (
673     is => 'ro',
674     isa => quote_sub(q{ my ($val) = @_; die "Not <3" unless $val < 3 })
675   );
676
677 which will be inlined as
678
679   do {
680     my ($val) = ($_[0]->{foo});
681     die "Not <3" unless $val < 3;
682   }
683
684 See L<Sub::Quote> for more information, including how to pass lexical
685 captures that will also be compiled into the subroutine.
686
687 =head1 INCOMPATIBILITIES WITH MOOSE
688
689 There is no built-in type system.  C<isa> is verified with a coderef; if you
690 need complex types, just make a library of coderefs, or better yet, functions
691 that return quoted subs. L<MooX::Types::MooseLike> provides a similar API
692 to L<MooseX::Types::Moose> so that you can write
693
694   has days_to_live => (is => 'ro', isa => Int);
695
696 and have it work with both; it is hoped that providing only subrefs as an
697 API will encourage the use of other type systems as well, since it's
698 probably the weakest part of Moose design-wise.
699
700 C<initializer> is not supported in core since the author considers it to be a
701 bad idea but may be supported by an extension in future. Meanwhile C<trigger> or
702 C<coerce> are more likely to be able to fulfill your needs.
703
704 There is no meta object.  If you need this level of complexity you wanted
705 L<Moose> - Moo succeeds at being small because it explicitly does not
706 provide a metaprotocol. However, if you load L<Moose>, then
707
708   Class::MOP::class_of($moo_class_or_role)
709
710 will return an appropriate metaclass pre-populated by L<Moo>.
711
712 No support for C<super>, C<override>, C<inner>, or C<augment> - the author
713 considers augment to be a bad idea, and override can be translated:
714
715   override foo => sub {
716     ...
717     super();
718     ...
719   };
720
721   around foo => sub {
722     my ($orig, $self) = (shift, shift);
723     ...
724     $self->$orig(@_);
725     ...
726   };
727
728 The C<dump> method is not provided by default. The author suggests loading
729 L<Devel::Dwarn> into C<main::> (via C<perl -MDevel::Dwarn ...> for example) and
730 using C<$obj-E<gt>$::Dwarn()> instead.
731
732 L</default> only supports coderefs, because doing otherwise is usually a
733 mistake anyway.
734
735 C<lazy_build> is not supported; you are instead encouraged to use the
736 C<< is => 'lazy' >> option supported by L<Moo> and L<MooseX::AttributeShortcuts>.
737
738 C<auto_deref> is not supported since the author considers it a bad idea.
739
740 C<documentation> will show up in a L<Moose> metaclass created from your class
741 but is otherwise ignored. Then again, L<Moose> ignores it as well, so this
742 is arguably not an incompatibility.
743
744 Since C<coerce> does not require C<isa> to be defined but L<Moose> does
745 require it, the metaclass inflation for coerce alone is a trifle insane
746 and if you attempt to subtype the result will almost certainly break.
747
748 Handling of warnings: when you C<use Moo> we enable FATAL warnings.  The nearest
749 similar invocation for L<Moose> would be:
750
751   use Moose;
752   use warnings FATAL => "all";
753
754 Additionally, L<Moo> supports a set of attribute option shortcuts intended to
755 reduce common boilerplate.  The set of shortcuts is the same as in the L<Moose>
756 module L<MooseX::AttributeShortcuts> as of its version 0.009+.  So if you:
757
758     package MyClass;
759     use Moo;
760
761 The nearest L<Moose> invocation would be:
762
763     package MyClass;
764
765     use Moose;
766     use warnings FATAL => "all";
767     use MooseX::AttributeShortcuts;
768
769 or, if you're inheriting from a non-Moose class,
770
771     package MyClass;
772
773     use Moose;
774     use MooseX::NonMoose;
775     use warnings FATAL => "all";
776     use MooseX::AttributeShortcuts;
777
778 Finally, Moose requires you to call
779
780     __PACKAGE__->meta->make_immutable;
781
782 at the end of your class to get an inlined (i.e. not horribly slow)
783 constructor. Moo does it automatically the first time ->new is called
784 on your class.
785
786 An extension L<MooX::late> exists to ease translating Moose packages
787 to Moo by providing a more Moose-like interface.
788
789 =head1 SUPPORT
790
791 Users' IRC: #moose on irc.perl.org
792
793 =for html <a href="http://chat.mibbit.com/#moose@irc.perl.org">(click for instant chatroom login)</a>
794
795 Development and contribution IRC: #web-simple on irc.perl.org
796
797 =for html <a href="http://chat.mibbit.com/#web-simple@irc.perl.org">(click for instant chatroom login)</a>
798
799 Bugtracker: L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Moo>
800
801 Git repository: L<git://git.shadowcat.co.uk/gitmo/Moo.git>
802
803 Git web access: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo/Moo.git>
804
805 =head1 AUTHOR
806
807 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
808
809 =head1 CONTRIBUTORS
810
811 dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx>
812
813 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
814
815 hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org>
816
817 jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com>
818
819 ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org>
820
821 chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com>
822
823 ajgb - Alex J. G. Burzyński (cpan:AJGB) <ajgb@cpan.org>
824
825 doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net>
826
827 perigrin - Chris Prather (cpan:PERIGRIN) <chris@prather.org>
828
829 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
830
831 ilmari - Dagfinn Ilmari Mannsåker (cpan:ILMARI) <ilmari@ilmari.org>
832
833 tobyink - Toby Inkster (cpan:TOBYINK) <tobyink@cpan.org>
834
835 haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
836
837 mattp - Matt Phillips (cpan:MATTP) <mattp@cpan.org>
838
839 =head1 COPYRIGHT
840
841 Copyright (c) 2010-2011 the Moo L</AUTHOR> and L</CONTRIBUTORS>
842 as listed above.
843
844 =head1 LICENSE
845
846 This library is free software and may be distributed under the same terms
847 as perl itself. See L<http://dev.perl.org/licenses/>.
848
849 =cut