Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dist::zilla::role::pluginbundle::easy(3pm) [debian man page]

Dist::Zilla::Role::PluginBundle::Easy(3pm)		User Contributed Perl Documentation		Dist::Zilla::Role::PluginBundle::Easy(3pm)

NAME

       Dist::Zilla::Role::PluginBundle::Easy - something that bundles a bunch of plugins easily

VERSION

       version 4.300020

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');
	 }

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
       "bundle_config" method for you.	In exchange, you must supply a "configure" method, which will store the bundle's configuration in the
       "plugins" attribute by calling "add_plugins" and/or "add_bundle".

ATTRIBUTES

   name
       This is the bundle name, taken from the Section passed to "bundle_config".

   payload
       This hashref contains the bundle's parameters (if any), taken from the Section passed to "bundle_config".

   plugins
       This arrayref contains the configuration that will be returned by "bundle_config".  You normally modify this by using the "add_plugins" and
       "add_bundle" methods.

METHODS

   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:

       o   a plugin moniker (like you might provide in your config file)

       o   an arrayref of: "[ $moniker, $plugin_name, \%plugin_config"

       In the case of an arrayref, both $plugin_name and "\%plugin_config" are optional.

       The plugins are added to the config in the order given.

   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 %bundle_config, an empty hashref will be supplied.

   config_slice
	 $hash_ref = $self->config_slice(arg1, { arg2 => 'plugin_arg2' })

       Use this method to extract parameters from your bundle's "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 "payload", or a hashref that maps keys in "payload" to keys in the hash being constructed.  If any specified
       key does not exist in "payload", then it is omitted from the result.

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 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.

perl v5.14.2							    2012-06-21				Dist::Zilla::Role::PluginBundle::Easy(3pm)

Check Out this Related Man Page

Dist::Zilla::Prereqs(3pm)				User Contributed Perl Documentation				 Dist::Zilla::Prereqs(3pm)

NAME

       Dist::Zilla::Prereqs - the prerequisites of a Dist::Zilla distribution

VERSION

       version 4.300020

DESCRIPTION

       Dist::Zilla::Prereqs is a subcomponent of Dist::Zilla.  The "prereqs" attribute on your Dist::Zilla object is a Dist::Zilla::Prereqs
       object, and is responsible for keeping track of the distribution's prerequisites.

       In fact, a Dist::Zilla::Prereqs object is just a thin layer over a CPAN::Meta::Prereqs object, stored in the "cpan_meta_prereqs" attribute.

       Almost everything this object does is proxied to the CPAN::Meta::Prereqs object, so you should really read how that works.

       Dist::Zilla::Prereqs proxies the following methods to the CPAN::Meta::Prereqs object:

       o   finalize

       o   is_finalized

       o   requirements_for

       o   as_string_hash

METHODS

   register_prereqs
	 $prereqs->register_prereqs(%prereqs);

	 $prereqs->register_prereqs(\%arg, %prereqs);

       This method adds new minimums to the prereqs object.  If a hashref is the first arg, it may have entries for "phase" and "type" to indicate
       what kind of prereqs are being registered.  (For more information on phase and type, see CPAN::Meta::Spec.)  For example, you might say:

	 $prereqs->register_prereqs(
	   { phase => 'test', type => 'recommends' },
	   'Test::Foo' => '1.23',
	   'XML::YZZY' => '2.01',
	 );

       If not given, phase and type default to runtime and requires, respectively.

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 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.

perl v5.14.2							    2012-06-21						 Dist::Zilla::Prereqs(3pm)
Man Page