clean up and add NAME sections

[gitmo/Moo.git] / lib / Role / Tiny.pm

diff --git a/lib/Role/Tiny.pm b/lib/Role/Tiny.pm
index 844272f..57028ed 100644 (file)
--- a/lib/Role/Tiny.pm
+++ b/lib/Role/Tiny.pm
@@ -35,7 +35,7 @@ sub import {
   };
   *{_getglob "${target}::with"} = sub {
     die "Only one role supported at a time by with" if @_ > 1;
-    $me->apply_role_to_package($_[0], $target);
+    $me->apply_role_to_package($target, $_[0]);
   };
   # grab all *non-constant* (ref eq 'SCALAR') subs present
   # in the symbol table and store their refaddrs (no need to forcibly
@@ -49,7 +49,7 @@ sub import {
 }
 
 sub apply_role_to_package {
-  my ($me, $role, $to) = @_;
+  my ($me, $to, $role) = @_;
 
   _load_module($role);
 
@@ -221,3 +221,137 @@ sub does_role {
 }
 
 1;
+
+=head1 NAME
+
+Role::Tiny - Roles. Like a nouvelle cusine portion size slice of Moose.
+
+=head1 SYNOPSIS
+
+ package Some::Role;
+
+ use Role::Tiny;
+
+ sub foo { ... }
+
+ sub bar { ... }
+
+ 1;
+
+else where
+
+ package Some::Class;
+
+ require Role::Tiny;
+
+ # bar gets imported, but not foo
+ Role::Tiny->apply_role_to_package('Some::Role', __PACKAGE__);
+
+ sub foo { ... }
+
+ 1;
+
+=head1 DESCRIPTION
+
+C<Role::Tiny> is a minimalist role composition tool.
+
+=head1 ROLE COMPOSITION
+
+Role composition can be thought of as much more clever and meaningful multiple
+inheritance.  The basics of this implementation of roles is:
+
+=over 2
+
+=item *
+
+If a method is already defined on a class, that method will not be composed in
+from the role.
+
+=item *
+
+If a method that the role L</requires> to be implemented is not implemented,
+role application will fail loudly.
+
+Unlike L<Class::C3>, where the B<last> class inherited from "wins," role
+composition is the other way around, where first wins.  In a more complete
+system (see L<Moose>) roles are checked to see if they clash.  The goal of this
+is to be much simpler, hence disallowing composition of multiple roles at once.
+
+=head1 METHODS
+
+=head2 apply_role_to_package
+
+ Role::Tiny->apply_role_to_package('Some::Package', 'Some::Role');
+
+Composes role with package
+
+=head2 apply_roles_to_object
+
+ Role::Tiny->apply_roles_to_object($foo, qw(Some::Role1 Some::Role2));
+
+Composes roles in order into object directly.  Object is reblessed into the
+resulting class.
+
+=head2 create_class_with_roles
+
+ Role::Tiny->create_class_with_roles('Some::Base', qw(Some::Role1 Some::Role2));
+
+Creates a new class based on base, with the roles composed into it in order.
+New class is returned.
+
+=head1 SUBROUTINES
+
+=head2 does_role
+
+ if (Role::Tiny::does_role($foo, 'Some::Role')) {
+   ...
+ }
+
+Returns true if class has been composed with role.
+
+This subroutine is also installed as ->does on any class a Role::Tiny is
+composed into unless that class already has an ->does method, so
+
+  if ($foo->does_role('Some::Role')) {
+    ...
+  }
+
+will work for classes but to test a role, one must use ::does_role directly
+
+=head1 IMPORTED SUBROUTINES
+
+=head2 requires
+
+ requires qw(foo bar);
+
+Declares a list of methods that must be defined to compose role.
+
+=head2 with
+
+ with 'Some::Role1';
+ with 'Some::Role2';
+
+Composes another role into the current role.  Only one role may be composed in
+at a time to allow the code to remain as simple as possible.
+
+=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.
+