File Coverage

blib/lib/DMOSS/Plugin/CommentLines.pm

Criterion	Covered	Total	%
statement	15	44	34.0
branch	0	12	0.0
condition	0	3	0.0
subroutine	5	11	45.4
pod	6	6	100.0
total	26	76	34.2

package DMOSS::Plugin::CommentLines;
$DMOSS::Plugin::CommentLines::VERSION = '0.01_2';
# ABSTRACT: DMOSS number of comment lines plugin
use parent qw/DMOSS::Plugin/;
use strict;
use warnings;

use File::Comments;
use File::Slurp qw/read_file/;

our @types = qw/_SOURCE/;

sub name { 'Comment Lines' }

sub process {
  my ($self, $dmoss, $file) = @_;
  my $content = read_file $file->fullpath;

  my $snoop = File::Comments->new;
  my $c = $snoop->comments($file->{fullpath});

  my $res = `wc -l $file->{fullpath}`;
  my $total = 0;
  $total = $1 if ($res =~ m/(\d+)/);
  my $comments = 0;
  $comments = @$c if $c;

  $dmoss->add_attr('comment_lines', {total=>$total, comments=>$comments});
}

sub reduce {
  my ($self, $dmoss, @attrs) = @_;

  my ($total, $comments) = (0, 0);
  foreach my $a (@attrs) {
    $total += $a->value->{total};
    $comments += $a->value->{comments};
  }

  $dmoss->add_attr('comment_lines', {total=>$total, comments=>$comments});
}

sub report {
  my ($self, $dmoss, $attr) = @_;
  return unless ($attr->value and keys %{$attr->value});
  return unless $attr->value->{total};
  my ($comments, $total) = ($attr->value->{comments}, $attr->value->{total});

  my $p = $total ? int($comments/$total*100) : 0;
  return [ $attr->file->path, $comments, $total, "$p%" ];
}

sub report_headers {
  my ($self, $dmoss) = @_;

  return [ '', 'Comment Lines', 'Total Lines', '% Comment Lines' ];
}

sub grade {
  my ($self, $dmoss, $attr) = @_;
  my ($comments, $total) = ($attr->value->{comments}, $attr->value->{total});

  return ($total ? ($comments/$total) : 0);
}

1;

__END__