3 sub _getglob { \*{$_[0]} }
4 sub _getstash { \%{"$_[0]::"} }
7 use warnings FATAL => 'all';
9 our $VERSION = '1.000_901'; # 1.0.901
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 => @_ ];
56 *{_getglob "${target}::requires"} = sub {
57 push @{$INFO{$target}{requires}||=[]}, @_;
59 *{_getglob "${target}::with"} = sub {
60 $me->apply_roles_to_package($target, @_);
62 # grab all *non-constant* (stash slot is not a scalarref) subs present
63 # in the symbol table and store their refaddrs (no need to forcibly
64 # inflate constant subs into real subs) - also add '' to here (this
66 @{$INFO{$target}{not_methods}={}}{
67 '', map { *$_{CODE}||() } grep !ref($_), values %$stash
70 $APPLIED_TO{$target} = { $target => undef };
73 sub apply_single_role_to_package {
74 my ($me, $to, $role) = @_;
78 die "This is apply_role_to_package" if ref($to);
79 die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
81 $me->_check_requires($to, $role, @{$info->{requires}||[]});
83 $me->_install_methods($to, $role);
85 $me->_install_modifiers($to, $info->{modifiers});
87 # only add does() method to classes and only if they don't have one
88 if (not $INFO{$to} and not $to->can('does')) {
89 *{_getglob "${to}::does"} = \&does_role;
92 # copy our role list into the target's
93 @{$APPLIED_TO{$to}||={}}{keys %{$APPLIED_TO{$role}}} = ();
96 sub apply_roles_to_object {
97 my ($me, $object, @roles) = @_;
98 die "No roles supplied!" unless @roles;
99 my $class = ref($object);
100 bless($object, $me->create_class_with_roles($class, @roles));
104 sub create_class_with_roles {
105 my ($me, $superclass, @roles) = @_;
107 die "No roles supplied!" unless @roles;
111 $seen{$_}++ for @roles;
112 if (my @dupes = grep $seen{$_} > 1, @roles) {
113 die "Duplicated roles: ".join(', ', @dupes);
118 '__WITH__', $superclass, my $compose_name = join '__AND__', @roles
121 return $new_name if $COMPOSED{class}{$new_name};
123 foreach my $role (@roles) {
125 die "${role} is not a Role::Tiny" unless $INFO{$role};
134 my @composable = map $me->_composable_package_for($_), reverse @roles;
136 *{_getglob("${new_name}::ISA")} = [ @composable, $superclass ];
138 my @info = map $INFO{$_}, @roles;
140 $me->_check_requires(
141 $new_name, $compose_name,
142 do { my %h; @h{map @{$_->{requires}||[]}, @info} = (); keys %h }
145 *{_getglob "${new_name}::does"} = \&does_role unless $new_name->can('does');
147 @{$APPLIED_TO{$new_name}||={}}{
148 map keys %{$APPLIED_TO{$_}}, @roles
151 $COMPOSED{class}{$new_name} = 1;
155 # preserved for compat, and apply_roles_to_package calls it to allow an
156 # updated Role::Tiny to use a non-updated Moo::Role
158 sub apply_role_to_package { shift->apply_single_role_to_package(@_) }
160 sub apply_roles_to_package {
161 my ($me, $to, @roles) = @_;
163 return $me->apply_role_to_package($to, $roles[0]) if @roles == 1;
165 my %conflicts = %{$me->_composite_info_for(@roles)->{conflicts}};
166 delete $conflicts{$_} for $me->_concrete_methods_of($to);
167 if (keys %conflicts) {
171 "Due to a method name conflict between roles "
172 ."'".join(' and ', sort values %{$conflicts{$_}})."'"
173 .", the method '$_' must be implemented by '${to}'"
177 delete $INFO{$to}{methods}; # reset since we're about to add methods
178 $me->apply_role_to_package($to, $_) for @roles;
179 $APPLIED_TO{$to}{join('|',@roles)} = 1;
182 sub _composite_info_for {
183 my ($me, @roles) = @_;
184 $COMPOSITE_INFO{join('|', sort @roles)} ||= do {
185 _load_module($_) for @roles;
187 foreach my $role (@roles) {
188 my $this_methods = $me->_concrete_methods_of($role);
189 $methods{$_}{$this_methods->{$_}} = $role for keys %$this_methods;
191 delete $methods{$_} for grep keys(%{$methods{$_}}) == 1, keys %methods;
192 +{ conflicts => \%methods }
196 sub _composable_package_for {
197 my ($me, $role) = @_;
198 my $composed_name = 'Role::Tiny::_COMPOSABLE::'.$role;
199 return $composed_name if $COMPOSED{role}{$composed_name};
200 $me->_install_methods($composed_name, $role);
201 my $base_name = $composed_name.'::_BASE';
202 *{_getglob("${composed_name}::ISA")} = [ $base_name ];
203 my $modifiers = $INFO{$role}{modifiers}||[];
205 foreach my $modified (
206 do { my %h; @h{map $_->[1], @$modifiers} = (); keys %h }
208 push @mod_base, "sub ${modified} { shift->next::method(\@_) }";
213 eval(my $code = join "\n", "package ${base_name};", @mod_base);
214 $e = "Evaling failed: $@\nTrying to eval:\n${code}" if $@;
217 $me->_install_modifiers($composed_name, $modifiers);
218 $COMPOSED{role}{$composed_name} = 1;
219 return $composed_name;
222 sub _check_requires {
223 my ($me, $to, $name, @requires) = @_;
224 if (my @requires_fail = grep !$to->can($_), @requires) {
225 # role -> role, add to requires, role -> class, error out
226 if (my $to_info = $INFO{$to}) {
227 push @{$to_info->{requires}||=[]}, @requires_fail;
229 die "Can't apply ${name} to ${to} - missing ".join(', ', @requires_fail);
234 sub _concrete_methods_of {
235 my ($me, $role) = @_;
236 my $info = $INFO{$role};
237 # grab role symbol table
238 my $stash = do { no strict 'refs'; \%{"${role}::"}};
239 my $not_methods = $info->{not_methods};
240 $info->{methods} ||= +{
241 # grab all code entries that aren't in the not_methods list
243 my $code = *{$stash->{$_}}{CODE};
244 # rely on the '' key we added in import for "no code here"
245 exists $not_methods->{$code||''} ? () : ($_ => $code)
246 } grep !ref($stash->{$_}), keys %$stash
250 sub methods_provided_by {
251 my ($me, $role) = @_;
252 die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
253 (keys %{$me->_concrete_methods_of($role)}, @{$info->{requires}||[]});
256 sub _install_methods {
257 my ($me, $to, $role) = @_;
259 my $info = $INFO{$role};
261 my $methods = $me->_concrete_methods_of($role);
263 # grab target symbol table
264 my $stash = do { no strict 'refs'; \%{"${to}::"}};
266 # determine already extant methods of target
269 +(ref($stash->{$_}) || *{$stash->{$_}}{CODE}),
273 foreach my $i (grep !exists $has_methods{$_}, keys %$methods) {
275 *{_getglob "${to}::${i}"} = $methods->{$i};
279 sub _install_modifiers {
280 my ($me, $to, $modifiers) = @_;
281 if (my $info = $INFO{$to}) {
282 push @{$info->{modifiers}}, @{$modifiers||[]};
284 foreach my $modifier (@{$modifiers||[]}) {
285 $me->_install_single_modifier($to, @$modifier);
290 sub _install_single_modifier {
291 my ($me, @args) = @_;
292 Class::Method::Modifiers::install_modifier(@args);
296 my ($proto, $role) = @_;
297 return exists $APPLIED_TO{ref($proto)||$proto}{$role};
304 Role::Tiny - Roles. Like a nouvelle cuisine portion size slice of Moose.
316 around baz => sub { ... }
324 use Role::Tiny::With;
326 # bar gets imported, but not foo
331 # baz is wrapped in the around modifier by Class::Method::Modifiers
336 If you wanted attributes as well, look at L<Moo::Role>.
340 C<Role::Tiny> is a minimalist role composition tool.
342 =head1 ROLE COMPOSITION
344 Role composition can be thought of as much more clever and meaningful multiple
345 inheritance. The basics of this implementation of roles is:
351 If a method is already defined on a class, that method will not be composed in
356 If a method that the role L</requires> to be implemented is not implemented,
357 role application will fail loudly.
361 Unlike L<Class::C3>, where the B<last> class inherited from "wins," role
362 composition is the other way around, where the class wins. If multiple roles
363 are applied in a single call (single with statement), then if any of their
364 provided methods clash, an exception is raised unless the class provides
365 a method since this conflict indicates a potential problem.
367 =head1 IMPORTED SUBROUTINES
371 requires qw(foo bar);
373 Declares a list of methods that must be defined to compose role.
379 with 'Some::Role1', 'Some::Role2';
381 Composes another role into the current role (or class via L<Role::Tiny::With>).
383 If you have conflicts and want to resolve them in favour of Some::Role1 you
389 If you have conflicts and want to resolve different conflicts in favour of
390 different roles, please refactor your codebase.
394 before foo => sub { ... };
396 See L<< Class::Method::Modifiers/before method(s) => sub { ... } >> for full
399 Note that since you are not required to use method modifiers,
400 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
401 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
402 both L<Class::Method::Modifiers> and L<Role::Tiny>.
406 around foo => sub { ... };
408 See L<< Class::Method::Modifiers/around method(s) => sub { ... } >> for full
411 Note that since you are not required to use method modifiers,
412 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
413 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
414 both L<Class::Method::Modifiers> and L<Role::Tiny>.
418 after foo => sub { ... };
420 See L<< Class::Method::Modifiers/after method(s) => sub { ... } >> for full
423 Note that since you are not required to use method modifiers,
424 L<Class::Method::Modifiers> is lazily loaded and we do not declare it as
425 a dependency. If your L<Role::Tiny> role uses modifiers you must depend on
426 both L<Class::Method::Modifiers> and L<Role::Tiny>.
432 if (Role::Tiny::does_role($foo, 'Some::Role')) {
436 Returns true if class has been composed with role.
438 This subroutine is also installed as ->does on any class a Role::Tiny is
439 composed into unless that class already has an ->does method, so
441 if ($foo->does('Some::Role')) {
445 will work for classes but to test a role, one must use ::does_role directly
449 =head2 apply_roles_to_package
451 Role::Tiny->apply_roles_to_package(
452 'Some::Package', 'Some::Role', 'Some::Other::Role'
455 Composes role with package. See also L<Role::Tiny::With>.
457 =head2 apply_roles_to_object
459 Role::Tiny->apply_roles_to_object($foo, qw(Some::Role1 Some::Role2));
461 Composes roles in order into object directly. Object is reblessed into the
464 =head2 create_class_with_roles
466 Role::Tiny->create_class_with_roles('Some::Base', qw(Some::Role1 Some::Role2));
468 Creates a new class based on base, with the roles composed into it in order.
469 New class is returned.
473 L<Role::Tiny> is the attribute-less subset of L<Moo::Role>; L<Moo::Role> is
474 a meta-protocol-less subset of the king of role systems, L<Moose::Role>.
476 If you don't want method modifiers and do want to be forcibly restricted
477 to a single role application per class, Ovid's L<Role::Basic> exists. But
478 Stevan Little (the L<Moose> author) and I don't find the additional
479 restrictions to be amazingly helpful in most cases; L<Role::Basic>'s choices
480 are more a guide to what you should prefer doing, to our mind, rather than
481 something that needs to be enforced.
485 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
489 dg - David Leadbeater (cpan:DGL) <dgl@dgl.cx>
491 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
493 hobbs - Andrew Rodland (cpan:ARODLAND) <arodland@cpan.org>
495 jnap - John Napiorkowski (cpan:JJNAPIORK) <jjn1056@yahoo.com>
497 ribasushi - Peter Rabbitson (cpan:RIBASUSHI) <ribasushi@cpan.org>
499 chip - Chip Salzenberg (cpan:CHIPS) <chip@pobox.com>
501 ajgb - Alex J. G. BurzyĆski (cpan:AJGB) <ajgb@cpan.org>
503 doy - Jesse Luehrs (cpan:DOY) <doy at tozt dot net>
505 perigrin - Chris Prather (cpan:PERIGRIN) <chris@prather.org>
507 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
511 Copyright (c) 2010-2012 the Role::Tiny L</AUTHOR> and L</CONTRIBUTORS>
516 This library is free software and may be distributed under the same terms