X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FRole%2FTiny.pm;h=751527d3f83531cf9bffb3fd9f0b03c18d1945ca;hb=d08f8b3a4538da568c97c9ff4af826c8765ca30f;hp=3a040fd8fe72fa2b27662c1c7454c836b7f427b4;hpb=0e5999f6bf632d065fe738f0f1f958d29221d74f;p=gitmo%2FRole-Tiny.git diff --git a/lib/Role/Tiny.pm b/lib/Role/Tiny.pm index 3a040fd..751527d 100644 --- a/lib/Role/Tiny.pm +++ b/lib/Role/Tiny.pm @@ -6,7 +6,7 @@ sub _getstash { \%{"$_[0]::"} } use strict; use warnings FATAL => 'all'; -our $VERSION = '1.001003'; # 1.1.3 +our $VERSION = '1.002005'; # 1.2.5 $VERSION = eval $VERSION; our %INFO; @@ -44,8 +44,9 @@ sub import { 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 = do { no strict 'refs'; \%{"${target}::"} }; + my $stash = _getstash($target); # install before/after/around subs foreach my $type (qw(before after around)) { *{_getglob "${target}::${type}"} = sub { @@ -64,33 +65,33 @@ sub import { }; # 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) - also add '' to here (this - # is used later) with a map to the coderefs in case of copying or re-use - my @not_methods = ('', map { *$_{CODE}||() } grep !ref($_), values %$stash); + # 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 my $info = $INFO{$role}; - - $me->_check_requires($to, $role, @{$info->{requires}||[]}); - - $me->_install_methods($to, $role); - - $me->_install_modifiers($to, $info->{modifiers}); + die "${role} is not a Role::Tiny" unless $INFO{$role}; - # only add does() method to classes and only if they don't have one - if (not $INFO{$to} and not $to->can('does')) { - *{_getglob "${to}::does"} = \&does_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}}} = (); } @@ -108,6 +109,7 @@ sub create_class_with_roles { die "No roles supplied!" unless @roles; + _load_module($superclass); { my %seen; $seen{$_}++ for @roles; @@ -133,7 +135,10 @@ sub create_class_with_roles { require MRO::Compat; } - my %conflicts = %{$me->_composite_info_for(@roles)->{conflicts}}; + my @composable = map $me->_composable_package_for($_), reverse @roles; + + my $composite_info = $me->_composite_info_for(@roles); + my %conflicts = %{$composite_info->{conflicts}}; if (keys %conflicts) { my $fail = join "\n", @@ -145,18 +150,17 @@ sub create_class_with_roles { die $fail; } - my @composable = map $me->_composable_package_for($_), reverse @roles; - - *{_getglob("${new_name}::ISA")} = [ @composable, $superclass ]; - - my @info = map $INFO{$_}, @roles; + my @requires = grep { + my $method = $_; + !grep $_->can($method) && !$COMPOSED{role}{$_}{modifiers_only}{$method}, + @composable + } @{$composite_info->{requires}}; $me->_check_requires( - $new_name, $compose_name, - do { my %h; @h{map @{$_->{requires}||[]}, @info} = (); keys %h } + $superclass, $compose_name, \@requires ); - *{_getglob "${new_name}::does"} = \&does_role unless $new_name->can('does'); + *{_getglob("${new_name}::ISA")} = [ @composable, $superclass ]; @{$APPLIED_TO{$new_name}||={}}{ map keys %{$APPLIED_TO{$_}}, @roles @@ -177,7 +181,7 @@ sub apply_roles_to_package { return $me->apply_role_to_package($to, $roles[0]) if @roles == 1; my %conflicts = %{$me->_composite_info_for(@roles)->{conflicts}}; - delete $conflicts{$_} for $me->_concrete_methods_of($to); + delete $conflicts{$_} for keys %{ $me->_concrete_methods_of($to) }; if (keys %conflicts) { my $fail = join "\n", @@ -196,21 +200,47 @@ sub apply_roles_to_package { delete $INFO{$to}{methods}; # reset since we're about to add methods } - $me->apply_role_to_package($to, $_) for @roles; + # 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 { - _load_module($_) for @roles; + 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 } + +{ conflicts => \%methods, requires => [keys %requires] } }; } @@ -220,12 +250,18 @@ sub _composable_package_for { return $composed_name if $COMPOSED{role}{$composed_name}; $me->_install_methods($composed_name, $role); my $base_name = $composed_name.'::_BASE'; - *{_getglob("${composed_name}::ISA")} = [ $base_name ]; + # force stash to exist + _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; - foreach my $modified ( - do { my %h; @h{map $_->[1], @$modifiers} = (); keys %h } - ) { + 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; @@ -235,13 +271,16 @@ sub _composable_package_for { $e = "Evaling failed: $@\nTrying to eval:\n${code}" if $@; } die $e if $e; - $me->_install_modifiers($composed_name, $modifiers); - $COMPOSED{role}{$composed_name} = 1; + $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) = @_; + 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}) { @@ -256,7 +295,7 @@ sub _concrete_methods_of { my ($me, $role) = @_; my $info = $INFO{$role}; # grab role symbol table - my $stash = do { no strict 'refs'; \%{"${role}::"}}; + 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}||{}} }; @@ -264,8 +303,7 @@ sub _concrete_methods_of { # grab all code entries that aren't in the not_methods list map { my $code = *{$stash->{$_}}{CODE}; - # rely on the '' key we added in import for "no code here" - exists $not_methods->{$code||''} ? () : ($_ => $code) + ( ! $code or exists $not_methods->{$code} ) ? () : ($_ => $code) } grep !ref($stash->{$_}), keys %$stash }; } @@ -284,7 +322,7 @@ sub _install_methods { my $methods = $me->_concrete_methods_of($role); # grab target symbol table - my $stash = do { no strict 'refs'; \%{"${to}::"}}; + my $stash = _getstash($to); # determine already extant methods of target my %has_methods; @@ -297,10 +335,13 @@ sub _install_methods { no warnings 'once'; *{_getglob "${to}::${i}"} = $methods->{$i}; } + + $me->_install_does($to); } sub _install_modifiers { - my ($me, $to, $modifiers) = @_; + my ($me, $to, $name) = @_; + return unless my $modifiers = $INFO{$name}{modifiers}; if (my $info = $INFO{$to}) { push @{$info->{modifiers}}, @{$modifiers||[]}; } else { @@ -310,18 +351,63 @@ sub _install_modifiers { } } +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) = @_; - return exists $APPLIED_TO{ref($proto)||$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. @@ -465,7 +551,11 @@ composed into unless that class already has an ->does method, so ... } -will work for classes but to test a role, one must use ::does_role directly +will work for classes but to test a role, one must use ::does_role directly. + +Additionally, Role::Tiny will override the standard Perl C method +for your class. However, if C class in your class' inheritance +hierarchy provides C, then Role::Tiny will not override it. =head1 METHODS @@ -491,6 +581,12 @@ resulting class. 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 is the attribute-less subset of L; L is @@ -529,6 +625,10 @@ perigrin - Chris Prather (cpan:PERIGRIN) Mithaldu - Christian Walde (cpan:MITHALDU) +ilmari - Dagfinn Ilmari Mannsåker (cpan:ILMARI) + +tobyink - Toby Inkster (cpan:TOBYINK) + =head1 COPYRIGHT Copyright (c) 2010-2012 the Role::Tiny L and L