3 sub _getglob { \*{$_[0]} }
4 sub _getstash { \%{"$_[0]::"} }
7 use warnings FATAL => 'all';
9 our $VERSION = '1.001002'; # 1.1.2
10 $VERSION = eval $VERSION;
17 # Module state workaround totally stolen from Zefram's Module::Runtime.
20 *_WORK_AROUND_BROKEN_MODULE_STATE = "$]" < 5.009 ? sub(){1} : sub(){0};
23 sub Role::Tiny::__GUARD__::DESTROY {
24 delete $INC{$_[0]->[0]} if @{$_[0]};
28 (my $proto = $_[0]) =~ s/::/\//g;
30 return 1 if $INC{$proto};
31 # can't just ->can('can') because a sub-package Foo::Bar::Baz
32 # creates a 'Baz::' key in Foo::Bar's symbol table
33 return 1 if grep !/::$/, keys %{_getstash($_[0])||{}};
34 my $guard = _WORK_AROUND_BROKEN_MODULE_STATE
35 && bless([ $proto ], 'Role::Tiny::__GUARD__');
37 pop @$guard if _WORK_AROUND_BROKEN_MODULE_STATE;
45 warnings->import(FATAL => 'all');
46 return if $INFO{$target}; # already exported into this package
47 # get symbol table reference
48 my $stash = do { no strict 'refs'; \%{"${target}::"} };
49 # install before/after/around subs
50 foreach my $type (qw(before after around)) {
51 *{_getglob "${target}::${type}"} = sub {
52 require Class::Method::Modifiers;
53 push @{$INFO{$target}{modifiers}||=[]}, [ $type => @_ ];
57 *{_getglob "${target}::requires"} = sub {
58 push @{$INFO{$target}{requires}||=[]}, @_;
61 *{_getglob "${target}::with"} = sub {
62 $me->apply_roles_to_package($target, @_);
65 # grab all *non-constant* (stash slot is not a scalarref) subs present
66 # in the symbol table and store their refaddrs (no need to forcibly
67 # inflate constant subs into real subs) - also add '' to here (this
68 # is used later) with a map to the coderefs in case of copying or re-use
69 my @not_methods = ('', map { *$_{CODE}||() } grep !ref($_), values %$stash);
70 @{$INFO{$target}{not_methods}={}}{@not_methods} = @not_methods;
72 $APPLIED_TO{$target} = { $target => undef };
75 sub apply_single_role_to_package {
76 my ($me, $to, $role) = @_;
80 die "This is apply_role_to_package" if ref($to);
81 die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
83 $me->_check_requires($to, $role, @{$info->{requires}||[]});
85 $me->_install_methods($to, $role);
87 $me->_install_modifiers($to, $info->{modifiers});
89 # only add does() method to classes and only if they don't have one
90 if (not $INFO{$to} and not $to->can('does')) {
91 *{_getglob "${to}::does"} = \&does_role;
94 # copy our role list into the target's
95 @{$APPLIED_TO{$to}||={}}{keys %{$APPLIED_TO{$role}}} = ();
98 sub apply_roles_to_object {
99 my ($me, $object, @roles) = @_;
100 die "No roles supplied!" unless @roles;
101 my $class = ref($object);
102 bless($object, $me->create_class_with_roles($class, @roles));
106 sub create_class_with_roles {
107 my ($me, $superclass, @roles) = @_;
109 die "No roles supplied!" unless @roles;
113 $seen{$_}++ for @roles;
114 if (my @dupes = grep $seen{$_} > 1, @roles) {
115 die "Duplicated roles: ".join(', ', @dupes);
120 '__WITH__', $superclass, my $compose_name = join '__AND__', @roles
123 return $new_name if $COMPOSED{class}{$new_name};
125 foreach my $role (@roles) {
127 die "${role} is not a Role::Tiny" unless $INFO{$role};
136 my @composable = map $me->_composable_package_for($_), reverse @roles;
138 *{_getglob("${new_name}::ISA")} = [ @composable, $superclass ];
140 my @info = map $INFO{$_}, @roles;
142 $me->_check_requires(
143 $new_name, $compose_name,
144 do { my %h; @h{map @{$_->{requires}||[]}, @info} = (); keys %h }
147 *{_getglob "${new_name}::does"} = \&does_role unless $new_name->can('does');
149 @{$APPLIED_TO{$new_name}||={}}{
150 map keys %{$APPLIED_TO{$_}}, @roles
153 $COMPOSED{class}{$new_name} = 1;
157 # preserved for compat, and apply_roles_to_package calls it to allow an
158 # updated Role::Tiny to use a non-updated Moo::Role
160 sub apply_role_to_package { shift->apply_single_role_to_package(@_) }
162 sub apply_roles_to_package {
163 my ($me, $to, @roles) = @_;
165 return $me->apply_role_to_package($to, $roles[0]) if @roles == 1;
167 my %conflicts = %{$me->_composite_info_for(@roles)->{conflicts}};
168 delete $conflicts{$_} for $me->_concrete_methods_of($to);
169 if (keys %conflicts) {
173 "Due to a method name conflict between roles "
174 ."'".join(' and ', sort values %{$conflicts{$_}})."'"
175 .", the method '$_' must be implemented by '${to}'"
179 delete $INFO{$to}{methods}; # reset since we're about to add methods
180 $me->apply_role_to_package($to, $_) for @roles;
181 $APPLIED_TO{$to}{join('|',@roles)} = 1;
184 sub _composite_info_for {
185 my ($me, @roles) = @_;
186 $COMPOSITE_INFO{join('|', sort @roles)} ||= do {
187 _load_module($_) for @roles;
189 foreach my $role (@roles) {
190 my $this_methods = $me->_concrete_methods_of($role);
191 $methods{$_}{$this_methods->{$_}} = $role for keys %$this_methods;
193 delete $methods{$_} for grep keys(%{$methods{$_}}) == 1, keys %methods;
194 +{ conflicts => \%methods }
198 sub _composable_package_for {
199 my ($me, $role) = @_;
200 my $composed_name = 'Role::Tiny::_COMPOSABLE::'.$role;
201 return $composed_name if $COMPOSED{role}{$composed_name};
202 $me->_install_methods($composed_name, $role);
203 my $base_name = $composed_name.'::_BASE';
204 *{_getglob("${composed_name}::ISA")} = [ $base_name ];
205 my $modifiers = $INFO{$role}{modifiers}||[];
207 foreach my $modified (
208 do { my %h; @h{map $_->[1], @$modifiers} = (); keys %h }
210 push @mod_base, "sub ${modified} { shift->next::method(\@_) }";
215 eval(my $code = join "\n", "package ${base_name};", @mod_base);
216 $e = "Evaling failed: $@\nTrying to eval:\n${code}" if $@;
219 $me->_install_modifiers($composed_name, $modifiers);
220 $COMPOSED{role}{$composed_name} = 1;
221 return $composed_name;
224 sub _check_requires {
225 my ($me, $to, $name, @requires) = @_;
226 if (my @requires_fail = grep !$to->can($_), @requires) {
227 # role -> role, add to requires, role -> class, error out
228 if (my $to_info = $INFO{$to}) {
229 push @{$to_info->{requires}||=[]}, @requires_fail;
231 die "Can't apply ${name} to ${to} - missing ".join(', ', @requires_fail);
236 sub _concrete_methods_of {
237 my ($me, $role) = @_;
238 my $info = $INFO{$role};
239 # grab role symbol table
240 my $stash = do { no strict 'refs'; \%{"${role}::"}};
241 # reverse so our keys become the values (captured coderefs) in case
242 # they got copied or re-used since
243 my $not_methods = { reverse %{$info->{not_methods}} };
244 $info->{methods} ||= +{
245 # grab all code entries that aren't in the not_methods list
247 my $code = *{$stash->{$_}}{CODE};
248 # rely on the '' key we added in import for "no code here"
249 exists $not_methods->{$code||''} ? () : ($_ => $code)
250 } grep !ref($stash->{$_}), keys %$stash
254 sub methods_provided_by {
255 my ($me, $role) = @_;
256 die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
257 (keys %{$me->_concrete_methods_of($role)}, @{$info->{requires}||[]});
260 sub _install_methods {
261 my ($me, $to, $role) = @_;
263 my $info = $INFO{$role};
265 my $methods = $me->_concrete_methods_of($role);
267 # grab target symbol table
268 my $stash = do { no strict 'refs'; \%{"${to}::"}};
270 # determine already extant methods of target
273 +(ref($stash->{$_}) || *{$stash->{$_}}{CODE}),
277 foreach my $i (grep !exists $has_methods{$_}, keys %$methods) {
279 *{_getglob "${to}::${i}"} = $methods->{$i};
283 sub _install_modifiers {
284 my ($me, $to, $modifiers) = @_;
285 if (my $info = $INFO{$to}) {
286 push @{$info->{modifiers}}, @{$modifiers||[]};
288 foreach my $modifier (@{$modifiers||[]}) {
289 $me->_install_single_modifier($to, @$modifier);
294 sub _install_single_modifier {
295 my ($me, @args) = @_;
296 Class::Method::Modifiers::install_modifier(@args);
300 my ($proto, $role) = @_;
301 return exists $APPLIED_TO{ref($proto)||$proto}{$role};
308 Role::Tiny - Roles. Like a nouvelle cuisine portion size slice of Moose.
320 around baz => sub { ... }
328 use Role::Tiny::With;
330 # bar gets imported, but not foo
335 # baz is wrapped in the around modifier by Class::Method::Modifiers
340 If you wanted attributes as well, look at L<Moo::Role>.
344 C<Role::Tiny> is a minimalist role composition tool.
346 =head1 ROLE COMPOSITION
348 Role composition can be thought of as much more clever and meaningful multiple
349 inheritance. The basics of this implementation of roles is:
355 If a method is already defined on a class, that method will not be composed in
360 If a method that the role L</requires> to be implemented is not implemented,
361 role application will fail loudly.
365 Unlike L<Class::C3>, where the B<last> class inherited from "wins," role
366 composition is the other way around, where the class wins. If multiple roles
367 are applied in a single call (single with statement), then if any of their
368 provided methods clash, an exception is raised unless the class provides
369 a method since this conflict indicates a potential problem.
371 =head1 IMPORTED SUBROUTINES
375 requires qw(foo bar);
377 Declares a list of methods that must be defined to compose role.
383 with 'Some::Role1', 'Some::Role2';
385 Composes another role into the current role (or class via L<Role::Tiny::With>).
387 If you have conflicts and want to resolve them in favour of Some::Role1 you
393 If you have conflicts and want to resolve different conflicts in favour of
394 different roles, please refactor your codebase.
398 before foo => sub { ... };
400 See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
403 Note that since you are not required to use method modifiers,
404 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
405 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
406 both L<Class::Method::Modifiers> and L<Role::Tiny>.
410 around foo => sub { ... };
412 See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
415 Note that since you are not required to use method modifiers,
416 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
417 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
418 both L<Class::Method::Modifiers> and L<Role::Tiny>.
422 after foo => sub { ... };
424 See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
427 Note that since you are not required to use method modifiers,
428 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
429 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
430 both L<Class::Method::Modifiers> and L<Role::Tiny>.
436 if (Role::Tiny::does_role($foo, 'Some::Role')) {
440 Returns true if class has been composed with role.
442 This subroutine is also installed as ->does on any class a Role::Tiny is
443 composed into unless that class already has an ->does method, so
445 if ($foo->does('Some::Role')) {
449 will work for classes but to test a role, one must use ::does_role directly
453 =head2 apply_roles_to_package
455 Role::Tiny->apply_roles_to_package(
456 'Some::Package', 'Some::Role', 'Some::Other::Role'
459 Composes role with package. See also L<Role::Tiny::With>.
461 =head2 apply_roles_to_object
463 Role::Tiny->apply_roles_to_object($foo, qw(Some::Role1 Some::Role2));
465 Composes roles in order into object directly. Object is reblessed into the
468 =head2 create_class_with_roles
470 Role::Tiny->create_class_with_roles('Some::Base', qw(Some::Role1 Some::Role2));
472 Creates a new class based on base, with the roles composed into it in order.
473 New class is returned.
477 L<Role::Tiny> is the attribute-less subset of L<Moo::Role>; L<Moo::Role> is
478 a meta-protocol-less subset of the king of role systems, L<Moose::Role>.
480 If you don't want method modifiers and do want to be forcibly restricted
481 to a single role application per class, Ovid's L<Role::Basic> exists. But
482 Stevan Little (the L<Moose> author) and I don't find the additional
483 restrictions to be amazingly helpful in most cases; L<Role::Basic>'s choices
484 are more a guide to what you should prefer doing, to our mind, rather than
485 something that needs to be enforced.
489 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
493 dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx>
495 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
497 hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org>
499 jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com>
501 ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org>
503 chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com>
505 ajgb - Alex J. G. BurzyĆski (cpan:AJGB) <ajgb@cpan.org>
507 doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net>
509 perigrin - Chris Prather (cpan:PERIGRIN) <chris@prather.org>
511 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
515 Copyright (c) 2010-2012 the Role::Tiny L</AUTHOR> and L</CONTRIBUTORS>
520 This library is free software and may be distributed under the same terms