Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

devel::cover::db(3pm) [debian man page]

Devel::Cover::DB(3pm)					User Contributed Perl Documentation				     Devel::Cover::DB(3pm)

NAME

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

VERSION

       version 0.89

SYNOPSIS

	use Devel::Cover::DB;

	my $db = Devel::Cover::DB->new(db => "my_coverage_db");
	$db->print_summary(statement => 1, pod => 1);
	$db->print_details;

DESCRIPTION

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

METHODS

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

       Contructs 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
";
	    my $f = $cover->file($file);
	    for my $criterion ($f->items)
	    {
		print "  $criterion
";
		my $c = $f->criterion($criterion);
		for my $location ($c->items)
		{
		    my $l = $c->location($location);
		    print "    $location @$l
";
		}
	    }
	}

       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):

       o   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

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

	   Aliased to Devel::Cover::DB::Cover->file, Devel::Cover::DB::File->criteriom, 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-2012, 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

perl v5.14.2							    2012-06-15						     Devel::Cover::DB(3pm)

Check Out this Related Man Page

Devel::Cover::Report::Html_minimal(3pm) 		User Contributed Perl Documentation		   Devel::Cover::Report::Html_minimal(3pm)

NAME

       Devel::Cover::Report::Html_minimal - Backend for HTML reporting of coverage statistics

VERSION

       version 0.89

SYNOPSIS

	cover -report html_minimal

DESCRIPTION

       This module provides a HTML reporting mechanism for coverage data. It is designed to be called from the "cover" program.

       Based on an original by Paul Johnson, the output was greatly improved by Michael Carman (mjcarman@mchsi.com).

OPTIONS

       Options are specified by adding the appropriate flags to the "cover" program.  This report format supports the following:

       outputfile
	   Specifies the filename of the main output file.  The default is coverage.html.  Specify index.html if you just want to publish the
	   whole directory.

       pod Includes POD (and blank lines) in the file report.  This is on by default.  It may be turned off with -nopod.

       data
	   Includes text after the "__DATA__" or "__END__" tokens in the file report.  By default, this text is trimmed.

	   Note: If your POD is after an "__END__", you have to specify 'data' to include it, not 'pod'.  The 'pod' option only applies to POD
	   before the "__END__".

       unified
	   Generates a "unified" report for each file.	The detailed data that normally appears in the auxiliary reports (branch, condition, etc.)
	   are placed in the file report, and the auxiliary reports are not generated.

       summarytitle
	   Specify the title of the summary.  The default is "Coverage Summary".

SEE ALSO

       Devel::Cover

LICENCE

       Copyright 2001-2012, 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

perl v5.14.2							    2012-06-16				   Devel::Cover::Report::Html_minimal(3pm)
Man Page