NAME
Perl::Metrics::Lite::Analysis - Contains anaylsis results.
SYNOPSIS
This is the class of objects returned by the analyze_files method of the Perl::Metrics::Lite class.
Normally you would not create objects of this class directly, instead you get them by calling the analyze_files method on a Perl::Metrics::Lite object.
VERSION
This is VERSION 0.092
DESCRIPTION
USAGE
new
$analysis = Perl::Metrics::Lite::Analsys->new( \@file_objects )Takes an arrayref of Perl::Metrics::Lite::Analysis::File objects and returns a new Perl::Metrics::Lite::Analysis object.
data
The raw data for the analysis. This is the arrayref you passed as the argument to new();
files
Arrayref of file paths, in the order they were encountered.
file_count
How many Perl files were found.
lines
Total lines in all files, excluding comments and pod.
main_stats
Returns a hashref of data based the main code in all files, that is, on the code minus all named subroutines.
{
lines => 723,
}file_stats
Returns an arrayref of hashrefs, each entry is for one analyzed file, in the order they were encountered. The main_stats slot in the hashref is for all the code in the file outside of any named subroutines.
[
{
path => '/path/to/file',
main_stats => {
lines => 23,
path => '/path/to/file',
name => '{code not in named subroutines}',
},
},
...
]sub_stats
Returns an hashref of subroutine metrics, each entry is for one analyzed file.
packages
Arrayref of unique packages found in code.
package_count
How many unique packages found.
subs
Array ref containing hashrefs of all named subroutines, in the order encounted.
Each hashref has the structure:
{
'lines' => 19,
'line_number' => 5,
'mccabe_complexity' => 6,
'name' => 'databaseRecords',
'path' => '../path/to/File.pm',
}sub_count
How many subroutines found.
BUGS AND LIMITATIONS
None reported yet ;-)
DEPENDENCIES
SUPPORT
Via github
Disussion Forum
http://www.cpanforum.com/dist/Perl-Metrics-Lite
Bug Reports
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Metrics-Lite
AUTHOR
Dann <techmemo {at} gmail.com>