NAME

Perl::Metrics::Lite::Analysis - Contains anaylsis results.

SYNOPSIS

This is the class of objects returned by the analyze_files method of the Perl::Metrics::Lite class.

Normally you would not create objects of this class directly, instead you get them by calling the analyze_files method on a Perl::Metrics::Lite object.

VERSION

This is VERSION 0.01

DESCRIPTION

USAGE

new

  $analysis = Perl::Metrics::Lite::Analsys->new( \@file_objects )

Takes an arrayref of Perl::Metrics::Lite::Analysis::File objects and returns a new Perl::Metrics::Lite::Analysis object.

data

The raw data for the analysis. This is the arrayref you passed as the argument to new();

files

Arrayref of file paths, in the order they were encountered.

lines

Total lines in all files, excluding comments and pod.

main_stats

Returns a hashref of data based the main code in all files, that is, on the code minus all named subroutines.

  {
    lines             => 723,
  }

Returns an arrayref of hashrefs, each entry is for one analyzed file, in the order they were encountered. The main_stats slot in the hashref is for all the code in the file outside of any named subroutines.

   [
      {
        path => '/path/to/file',
        main_stats => {
                        lines             => 23,
                        path              => '/path/to/file',
                        name              => '{code not in named subroutines}',
                       },
        },
        ...
   ]

    {
         'lines' => 19,
         'line_number' => 5,
         'mccabe_complexity' => 6,
         'name' => 'databaseRecords',
         'path' => '../path/to/File.pm',
    }