/usr/share/perl5/Dist/Zilla/Role/PluginBundle/Easy.pm is in libdist-zilla-perl 6.010-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 | package Dist::Zilla::Role::PluginBundle::Easy 6.010;
# ABSTRACT: something that bundles a bunch of plugins easily
# This plugin was originally contributed by Christopher J. Madsen
use Moose::Role;
with 'Dist::Zilla::Role::PluginBundle';
use namespace::autoclean;
#pod =head1 SYNOPSIS
#pod
#pod package Dist::Zilla::PluginBundle::Example;
#pod use Moose;
#pod with 'Dist::Zilla::Role::PluginBundle::Easy';
#pod
#pod sub configure {
#pod my $self = shift;
#pod
#pod $self->add_plugins('VersionFromModule');
#pod $self->add_bundle('Basic');
#pod }
#pod
#pod =head1 DESCRIPTION
#pod
#pod This role builds upon the PluginBundle role, adding methods to take most of the
#pod grunt work out of creating a bundle. It supplies the C<bundle_config> method
#pod for you. In exchange, you must supply a C<configure> method, which will store
#pod the bundle's configuration in the C<plugins> attribute by calling
#pod C<add_plugins> and/or C<add_bundle>.
#pod
#pod =cut
use MooseX::Types::Moose qw(Str ArrayRef HashRef);
use String::RewritePrefix 0.005
rewrite => {
-as => '_plugin_class',
prefixes => { '' => 'Dist::Zilla::Plugin::', '=' => '' },
},
rewrite => {
-as => '_bundle_class',
prefixes => {
'' => 'Dist::Zilla::PluginBundle::',
'@' => 'Dist::Zilla::PluginBundle::',
'=' => ''
},
};
use namespace::autoclean;
requires 'configure';
#pod =attr name
#pod
#pod This is the bundle name, taken from the Section passed to
#pod C<bundle_config>.
#pod
#pod =cut
has name => (
is => 'ro',
isa => Str,
required => 1,
);
#pod =attr payload
#pod
#pod This hashref contains the bundle's parameters (if any), taken from the
#pod Section passed to C<bundle_config>.
#pod
#pod =cut
has payload => (
is => 'ro',
isa => HashRef,
required => 1,
);
#pod =attr plugins
#pod
#pod This arrayref contains the configuration that will be returned by
#pod C<bundle_config>. You normally modify this by using the
#pod C<add_plugins> and C<add_bundle> methods.
#pod
#pod =cut
has plugins => (
is => 'ro',
isa => ArrayRef,
default => sub { [] },
);
sub bundle_config {
my ($class, $section) = @_;
my $self = $class->new($section);
$self->configure;
return @{ $self->plugins };
}
#pod =method add_plugins
#pod
#pod $self->add_plugins('Plugin1', [ Plugin2 => \%plugin2config ])
#pod
#pod Use this method to add plugins to your bundle.
#pod
#pod It is passed a list of plugin specifiers, which can be one of a few things:
#pod
#pod =for :list
#pod * a plugin moniker (like you might provide in your config file)
#pod * an arrayref of: C<< [ $moniker, $plugin_name, \%plugin_config ] >>
#pod
#pod In the case of an arrayref, both C<$plugin_name> and C<\%plugin_config> are
#pod optional.
#pod
#pod The plugins are added to the config in the order given.
#pod
#pod =cut
sub add_plugins {
my ($self, @plugin_specs) = @_;
my $prefix = $self->name . '/';
my $plugins = $self->plugins;
foreach my $this_spec (@plugin_specs) {
my $moniker;
my $name;
my $payload;
if (! ref $this_spec) {
($moniker, $name, $payload) = ($this_spec, $this_spec, {});
} elsif (@$this_spec == 1) {
($moniker, $name, $payload) = ($this_spec->[0], $this_spec->[0], {});
} elsif (@$this_spec == 2) {
$moniker = $this_spec->[0];
$name = ref $this_spec->[1] ? $moniker : $this_spec->[1];
$payload = ref $this_spec->[1] ? $this_spec->[1] : {};
} else {
($moniker, $name, $payload) = @$this_spec;
}
push @$plugins, [ $prefix . $name => _plugin_class($moniker) => $payload ];
}
}
#pod =method add_bundle
#pod
#pod $self->add_bundle(BundleName => \%bundle_config)
#pod
#pod Use this method to add all the plugins from another bundle to your bundle. If
#pod you omit C<%bundle_config>, an empty hashref will be supplied.
#pod
#pod =cut
sub add_bundle {
my ($self, $bundle, $payload) = @_;
my $package = _bundle_class($bundle);
$payload ||= {};
my $load_opts = {};
if( my $v = $payload->{':version'} ){
$load_opts->{'-version'} = $v;
}
Class::Load::load_class($package, $load_opts);
$bundle = "\@$bundle" unless $bundle =~ /^@/;
push @{ $self->plugins },
$package->bundle_config({
name => $self->name . '/' . $bundle,
package => $package,
payload => $payload,
});
}
#pod =method config_slice
#pod
#pod $hash_ref = $self->config_slice(arg1, { arg2 => 'plugin_arg2' })
#pod
#pod Use this method to extract parameters from your bundle's C<payload> so
#pod that you can pass them to a plugin or subsidiary bundle. It supports
#pod easy renaming of parameters, since a plugin may expect a parameter
#pod name that's too generic to be suitable for a bundle.
#pod
#pod Each arg is either a key in C<payload>, or a hashref that maps keys in
#pod C<payload> to keys in the hash being constructed. If any specified
#pod key does not exist in C<payload>, then it is omitted from the result.
#pod
#pod =cut
sub config_slice {
my $self = shift;
my $payload = $self->payload;
my %arg;
foreach my $arg (@_) {
if (ref $arg) {
while (my ($in, $out) = each %$arg) {
$arg{$out} = $payload->{$in} if exists $payload->{$in};
}
} else {
$arg{$arg} = $payload->{$arg} if exists $payload->{$arg};
}
}
return \%arg;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Zilla::Role::PluginBundle::Easy - something that bundles a bunch of plugins easily
=head1 VERSION
version 6.010
=head1 SYNOPSIS
package Dist::Zilla::PluginBundle::Example;
use Moose;
with 'Dist::Zilla::Role::PluginBundle::Easy';
sub configure {
my $self = shift;
$self->add_plugins('VersionFromModule');
$self->add_bundle('Basic');
}
=head1 DESCRIPTION
This role builds upon the PluginBundle role, adding methods to take most of the
grunt work out of creating a bundle. It supplies the C<bundle_config> method
for you. In exchange, you must supply a C<configure> method, which will store
the bundle's configuration in the C<plugins> attribute by calling
C<add_plugins> and/or C<add_bundle>.
=head1 ATTRIBUTES
=head2 name
This is the bundle name, taken from the Section passed to
C<bundle_config>.
=head2 payload
This hashref contains the bundle's parameters (if any), taken from the
Section passed to C<bundle_config>.
=head2 plugins
This arrayref contains the configuration that will be returned by
C<bundle_config>. You normally modify this by using the
C<add_plugins> and C<add_bundle> methods.
=head1 METHODS
=head2 add_plugins
$self->add_plugins('Plugin1', [ Plugin2 => \%plugin2config ])
Use this method to add plugins to your bundle.
It is passed a list of plugin specifiers, which can be one of a few things:
=over 4
=item *
a plugin moniker (like you might provide in your config file)
=item *
an arrayref of: C<< [ $moniker, $plugin_name, \%plugin_config ] >>
=back
In the case of an arrayref, both C<$plugin_name> and C<\%plugin_config> are
optional.
The plugins are added to the config in the order given.
=head2 add_bundle
$self->add_bundle(BundleName => \%bundle_config)
Use this method to add all the plugins from another bundle to your bundle. If
you omit C<%bundle_config>, an empty hashref will be supplied.
=head2 config_slice
$hash_ref = $self->config_slice(arg1, { arg2 => 'plugin_arg2' })
Use this method to extract parameters from your bundle's C<payload> so
that you can pass them to a plugin or subsidiary bundle. It supports
easy renaming of parameters, since a plugin may expect a parameter
name that's too generic to be suitable for a bundle.
Each arg is either a key in C<payload>, or a hashref that maps keys in
C<payload> to keys in the hash being constructed. If any specified
key does not exist in C<payload>, then it is omitted from the result.
=head1 AUTHOR
Ricardo SIGNES 😏 <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Ricardo SIGNES.
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
|