Module::Build::Bundle - subclass for supporting Tasks and Bundles

NAME

Module::Build::Bundle - subclass for supporting Tasks and Bundles

Back to Top

VERSION

This documentation describes version 0.06

Back to Top

SYNOPSIS

    #In your Build.PL
    use Module::Build::Bundle;
    
    #Example lifted from: Perl::Critic::logicLAB 
    my $build = Module::Build::Bundle->new(
        dist_author   => 'Jonas B. Nielsen (jonasbn), <jonasbn@cpan.org>',
        module_name   => 'Perl::Critic::logicLAB',
        license       => 'artistic',
        create_readme => 1,
        requires      => {
            'Perl::Critic::Policy::logicLAB::ProhibitUseLib' => '0',
            'Perl::Critic::Policy::logicLAB::RequireVersionFormat' => '0',
        },
    );
    
    $build->create_build_script();

    #In your shell
    % ./Build contents
    
    #Or implicitly executing contents action
    % ./Build
    
=head1 DESCRIPTION

FEATURES

This module adds a very basic action for propagating a requirements list from a Build.PL file's requires section to the a POD section in the distribution targetted.

Back to Top

SUBROUTINES/METHODS

ACTION_contents

This is the build action parsing the requirements specified in the Build.PL file. It creates a POD section (see also FEATURES above).

By default it overwrites the CONTENTS section with a POD link listing. You can specify a note indicating if what section you want to overwrite using the section_header note.

    #Example lifted from: Perl::Critic::logicLAB 
    my $build = Module::Build::Bundle->new(
        dist_author   => 'Jonas B. Nielsen (jonasbn), <jonasbn@cpan.org>',
        module_name   => 'Perl::Critic::logicLAB',
        license       => 'artistic',
        create_readme => 1,
        requires      => {
            'Perl::Critic::Policy::logicLAB::ProhibitUseLib' => '0',
            'Perl::Critic::Policy::logicLAB::RequireVersionFormat' => '0',
        },
    );
    
    $build->notes('section_header' => 'POLICIES');

    $build->create_build_script();

The section of course has to be present.

Based on your version of perl and you Build.PL requirements, the links will be rendered in the following formats:

Basic:

    #Build.PL
    requires => {
        'Some::Package' => '0',
    }

    #POD, perl all
    =item * L<Some::Package|Some::Package>

With version:

    #Build.PL
    requires => {
        'Some::Package' => '1.99',
    }

    #POD, perl < 5.12.0
    =item * L<Some::Package|Some::Package>, 1.99
    #POD, perl >= 5.12.0
    =item * L<Some::Package|Some::Package>, L<1\.99\|http://search.cpan.org/dist/Some-Package-1.99/lib/Some/Package.pm>;

ACTION_build

This is a simple wrapper around the standard action: Module::Build build action. It checks whether ACTION_contents have been executed, if not it executes it.

create_mymeta

This method has been lifted from Module::Build::Base and altered.

It sets the:

For Module::Build::Bundle:

    #Example MYMETA.yml
    configure_requires:
        Module::Build::Bundle: 0.01
    generated_by: 'Module::Build::Bundle version 0.01'
    
=head2 get_metadata

This method has been lifted from Module::Build::Base and altered.

It sets:

For Module::Build::Bundle:

    #Example META.yml
    configure_requires:
        Module::Build::Bundle: 0.01
    generated_by: 'Module::Build::Bundle version 0.01'

Back to Top

DIAGNOSTICS

Back to Top

CONFIGURATION AND ENVIRONMENT

CONTENTS SECTION

The module does per default look for the section named: CONTENTS.

This is the section used in Bundles, this can be overwritten using the section parameter.

For example Perl::Critic::logicLAB uses a section named POLICIES and the Task::BeLike::JONASBN manpage uses DEPENDENCIES.

The problem is that the section has to be present or else the contents action will throw an error.

Module::Build::Bundle is primarily aimed at Bundle distributions. Their use is however no longer recommended and Task provides a better way.

Back to Top

DEPENDENCIES

Back to Top

INCOMPATIBILITIES

The distribution requires perl version from 5.6.0 and up.

Back to Top

BUGS AND LIMITATIONS

There are no known bugs or special limitations at this time, but I am sure there are plenty of scenarios is distribution packaging the module is not currently handling.

Currently the module only supports Bundle/Task distributions based on Module::Build. The implementation is based on a subclass of Module::Build, which can replace Module::Build (See: SYNOPSIS).

Back to Top

SEE ALSO

Back to Top

MOTIVATION

The motivation was driven by two things.

I have a few perks and one of them is that I never get to automate stuff until very late and I always regret that. So when I released Bundle::JONASBN, now the Task::BeLike::JONASBN::Task::BeLike::JONASBN manpage I thought I might aswell get it automated right away.

This module lived for a long time as a part of Bundle::JONASBN but then I needed it for some other distributions, so I decided to separate it out.

Back to Top

ACKNOWLEDGEMENTS

Back to Top

AUTHOR

Back to Top

LICENSE AND COPYRIGHT

Copyright 2010 jonasbn, all rights reserved.

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

Back to Top

 Module::Build::Bundle - subclass for supporting Tasks and Bundles