make role application interface consistent
[gitmo/Moo.git] / lib / Moo.pm
index cc8de95..0ec27a7 100644 (file)
@@ -20,7 +20,7 @@ sub import {
   *{_getglob("${target}::with")} = sub {
     require Moo::Role;
     die "Only one role supported at a time by with" if @_ > 1;
-    Moo::Role->apply_role_to_package($_[0], $target);
+    Moo::Role->apply_role_to_package($target, $_[0]);
   };
   $MAKERS{$target} = {};
   *{_getglob("${target}::has")} = sub {
@@ -76,3 +76,285 @@ sub _constructor_maker_for {
 }
 
 1;
+
+=pod
+
+=head1 NAME
+
+Moo - Minimalist Object Orientation (with Moose compatiblity)
+
+=head1 SYNOPSIS
+
+ package Cat::Food;
+
+ use Moo;
+ use Sub::Quote;
+
+ sub feed_lion {
+   my $self = shift;
+   my $amount = shift || 1;
+
+   $self->pounds( $self->pounds - $amount );
+ }
+
+ has taste => (
+   is => 'ro',
+ );
+
+ has brand => (
+   is  => 'ro',
+   isa => sub {
+     die "Only SWEET-TREATZ supported!" unless $_[0] eq 'SWEET-TREATZ'
+   },
+);
+
+ has pounds => (
+   is  => 'rw',
+   isa => quote_sub q{ die "$_[0] is too much cat food!" unless $_[0] < 15 },
+ );
+
+ 1;
+
+and else where
+
+ my $full = Cat::Food->new(
+    taste  => 'DELICIOUS.',
+    brand  => 'SWEET-TREATZ',
+    pounds => 10,
+ );
+
+ $full->feed_lion;
+
+ say $full->pounds;
+
+=head1 DESCRIPTION
+
+This module is an extremely light-weight, high-performance L<Moose> replacement.
+It also avoids depending on any XS modules to allow simple deployments.  The
+name C<Moo> is based on the idea that it provides almost -but not quite- two
+thirds of L<Moose>.
+
+Unlike C<Mouse> this module does not aim at full L<Moose> compatibility.  See
+L</INCOMPATIBILITIES> for more details.
+
+=head1 IMPORTED METHODS
+
+=head2 new
+
+ Foo::Bar->new( attr1 => 3 );
+
+or
+
+ Foo::Bar->new({ attr1 => 3 });
+
+=head2 BUILDARGS
+
+This feature from Moose is not yet supported.
+
+=head2 BUILDALL
+
+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.
+
+=head2 does
+
+ if ($foo->does('Some::Role1')) {
+   ...
+ }
+
+Returns true if the object composes in the passed role.
+
+=head1 IMPORTED SUBROUTINES
+
+=head2 extends
+
+ extends 'Parent::Class';
+
+Declares base class. Multiple superclasses can be passed for multiple
+inheritance (but please use roles instead).
+
+Calling extends more than once will REPLACE your superclasses, not add to
+them like 'use base' would.
+
+=head2 with
+
+ with 'Some::Role1';
+ with 'Some::Role2';
+
+Composes a L<Role::Tiny> into current class.  Only one role may be composed in
+at a time to allow the code to remain as simple as possible.
+
+=head2 has
+
+ has attr => (
+   is => 'ro',
+ );
+
+Declares an attribute for the class.
+
+The options for C<has> are as follows:
+
+=over 2
+
+=item * is
+
+B<required>, must be C<ro> or C<rw>.  Unsurprisingly, C<ro> generates an
+accessor that will not respond to arguments; to be clear: a setter only. C<rw>
+will create a perlish getter/setter.
+
+=item * isa
+
+Takes a coderef which is meant to validate the attribute.  Unlike L<Moose> Moo
+does not include a basic type system, so instead of doing C<< isa => 'Num' >>,
+one should do
+
+ isa => quote_sub q{
+   die "$_[0] is not a number!" unless looks_like_number $_[0]
+ },
+
+L<Sub::Quote aware|/SUB QUOTE AWARE>
+
+=item * coerce
+
+This Moose feature is not yet supported
+
+=begin hide
+
+Takes a coderef which is meant to coerce the attribute.  The basic idea is to
+do something like the following:
+
+ coerce => quote_sub q{
+   $_[0] + 1 unless $_[0] % 2
+ },
+
+L<Sub::Quote aware|/SUB QUOTE AWARE>
+
+=end hide
+
+=item * trigger
+
+Takes a coderef which will get called any time the attribute is set. Coderef
+will be invoked against the object with the new value as an argument.
+
+Note that Moose also passes the old value, if any; this feature is not yet
+supported.
+
+L<Sub::Quote aware|/SUB QUOTE AWARE>
+
+=item * default
+
+Takes a coderef which will get called with $self as its only argument
+to populate an attribute if no value is supplied to the constructor - or
+if the attribute is lazy, when the attribute is first retrieved if no
+value has yet been provided.
+
+Note that if your default is fired during new() there is no guarantee that
+other attributes have been populated yet so you should not rely on their
+existence.
+
+L<Sub::Quote aware|/SUB QUOTE AWARE>
+
+=item * predicate
+
+Takes a method name which will return true if an attribute has a value.
+
+A common example of this would be to call it C<has_$foo>, implying that the
+object has a C<$foo> set.
+
+=item * builder
+
+Takes a method name which will be called to create the attribute - functions
+exactly like default except that instead of calling
+
+  $default->($self);
+
+Moo will call
+
+  $self->$builder;
+
+=item * clearer
+
+Takes a method name which will clear the attribute.
+
+=item * lazy
+
+B<Boolean>.  Set this if you want values for the attribute to be grabbed
+lazily.  This is usually a good idea if you have a L</builder> which requires
+another attribute to be set.
+
+=item * required
+
+B<Boolean>.  Set this if the attribute must be passed on instantiation.
+
+=item * weak_ref
+
+B<Boolean>.  Set this if you want the reference that the attribute contains to
+be weakened; use this when circular references are possible, which will cause
+leaks.
+
+=item * init_arg
+
+Takes the name of the key to look for at instantiation time of the object.  A
+common use of this is to make an underscored attribute have a non-underscored
+initialization name. C<undef> means that passing the value in on instantiation
+
+=back
+
+=head2 before
+
+ before foo => sub { ... };
+
+See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
+documentation.
+
+=head2 around
+
+ around foo => sub { ... };
+
+See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
+documentation.
+
+=head2 after
+
+ after foo => sub { ... };
+
+See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
+documentation.
+
+=head1 SUB QUOTE AWARE
+
+L<Sub::Quote/quote_sub> allows us to create coderefs that are "inlineable,"
+giving us a handy, XS-free speed boost.  Any option that is L<Sub::Quote>
+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>.
+
+There is no complex 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.
+
+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.
+
+There is no meta object.  If you need this level of complexity you wanted
+L<Moose> - Moo succeeds at being small because it explicitly does not
+provide a metaprotocol.
+
+No support for C<super>, C<override>, C<inner>, or C<augment> - override can
+be handled by around albeit with a little more typing, and the author considers
+augment to be a bad idea.
+
+L</default> only supports coderefs, because doing otherwise is usually a
+mistake anyway.
+
+C<lazy_build> is not supported per se, but of course it will work if you
+manually set all the options it implies.
+
+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.