NAME

P5U::Lib::Testers - support library implementing p5u's testers command

SYNOPSIS

use P5U::Lib::DebianRelease;
use Path::Tiny qw(path);

my $dr = P5U::Lib::DebianRelease->new(
  cache_file => path("/tmp/debian.data"),
);

my $author_data = $dr->author_data('tobyink');
foreach my $dist (@$author_data)
{
  print "Dist:   $dist->[0]\n";
  print "CPAN:   $dist->[1]\n";
  print "Debian: $dist->[2]\n\n";
}

DESCRIPTION

This is a support library for the testers command.

It's a Moo-based class.

Constructor

new(%attributes)

Creates a new instance of the class.

Attributes

distro

Distribution name; read-only; string; required.

version

Version number; read-only; string.

If omitted, the latest version for which CPAN Testers results are available is assumed.

os_data

Indicates that reports should be split by operating system. Read-only; boolean; default false.

stable

Indicates that reports should ignore development releases. Read-only; boolean; default false.

cache_dir

A directory for caching JSON files into. Read-only; string. If omitted, something sensible will be used.

results

The CPAN testers results, as an array of hashes. You generally do not want to set this yourself, but rely on this module to build it for you!

Methods

version_data

Returns a hashref. Keys are Perl versions such as "Perl 5.008", or if os_data is true "Perl 5.008, Linux". Values are arrayrefs of three numbers indicating counts of passes, fails and other results respectively.

summary_data

Returns a similar hash of arrays (HoA) structure to version_data, except keys are versions of the distribution, not versions of Perl.

format_report

Given an HoA structure as above, formats it into a single string for printing to a terminal or other output device using a fixed-width font.

version_report

version_data and format_report in a single method call.

summary_report

summary_data and format_report in a single method call.

BUGS

Please report any bugs to http://rt.cpan.org/Dist/Display.html?Queue=P5U.

SEE ALSO

p5u.

http://www.perlmonks.org/?node_id=978606.

AUTHOR

Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE

This software is copyright (c) 2012-2013 by Toby Inkster.

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

DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.