MooseX::Object::Pluggable - Make your classes pluggable
version 0.0014
package MyApp;
use Moose;
with 'MooseX::Object::Pluggable';
...
package MyApp::Plugin::Pretty;
use Moose::Role;
sub pretty{ print "I am pretty" }
1;
#
use MyApp;
my $app = MyApp->new;
$app->load_plugin('Pretty');
$app->pretty;
This module is meant to be loaded as a role from Moose-based classes.
It will add five methods and four attributes to assist you with the loading
and handling of plugins and extensions for plugins. I understand that this may
pollute your namespace, however I took great care in using the least ambiguous
names possible.
Plugins and extensions are just Roles by a fancy name. They are loaded at runtime
on demand and are instance, not class based. This means that if you have more than
one instance of a class they can all have different plugins loaded. This is a feature.
Plugin methods are allowed to around, before, after
their consuming classes, so it is important to watch for load order as plugins can
and will overload each other. You may also add attributes through has.
Please note that when you load at runtime you lose the ability to wrap BUILD
and roles using has will not go through compile time checks like required
and default.
Even though override will work, I STRONGLY discourage its use
and a warning will be thrown if you try to use it.
This is closely linked to the way multiple roles being applied is handled and is not
likely to change. override behavior is closely linked to inheritance and thus will
likely not work as you expect it in multiple inheritance situations. Point being,
save yourself the headache.
When roles are applied at runtime an anonymous class will wrap your class and
$self->blessed, ref $self and $self->meta->name
will no longer return the name of your object;
they will instead return the name of the anonymous class created at runtime.
See _original_class_name.
For a simple example see the tests included in this distribution.
String. The prefix to use for plugin names provided. MyApp::Plugin is sensible.
An ArrayRef accessor that automatically dereferences into array on a read call.
By default it will be filled with the class name and its precedents. It is used
to determine which directories to look for plugins as well as which plugins
take precedence upon namespace collisions. This allows you to subclass a pluggable
class and still use its plugins while using yours first if they are available.
An automatically built instance of the Module::Pluggable::Object manpage used to locate
available plugins.
Because of the way roles apply, $self->blessed, ref $self
and $self->meta->name will
no longer return what you expect. Instead, upon instantiation, the name of the
class instantiated will be stored in this attribute if you need to access the
name the class held before any runtime roles were applied.
Load the appropriate role for $plugin.
There's nothing stopping you from using these, but if you are using them
for anything that's not really complicated you are probably doing
something wrong.
Creates a role name from a plugin name. If the plugin name is prepended
with a + it will be treated as a full name returned as is. Otherwise
a string consisting of $plugin prepended with the _plugin_ns
and the first valid value from _plugin_app_ns will be returned. Example
#assuming appname MyApp and C<_plugin_ns> 'Plugin'
$self->_role_from_plugin("MyPlugin"); # MyApp::Plugin::MyPlugin
Require $role if it is not already loaded and apply it. This is
the meat of this module.
Automatically builds the _plugin_app_ns attribute with the classes in the
class precedence list that are not part of Moose.
Automatically creates a the Module::Pluggable::Object manpage instance with the correct
search_path.
Keep tests happy. See Moose
Moose, the Moose::Role manpage, the Class::Inspector manpage
Holler?
Please report any bugs or feature requests to
bug-MooseX-Object-Pluggable at rt.cpan.org, or through the web interface at
http://rt.cpan.org/Public/Dist/Display.html.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc MooseX-Object-Pluggable
You can also look for information at:
- #Moose - Huge number of questions
-
- Matt S Trout - ideas / planning.
-
- Stevan Little - EVERYTHING. Without him this would have never happened.
-
- Shawn M Moore - bugfixes
-
Guillermo Roditi <groditi@cpan.org>
This software is copyright (c) 2007 by Guillermo Roditi <groditi@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|