Perl::ToPerl6::Statistics - Compile stats on Perl::ToPerl6 transformations.
This class accumulates statistics on Perl::ToPerl6 transformations across one or more files. NOTE: This class is experimental and subject to change.
This is considered to be a non-public class. Its interface is subject to change without notice.
new()
Create a new instance of Perl::ToPerl6::Statistics. No arguments are supported at this time.
accumulate( $doc, \@transformations )
Accumulates statistics about the $doc and the @transformations that were found.
$doc
@transformations
modules()
The number of chunks of code (usually files) that have been analyzed.
subs()
The total number of subroutines analyzed by this ToPerl6.
statements()
The total number of statements analyzed by this ToPerl6.
lines()
The total number of lines of code analyzed by this ToPerl6.
lines_of_blank()
The total number of blank lines analyzed by this ToPerl6. This includes only blank lines in code, not POD or data.
lines_of_comment()
The total number of comment lines analyzed by this ToPerl6. This includes only lines whose first non-whitespace character is #.
#
lines_of_data()
The total number of lines of data section analyzed by this ToPerl6, not counting the __END__ or __DATA__ line. POD in a data section is counted as POD, not data.
__END__
__DATA__
lines_of_perl()
The total number of lines of Perl code analyzed by this ToPerl6. Perl appearing in the data section is not counted.
lines_of_pod()
The total number of lines of POD analyzed by this ToPerl6. Pod occurring in a data section is counted as POD, not as data.
transformations_by_severity()
The number of transformations of each severity found by this ToPerl6 as a reference to a hash keyed by severity.
transformations_by_policy()
The number of transformations of each policy found by this ToPerl6 as a reference to a hash keyed by full policy name.
total_transformations()
The total number of transformations found by this ToPerl6.
statements_other_than_subs()
The total number of statements minus the number of subroutines. Useful because a subroutine is considered a statement by PPI.
average_sub_mccabe()
The average McCabe score of all scanned subroutines.
transformations_per_file()
The total transformations divided by the number of modules.
transformations_per_statement()
The total transformations divided by the number statements minus subroutines.
transformations_per_line_of_code()
The total transformations divided by the lines of code.
Elliot Shank <perl@galumph.com>
<perl@galumph.com>
Copyright (c) 2007-2011 Elliot Shank.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.
To install Perl::ToPerl6, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::ToPerl6
CPAN shell
perl -MCPAN -e shell install Perl::ToPerl6
For more information on module installation, please visit the detailed CPAN module installation guide.