Module::License::Report::CPANPLUSModule - Abstraction of a CPAN module
Copyright 2005 Clotho Advanced Media, Inc., <cpan@clotho.com>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
use Module::License::Report::CPANPLUS.pm use Module::License::Report::CPANPLUSModule.pm my $cp = Module::License::Report::CPANPLUS->new(); my $module = Module::License::Report::CPANPLUSModule->new($cp, 'Foo::Bar'); my $license = $module->license();
This is an extension of the CPANPLUS::Module API for use by Module::License::Report. It's unlikely that you want to use this directly.
The $cp argument is a Module::License::Report::CPANPLUS instance. The $module_name should be of a form acceptable to Module::License::Report::CPANPLUS::get_module().
$cp
$module_name
Returns a boolean.
Returns a Module::License::Report::Object instance, or undef.
Searches the specified file for license and/or copyright information. This uses heuristics.
Loads and parses a META.yml file. Returns a hashref that has, minimally, a license field.
META.yml
license
Parses the CPAN DSLIP metadata. Returns a hashref that has, minimally, a license field.
See http://cpan.uwinnipeg.ca/htdocs/faqs/dslip.html for more information.
Loads and parses a Makefile.PL file. Returns a hashref that has, minimally, a license field.
Makefile.PL
The parsing is very simplistic.
Loads and parses a Build.PL file. Returns a hashref that has, minimally, a license field.
Build.PL
Returns the name of the file that has the definitive VERSION. This file might not exist.
VERSION
This relies on parsing META.yml, Build.PL or Makefile.PL.
Returns the name of a .pod file that corresponds to version_from(). This file might not exist.
.pod
Returns the name of the file that is the most likely source of license or copyright information.
Returns a list of all files in the root of the distribution directory, like README, Makefile.PL, etc.
README
Returns the module name that was specified in the constructor.
Returns the name of the package, like Foo-Bar.
Foo-Bar
Returns the version of the package, like 0.12.04_01.
0.12.04_01
Returns the path to the extracted distribution. If the distribution is not yet extracted, does that first.
Extracts the distribution archive (perhaps a .tar.gz or a .zip file) and returns the path.
.tar.gz
.zip
Downloads the distribution from CPAN.
Clotho Advanced Media Inc., cpan@clotho.com
Primary developer: Chris Dolan
To install Module::License::Report, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::License::Report
CPAN shell
perl -MCPAN -e shell install Module::License::Report
For more information on module installation, please visit the detailed CPAN module installation guide.