De-dzilify. This may look odd and borderline revolting - read on

[p5sagit/namespace-clean.git] / lib / namespace / clean.pm

diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm
index f02bece..41cd7a3 100644 (file)
--- a/lib/namespace/clean.pm
+++ b/lib/namespace/clean.pm
@@ -5,11 +5,51 @@ use warnings;
 use strict;
 
 use vars qw( $STORAGE_VAR );
-use Package::Stash 0.22;
-use B::Hooks::EndOfScope 0.07;
+use Package::Stash;
+
+our $VERSION = '0.20';
 
 $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
 
+BEGIN {
+  if (eval {
+    require B::Hooks::EndOfScope;
+    B::Hooks::EndOfScope->VERSION('0.07');  # when changing also change in Makefile.PL
+    1
+  } ) {
+    B::Hooks::EndOfScope->import('on_scope_end');
+  }
+  else {
+    eval <<'PP' or die $@;
+
+  {
+    package namespace::clean::_ScopeGuard;
+
+    sub arm { bless [ $_[1] ] }
+
+    sub DESTROY { $_[0]->[0]->() }
+  }
+
+  use Tie::Hash ();
+
+  sub on_scope_end (&) {
+    $^H |= 0x020000;
+
+    if( my $stack = tied( %^H ) ) {
+      push @$stack, namespace::clean::_ScopeGuard->arm(shift);
+    }
+    else {
+      tie( %^H, 'Tie::ExtraHash', namespace::clean::_ScopeGuard->arm(shift) );
+    }
+  }
+
+  1;
+
+PP
+
+  }
+}
+
 =head1 SYNOPSIS
 
   package Foo;
@@ -69,9 +109,9 @@ be a module exporting an C<import> 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
+=head2 Explicitly removing functions when your scope is compiled
 
-It is also possible to explicitely tell C<namespace::clean> what packages
+It is also possible to explicitly tell C<namespace::clean> what packages
 to remove when the surrounding scope has finished compiling. Here is an
 example:
 
@@ -123,7 +163,9 @@ option like this:
 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>.
 
-=method clean_subroutines
+=head1 METHODS
+
+=head2 clean_subroutines
 
 This exposes the actual subroutine-removal logic.
 
@@ -207,7 +249,7 @@ sub clean_subroutines {
     $RemoveSubs->($cleanee, {}, @subs);
 }
 
-=method import
+=head2 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.
@@ -272,7 +314,7 @@ sub import {
     }
 }
 
-=method unimport
+=head2 unimport
 
 This method will be called when you do a
 
@@ -300,7 +342,7 @@ sub unimport {
     return 1;
 }
 
-=method get_class_store
+=head2 get_class_store
 
 This returns a reference to a hash in a passed package containing
 information about function names included and excluded from removal.
@@ -316,7 +358,7 @@ sub get_class_store {
     return $stash->get_symbol($var);
 }
 
-=method get_functions
+=head2 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
@@ -351,6 +393,14 @@ will be stable in future releases.
 Just for completeness sake, if you want to remove the symbol completely,
 use C<undef> instead.
 
+=head1 CAVEATS
+
+This module is fully functional in a pure-perl environment, where
+L<Variable::Magic>, a L<B::Hooks::EndOfScope> dependency, may not be
+available. However in this case this module falls back to a
+L<tie()|perlfunc/tie> of L<%^H|perlvar/%^H>  which may or may not interfere
+with some crack you may be doing independently of namespace::clean.
+
 =head1 SEE ALSO
 
 L<B::Hooks::EndOfScope>
@@ -359,6 +409,34 @@ L<B::Hooks::EndOfScope>
 
 Many thanks to Matt S Trout for the inspiration on the whole idea.
 
+=head1 AUTHORS
+
+=over
+
+=item *
+
+Robert 'phaylon' Sedlacek <rs@474.at>
+
+=item *
+
+Florian Ragwitz <rafl@debian.org>
+
+=item *
+
+Jesse Luehrs <doy@tozt.net>
+
+=item *
+
+Peter Rabbitson <ribasushi@cpan.org>
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2011 by Robert 'phaylon' Sedlacek.
+
+This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
+
 =cut
 
 no warnings;