Provided by: libdist-zilla-plugins-cjm-perl_4.20-1_all bug

NAME

       Dist::Zilla::Plugin::ModuleBuild::Custom - Allow a dist to have a custom Build.PL

VERSION

       This document describes version 4.16 of Dist::Zilla::Plugin::ModuleBuild::Custom, released
       August 24, 2013 as part of Dist-Zilla-Plugins-CJM version 4.20.

SYNOPSIS

       In dist.ini:

         [ModuleBuild::Custom]
         mb_version = 0.34  ; the default comes from the ModuleBuild plugin

       In your Build.PL:

         use Module::Build;

         my %module_build_args = (
           module_name => 'Foo::Bar',
         ##{ $plugin->get_prereqs(1) ##}
         ##{ $plugin->get_default('share_dir') ##}
         );

         unless ( eval { Module::Build->VERSION(0.4004) } ) {
           my $tr = delete $module_build_args{test_requires};
           my $br = $module_build_args{build_requires};
           for my $mod ( keys %$tr ) {
             if ( exists $br->{$mod} ) {
               $br->{$mod} = $tr->{$mod} if $tr->{$mod} > $br->{$mod};
             }
             else {
               $br->{$mod} = $tr->{$mod};
             }
           }
         }

         my $builder = Module::Build->new(%module_build_args);
         $builder->create_build_script;

       Of course, your Build.PL should be more complex than that, or you don't need this plugin.

DESCRIPTION

       This plugin is for people who need something more complex than the auto-generated
       Makefile.PL or Build.PL generated by the MakeMaker or ModuleBuild plugins.

       It is a subclass of the ModuleBuild plugin, but it does not write a Build.PL for you.
       Instead, you write your own Build.PL, which may do anything Module::Build is capable of
       (except generate a compatibility Makefile.PL).

       This plugin will process Build.PL as a template (using Text::Template), which allows you
       to add data from Dist::Zilla to the version you distribute (if you want).  The template
       delimiters are "##{" and "##}", because that makes them look like comments.  That makes it
       easier to have a Build.PL that works both before and after it is processed as a template.

       This is particularly useful for XS-based modules, because it can allow you to build and
       test the module without the overhead of "dzil build" after every small change.

       The template may use the following variables:

       $dist
           The name of the distribution.

       $meta
           The hash of metadata (in META 1.4 format) that will be stored in META.yml.

       $meta2
           The hash of metadata (in META 2 format) that will be stored in META.json.

       $plugin
           The ModuleBuild::Custom object that is processing the template.

       $version
           The distribution's version number.

       $zilla
           The Dist::Zilla object that is creating the distribution.

   Using ModuleBuild::Custom with AutoPrereqs
       If you are using the AutoPrereqs plugin, then you will probably want to set its
       "configure_finder" to a FileFinder that includes Build.PL.  You may also want to set this
       plugin's "mb_version" parameter to 0 and allow AutoPrereqs to get the version from your
       "use Module::Build" line.

       Example dist.ini configuration:

         [ModuleBuild::Custom]
         mb_version = 0 ; AutoPrereqs gets actual version from Build.PL

         [FileFinder::ByName / :BuildPL]
         file = Build.PL

         [AutoPrereqs]
         :version = 4.300005 ; need configure_finder
         configure_finder = :BuildPL
         ; Add next line if your Build.PL uses modules you ship in inc/
         configure_finder = :IncModules

       Then in your Build.PL you'd say:

         use Module::Build 0.28; # or whatever version you need

METHODS

   get_default
         $plugin->get_default(qw(key1 key2 ...))

       A template can call this method to extract the specified key(s) from the default
       Module::Build arguments created by the normal ModuleBuild plugin and have them formatted
       into a comma-separated list suitable for a hash constructor or a method's parameter list.

       If any key has no value (or its value is an empty hash or array ref) it will be omitted
       from the list.  If all keys are omitted, the empty string is returned.  Otherwise, the
       result always ends with a comma.

       The most common usage would be

           ##{ $plugin->get_default('share_dir') ##}

   get_meta
         $plugin->get_meta(qw(key1 key2 ...))

       A template can call this method to extract the specified key(s) from "distmeta" and have
       them formatted into a comma-separated list suitable for a hash constructor or a method's
       parameter list.  The keys (and the returned values) are from the META 1.4 spec, because
       that's what Module::Build uses in its API.

       If any key has no value (or its value is an empty hash or array ref) it will be omitted
       from the list.  If all keys are omitted, the empty string is returned.  Otherwise, the
       result always ends with a comma.

   get_prereqs
         $plugin->get_prereqs($api_version)

       This returns all the keys that describe the distribution's prerequisites.  The
       $api_version indicates what keys the template can handle.  The currently defined values
       are:

       0 (or undef)
               This is equivalent to

                 $plugin->get_meta(qw(build_requires configure_requires requires
                                      recommends conflicts))

       1       This adds "test_requires" as a separate key (which requires Dist::Zilla 4.300032
               or later).  It's equivalent to

                 $plugin->get_default(qw(build_requires configure_requires requires
                                         test_requires recommends conflicts))

               Your Build.PL should either require Module::Build 0.4004, or fold test_requires
               into build_requires if an older version is used (as shown in the SYNOPSIS).

SEE ALSO

       The MakeMaker::Custom plugin does basically the same thing as this plugin, but for
       Makefile.PL (if you prefer ExtUtils::MakeMaker).

DEPENDENCIES

       ModuleBuild::Custom requires Dist::Zilla (4.300009 or later) and Text::Template.  I also
       recommend applying Template_strict.patch to Text::Template.  This will add support for the
       STRICT option, which will help catch errors in your templates.

INCOMPATIBILITIES

       You must not use this in conjunction with the ModuleBuild plugin.

BUGS AND LIMITATIONS

       No bugs have been reported.

AUTHOR

       Christopher J. Madsen  "<perl AT cjmweb.net>"

       Please report any bugs or feature requests to
       "<bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>" or through the web interface at
       <http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM>.

       You can follow or contribute to Dist-Zilla-Plugins-CJM's development at
       <http://github.com/madsen/dist-zilla-plugins-cjm>.

COPYRIGHT AND LICENSE

       This software is copyright (c) 2013 by Christopher J. Madsen.

       This is free software; you can redistribute it and/or modify it under the same terms as
       the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE,
       TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
       COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF
       ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
       THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE
       DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT
       HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY
       THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
       INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
       LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY
       OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
       SUCH DAMAGES.

perl v5.18.1                                2013-08-Dist::Zilla::Plugin::ModuleBuild::Custom(3pm)