X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnamespace%2Fclean.pm;h=156bde09032667ea3e503f5b90d82f6ec157d0ea;hb=5460fcfb77326c9e5f10b6f6961b4e3eb96e6dd2;hp=63521871ba1ee747788a57312f270d363a3c7a2d;hpb=0495b5c7558bf9f05c35716ffebb0bbe51f72d12;p=p5sagit%2Fnamespace-clean.git diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm index 6352187..156bde0 100644 --- a/lib/namespace/clean.pm +++ b/lib/namespace/clean.pm @@ -1,28 +1,16 @@ 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 B::Hooks::EndOfScope; -use Package::Stash; -use Sub::Identify qw(sub_fullname); -use Sub::Name qw(subname); - -=head1 VERSION - -0.13 - -=cut +use vars qw( $STORAGE_VAR ); +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; -$VERSION = '0.15'; -$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; +$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; =head1 SYNOPSIS @@ -62,7 +50,7 @@ $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; 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 pragma will remove all previously declared or @@ -137,14 +125,7 @@ option like this: 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 -appropriate place. - -=cut - -=head2 clean_subroutines +=method clean_subroutines This exposes the actual subroutine-removal logic. @@ -194,7 +175,7 @@ sub clean_subroutines { $RemoveSubs->($cleanee, {}, @subs); } -=head2 import +=method import Makes a snapshot of the current defined functions and installs a L hook in the current scope to invoke the cleanups. @@ -259,7 +240,7 @@ sub import { } } -=head2 unimport +=method unimport This method will be called when you do a @@ -287,9 +268,9 @@ sub unimport { 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 @@ -297,10 +278,13 @@ information about function names included and excluded from removal. sub get_class_store { my ($pragma, $class) = @_; my $stash = Package::Stash->new($class); - return $stash->get_package_symbol("%$STORAGE_VAR"); + my $var = "%$STORAGE_VAR"; + $stash->add_package_symbol($var, {}) + unless $stash->has_package_symbol($var); + return $stash->get_package_symbol($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 @@ -318,15 +302,9 @@ sub get_functions { }; } -=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 +This module works through the effect that a delete $SomePackage::{foo}; @@ -345,15 +323,9 @@ use C instead. L -=head1 AUTHOR AND COPYRIGHT - -Robert 'phaylon' Sedlacek Crs@474.atE>, 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