1 package MooseX::Object::Pluggable;
6 use Module::Pluggable::Object;
8 our $VERSION = '0.0008';
12 MooseX::Object::Pluggable - Make your classes pluggable
19 with 'MooseX::Object::Pluggable';
23 package MyApp::Plugin::Pretty;
26 sub pretty{ print "I am pretty" }
33 $app->load_plugin('Pretty');
38 This module is meant to be loaded as a role from Moose-based classes
39 it will add five methods and four attributes to assist you with the loading
40 and handling of plugins and extensions for plugins. I understand that this may
41 pollute your namespace, however I took great care in using the least ambiguous
44 =head1 How plugins Work
46 Plugins and extensions are just Roles by a fancy name. They are loaded at runtime
47 on demand and are instance, not class based. This means that if you have more than
48 one instance of a class they can all have different plugins loaded. This is a feature.
50 Plugin methods are allowed to C<around>, C<before>, C<after>
51 their consuming classes, so it is important to watch for load order as plugins can
52 and will overload each other. You may also add attributes through has.
54 Please note that when you load at runtime you lose the ability to wrap C<BUILD>
55 and roles using C<has> will not go through compile time checks like C<required>
58 Even though C<override> will work , I STRONGLY discourage it's use
59 and a warning will be thrown if you try to use it.
60 This is closely linked to the way multiple roles being applied is handled and is not
61 likely to change. C<override> bevavior is closely linked to inheritance and thus will
62 likely not work as you expect it in multiple inheritance situations. Point being,
63 save yourself the headache.
65 =head1 How plugins are loaded
67 When roles are applied at runtime an anonymous class will wrap your class and
68 C<$self-E<gt>blessed> and C<ref $self> will no longer return the name of your object,
69 they will instead return the name of the anonymous class created at runtime.
70 See C<_original_class_name>.
74 For a simple example see the tests included in this distribution.
80 String. The prefix to use for plugin names provided. MyApp::Plugin is sensible.
84 ArrayRef, Accessor automatically dereferences into array on a read call.
85 By default will be filled with the class name and it's prescedents, it is used
86 to determine which directories to look for plugins as well as which plugins
87 take presedence upon namespace collitions. This allows you to subclass a pluggable
88 class and still use it's plugins while using yours first if they are available.
92 =head2 _plugin_locator
94 An automatically built instance of L<Module::Pluggable::Object> used to locate
99 #--------#---------#---------#---------#---------#---------#---------#---------#
106 default => sub{ 'Plugin' },
109 has _plugin_loaded =>
117 has _plugin_app_ns =>
124 builder => '_build_plugin_app_ns',
125 trigger => sub{ $_[0]->_clear_plugin_locator if $_[0]->_has_plugin_locator; },
128 has _plugin_locator =>
133 isa => 'Module::Pluggable::Object',
134 clearer => '_clear_plugin_locator',
135 predicate => '_has_plugin_locator',
136 builder => '_build_plugin_locator'
139 #--------#---------#---------#---------#---------#---------#---------#---------#
141 =head1 Public Methods
143 =head2 load_plugins @plugins
145 =head2 load_plugin $plugin
147 Load the apropriate role for C<$plugin>.
152 my ($self, @plugins) = @_;
153 die("You must provide a plugin name") unless @plugins;
155 my $loaded = $self->_plugin_loaded;
156 my @load = grep { not exists $loaded->{$_} } @plugins;
157 my @roles = map { $self->_role_from_plugin($_) } @load;
159 if ( $self->_load_and_apply_role(@roles) ) {
160 @{ $loaded }{@load} = @roles;
170 $self->load_plugins(@_);
173 =head2 _original_class_name
175 Because of the way roles apply C<$self-E<gt>blessed> and C<ref $self> will
176 no longer return what you expect. Instead use this class to get your original
181 sub _original_class_name{
183 return (grep {$_ !~ /^Moose::/} $self->meta->class_precedence_list)[0];
187 =head1 Private Methods
189 There's nothing stopping you from using these, but if you are using them
190 for anything thats not really complicated you are probably doing
193 =head2 _role_from_plugin $plugin
195 Creates a role name from a plugin name. If the plugin name is prepended
196 with a C<+> it will be treated as a full name returned as is. Otherwise
197 a string consisting of C<$plugin> prepended with the C<_plugin_ns>
198 and the first valid value from C<_plugin_app_ns> will be returned. Example
200 #assuming appname MyApp and C<_plugin_ns> 'Plugin'
201 $self->_role_from_plugin("MyPlugin"); # MyApp::Plugin::MyPlugin
205 sub _role_from_plugin{
206 my ($self, $plugin) = @_;
208 return $1 if( $plugin =~ /^\+(.*)/ );
210 my $o = join '::', $self->_plugin_ns, $plugin;
211 #Father, please forgive me for I have sinned.
212 my @roles = grep{ /${o}$/ } $self->_plugin_locator->plugins;
214 croak("Unable to locate plugin '$plugin'") unless @roles;
215 return $roles[0] if @roles == 1;
218 my %presedence_list = map{ $i++; "${_}::${o}", $i } $self->_plugin_app_ns;
220 @roles = sort{ $presedence_list{$a} <=> $presedence_list{$b}} @roles;
225 =head2 _load_and_apply_role @roles
227 Require C<$role> if it is not already loaded and apply it. This is
228 the meat of this module.
232 sub _load_and_apply_role{
233 my ($self, @roles) = @_;
234 die("You must provide a role name") unless @roles;
236 foreach my $role ( @roles ) {
237 eval { Class::MOP::load_class($role) };
238 confess("Failed to load role: ${role} $@") if $@;
240 carp("Using 'override' is strongly discouraged and may not behave ".
241 "as you expect it to. Please use 'around'")
242 if scalar keys %{ $role->meta->get_override_method_modifiers_map };
245 Moose::Util::apply_all_roles( $self, @roles );
250 =head2 _build_plugin_app_ns
252 Automatically builds the _plugin_app_ns attribute with the classes in the
253 class presedence list that are not part of Moose.
257 sub _build_plugin_app_ns{
259 my @names = (grep {$_ !~ /^Moose::/} $self->meta->class_precedence_list);
263 =head2 _build_plugin_locator
265 Automatically creates a L<Module::Pluggable::Object> instance with the correct
270 sub _build_plugin_locator{
273 my $locator = Module::Pluggable::Object->new
275 [ map { join '::', ($_, $self->_plugin_ns) } $self->_plugin_app_ns ]
282 Keep tests happy. See L<Moose>
292 L<Moose>, L<Moose::Role>, L<Class::Inspector>
296 Guillermo Roditi, <groditi@cpan.org>
302 Please report any bugs or feature requests to
303 C<bug-moosex-object-pluggable at rt.cpan.org>, or through the web interface at
304 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MooseX-Object-Pluggable>.
305 I will be notified, and then you'll automatically be notified of progress on
306 your bug as I make changes.
310 You can find documentation for this module with the perldoc command.
312 perldoc MooseX-Object-Pluggable
314 You can also look for information at:
318 =item * AnnoCPAN: Annotated CPAN documentation
320 L<http://annocpan.org/dist/MooseX-Object-Pluggable>
324 L<http://cpanratings.perl.org/d/MooseX-Object-Pluggable>
326 =item * RT: CPAN's request tracker
328 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Object-Pluggable>
332 L<http://search.cpan.org/dist/MooseX-Object-Pluggable>
336 =head1 ACKNOWLEDGEMENTS
340 =item #Moose - Huge number of questions
342 =item Matt S Trout <mst@shadowcatsystems.co.uk> - ideas / planning.
344 =item Stevan Little - EVERYTHING. Without him this would have never happened.
350 Copyright 2007 Guillermo Roditi. All Rights Reserved. This is
351 free software; you may redistribute it and/or modify it under the same
352 terms as Perl itself.