File Coverage: lib/Code/Statistics/Metric/deviation.pm

# File Coverage

File: | lib/Code/Statistics/Metric/deviation.pm
Coverage: | 100.0%

line | stmt | bran | cond | sub | pod | time | code
--- | --- | --- | --- | --- | --- | --- | ---
1 | 1 1 1 |  |  | 1 |  | 0 0 0 | use strict;
2 | 1 1 1 |  |  | 1 |  | 0 0 0 | use warnings;
3 |
4 |  |  |  |  |  |  | package Code::Statistics::Metric::deviation;
5 |
6 |  |  |  |  |  |  | # ABSTRACT: measures the starting column of a target
7 |
8 | 1 1 1 |  |  | 1 |  | 0 0 0 | use Moose;
9 |  |  |  |  |  |  | extends 'Code::Statistics::Metric';
10 |
11 - 17 |  |
    =head2 incompatible_with
        Returns true if the given target is explicitly not supported by this metric.

        Returns false for this class, since it is never measured and just serves as
        a placeholder for the deviation column, which can be calculated by the
        reporter.
    =cut
18 |
19 |  |  |  |  |  |  | sub incompatible_with {
20 |  |  |  |  |  |  | my ( $class, $target ) = @_;
21 |  |  |  |  |  |  | return 1;
22 |  |  |  |  |  |  | }
23 |
24 - 29 |  |
    =head2 is_insignificant
        Returns true if the metric is considered statistically insignificant.

        Returns false for this class, since it is calculated from other significant
        statistics.
    =cut
30 |
31 |  |  |  |  |  |  | sub is_insignificant {
32 |  |  |  |  |  |  | my ( $class ) = @_;
33 |  |  |  |  |  |  | return 1;
34 |  |  |  |  |  |  | }
35 |
36 - 40 |  |
    =head2 short_name
        Allows a metric to return a short name, which can be used by shell report
        builders for example.
        This metric defines the short name "Dev.".
    =cut
41 |
42 |  |  |  |  |  |  | sub short_name {
43 |  |  |  |  |  |  | my ( $class ) = @_;
44 |  |  |  |  |  |  | return 'Dev.';
45 |  |  |  |  |  |  | }
46 |
47 |  |  |  |  |  |  | 1;