The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

CPAN::Cover::Results - get CPAN coverage test results from CPAN Cover service

SYNOPSIS

 use CPAN::Cover::Results;

 my $iterator = CPAN::Cover::Results->new()->release_iterator();

 while (my $release = $iterator->next) {
     printf "%s (%s) : %.2f\n",
            $release->distname,
            $release->version,
            $release->total;
 }

DESCRIPTION

This module will get the coverage test results from the CPAN Cover service and let you iterate over them, distribution by distribution. CPAN Cover is a service that runs Devel::Cover on as much of CPAN as possible, and makes the results available.

The release iterator returns instances of CPAN::Cover::Results::Release, which has the following attributes:

  • distname - the name of the distribution, as determined by CPAN::DistnameInfo.

  • version - the version number of the release.

  • branch - the branch coverage of the release's testsuite, or undef.

  • condition - the condition coverage figure, or undef.

  • pod - the pod coverage, if available, or undef.

  • statement - the statement coverage, or undef.

  • subroutine - the subroutine coverage, or undef.

  • total - the total coverage.

See the Devel::Cover documentation for more information on the different coverage figures.

SEE ALSO

Devel::Cover - the module used to generate test coverage statistics.

cpancover.com - the coverage testing service that generates the results accessed via this module.

Practical code coverage - slides from a talk by Paul Johnson, the author of Devel::Cover and cpancover.

CPAN::Cover::Results::Release - the release iterator returns instances of this class.

REPOSITORY

https://github.com/neilbowers/CPAN-Cover-Results

AUTHOR

Neil Bowers <neilb@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Neil Bowers <neilb@cpan.org>.

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