NAME

namespace::autoclean - Keep imports out of your namespace

SYNOPSIS

package Foo;
use namespace::autoclean;
use Some::Package qw/imported_function/;

sub bar { imported_function('stuff') }

# later on:
Foo->bar;               # works
Foo->imported_function; # will fail. imported_function got cleaned after compilation

DESCRIPTION

When you import a function into a Perl package, it will naturally also be available as a method.

The namespace::autoclean pragma will remove all 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.

This module is very similar to namespace::clean, except it will clean all imported functions, no matter if you imported them before or after you used the pragma. It will also not touch anything that looks like a method, according to either Class::MOP::Class::get_method_list or, if Mouse is already loaded, Mouse::Meta::Class::get_method_list.

If you're writing an exporter and you want to clean up after yourself (and your peers), you can use the -cleanee switch to specify what package to clean:

package My::MooseX::namespace::autoclean;
use strict;

use namespace::autoclean (); # no cleanup, just load

sub import {
    namespace::autoclean->import(
      -cleanee => scalar(caller),
    );
}

PARAMETERS

-also => [ ITEM | REGEX | SUB, .. ]

-also => ITEM

-also => REGEX

-also => SUB

-except => [ ITEM | REGEX | SUB, .. ]

-except => ITEM

-except => REGEX

-except => SUB

Sometimes you don't want to clean imports only, but also helper functions you're using in your methods. The -also switch can be used to declare a list of functions that should be removed additional to any imports:

use namespace::autoclean -also => ['some_function', 'another_function'];

Similarly, sometimes you don't want to clean all the exporters. The -except switch can be used to declare a list of imports that should not be removed:

use namespace::autoclean -except => ['import'];

If only one function needs to be additionally cleaned the -also and -except switches also accept a plain string:

use namespace::autoclean -also => 'some_function';

In some situations, you may wish for a more powerful cleaning solution.

The -also and -except switches can take a Regex or a CodeRef to match against local function names to clean.

use namespace::autoclean -also => qr/^_/

use namespace::autoclean -also => sub { $_ =~ m{^_} };

use namespace::autoclean -also => [qr/^_/ , qr/^hidden_/ ];

use namespace::autoclean -also => [sub { $_ =~ m/^_/ or $_ =~ m/^hidden/ }, sub { uc($_) == $_ } ];

SEE ALSO

namespace::clean

Class::MOP

Mouse

Sub::Identify

Package::Stash

B::Hooks::EndOfScope

AUTHOR

Chip Salzenberg <chip@pobox.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Florian Ragwitz, Tomas Duran, Chip Salzenberg.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm namespace::autoclean

perl -MCPAN -e shell
install namespace::autoclean