/usr/share/perl5/Role/Tiny.pm is in librole-tiny-perl 1.003002-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 | package Role::Tiny;
sub _getglob { \*{$_[0]} }
sub _getstash { \%{"$_[0]::"} }
use strict;
use warnings FATAL => 'all';
our $VERSION = '1.003002'; # 1.3.2
$VERSION = eval $VERSION;
our %INFO;
our %APPLIED_TO;
our %COMPOSED;
our %COMPOSITE_INFO;
# 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;
$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])||{}};
my $guard = _WORK_AROUND_BROKEN_MODULE_STATE
&& bless([ $proto ], 'Role::Tiny::__GUARD__');
require $proto;
pop @$guard if _WORK_AROUND_BROKEN_MODULE_STATE;
return 1;
}
sub import {
my $target = caller;
my $me = shift;
strict->import;
warnings->import(FATAL => 'all');
return if $INFO{$target}; # already exported into this package
$INFO{$target}{is_role} = 1;
# get symbol table reference
my $stash = _getstash($target);
# install before/after/around subs
foreach my $type (qw(before after around)) {
*{_getglob "${target}::${type}"} = sub {
require Class::Method::Modifiers;
push @{$INFO{$target}{modifiers}||=[]}, [ $type => @_ ];
return;
};
}
*{_getglob "${target}::requires"} = sub {
push @{$INFO{$target}{requires}||=[]}, @_;
return;
};
*{_getglob "${target}::with"} = sub {
$me->apply_roles_to_package($target, @_);
return;
};
# grab all *non-constant* (stash slot is not a scalarref) subs present
# in the symbol table and store their refaddrs (no need to forcibly
# inflate constant subs into real subs) with a map to the coderefs in
# case of copying or re-use
my @not_methods = (map { *$_{CODE}||() } grep !ref($_), values %$stash);
@{$INFO{$target}{not_methods}={}}{@not_methods} = @not_methods;
# a role does itself
$APPLIED_TO{$target} = { $target => undef };
}
sub role_application_steps {
qw(_install_methods _check_requires _install_modifiers _copy_applied_list);
}
sub apply_single_role_to_package {
my ($me, $to, $role) = @_;
_load_module($role);
die "This is apply_role_to_package" if ref($to);
die "${role} is not a Role::Tiny" unless $INFO{$role};
foreach my $step ($me->role_application_steps) {
$me->$step($to, $role);
}
}
sub _copy_applied_list {
my ($me, $to, $role) = @_;
# copy our role list into the target's
@{$APPLIED_TO{$to}||={}}{keys %{$APPLIED_TO{$role}}} = ();
}
sub apply_roles_to_object {
my ($me, $object, @roles) = @_;
die "No roles supplied!" unless @roles;
my $class = ref($object);
bless($object, $me->create_class_with_roles($class, @roles));
$object;
}
my $role_suffix = 'A000';
sub _composite_name {
my ($me, $superclass, @roles) = @_;
my $new_name = join(
'__WITH__', $superclass, my $compose_name = join '__AND__', @roles
);
if (length($new_name) > 252) {
$new_name = $COMPOSED{abbrev}{$new_name}
||= substr($new_name, 0, 250 - length $role_suffix).'__'.$role_suffix++;
}
return wantarray ? ($new_name, $compose_name) : $new_name;
}
sub create_class_with_roles {
my ($me, $superclass, @roles) = @_;
die "No roles supplied!" unless @roles;
_load_module($superclass);
{
my %seen;
$seen{$_}++ for @roles;
if (my @dupes = grep $seen{$_} > 1, @roles) {
die "Duplicated roles: ".join(', ', @dupes);
}
}
my ($new_name, $compose_name) = $me->_composite_name($superclass, @roles);
return $new_name if $COMPOSED{class}{$new_name};
foreach my $role (@roles) {
_load_module($role);
die "${role} is not a Role::Tiny" unless $INFO{$role};
}
if ($] >= 5.010) {
require mro;
} else {
require MRO::Compat;
}
my $composite_info = $me->_composite_info_for(@roles);
my %conflicts = %{$composite_info->{conflicts}};
if (keys %conflicts) {
my $fail =
join "\n",
map {
"Method name conflict for '$_' between roles "
."'".join(' and ', sort values %{$conflicts{$_}})."'"
.", cannot apply these simultaneously to an object."
} keys %conflicts;
die $fail;
}
my @composable = map $me->_composable_package_for($_), reverse @roles;
# some methods may not exist in the role, but get generated by
# _composable_package_for (Moose accessors via Moo). filter out anything
# provided by the composable packages, excluding the subs we generated to
# make modifiers work.
my @requires = grep {
my $method = $_;
!grep $_->can($method) && !$COMPOSED{role}{$_}{modifiers_only}{$method},
@composable
} @{$composite_info->{requires}};
$me->_check_requires(
$superclass, $compose_name, \@requires
);
*{_getglob("${new_name}::ISA")} = [ @composable, $superclass ];
@{$APPLIED_TO{$new_name}||={}}{
map keys %{$APPLIED_TO{$_}}, @roles
} = ();
$COMPOSED{class}{$new_name} = 1;
return $new_name;
}
# preserved for compat, and apply_roles_to_package calls it to allow an
# updated Role::Tiny to use a non-updated Moo::Role
sub apply_role_to_package { shift->apply_single_role_to_package(@_) }
sub apply_roles_to_package {
my ($me, $to, @roles) = @_;
return $me->apply_role_to_package($to, $roles[0]) if @roles == 1;
my %conflicts = %{$me->_composite_info_for(@roles)->{conflicts}};
delete $conflicts{$_} for keys %{ $me->_concrete_methods_of($to) };
if (keys %conflicts) {
my $fail =
join "\n",
map {
"Due to a method name conflict between roles "
."'".join(' and ', sort values %{$conflicts{$_}})."'"
.", the method '$_' must be implemented by '${to}'"
} keys %conflicts;
die $fail;
}
# the if guard here is essential since otherwise we accidentally create
# a $INFO for something that isn't a Role::Tiny (or Moo::Role) because
# autovivification hates us and wants us to die()
if ($INFO{$to}) {
delete $INFO{$to}{methods}; # reset since we're about to add methods
}
# backcompat: allow subclasses to use apply_single_role_to_package
# to apply changes. set a local var so ours does nothing.
our %BACKCOMPAT_HACK;
if($me ne __PACKAGE__
and exists $BACKCOMPAT_HACK{$me} ? $BACKCOMPAT_HACK{$me} :
$BACKCOMPAT_HACK{$me} =
$me->can('role_application_steps')
== \&role_application_steps
&& $me->can('apply_single_role_to_package')
!= \&apply_single_role_to_package
) {
foreach my $role (@roles) {
$me->apply_single_role_to_package($to, $role);
}
}
else {
foreach my $step ($me->role_application_steps) {
foreach my $role (@roles) {
$me->$step($to, $role);
}
}
}
$APPLIED_TO{$to}{join('|',@roles)} = 1;
}
sub _composite_info_for {
my ($me, @roles) = @_;
$COMPOSITE_INFO{join('|', sort @roles)} ||= do {
foreach my $role (@roles) {
_load_module($role);
}
my %methods;
foreach my $role (@roles) {
my $this_methods = $me->_concrete_methods_of($role);
$methods{$_}{$this_methods->{$_}} = $role for keys %$this_methods;
}
my %requires;
@requires{map @{$INFO{$_}{requires}||[]}, @roles} = ();
delete $requires{$_} for keys %methods;
delete $methods{$_} for grep keys(%{$methods{$_}}) == 1, keys %methods;
+{ conflicts => \%methods, requires => [keys %requires] }
};
}
sub _composable_package_for {
my ($me, $role) = @_;
my $composed_name = 'Role::Tiny::_COMPOSABLE::'.$role;
return $composed_name if $COMPOSED{role}{$composed_name};
$me->_install_methods($composed_name, $role);
my $base_name = $composed_name.'::_BASE';
# force stash to exist so ->can doesn't complain
_getstash($base_name);
# Not using _getglob, since setting @ISA via the typeglob breaks
# inheritance on 5.10.0 if the stash has previously been accessed an
# then a method called on the class (in that order!), which
# ->_install_methods (with the help of ->_install_does) ends up doing.
{ no strict 'refs'; @{"${composed_name}::ISA"} = ( $base_name ); }
my $modifiers = $INFO{$role}{modifiers}||[];
my @mod_base;
my @modifiers = grep !$composed_name->can($_),
do { my %h; @h{map @{$_}[1..$#$_-1], @$modifiers} = (); keys %h };
foreach my $modified (@modifiers) {
push @mod_base, "sub ${modified} { shift->next::method(\@_) }";
}
my $e;
{
local $@;
eval(my $code = join "\n", "package ${base_name};", @mod_base);
$e = "Evaling failed: $@\nTrying to eval:\n${code}" if $@;
}
die $e if $e;
$me->_install_modifiers($composed_name, $role);
$COMPOSED{role}{$composed_name} = {
modifiers_only => { map { $_ => 1 } @modifiers },
};
return $composed_name;
}
sub _check_requires {
my ($me, $to, $name, $requires) = @_;
return unless my @requires = @{$requires||$INFO{$name}{requires}||[]};
if (my @requires_fail = grep !$to->can($_), @requires) {
# role -> role, add to requires, role -> class, error out
if (my $to_info = $INFO{$to}) {
push @{$to_info->{requires}||=[]}, @requires_fail;
} else {
die "Can't apply ${name} to ${to} - missing ".join(', ', @requires_fail);
}
}
}
sub _concrete_methods_of {
my ($me, $role) = @_;
my $info = $INFO{$role};
# grab role symbol table
my $stash = _getstash($role);
# reverse so our keys become the values (captured coderefs) in case
# they got copied or re-used since
my $not_methods = { reverse %{$info->{not_methods}||{}} };
$info->{methods} ||= +{
# grab all code entries that aren't in the not_methods list
map {
my $code = *{$stash->{$_}}{CODE};
( ! $code or exists $not_methods->{$code} ) ? () : ($_ => $code)
} grep !ref($stash->{$_}), keys %$stash
};
}
sub methods_provided_by {
my ($me, $role) = @_;
die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
(keys %{$me->_concrete_methods_of($role)}, @{$info->{requires}||[]});
}
sub _install_methods {
my ($me, $to, $role) = @_;
my $info = $INFO{$role};
my $methods = $me->_concrete_methods_of($role);
# grab target symbol table
my $stash = _getstash($to);
# determine already extant methods of target
my %has_methods;
@has_methods{grep
+(ref($stash->{$_}) || *{$stash->{$_}}{CODE}),
keys %$stash
} = ();
foreach my $i (grep !exists $has_methods{$_}, keys %$methods) {
no warnings 'once';
*{_getglob "${to}::${i}"} = $methods->{$i};
}
$me->_install_does($to);
}
sub _install_modifiers {
my ($me, $to, $name) = @_;
return unless my $modifiers = $INFO{$name}{modifiers};
if (my $info = $INFO{$to}) {
push @{$info->{modifiers}}, @{$modifiers||[]};
} else {
foreach my $modifier (@{$modifiers||[]}) {
$me->_install_single_modifier($to, @$modifier);
}
}
}
my $vcheck_error;
sub _install_single_modifier {
my ($me, @args) = @_;
defined($vcheck_error) or $vcheck_error = do {
local $@;
eval { Class::Method::Modifiers->VERSION(1.05); 1 }
? 0
: $@
};
$vcheck_error and die $vcheck_error;
Class::Method::Modifiers::install_modifier(@args);
}
my $FALLBACK = sub { 0 };
sub _install_does {
my ($me, $to) = @_;
# only add does() method to classes
return if $INFO{$to};
# add does() only if they don't have one
*{_getglob "${to}::does"} = \&does_role unless $to->can('does');
return if ($to->can('DOES') and $to->can('DOES') != (UNIVERSAL->can('DOES') || 0));
my $existing = $to->can('DOES') || $to->can('isa') || $FALLBACK;
my $new_sub = sub {
my ($proto, $role) = @_;
Role::Tiny::does_role($proto, $role) or $proto->$existing($role);
};
no warnings 'redefine';
*{_getglob "${to}::DOES"} = $new_sub;
}
sub does_role {
my ($proto, $role) = @_;
if ($] >= 5.010) {
require mro;
} else {
require MRO::Compat;
}
foreach my $class (@{mro::get_linear_isa(ref($proto)||$proto)}) {
return 1 if exists $APPLIED_TO{$class}{$role};
}
return 0;
}
sub is_role {
my ($me, $role) = @_;
return !!$INFO{$role};
}
1;
=encoding utf-8
=head1 NAME
Role::Tiny - Roles. Like a nouvelle cuisine portion size slice of Moose.
=head1 SYNOPSIS
package Some::Role;
use Role::Tiny;
sub foo { ... }
sub bar { ... }
around baz => sub { ... }
1;
else where
package Some::Class;
use Role::Tiny::With;
# bar gets imported, but not foo
with 'Some::Role';
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.
=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.
=back
Unlike L<Class::C3>, where the B<last> class inherited from "wins," role
composition is the other way around, where the class wins. If multiple roles
are applied in a single call (single with statement), then if any of their
provided methods clash, an exception is raised unless the class provides
a method since this conflict indicates a potential problem.
=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::Role1', 'Some::Role2';
Composes another role into the current role (or class via L<Role::Tiny::With>).
If you have conflicts and want to resolve them in favour of Some::Role1 you
can instead write:
with 'Some::Role1';
with 'Some::Role2';
If you have conflicts and want to resolve different conflicts in favour of
different roles, please refactor your codebase.
=head2 before
before foo => sub { ... };
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 { ... };
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 { ... };
See L<< Class::Method::Modifiers/after 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>.
=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('Some::Role')) {
...
}
will work for classes but to test a role, one must use ::does_role directly.
Additionally, Role::Tiny will override the standard Perl C<DOES> method
for your class. However, if C<any> class in your class' inheritance
hierarchy provides C<DOES>, then Role::Tiny will not override it.
=head1 METHODS
=head2 apply_roles_to_package
Role::Tiny->apply_roles_to_package(
'Some::Package', 'Some::Role', 'Some::Other::Role'
);
Composes role with package. See also L<Role::Tiny::With>.
=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.
=head2 is_role
Role::Tiny->is_role('Some::Role1')
Returns true if the given package is a role.
=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 don't find the additional
restrictions to be amazingly helpful in most cases; L<Role::Basic>'s choices
are more a guide to what you should prefer doing, to our mind, rather than
something that needs to be enforced.
=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>
Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
ilmari - Dagfinn Ilmari Mannsåker (cpan:ILMARI) <ilmari@ilmari.org>
tobyink - Toby Inkster (cpan:TOBYINK) <tobyink@cpan.org>
=head1 COPYRIGHT
Copyright (c) 2010-2012 the Role::Tiny L</AUTHOR> and L</CONTRIBUTORS>
as listed above.
=head1 LICENSE
This library is free software and may be distributed under the same terms
as perl itself.
=cut
|