Manual Reference Pages - PERL::METRICS::SIMPLE (3)
Perl::Metrics::Simple - Count packages, subs, lines, etc. of many files.
my $analyzer = Perl::Metrics::Simple->new;
my $analysis = $analyzer->analyze_files(@paths, @refs_to_file_contents);
$file_count = $analysis->file_count;
$package_count = $analysis->package_count;
$sub_count = $analysis->sub_count;
$lines = $analysis->lines;
$main_stats = $analysis->main_stats;
$file_stats = $analysis->file_stats;
This is VERSION 0.12
<B>Perl::Metrics::SimpleB> provides just enough methods to run static analysis
of one or many Perl files and obtain a few metrics: packages, subroutines,
lines of code, and an approximation of cyclomatic (mccabe) complexity for
the subroutines and the main portion of the code.
<B>Perl::Metrics::SimpleB> is far simpler than Perl::Metrics.
Installs a script called <B>countperlB>.
See the countperl script (included with this distribution)
for a simple example of usage.
Takes no arguments and returns a new Perl::Metrics::Simple object.
Takes a path and returns true if the target is a Perl file.
analyze_files( CW@paths, CW@refs_to_file_contents )
Takes an array of files and or directory paths, and/or
SCALAR refs to file contents and returns
an Perl::Metrics::Simple::Analysis object.
find_files( CW@directories_and_files )
Uses list_perl_files to find all the readable Perl files
and returns a reference to a (possibly empty) list of paths.
Takes a list of one or more paths and returns an
alphabetically sorted list of only the perl files.
Uses is_perl_file so may throw an exception if a file is unreadable.
Takes a path to a file and returns true if the file appears to be a Perl file,
otherwise returns false.
If the file name does not match any of @Perl::Metrics::Simple::PERL_FILE_SUFFIXES
then the file is opened for reading and the first line examined for a a Perl
shebang line. An exception is thrown if the file cannot be opened in this case.
Returns true if the path should be skipped when looking for Perl files.
Currently skips .svn, CVS, and _darcs directories.
BUGS AND LIMITATIONS
CPAN ID: MATISSE
Eigenstate Consulting, LLC
LICENSE AND COPYRIGHT
Copyright (c) 2006-2009 by Eigenstate Consulting, LLC.
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.
|perl v5.20.3 ||PERL::METRICS::SIMPLE (3) ||2015-01-04 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.