Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::statistics(3) [centos man page]

Perl::Critic::Statistics(3)				User Contributed Perl Documentation			       Perl::Critic::Statistics(3)

NAME

       Perl::Critic::Statistics - Compile stats on Perl::Critic violations.

DESCRIPTION

       This class accumulates statistics on Perl::Critic violations across one or more files.  NOTE: This class is experimental and subject to
       change.

INTERFACE SUPPORT

       This is considered to be a non-public class.  Its interface is subject to change without notice.

METHODS

       "new()"
	   Create a new instance of Perl::Critic::Statistics.  No arguments are supported at this time.

       " accumulate( $doc, @violations ) "
	   Accumulates statistics about the $doc and the @violations that were found.

       "modules()"
	   The number of chunks of code (usually files) that have been analyzed.

       "subs()"
	   The total number of subroutines analyzed by this Critic.

       "statements()"
	   The total number of statements analyzed by this Critic.

       "lines()"
	   The total number of lines of code analyzed by this Critic.

       "lines_of_blank()"
	   The total number of blank lines analyzed by this Critic. This includes only blank lines in code, not POD or data.

       "lines_of_comment()"
	   The total number of comment lines analyzed by this Critic. This includes only lines whose first non-whitespace character is "#".

       "lines_of_data()"
	   The total number of lines of data section analyzed by this Critic, not counting the "__END__" or "__DATA__" line. POD in a data section
	   is counted as POD, not data.

       "lines_of_perl()"
	   The total number of lines of Perl code analyzed by this Critic. Perl appearing in the data section is not counted.

       "lines_of_pod()"
	   The total number of lines of POD analyzed by this Critic. Pod occurring in a data section is counted as POD, not as data.

       "violations_by_severity()"
	   The number of violations of each severity found by this Critic as a reference to a hash keyed by severity.

       "violations_by_policy()"
	   The number of violations of each policy found by this Critic as a reference to a hash keyed by full policy name.

       "total_violations()"
	   The the total number of violations found by this Critic.

       "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.

       "violations_per_file()"
	   The total violations divided by the number of modules.

       "violations_per_statement()"
	   The total violations divided by the number statements minus subroutines.

       "violations_per_line_of_code()"
	   The total violations divided by the lines of code.

AUTHOR

       Elliot Shank "<perl@galumph.com>"

COPYRIGHT

       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.

perl v5.16.3							    2014-06-09					       Perl::Critic::Statistics(3)

Check Out this Related Man Page

Perl::Critic::UserProfile(3)				User Contributed Perl Documentation			      Perl::Critic::UserProfile(3)

NAME

       Perl::Critic::UserProfile - The contents of the user's profile, often .perlcriticrc.

DESCRIPTION

       This is a helper class that encapsulates the contents of the user's profile, which is usually stored in a .perlcriticrc file. There are no
       user-serviceable parts here.

INTERFACE SUPPORT

       This is considered to be a non-public class.  Its interface is subject to change without notice.

CONSTRUCTOR

       " new( -profile =" $p ) >
	   -profile is the path to the user's profile.	If -profile is not defined, then it looks for the profile at ./.perlcriticrc and then
	   $HOME/.perlcriticrc.  If neither of those files exists, then the UserProfile is created with default values.

	   This object does not take into account any command-line overrides; Perl::Critic::Config does that.

METHODS

       " options_processor() "
	   Returns the Perl::Critic::OptionsProcessor object for this UserProfile.

       " policy_is_disabled( $policy ) "
	   Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has disabled that policy in their
	   profile.

       " policy_is_enabled( $policy ) "
	   Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has explicitly enabled that policy in
	   their user profile.

       " policy_params( $policy ) "
	   Given a reference to a Perl::Critic::Policy object or the name of one, returns a Perl::Critic::PolicyConfig for the user's
	   configuration parameters for that policy.

       " raw_policy_params( $policy ) "
	   Given a reference to a Perl::Critic::Policy object or the name of one, returns a reference to a hash of the user's configuration
	   parameters for that policy.

       " listed_policies() "
	   Returns a list of the names of all the Policies that are mentioned in the profile.  The Policy names will be fully qualified (e.g.
	   Perl::Critic::Foo).

       " source() "
	   The place where the profile information came from, if available.  Usually the path to a .perlcriticrc.

SEE ALSO

       Perl::Critic::Config, Perl::Critic::OptionsProcessor

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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.

perl v5.16.3							    2014-06-09					      Perl::Critic::UserProfile(3)
Man Page