SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE




YUM REPOSITORY

 
 

MAN page from Mandriva 2011 perl-Module-CPANTS-0.20030725-5mdv2011.0.noarch.rpm

Module::CPANTS

Section: User Contributed Perl Documentation (3)
Updated: 2003-07-27
Index 

NAME

Module::CPANTS - CPAN Module Testing 

SYNOPSIS

  use Module::CPANTS;  my $c = Module::CPANTS->new();  my $cpants = $c->data;
 

DESCRIPTION

This is an initial stab at providing automated testing metrics for themodules on CPAN. Alpha release and all that. It's just out there totest the waters.

CPANTS was initially described by Michael Schwern a long time ago in:http://archive.develooper.com/perl-qa@perl.org/msg00148.htmlIt is highly recommended that you read that.

The idea is to have automated module testing reporting back all sortsof metadata about the modules on CPAN.

The current interface is a large hash. The keys in the hash aredistributions. For example, the information available forAcme-Colour-0.20.tar.gz is accessible using:

  my $dist = 'Acme-Colour-0.20.tar.gz';  my $data = $cpants->{$dist};

The actual information currently returned is as follows:

  'Acme-Colour-0.20.tar.gz' => {    'author' => 'LBROCARD',    'description' => 'additive and subtractive human-readable colours',    'files' => [      'Makefile.PL',      'README',      'MANIFEST'    ],    'lines' => {      'nonpod' => 170,      'pod' => 95,      'pod_errors' => 0,      'total' => 265,      'with_comments' => 8,    },    'releases' => '5',    'requires' => [      'Graphics-ColorNames-0.32.tar.gz',      'Scalar-List-Utils-1.11.tar.gz',      'Test-Simple-0.47.tar.gz'    ],    'requires_module' => {      'Graphics::ColorNames' => 0,      'List::Util' => 0,      'Test::Simple' => 0    },    'requires_recursive' => [      'File-Spec-0.82.tar.gz',      'Graphics-ColorNames-0.32.tar.gz',      'Scalar-List-Utils-1.11.tar.gz',      'Test-Harness-2.28.tar.gz',      'Test-Simple-0.47.tar.gz'    ],    'size' => {      'packed' => 3883,      'unpacked' => 13078    },    'testers' => {      'fail' => 1,      'pass' => 5    },    'uses' => [      'Graphics::ColorNames',      'List::Util',      'strict',      'vars'    ]  }

The ``author'' field is the PAUSE ID of the author of the distribution.

The ``description'' field is the description listed in the CPAN moduleslist for the distribibution.

The ``lines'' field shows the number of POD lines (documentation),number of POD errors reported by Pod::Simple::Checker, non-POD lines(code), lines with comments, and total lines in all the modules in adistribution.

The ``files'' field is a listref containing interesting files which werefound. The following files are deemed interesting at the moment: Makefile.PL, README, Build.PL, META.yml, SIGNATURE, MANIFEST.

The ``releases'' field contains the total number of releases to CPANthat distribution has.

The ``requires_module'' field is a hashref containing the moduleprerequisites listed in the Makefile.PL for the distribution.

The ``requires'' field is a listref containing all the distributionscontaining the module prerequisite listed in the Makefile.PL for thedistribution.

The ``requires_recursive'' is the same as ``requires'' but lists therecursive dependencies. This should be all the distributions that thedistribution needs to run.

The ``size'' contains two fields: the packed and unpacked size of thedistribution in bytes.

The ``testers'' field contains the number of passes and fails reportedby the CPAN testers (http://testers.cpan.org/). The ``tests'' subfieldreturns the number of tests in that distribution (this is onlyavailable for a limited number of distributions at the moment).

More data is to be added soon. A kwalitee rating may be added soon.

Note that CPANPLUS is very useful for relating modules todistributions. 

AUTHOR

Leon Brocard <acmeAATTastray.com> 

LICENSE

This code is distributed under the same license as Perl.


 

Index

NAME
SYNOPSIS
DESCRIPTION
AUTHOR
LICENSE

This document was created byman2html,using the manual pages.