/ 
Devel-Cover-1.44
River stage three • 63 direct dependents • 118 total dependents
/ Devel::Cover::DB

NAME

Devel::Cover::DB - Code coverage metrics for Perl

VERSION

version 1.44

SYNOPSIS

use Devel::Cover::DB;

my $db = Devel::Cover::DB->new(db => "my_coverage_db");
$db->print_summary([$file1, $file2], ["statement", "pod"]);

DESCRIPTION

This module provides access to a database of code coverage information.

METHODS

new

my $db = Devel::Cover::DB->new(db => "my_coverage_db");

Constructs the DB from the specified database.

cover

my $cover = $db->cover;

Returns a Devel::Cover::DB::Cover object. From here all the coverage data may be accessed.

my $cover = $db->cover;
for my $file ($cover->items) {
    print "$file\n";
    my $f = $cover->file($file);
    for my $criterion ($f->items) {
        print "  $criterion\n";
        my $c = $f->criterion($criterion);
        for my $location ($c->items) {
            my $l = $c->location($location);
            print "    $location @$l\n";
        }
    }
}

Data for different criteria will be in different formats, so that will need special handling. This is not yet documented so your best bet for now is to look at some of the simpler reports and/or the source.

The methods in the above example are actually aliases for methods in Devel::Cover::DB::Base (the base class for all Devel::Cover::DB::* classes):

  • Devel::Cover::DB::Base->values

    Aliased to Devel::Cover::DB::Cover->files, Devel::Cover::DB::File->criteria, Devel::Cover::DB::Criterion->locations, and Devel::Cover::DB::Location->data

  • Devel::Cover::DB::Base->get

    Aliased to Devel::Cover::DB::Cover->file, Devel::Cover::DB::File->criterion, Devel::Cover::DB::Criterion->location, and Devel::Cover::DB::Location->datum

Instead of calling $file->criterion("x") you can also call $file->x.

is_valid

my $valid = $db->is_valid;

Returns true if $db is valid (or looks valid, the function is too lax).

SEE ALSO

Devel::Cover
Devel::Cover::DB::Base
Devel::Cover::DB::Cover
Devel::Cover::DB::File
Devel::Cover::DB::Criterion
Devel::Cover::DB::Location

BUGS

Huh?

LICENCE

Copyright 2001-2024, Paul Johnson (paul@pjcj.net)

This software is free. It is licensed under the same terms as Perl itself.

The latest version of this software should be available from my homepage: http://www.pjcj.net