.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Perl::Metrics::Simple 3pm"
.TH Perl::Metrics::Simple 3pm "2010-05-13" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Perl::Metrics::Simple \- Count packages, subs, lines, etc. of many files.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\&  use 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;
.Ve
.SH "VERSION"
.IX Header "VERSION"
This is \s-1VERSION\s0 0.12
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBPerl::Metrics::Simple\fR 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 \*(L"main\*(R" portion of the code.
.PP
\&\fBPerl::Metrics::Simple\fR is far simpler than Perl::Metrics.
.PP
Installs a script called \fBcountperl\fR.
.SH "USAGE"
.IX Header "USAGE"
See the \fIcountperl\fR script (included with this distribution)
for a simple example of usage.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS "new"
.IX Subsection "new"
Takes no arguments and returns a new Perl::Metrics::Simple object.
.SS "is_perl_file"
.IX Subsection "is_perl_file"
Takes a path and returns true if the target is a Perl file.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.ie n .SS "analyze_files( @paths, @refs_to_file_contents )"
.el .SS "analyze_files( \f(CW@paths\fP, \f(CW@refs_to_file_contents\fP )"
.IX Subsection "analyze_files( @paths, @refs_to_file_contents )"
Takes an array of files and or directory paths, and/or
\&\s-1SCALAR\s0 refs to file contents and returns
an Perl::Metrics::Simple::Analysis object.
.ie n .SS "find_files( @directories_and_files )"
.el .SS "find_files( \f(CW@directories_and_files\fP )"
.IX Subsection "find_files( @directories_and_files )"
Uses \fIlist_perl_files\fR to find all the readable Perl files
and returns a reference to a (possibly empty) list of paths.
.SS "list_perl_files"
.IX Subsection "list_perl_files"
Takes a list of one or more paths and returns an
alphabetically sorted list of only the perl files.
Uses \fIis_perl_file\fR so may throw an exception if a file is unreadable.
.SS "is_perl_file($path)"
.IX Subsection "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.
.PP
If the file name does not match any of \f(CW@Perl::Metrics::Simple::PERL_FILE_SUFFIXES\fR
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.
.SS "should_be_skipped($path)"
.IX Subsection "should_be_skipped($path)"
Returns true if the \fIpath\fR should be skipped when looking for Perl files.
Currently skips  \fI.svn\fR, \fI\s-1CVS\s0\fR, and \fI_darcs\fR directories.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
See: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl\-Metrics\-Simple
.SH "SUPPORT"
.IX Header "SUPPORT"
Via \s-1CPAN:\s0
.SS "Disussion Forum"
.IX Subsection "Disussion Forum"
http://www.cpanforum.com/dist/Perl\-Metrics\-Simple
.SS "Bug Reports"
.IX Subsection "Bug Reports"
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl\-Metrics\-Simple
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 5
\&    Matisse Enzer
\&    CPAN ID: MATISSE
\&    Eigenstate Consulting, LLC
\&    matisse@eigenstate.net
\&    http://www.eigenstate.net/
.Ve
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2006\-2009 by Eigenstate Consulting, \s-1LLC\s0.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "The \fIcountperl\fR script included with this distribution." 4
.IX Item "The countperl script included with this distribution."
.PD 0
.IP "\s-1PPI\s0" 4
.IX Item "PPI"
.IP "Perl::Critic" 4
.IX Item "Perl::Critic"
.IP "Perl::Metrics" 4
.IX Item "Perl::Metrics"
.IP "http://en.wikipedia.org/wiki/Cyclomatic_complexity" 4
.IX Item "http://en.wikipedia.org/wiki/Cyclomatic_complexity"