NAME¶

Module::Pluggable - automatically give your module the ability to have plugins

SYNOPSIS¶

Simple use Module::Pluggable -

    package MyClass;
    use Module::Pluggable;

and then later ...

    use MyClass;
    my $mc = MyClass->new();
    # returns the names of all plugins installed under MyClass::Plugin::*
    my @plugins = $mc->plugins();

EXAMPLE¶

Why would you want to do this? Say you have something that wants to pass an object to a number of different plugins in turn. For example you may want to extract meta-data from every email you get sent and do something with it. Plugins make sense here because then you can keep adding new meta data parsers and all the logic and docs for each one will be self contained and new handlers are easy to add without changing the core code. For that, you might do something like ...

    package Email::Examiner;
    use strict;
    use Email::Simple;
    use Module::Pluggable require => 1;
    sub handle_email {
        my $self  = shift;
        my $email = shift;
        foreach my $plugin ($self->plugins) {
            $plugin->examine($email);
        }
        return 1;
    }

.. and all the plugins will get a chance in turn to look at it.

This can be trivially extended so that plugins could save the email somewhere and then no other plugin should try and do that. Simply have it so that the "examine" method returns 1 if it has saved the email somewhere. You might also want to be paranoid and check to see if the plugin has an "examine" method.

        foreach my $plugin ($self->plugins) {
            next unless $plugin->can('examine');
            last if     $plugin->examine($email);
        }

And so on. The sky's the limit.

DESCRIPTION¶

Provides a simple but, hopefully, extensible way of having 'plugins' for your module. Obviously this isn't going to be the be all and end all of solutions but it works for me.

Essentially all it does is export a method into your namespace that looks through a search path for .pm files and turn those into class names.

Optionally it instantiates those classes for you.

ADVANCED USAGE¶

Alternatively, if you don't want to use 'plugins' as the method ...

    package MyClass;
    use Module::Pluggable sub_name => 'foo';

and then later ...

    my @plugins = $mc->foo();

Or if you want to look in another namespace

    package MyClass;
    use Module::Pluggable search_path => ['Acme::MyClass::Plugin', 'MyClass::Extend'];

or directory

    use Module::Pluggable search_dirs => ['mylibs/Foo'];

Or if you want to instantiate each plugin rather than just return the name

    package MyClass;
    use Module::Pluggable instantiate => 'new';

and then

    # whatever is passed to 'plugins' will be passed
    # to 'new' for each plugin
    my @plugins = $mc->plugins(@options);

alternatively you can just require the module without instantiating it

    package MyClass;
    use Module::Pluggable require => 1;

since requiring automatically searches inner packages, which may not be desirable, you can turn this off

    package MyClass;
    use Module::Pluggable require => 1, inner => 0;

You can limit the plugins loaded using the except option, either as a string, array ref or regex

    package MyClass;
    use Module::Pluggable except => 'MyClass::Plugin::Foo';

or

    package MyClass;
    use Module::Pluggable except => ['MyClass::Plugin::Foo', 'MyClass::Plugin::Bar'];

or

    package MyClass;
    use Module::Pluggable except => qr/^MyClass::Plugin::(Foo|Bar)$/;

and similarly for only which will only load plugins which match.

Remember you can use the module more than once

    package MyClass;
    use Module::Pluggable search_path => 'MyClass::Filters' sub_name => 'filters';
    use Module::Pluggable search_path => 'MyClass::Plugins' sub_name => 'plugins';

and then later ...

    my @filters = $self->filters;
    my @plugins = $self->plugins;

PLUGIN SEARCHING¶

Every time you call 'plugins' the whole search path is walked again. This allows for dynamically loading plugins even at run time. However this can get expensive and so if you don't expect to want to add new plugins at run time you could do

  package Foo;
  use strict;
  use Module::Pluggable sub_name => '_plugins';
  our @PLUGINS;
  sub plugins { @PLUGINS ||= shift->_plugins }
  1;

INNER PACKAGES¶

If you have, for example, a file lib/Something/Plugin/Foo.pm that contains package definitions for both "Something::Plugin::Foo" and "Something::Plugin::Bar" then as long as you either have either the require or instantiate option set then we'll also find "Something::Plugin::Bar". Nifty!

OPTIONS¶

You can pass a hash of options when importing this module.

The options can be ...

    file_regex => qr/\.plugin$/

        package MyClass;
        use Module::Pluggable max_depth => 3;

        package MyClass;
        use Module::Pluggable min_depth => 4;

TRIGGERS¶

Various triggers can also be passed in to the options.

If any of these triggers return 0 then the plugin will not be returned.

METHODs¶

    $self->search_path( add => "New::Path" ); # add
    $self->search_path( new => "New::Path" ); # replace

BEHAVIOUR UNDER TEST ENVIRONMENT¶

In order to make testing reliable we exclude anything not from blib if blib.pm is in %INC.

However if the module being tested used another module that itself used "Module::Pluggable" then the second module would fail. This was fixed by checking to see if the caller had (^|/)blib/ in their filename.

There's an argument that this is the wrong behaviour and that modules should explicitly trigger this behaviour but that particular code has been around for 7 years now and I'm reluctant to change the default behaviour.

You can now (as of version 4.1) force Module::Pluggable to look outside blib in a test environment by doing either

        require Module::Pluggable;
        $Module::Pluggable::FORCE_SEARCH_ALL_PATHS = 1;
        import Module::Pluggable;

or

        use Module::Pluggable force_search_all_paths => 1;

@INC hooks and App::FatPacker¶

If a module's @INC has a hook and that hook is an object which has a "files()" method then we will try and require those files too. See "t/26inc_hook.t" for an example.

This has allowed App::FatPacker (as of version 0.10.0) to provide support for Module::Pluggable.

This should also, theoretically, allow someone to modify PAR to do the same thing.

Module::Require recommended¶

Up until version 5.2 Module::Pluggable used a string "eval" to require plugins.

This has now been changed to optionally use Module::Runtime and it's "require_module" method when available and fall back to using a path based "require" when not.

It's recommended, but not required, that you install Module::Runtime.

FUTURE PLANS¶

This does everything I need and I can't really think of any other features I want to add. Famous last words of course (not least because we're up to version 5.0 at the time of writing).

However suggestions (and patches) are always welcome.

DEVELOPMENT¶

The master repo for this module is at

https://github.com/simonwistow/Module-Pluggable

AUTHOR¶

Simon Wistow <simon@thegestalt.org>

COPYING¶

Copyright, 2006 Simon Wistow

Distributed under the same terms as Perl itself.

BUGS¶

None known.

SEE ALSO¶

File::Spec, File::Find, File::Basename, Class::Factory::Util, Module::Pluggable::Ordered