namespace::clean

Keep imports and functions out of your namespace
Download

namespace::clean Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Perl Artistic License
  • Price:
  • FREE
  • Publisher Name:
  • Florian Ragwitz
  • Publisher web site:
  • http://search.cpan.org/~flora/

namespace::clean Tags


namespace::clean Description

Keep imports and functions out of your namespace namespace::clean is a Perl module to keep functions and imports out of your namespace.Keeping packages cleanWhen 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 base classes.The namespace::clean pragma will remove all previously declared or imported symbols at the end of the current package's compile cycle. Functions called in the package itself will still be bound by their name, but they won't show up as methods on your class or instances.By unimporting via no you can tell namespace::clean to start collecting functions for the next use namespace::clean; specification.You can use the -except flag to tell namespace::clean that you don't want it to remove a certain function or method. A common use would be a module exporting an import method along with some functions: use ModuleExportingImport; use namespace::clean -except => ;If you just want to -except a single sub, you can pass it directly. For more than one value you have to use an array reference.Explicitely removing functions when your scope is compiledIt is also possible to explicitely tell namespace::clean 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 availableMooseWhen using namespace::clean together with Moose you want to keep the installed meta method. So your classes should look like: package Foo; use Moose; use namespace::clean -except => 'meta'; ...Same goes for Moose::Role.Cleaning other packagesYou can tell namespace::clean that you want to clean up another package instead of the one importing. To do this you have to pass in the -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 namespace::cleans discover-and--except logic, and just want to remove subroutines, try "clean_subroutines".SYNOPSIS package Foo; use warnings; use strict; use Carp qw(croak); # 'croak' will be removed sub bar { 23 } # 'bar' will be removed # remove all previously defined functions use namespace::clean; sub baz { bar() } # 'baz' still defined, 'bar' still bound # begin to collection function names from here again no namespace::clean; sub quux { baz() } # 'quux' will be removed # remove all functions defined after the 'no' unimport use namespace::clean; # Will print: 'No', 'No', 'Yes' and 'No' print +(__PACKAGE__->can('croak') ? 'Yes' : 'No'), " "; print +(__PACKAGE__->can('bar') ? 'Yes' : 'No'), " "; print +(__PACKAGE__->can('baz') ? 'Yes' : 'No'), " "; print +(__PACKAGE__->can('quux') ? 'Yes' : 'No'), " "; 1; Requirements: · Perl


namespace::clean Related Software