NAME
Perl::Metrics::Simple::Analysis - Contains anaylsis results.
SYNOPSIS
This is the class of objects returned by the analyze_files method of the Perl::Metrics::Simple 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::Simple object.
VERSION
This is VERSION 0.02.
DESCRIPTION
USAGE
new
$analysis = Perl::Metrics::Simple::Analsys->new( $array_of_data )Takes an arrayref of data and returns a new Perl::Metrics::Simple::Analysis object.
data
The raw data for the analysis. This is the arryref you passed as athe 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, including comments.
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,
mccabe_complexity => 45
}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,
mccabe_complexity => 3,
},
},
...
]packages
Arrayref of unique packages found in code.
package_count
How many unique packages found.
subs
Array ref containing names of all named subroutines, in the order encounted.
sub_count
How many subroutines found.
BUGS AND LIMITATIONS
None reported yet ;-)
DEPENDENCIES
SUPPORT
Via CPAN:
Disussion Forum
http://www.cpanforum.com/dist/Perl-Metrics-Simple
Bug Reports
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Metrics-Simple
AUTHOR
Matisse Enzer
CPAN ID: MATISSE
Eigenstate Consulting, LLC
matisse@eigenstate.net
http://www.eigenstate.net/LICENSE AND COPYRIGHT
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
SEE ALSO
perl(1).