![]() |
![]()
| ![]() |
![]()
NAMEPerl::Metrics::Simple - Count packages, subs, lines, etc. of many files.SYNOPSISuse Perl::Metrics::Simple; 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; VERSIONThis is VERSION 0.12DESCRIPTIONPerl::Metrics::Simple 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.Perl::Metrics::Simple is far simpler than Perl::Metrics. Installs a script called countperl. USAGESee the countperl script (included with this distribution) for a simple example of usage.CLASS METHODSnewTakes no arguments and returns a new Perl::Metrics::Simple object.is_perl_fileTakes a path and returns true if the target is a Perl file.OBJECT METHODSanalyze_files( @paths, @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( @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.list_perl_filesTakes 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.is_perl_file($path)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. should_be_skipped($path)Returns true if the path should be skipped when looking for Perl files. Currently skips .svn, CVS, and _darcs directories.BUGS AND LIMITATIONSSee: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Metrics-SimpleSUPPORTVia CPAN:Disussion Forumhttp://www.cpanforum.com/dist/Perl-Metrics-SimpleBug Reportshttp://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Metrics-SimpleAUTHORMatisse Enzer CPAN ID: MATISSE Eigenstate Consulting, LLC matisse@eigenstate.net http://www.eigenstate.net/ LICENSE AND COPYRIGHTCopyright (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. SEE ALSO
|