improve incompat w/Moose docs
[gitmo/Moo.git] / lib / Moo.pm
index d354bcc..19f5327 100644 (file)
@@ -4,7 +4,7 @@ use strictures 1;
 use Moo::_Utils;
 use B 'perlstring';
 
-our $VERSION = '0.009010'; # 0.9.10
+our $VERSION = '0.009013'; # 0.9.13
 $VERSION = eval $VERSION;
 
 our %MAKERS;
@@ -211,18 +211,23 @@ passed to the constructor.
 
 This method should always return a hash reference of named options.
 
-=head2 BUILDALL
+=head2 BUILD
 
-Don't override (or probably even call) this method.  Instead, you can define
-a C<BUILD> method on your class and the constructor will automatically call the
-C<BUILD> method from parent down to child after the object has been
-instantiated.  Typically this is used for object validation or possibly logging.
+Define a C<BUILD> method on your class and the constructor will automatically
+call the C<BUILD> method from parent down to child after the object has
+been instantiated.  Typically this is used for object validation or possibly
+logging.
 
-=head2 DESTROY
+=head2 DEMOLISH
 
-A default destructor is provided, which calls
+If you have a C<DEMOLISH> method anywhere in your inheritance hierarchy,
+a C<DESTROY> method is created on first object construction which will call
 C<< $instance->DEMOLISH($in_global_destruction) >> for each C<DEMOLISH>
-method in the inheritance hierarchy.
+method from child upwards to parents.
+
+Note that the C<DESTROY> method is created on first construction of an object
+of your class in order to not add overhead to classes without C<DEMOLISH>
+methods; this may prove slightly surprising if you try and define your own.
 
 =head2 does
 
@@ -295,6 +300,25 @@ Coerce does not require C<isa> to be defined.
 
 L<Sub::Quote aware|/SUB QUOTE AWARE>
 
+=item * handles
+
+Takes a string
+
+  handles => 'RobotRole'
+
+Where C<RobotRole> is a role (L<Moo::Role>) that defines an interface which
+becomes the list of methods to handle.
+
+Takes a list of methods
+
+ handles => [ qw( one two ) ]
+
+Takes a hashref
+
+ handles => {
+   un => 'one',
+ }
+
 =item * trigger
 
 Takes a coderef which will get called any time the attribute is set. Coderef
@@ -406,11 +430,28 @@ aware can take advantage of this.
 =head1 INCOMPATIBILITIES WITH MOOSE
 
 You can only compose one role at a time.  If your application is large or
-complex enough to warrant complex composition, you wanted L<Moose>.
+complex enough to warrant complex composition, you wanted L<Moose>.  Note that
+this does not mean you can only compose one role per class -
+
+  with 'FirstRole';
+  with 'SecondRole';
+
+is absolutely fine, there's just currently no equivalent of Moose's
 
-There is no complex type system.  C<isa> is verified with a coderef, if you
+  with 'FirstRole', 'SecondRole';
+
+which composes the two roles together, and then applies them.
+
+There is no built in type system.  C<isa> is verified with a coderef, if you
 need complex types, just make a library of coderefs, or better yet, functions
-that return quoted subs.
+that return quoted subs. L<MooX::Types::MooseLike> provides a similar API
+to L<MooseX::Types::Moose> so that you can write
+
+  has days_to_live => (is => 'ro', isa => Int);
+
+and have it work with both; it is hoped that providing only subrefs as an
+API will encourage the use of other type systems as well, since it's
+probably the weakest part of Moose design-wise.
 
 C<initializer> is not supported in core since the author considers it to be a
 bad idea but may be supported by an extension in future.
@@ -433,6 +474,44 @@ C<auto_deref> is not supported since the author considers it a bad idea.
 
 C<documentation> is not supported since it's a very poor replacement for POD.
 
+Handling of warnings: when you C<use Moo> we enable FATAL warnings.  The nearest
+similar invocation for L<Moose> would be:
+
+  use Moose;
+  use warnings FATAL => "all";
+
+Additionally, L<Moo> supports a set of attribute option shortcuts intended to
+reduce common boilerplate.  The set of shortcuts is the same as in the L<Moose>
+module L<MooseX::AttributeShortcuts>.  So if you:
+
+    package MyClass;
+    use Moo;
+
+The nearest L<Moose> invocation would be:
+
+    package MyClass;
+
+    use Moose;
+    use warnings FATAL => "all";
+    use MooseX::AttributeShortcuts;
+
+or, if you're inheriting from a non-Moose class,
+
+    package MyClass;
+
+    use Moose;
+    use MooseX::NonMoose;
+    use warnings FATAL => "all";
+    use MooseX::AttributeShortcuts;
+
+Finally, Moose requires you to call
+
+    __PACKAGE__->meta->make_immutable;
+
+at the end of your class to get an inlined (i.e. not horribly slow)
+constructor. Moo does it automatically the first time ->new is called
+on your class.
+
 =head1 AUTHOR
 
 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
@@ -453,6 +532,8 @@ chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com>
 
 ajgb - Alex J. G. BurzyƄski (cpan:AJGB) <ajgb@cpan.org>
 
+doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net>
+
 =head1 COPYRIGHT
 
 Copyright (c) 2010-2011 the Moo L</AUTHOR> and L</CONTRIBUTORS>