/usr/share/perl5/MooseX/Object/Pluggable.pm is in libmoosex-object-pluggable-perl 0.0012-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | package MooseX::Object::Pluggable;
{
$MooseX::Object::Pluggable::VERSION = '0.0012';
}
# git description: v0.0011-6-g98105e4
BEGIN {
$MooseX::Object::Pluggable::AUTHORITY = 'cpan:GRODITI';
}
# ABSTRACT: Make your classes pluggable
use Carp;
use Moose::Role;
use Class::Load 'load_class';
use Scalar::Util 'blessed';
use Module::Pluggable::Object;
#--------#---------#---------#---------#---------#---------#---------#---------#
has _plugin_ns => (
is => 'rw',
required => 1,
isa => 'Str',
default => sub{ 'Plugin' },
);
has _original_class_name => (
is => 'ro',
required => 1,
isa => 'Str',
default => sub{ blessed($_[0]) },
);
has _plugin_loaded => (
is => 'rw',
required => 1,
isa => 'HashRef',
default => sub{ {} }
);
has _plugin_app_ns => (
is => 'rw',
required => 1,
isa => 'ArrayRef',
lazy => 1,
auto_deref => 1,
builder => '_build_plugin_app_ns',
trigger => sub{ $_[0]->_clear_plugin_locator if $_[0]->_has_plugin_locator; },
);
has _plugin_locator => (
is => 'rw',
required => 1,
lazy => 1,
isa => 'Module::Pluggable::Object',
clearer => '_clear_plugin_locator',
predicate => '_has_plugin_locator',
builder => '_build_plugin_locator'
);
#--------#---------#---------#---------#---------#---------#---------#---------#
sub load_plugins {
my ($self, @plugins) = @_;
die("You must provide a plugin name") unless @plugins;
my $loaded = $self->_plugin_loaded;
my @load = grep { not exists $loaded->{$_} } @plugins;
my @roles = map { $self->_role_from_plugin($_) } @load;
return if @roles == 0;
if ( $self->_load_and_apply_role(@roles) ) {
@{ $loaded }{@load} = @roles;
return 1;
} else {
return;
}
}
sub load_plugin {
my $self = shift;
$self->load_plugins(@_);
}
sub _role_from_plugin{
my ($self, $plugin) = @_;
return $1 if( $plugin =~ /^\+(.*)/ );
my $o = join '::', $self->_plugin_ns, $plugin;
#Father, please forgive me for I have sinned.
my @roles = grep{ /${o}$/ } $self->_plugin_locator->plugins;
croak("Unable to locate plugin '$plugin'") unless @roles;
return $roles[0] if @roles == 1;
my $i = 0;
my %presedence_list = map{ $i++; "${_}::${o}", $i } $self->_plugin_app_ns;
@roles = sort{ $presedence_list{$a} <=> $presedence_list{$b}} @roles;
return shift @roles;
}
sub _load_and_apply_role{
my ($self, @roles) = @_;
die("You must provide a role name") unless @roles;
foreach my $role ( @roles ) {
eval { load_class($role) };
confess("Failed to load role: ${role} $@") if $@;
carp("Using 'override' is strongly discouraged and may not behave ".
"as you expect it to. Please use 'around'")
if scalar keys %{ $role->meta->get_override_method_modifiers_map };
}
Moose::Util::apply_all_roles( $self, @roles );
return 1;
}
sub _build_plugin_app_ns{
my $self = shift;
my @names = (grep {$_ !~ /^Moose::/} $self->meta->class_precedence_list);
return \@names;
}
sub _build_plugin_locator{
my $self = shift;
my $locator = Module::Pluggable::Object->new
( search_path =>
[ map { join '::', ($_, $self->_plugin_ns) } $self->_plugin_app_ns ]
);
return $locator;
}
1;
=pod
=encoding UTF-8
=head1 NAME
MooseX::Object::Pluggable - Make your classes pluggable
=head1 VERSION
version 0.0012
=head1 SYNOPSIS
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;
=head1 DESCRIPTION
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.
=head1 How plugins Work
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 C<around>, C<before>, C<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 C<BUILD>
and roles using C<has> will not go through compile time checks like C<required>
and <default>.
Even though C<override> will work , I STRONGLY discourage it's 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. C<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.
=head1 How plugins are loaded
When roles are applied at runtime an anonymous class will wrap your class and
C<$self-E<gt>blessed> and C<ref $self> will no longer return the name of your object,
they will instead return the name of the anonymous class created at runtime.
See C<_original_class_name>.
=head1 Usage
For a simple example see the tests included in this distribution.
=head1 Attributes
=head2 _plugin_ns
String. The prefix to use for plugin names provided. MyApp::Plugin is sensible.
=head2 _plugin_app_ns
ArrayRef, Accessor automatically dereferences into array on a read call.
By default 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 it's plugins while using yours first if they are available.
=head2 _plugin_locator
An automatically built instance of L<Module::Pluggable::Object> used to locate
available plugins.
=head2 _original_class_name
=for stopwords instantiation
Because of the way roles apply C<$self-E<gt>blessed> and C<ref $self> 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.
=head1 Public Methods
=head2 load_plugins @plugins
=head2 load_plugin $plugin
Load the appropriate role for C<$plugin>.
=head1 Private Methods
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.
=head2 _role_from_plugin $plugin
Creates a role name from a plugin name. If the plugin name is prepended
with a C<+> it will be treated as a full name returned as is. Otherwise
a string consisting of C<$plugin> prepended with the C<_plugin_ns>
and the first valid value from C<_plugin_app_ns> will be returned. Example
#assuming appname MyApp and C<_plugin_ns> 'Plugin'
$self->_role_from_plugin("MyPlugin"); # MyApp::Plugin::MyPlugin
=head2 _load_and_apply_role @roles
Require C<$role> if it is not already loaded and apply it. This is
the meat of this module.
=head2 _build_plugin_app_ns
Automatically builds the _plugin_app_ns attribute with the classes in the
class precedence list that are not part of Moose.
=head2 _build_plugin_locator
Automatically creates a L<Module::Pluggable::Object> instance with the correct
search_path.
=head2 meta
Keep tests happy. See L<Moose>
=head1 SEE ALSO
L<Moose>, L<Moose::Role>, L<Class::Inspector>
=head1 BUGS
Holler?
Please report any bugs or feature requests to
C<bug-MooseX-Object-Pluggable at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-Object-Pluggable>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc MooseX-Object-Pluggable
You can also look for information at:
=for stopwords AnnoCPAN
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/MooseX-Object-Pluggable>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/MooseX-Object-Pluggable>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Object-Pluggable>
=item * Search CPAN
L<http://search.cpan.org/dist/MooseX-Object-Pluggable>
=back
=head1 ACKNOWLEDGEMENTS
=for stopwords Stevan
=over 4
=item #Moose - Huge number of questions
=item Matt S Trout <mst@shadowcatsystems.co.uk> - ideas / planning.
=item Stevan Little - EVERYTHING. Without him this would have never happened.
=item Shawn M Moore - bugfixes
=back
=head1 AUTHOR
Guillermo Roditi <groditi@cpan.org>
=head1 COPYRIGHT AND LICENSE
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.
=cut
__END__;
|