1Module::CPANTS::AnalyseU(s3e)r Contributed Perl DocumentaMtoidounle::CPANTS::Analyse(3)
2
3
4

NAME

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

SYNOPSIS

9           use Module::CPANTS::Analyse;
10
11           my $analyser=Module::CPANTS::Analyse->new({
12               dist=>'path/to/Foo-Bar-1.42.tgz',
13           });
14           $analyser->unpack;
15           $analyser->analyse;
16           $analyser->calc_kwalitee;
17           # results are in $analyser->d;
18

DESCRIPTION

20   Methods
21       new
22
23         my $analyser=Module::CPANTS::Analyse->new({dist=>'path/to/file'});
24
25       Plain old constructor.
26
27       unpack
28
29       Unpack the distribution into a temporary directory.
30
31       Returns an error if something went wrong, "undef" if all went well.
32
33       analyse
34
35       Run all analysers (defined in "Module::CPANTS::Kwalitee::*" on the
36       dist.
37
38       calc_kwalitee
39
40       Check if the dist conforms to the Kwalitee indicators.
41
42   Helper Methods
43       testdir
44
45       Returns the path to the unique temp directory.
46
47       testfile
48
49       Returns the location of the unextracted tarball.
50
51       tarball
52
53       Returns the filename of the tarball.
54
55       read_meta_yml
56
57       Reads the META.yml file and returns its content.
58

WEBSITE

60       http://cpants.perl.org/
61

BUGS

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

AUTHOR

71       Thomas Klausner, <domm@cpan.org>, http://domm.zsi.at
72
73       Please use the perl-qa mailing list for discussing all things CPANTS:
74       http://lists.perl.org/showlist.cgi?name=perl-qa
75
76       Based on work by Leon Brocard <acme@astray.com> and the original idea
77       proposed by Michael G. Schwern <schwern@pobox.com>
78

LICENSE

80       This code is Copyright (c) 2003-2006 Thomas Klausner.  All rights
81       reserved.
82
83       You may use and distribute this module according to the same terms that
84       Perl is distributed under.
85
86
87
88perl v5.12.0                      2010-05-03        Module::CPANTS::Analyse(3)
Impressum