doc updates explaining why you need to ask for CMM
[gitmo/Role-Tiny.git] / lib / Role / Tiny.pm
index 4479012..eb4cb0b 100644 (file)
@@ -6,38 +6,49 @@ sub _getstash { \%{"$_[0]::"} }
 use strict;
 use warnings FATAL => 'all';
 
+our $VERSION = '1.000000'; # 1.0.0
+$VERSION = eval $VERSION;
+
 our %INFO;
 our %APPLIED_TO;
 our %COMPOSED;
 
-# inlined from Moo::_Utils - update that first.
+# Module state workaround totally stolen from Zefram's Module::Runtime.
+
+BEGIN {
+  *_WORK_AROUND_BROKEN_MODULE_STATE = "$]" < 5.009 ? sub(){1} : sub(){0};
+}
+
+sub Role::Tiny::__GUARD__::DESTROY {
+  delete $INC{$_[0]->[0]} if @{$_[0]};
+}
 
 sub _load_module {
   (my $proto = $_[0]) =~ s/::/\//g;
-  return 1 if $INC{"${proto}.pm"};
+  $proto .= '.pm';
+  return 1 if $INC{$proto};
   # can't just ->can('can') because a sub-package Foo::Bar::Baz
   # creates a 'Baz::' key in Foo::Bar's symbol table
   return 1 if grep !/::$/, keys %{_getstash($_[0])||{}};
-  { local $@; require "${proto}.pm"; }
+  my $guard = _WORK_AROUND_BROKEN_MODULE_STATE
+    && bless([ $proto ], 'Role::Tiny::__GUARD__');
+  require $proto;
+  pop @$guard if _WORK_AROUND_BROKEN_MODULE_STATE;
   return 1;
 }
 
-{ # \[] is REF, not SCALAR. \v1 is VSTRING (thanks to doy for that one)
-  my %reftypes = map +($_ => 1), qw(SCALAR REF VSTRING);
-  sub _is_scalar_ref { $reftypes{ref($_[0])} }
-}
-
 sub import {
   my $target = caller;
   my $me = shift;
-  strictures->import;
+  strict->import;
+  warnings->import(FATAL => 'all');
   return if $INFO{$target}; # already exported into this package
   # get symbol table reference
   my $stash = do { no strict 'refs'; \%{"${target}::"} };
   # install before/after/around subs
   foreach my $type (qw(before after around)) {
     *{_getglob "${target}::${type}"} = sub {
-      { local $@; require Class::Method::Modifiers; }
+      require Class::Method::Modifiers;
       push @{$INFO{$target}{modifiers}||=[]}, [ $type => @_ ];
     };
   }
@@ -53,7 +64,7 @@ sub import {
   # inflate constant subs into real subs) - also add '' to here (this
   # is used later)
   @{$INFO{$target}{not_methods}={}}{
-    '', map { *$_{CODE}||() } grep !_is_scalar_ref($_), values %$stash
+    '', map { *$_{CODE}||() } grep !ref($_), values %$stash
   } = ();
   # a role does itself
   $APPLIED_TO{$target} = { $target => undef };
@@ -103,20 +114,20 @@ sub create_class_with_roles {
 
   foreach my $role (@roles) {
     _load_module($role);
-    die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
+    die "${role} is not a Role::Tiny" unless $INFO{$role};
   }
 
   if ($] >= 5.010) {
-    { local $@; require mro; }
+    require mro;
   } else {
-    { local $@; require MRO::Compat; }
+    require MRO::Compat;
   }
 
   my @composable = map $me->_composable_package_for($_), reverse @roles;
 
   *{_getglob("${new_name}::ISA")} = [ @composable, $superclass ];
 
-  my @info = map +($INFO{$_} ? $INFO{$_} : ()), @roles;
+  my @info = map $INFO{$_}, @roles;
 
   $me->_check_requires(
     $new_name, $compose_name,
@@ -147,11 +158,13 @@ sub _composable_package_for {
   ) {
     push @mod_base, "sub ${modified} { shift->next::method(\@_) }";
   }
+  my $e;
   {
     local $@;
     eval(my $code = join "\n", "package ${base_name};", @mod_base);
-    die "Evaling failed: $@\nTrying to eval:\n${code}" if $@;
+    $e = "Evaling failed: $@\nTrying to eval:\n${code}" if $@;
   }
+  die $e if $e;
   $me->_install_modifiers($composed_name, $modifiers);
   $COMPOSED{role}{$composed_name} = 1;
   return $composed_name;
@@ -182,7 +195,7 @@ sub _concrete_methods_of {
         my $code = *{$stash->{$_}}{CODE};
         # rely on the '' key we added in import for "no code here"
         exists $not_methods->{$code||''} ? () : ($_ => $code)
-      } grep !_is_scalar_ref($stash->{$_}), keys %$stash
+      } grep !ref($stash->{$_}), keys %$stash
     };
   };
 }
