NAME

Dist::Man::BuilderSet - determine builder metadata

VERSION

Version 0.0.1

SYNOPSIS

    use Dist::Man::BuilderSet;

    my $builder_set = Dist::Man::BuilderSet->new;
    my @supported_builders = $builder_set->supported_builders();
    my $default_builder = $builder_set->default_builder();
    my $output_file = $builder_set->file_for_builder($default_builder);

    my $create_method = $builder_set->method_for_builder($default_builder);
    Dist::Man::Simple->$create_method($default_builder); # eeew.

    my @build_commands = $builder_set->instructions_for_builder($default_builder);
    my @builder_dependencies = $builder_set->deps_for_builder($default_builder);
    my @compatible_builders = $builder_set->check_compatibility(@builder_list);

DESCRIPTION

Dist::Man::BuilderSet is a collection of utility methods used to provide metadata about builders supported by Dist::Man.

CLASS METHODS

new()

This method initializes and returns an object representing the set of Builders supported by Dist::Man

supported_builders()

This method returns a list of builders supported by Dist::Man

file_for_builder($builder)

This method returns the name of the file generated by Dist::Man that will be used to build the generated module

method_for_builder($builder)

This method returns the name of the method in the Dist::Man::Simple package that is called to create the file returned by file_for_builder($builder)

instructions_for_builder($builder)

This method returns a list of commands that, when run from the command line (or with system()), will cause the generated module to be built, tested and installed.

deps_for_builder($builder)

This method returns a list of dependencies in the following format: ( { command => "make", aliases => [ 'make', 'gmake' ], }, { command => "another_command", aliases => [ 'alias0', 'alias1', '...' ], }, )

check_compatibility(@builders)

This method accepts a list of builders and filters out the ones that are unsupported or mutually exclusive, returning the builders that passed the filter. If none pass the filter, the default builder is returned.

default_builder()

This method returns the module name of the default builder.

BUGS

Please report any bugs or feature requests to bug-dist-man at rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

C.J. Adams-Collier, <cjac@colliertech.org>

Copyright & License

Module::Starter::BuilderSet

Copyright 2007 C.J. Adams-Collier, All Rights Reserved.

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

Please note that these modules are not products of or supported by the employers of the various contributors to the code.

Dist::Man::BuilderSet

Modified by Shlomi Fish while disclaiming any explicit or implicit ownership. May be used under the present or future terms of Module::Starter::BuilderSet.

cpanm Dist::Man

perl -MCPAN -e shell
install Dist::Man