The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Requires-0.007
++
/ Dist::Requires

NAME

Dist::Requires - Identify requirements for a distribution

VERSION

version 0.007

SYNOPSIS

  use Dist::Requires;
  my $dr = Dist::Requires->new();

  # From a distribution archive file...
  my $prereqs = $dr->prerequisites(dist => 'Foo-Bar-1.2.tar.gz');

  # From an unpacked distribution directory...
  my $prereqs = $dr->prerequisites(dist => 'Foo-Bar-1.2');

DESCRIPTION

Dist::Requires answers the question "Which packages are required to install a distribution with a particular version of perl?" The distribution can be in an archive file or unpacked into a directory. By default, the requirements will only include packages that are newer than the ones in the perl core (if they were in the core at all). You can turn this feature off to get all requirements. You can also control which version of perl to consider.

CONSTRUCTOR

new( %attributes )

All of the attributes listed below can be set via the constructor, and retrieved via accessor methods by the same name. Once constructed, the object is immutable and all attributes are read-only.

ATTRIBUTES

target_perl => $PATH

The path to the perl executable that will be used to configure the distribution. Defaults to the perl that loaded this module. NOTE: this attribute is not configurable at this time.

target_perl_version => $FLOAT

The core module list for the specified perl version will be used to filter the requirements. This only matters if you're using the default package filter. Defaults to the version of the perl specified by the perl attribute. Can be specified as a decimal number, a dotted version string, or a version object.

timeout => $INT

Sets the timeout (in seconds) for running the distribution's configuration step. Defaults to 15 seconds.

filter => $HASHREF

Given a hashref of MODULE_NAME => VERSION pairs, any distribution requirements that have the same version or less than those listed in the hashref will be excluded from the output. This defaults to the modules and versions reported by Module::CoreList for the version of perl that was specified by the target_perl_version attribute. If you don't want any filter to be applied, then just give a reference to any empty hash.

METHODS

prerequisites( dist => $SOME_PATH )

Returns the requirements of the distribution as a hash of PACKAGE_NAME => VERSION pairs. The c<dist> argument can be the path to either a distribution archive file (e.g. Foo-Bar-1.2.tar.gz) or an unpacked distribution directory (e.g. Foo-Bar-1.2). The requirements will be filtered according to the values specified by the filter attribute.

LIMITATIONS

Much of Dist::Requires was inspired (even copied) from CPAN and cpanm. However, both of those are much more robust and better at handling old versions of toolchain modules, broken metadata, etc. Dist::Requires requires relatively new toolchain modules, and will probably only work if given a well-packaged distribution with sane metadata. Perhaps Dist::Metadata will become more robust in the future.

BEWARE

Dist::Requires will attempt to configure the distribution using whatever build mechanism it provides (i.e. Module::Build or ExtUtils::MakeMaker) and then extract the requirements from the resulting metadata files. That means you could be executing unsafe code. However, this is no different from what cpanm and cpan do when you install a distribution.

SEE ALSO

Module::Depends

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc Dist::Requires

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

https://github.com/thaljef/Dist-Requires/issues

Source Code

https://github.com/thaljef/Dist-Requires

  git clone git://github.com/thaljef/Dist-Requires.git

AUTHOR

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Imaginative Software Systems.

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