@@ -206,7 +219,7 @@ sub _install_methods {
   # determine already extant methods of target
   my %has_methods;
   @has_methods{grep
-    +(_is_scalar_ref($stash->{$_}) || *{$stash->{$_}}{CODE}),
+    +(ref($stash->{$_}) || *{$stash->{$_}}{CODE}),
     keys %$stash
   } = ();
 
@@ -241,7 +254,7 @@ sub does_role {
 
 =head1 NAME
 
-Role::Tiny - Roles. Like a nouvelle cusine portion size slice of Moose.
+Role::Tiny - Roles. Like a nouvelle cuisine portion size slice of Moose.
 
 =head1 SYNOPSIS
 
@@ -253,6 +266,8 @@ Role::Tiny - Roles. Like a nouvelle cusine portion size slice of Moose.
 
  sub bar { ... }
 
+ around baz => sub { ... }
+
  1;
 
 else where
@@ -266,8 +281,13 @@ else where
 
  sub foo { ... }
 
+ # baz is wrapped in the around modifier by Class::Method::Modifiers
+ sub baz { ... }
+
  1;
 
+If you wanted attributes as well, look at L<Moo::Role>.
+
 =head1 DESCRIPTION
 
 C<Role::Tiny> is a minimalist role composition tool.
@@ -331,7 +351,7 @@ 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')) {
+  if ($foo->does('Some::Role')) {
     ...
   }
 
@@ -360,6 +380,11 @@ at a time to allow the code to remain as simple as possible.
 See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
 documentation.
 
+Note that since you are not required to use method modifiers,
+L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
+a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
+both L<Class::Method::Modifiers> and L<Role::Tiny>.
+
 =head2 around
 
  around foo => sub { ... };
@@ -367,6 +392,11 @@ documentation.
 See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
 documentation.
 
+Note that since you are not required to use method modifiers,
+L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
+a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
+both L<Class::Method::Modifiers> and L<Role::Tiny>.
+
 =head2 after
 
  after foo => sub { ... };
@@ -374,12 +404,53 @@ documentation.
 See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
 documentation.
 
-=head1 AUTHORS
+Note that since you are not required to use method modifiers,
+L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
+a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
+both L<Class::Method::Modifiers> and L<Role::Tiny>.
+
+=head1 SEE ALSO
+
+L<Role::Tiny> is the attribute-less subset of L<Moo::Role>; L<Moo::Role> is
+a meta-protocol-less subset of the king of role systems, L<Moose::Role>.
+
+If you don't want method modifiers and do want to be forcibly restricted
+to a single role application per class, Ovid's L<Role::Basic> exists. But
+Stevan Little (the L<Moose> author) and I are both still convinced that
+he's Doing It Wrong.
+
+=head1 AUTHOR
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+=head1 CONTRIBUTORS
+
+dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx>
+
+frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
+
+hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org>
+
+jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com>
+
+ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org>
+
+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>
+
+perigrin - Chris Prather (cpan:PERIGRIN) <chris@prather.org>
+
+=head1 COPYRIGHT
 
-See L<Moo> for authors.
+Copyright (c) 2010-2012 the Role::Tiny L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
 
-=head1 COPYRIGHT AND LICENSE
+=head1 LICENSE
 
-See L<Moo> for the copyright and license.
+This library is free software and may be distributed under the same terms
+as perl itself.
 
 =cut