package namespace::clean;
-
-=head1 NAME
-
-namespace::clean - Keep imports and functions out of your namespace
-
-=cut
+# ABSTRACT: Keep imports and functions out of your namespace
use warnings;
use strict;
-use vars qw( $VERSION $STORAGE_VAR $SCOPE_HOOK_KEY $SCOPE_EXPLICIT );
-use Symbol qw( qualify_to_ref gensym );
-use B::Hooks::EndOfScope;
-use Sub::Identify qw(sub_fullname);
-use Sub::Name qw(subname);
+use vars qw( $STORAGE_VAR $SCOPE_HOOK_KEY $SCOPE_EXPLICIT );
+use Sub::Name 0.04 qw(subname);
+use Sub::Identify 0.04 qw(sub_fullname);
+use Package::Stash 0.03;
+use B::Hooks::EndOfScope 0.07;
-=head1 VERSION
-
-0.13
-
-=cut
-
-$VERSION = '0.13';
$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
=head1 SYNOPSIS
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
-classes that are included via multiple inheritance by loading them as
+classes that are included via multiple inheritance by loading them as
base classes.
The C<namespace::clean> pragma will remove all previously declared or
If you don't care about C<namespace::clean>s discover-and-C<-except> logic, and
just want to remove subroutines, try L</clean_subroutines>.
-=head1 METHODS
-
-You shouldn't need to call any of these. Just C<use> the package at the
-appropriate place.
-
-=cut
-
-=head2 clean_subroutines
+=method clean_subroutines
This exposes the actual subroutine-removal logic.
my $cleanee = shift;
my $store = shift;
+ my $cleanee_stash = Package::Stash->new($cleanee);
+ my $deleted_stash = Package::Stash->new("namespace::clean::deleted::$cleanee");
SYMBOL:
for my $f (@_) {
- my $fq = "${cleanee}::$f";
-
+ my $variable = "&$f";
# ignore already removed symbols
next SYMBOL if $store->{exclude}{ $f };
- no strict 'refs';
- next SYMBOL unless exists ${ "${cleanee}::" }{ $f };
+ next SYMBOL unless $cleanee_stash->has_package_symbol($variable);
- if (ref(\${ "${cleanee}::" }{ $f }) eq 'GLOB') {
+ 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 = \&$fq;
- if ( sub_fullname($sub) eq $fq ) {
- my $new_fq = "namespace::clean::deleted::$fq";
+ 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);
- *{$new_fq} = $sub;
+ $deleted_stash->add_package_symbol($variable, $sub);
}
-
- local *__tmp;
-
- # keep original value to restore non-code slots
- { no warnings 'uninitialized'; # fix possible unimports
- *__tmp = *{ ${ "${cleanee}::" }{ $f } };
- delete ${ "${cleanee}::" }{ $f };
- }
-
- SLOT:
- # restore non-code slots to symbol.
- # omit the FORMAT slot, since perl erroneously puts it into the
- # SCALAR slot of the new glob.
- for my $t (qw( SCALAR ARRAY HASH IO )) {
- next SLOT unless defined *__tmp{ $t };
- *{ "${cleanee}::$f" } = *__tmp{ $t };
- }
- }
- else {
- # A non-glob in the stash is assumed to stand for some kind
- # of function. So far they all do, but the core might change
- # this some day. Watch perl5-porters.
- delete ${ "${cleanee}::" }{ $f };
}
+
+ $cleanee_stash->remove_package_symbol($variable);
}
};
$RemoveSubs->($cleanee, {}, @subs);
}
-=head2 import
+=method import
Makes a snapshot of the current defined functions and installs a
L<B::Hooks::EndOfScope> hook in the current scope to invoke the cleanups.
# calling class, all current functions and our storage
my $functions = $pragma->get_functions($cleanee);
my $store = $pragma->get_class_store($cleanee);
+ my $stash = Package::Stash->new($cleanee);
# except parameter can be array ref or single value
my %except = map {( $_ => 1 )} (
# 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};
+ next unless $stash->has_package_symbol("&$f");
$store->{remove}{ $f } = 1;
}
}
}
-=head2 unimport
+=method unimport
This method will be called when you do a
return 1;
}
-=head2 get_class_store
+=method get_class_store
-This returns a reference to a hash in a passed package containing
+This returns a reference to a hash in a passed package containing
information about function names included and excluded from removal.
=cut
sub get_class_store {
my ($pragma, $class) = @_;
- no strict 'refs';
- return \%{ "${class}::${STORAGE_VAR}" };
+ my $stash = Package::Stash->new($class);
+ return $stash->get_package_symbol("%$STORAGE_VAR");
}
-=head2 get_functions
+=method get_functions
Takes a class as argument and returns all currently defined functions
in it as a hash reference with the function name as key and a typeglob
sub get_functions {
my ($pragma, $class) = @_;
+ my $stash = Package::Stash->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<namespace::clean> 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
+This module works through the effect that a
delete $SomePackage::{foo};
L<B::Hooks::EndOfScope>
-=head1 AUTHOR AND COPYRIGHT
-
-Robert 'phaylon' Sedlacek C<E<lt>rs@474.atE<gt>>, with many thanks to
-Matt S Trout for the inspiration on the whole idea.
-
-=head1 LICENSE
+=head1 THANKS
-This program is free software; you can redistribute it and/or modify
-it under the same terms as perl itself.
+Many thanks to Matt S Trout for the inspiration on the whole idea.
=cut
projects / p5sagit/namespace-clean.git / blobdiff