Scroll to navigation

Module::CPANTS::Analyse(3pm) User Contributed Perl Documentation Module::CPANTS::Analyse(3pm)

NAME

Module::CPANTS::Analyse - Generate Kwalitee ratings for a distribution

SYNOPSIS

    use Module::CPANTS::Analyse;
    my $analyser=Module::CPANTS::Analyse->new({
        dist=>'path/to/Foo-Bar-1.42.tgz',
    });
    $analyser->unpack;
    $analyser->analyse;
    $analyser->calc_kwalitee;
    # results are in $analyser->d;

DESCRIPTION

Methods

new
  my $analyser=Module::CPANTS::Analyse->new({dist=>'path/to/file'});
Plain old constructor.
unpack
Unpack the distribution into a temporary directory.
Returns an error if something went wrong, "undef" if all went well.
analyse
Run all analysers (defined in "Module::CPANTS::Kwalitee::*" on the dist.
calc_kwalitee
Check if the dist conforms to the Kwalitee indicators.

Helper Methods

testdir
Returns the path to the unique temp directory.
testfile
Returns the location of the unextracted tarball.
tarball
Returns the filename of the tarball.
read_meta_yml
Reads the META.yml file and returns its content.

WEBSITE

<http://cpants.perl.org/>

BUGS

Please report any bugs or feature requests, or send any patches, to bug-module-cpants-analyse at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

Thomas Klausner <https://metacpan.org/author/domm>
Please use the "perl-qa" mailing list for discussing all things CPANTS: http://lists.perl.org/list/perl-qa.html <http://lists.perl.org/list/perl-qa.html>
Based on work by Leon Brocard <https://metacpan.org/author/lbrocard> and the original idea proposed by Michael G. Schwern <https://metacpan.org/author/schwern>.

LICENSE

This code is Copyright X 2003X2006 Thomas Klausner <https://metacpan.org/author/domm>. All rights reserved.
You may use and distribute this module according to the same terms that Perl is distributed under.
2012-06-08 perl v5.14.2