X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnamespace%2Fclean.pm;h=d31d2a82ba6d8ef568e79d8df7f67f3ea5a2740b;hb=d6aecfbf3b72bb46d52032f696415e93a22dc5ab;hp=d11a7c46a348ac3d2448c382a7772321c2beb3ea;hpb=99d2e6b61c03d29efc6848f563f67308cb0da816;p=p5sagit%2Fnamespace-clean.git diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm index d11a7c4..d31d2a8 100644 --- a/lib/namespace/clean.pm +++ b/lib/namespace/clean.pm @@ -9,18 +9,20 @@ namespace::clean - Keep imports and functions out of your namespace use warnings; use strict; -use vars qw( $VERSION $STORAGE_VAR ); -use Symbol qw( qualify_to_ref ); -use Filter::EOF; +use vars qw( $VERSION $STORAGE_VAR $SCOPE_HOOK_KEY $SCOPE_EXPLICIT ); +use B::Hooks::EndOfScope; +use Stash::Manip; +use Sub::Identify qw(sub_fullname); +use Sub::Name qw(subname); =head1 VERSION -0.06 +0.13 =cut -$VERSION = 0.06; -$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; +$VERSION = '0.14'; +$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; =head1 SYNOPSIS @@ -55,6 +57,8 @@ $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; =head1 DESCRIPTION +=head2 Keeping packages clean + When you define a function, or import one, into a Perl package, it will naturally also be available as a method. This does not per se cause problems, but it can complicate subclassing and, for example, plugin @@ -79,6 +83,60 @@ be a module exporting an C method along with some functions: If you just want to C<-except> a single sub, you can pass it directly. For more than one value you have to use an array reference. +=head2 Explicitely removing functions when your scope is compiled + +It is also possible to explicitely tell C what packages +to remove when the surrounding scope has finished compiling. Here is an +example: + + package Foo; + use strict; + + # blessed NOT available + + sub my_class { + use Scalar::Util qw( blessed ); + use namespace::clean qw( blessed ); + + # blessed available + return blessed shift; + } + + # blessed NOT available + +=head2 Moose + +When using C together with L you want to keep +the installed C method. So your classes should look like: + + package Foo; + use Moose; + use namespace::clean -except => 'meta'; + ... + +Same goes for L. + +=head2 Cleaning other packages + +You can tell C that you want to clean up another package +instead of the one importing. To do this you have to pass in the C<-cleanee> +option like this: + + package My::MooseX::namespace::clean; + use strict; + + use namespace::clean (); # no cleanup, just load + + sub import { + namespace::clean->import( + -cleanee => scalar(caller), + -except => 'meta', + ); + } + +If you don't care about Cs discover-and-C<-except> logic, and +just want to remove subroutines, try L. + =head1 METHODS You shouldn't need to call any of these. Just C the package at the @@ -86,65 +144,119 @@ appropriate place. =cut -=head2 import +=head2 clean_subroutines -Makes a snapshot of the current defined functions and registers a -L cleanup routine to remove those symbols at the end -of the compile-time. +This exposes the actual subroutine-removal logic. -=cut + namespace::clean->clean_subroutines($cleanee, qw( subA subB )); -sub import { - my ($pragma, %args) = @_; +will remove C and C from C<$cleanee>. Note that this will remove the +subroutines B and not wait for scope end. If you want to have this +effect at a specific time (e.g. C acts on scope compile end) +it is your responsibility to make sure it runs at that time. - # calling class, all current functions and our storage - my $cleanee = caller; - my $functions = $pragma->get_functions($cleanee); - my $store = $pragma->get_class_store($cleanee); +=cut - # except parameter can be array ref or single value - my %except = map {( $_ => 1 )} ( - $args{ -except } - ? ( ref $args{ -except } eq 'ARRAY' ? @{ $args{ -except } } : $args{ -except } ) - : () - ); +my $RemoveSubs = sub { + + my $cleanee = shift; + my $store = shift; + my $cleanee_stash = Stash::Manip->new($cleanee); + my $deleted_stash = Stash::Manip->new("namespace::clean::deleted::$cleanee"); + SYMBOL: + for my $f (@_) { + my $variable = "&$f"; + # ignore already removed symbols + next SYMBOL if $store->{exclude}{ $f }; + + next SYMBOL unless $cleanee_stash->has_package_symbol($variable); + + if (ref(\$cleanee_stash->namespace->{$f}) eq 'GLOB') { + # convince the Perl debugger to work + # it assumes that sub_fullname($sub) can always be used to find the CV again + # since we are deleting the glob where the subroutine was originally + # defined, that assumption no longer holds, so we need to move it + # elsewhere and point the CV's name to the new glob. + my $sub = $cleanee_stash->get_package_symbol($variable); + if ( sub_fullname($sub) eq ($cleanee_stash->name . "::$f") ) { + my $new_fq = $deleted_stash->name . "::$f"; + subname($new_fq, $sub); + $deleted_stash->add_package_symbol($variable, $sub); + } + } - # register symbols for removal, if they have a CODE entry - for my $f (keys %$functions) { - next if $except{ $f }; - next unless $functions->{ $f } - and *{ $functions->{ $f } }{CODE}; - $store->{remove}{ $f } = 1; + $cleanee_stash->remove_package_symbol($variable); } +}; - # register EOF handler on first call to import - unless ($store->{handler_is_installed}) { - Filter::EOF->on_eof_call(sub { - SYMBOL: - for my $f (keys %{ $store->{remove} }) { - - # ignore already removed symbols - next SYMBOL if $store->{exclude}{ $f }; - no strict 'refs'; - - # keep original value to restore non-code slots - { no warnings 'uninitialized'; # fix possible unimports - local *__tmp = *{ ${ "${cleanee}::" }{ $f } }; - delete ${ "${cleanee}::" }{ $f }; - } - - SLOT: - # restore non-code slots to symbol - for my $t (qw( SCALAR ARRAY HASH IO FORMAT )) { - next SLOT unless defined *__tmp{ $t }; - *{ "${cleanee}::$f" } = *__tmp{ $t }; - } - } - }); - $store->{handler_is_installed} = 1; +sub clean_subroutines { + my ($nc, $cleanee, @subs) = @_; + $RemoveSubs->($cleanee, {}, @subs); +} + +=head2 import + +Makes a snapshot of the current defined functions and installs a +L hook in the current scope to invoke the cleanups. + +=cut + +sub import { + my ($pragma, @args) = @_; + + my (%args, $is_explicit); + + ARG: + while (@args) { + + if ($args[0] =~ /^\-/) { + my $key = shift @args; + my $value = shift @args; + $args{ $key } = $value; + } + else { + $is_explicit++; + last ARG; + } } - return 1; + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; + if ($is_explicit) { + on_scope_end { + $RemoveSubs->($cleanee, {}, @args); + }; + } + else { + + # calling class, all current functions and our storage + my $functions = $pragma->get_functions($cleanee); + my $store = $pragma->get_class_store($cleanee); + my $stash = Stash::Manip->new($cleanee); + + # except parameter can be array ref or single value + my %except = map {( $_ => 1 )} ( + $args{ -except } + ? ( ref $args{ -except } eq 'ARRAY' ? @{ $args{ -except } } : $args{ -except } ) + : () + ); + + # register symbols for removal, if they have a CODE entry + for my $f (keys %$functions) { + next if $except{ $f }; + next unless $stash->has_package_symbol("&$f"); + $store->{remove}{ $f } = 1; + } + + # register EOF handler on first call to import + unless ($store->{handler_is_installed}) { + on_scope_end { + $RemoveSubs->($cleanee, $store, keys %{ $store->{remove} }); + }; + $store->{handler_is_installed} = 1; + } + + return 1; + } } =head2 unimport @@ -158,10 +270,10 @@ It will start a new section of code that defines functions to clean up. =cut sub unimport { - my ($pragma) = @_; + my ($pragma, %args) = @_; # the calling class, the current functions and our storage - my $cleanee = caller; + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; my $functions = $pragma->get_functions($cleanee); my $store = $pragma->get_class_store($cleanee); @@ -184,8 +296,8 @@ information about function names included and excluded from removal. sub get_class_store { my ($pragma, $class) = @_; - no strict 'refs'; - return \%{ "${class}::${STORAGE_VAR}" }; + my $stash = Stash::Manip->new($class); + return $stash->get_package_symbol("%$STORAGE_VAR"); } =head2 get_functions @@ -199,15 +311,19 @@ reference to the symbol as value. sub get_functions { my ($pragma, $class) = @_; + my $stash = Stash::Manip->new($class); return { - map { @$_ } # key => value - grep { *{ $_->[1] }{CODE} } # only functions - map { [$_, qualify_to_ref( $_, $class )] } # get globref - grep { $_ !~ /::$/ } # no packages - do { no strict 'refs'; keys %{ "${class}::" } } # symbol entries + map { $_ => $stash->get_package_symbol("&$_") } + $stash->list_all_package_symbols('CODE') }; } +=head1 BUGS + +C will clobber any formats that have the same name as +a deleted sub. This is due to a bug in perl that makes it impossible to +re-assign the FORMAT ref into a new glob. + =head1 IMPLEMENTATION DETAILS This module works through the effect that a @@ -227,7 +343,7 @@ use C instead. =head1 SEE ALSO -L +L =head1 AUTHOR AND COPYRIGHT @@ -241,4 +357,5 @@ it under the same terms as perl itself. =cut -1; +no warnings; +'Danger! Laws of Thermodynamics may not apply.'