/ 
Perl-Critic-Git-v1.3.1
River stage one • 2 direct dependents • 2 total dependents
/ Perl::Critic::Git

NAME

Perl::Critic::Git - Bond git and Perl::Critic to blame the right people for violations.

VERSION

Version 1.3.1

SYNOPSIS

use Perl::Critic::Git;
my $git_critic = Perl::Critic::Git->new(
	file   => $file,
	level  => $critique_level,         # or undef to use default profile
);

my $violations = $git_critic->report_violations(
	author => $author,
	since  => $date,                   # to critique only recent changes
);

METHODS

new()

Create a new Perl::Critic::Git object.

my $git_critic = Perl::Critic::Git->new(
	file   => $file,
	level  => $critique_level,         # or undef to use default profile
);

Parameters:

  • 'file'

    Mandatory, the path to a file in a Git repository.

  • 'level'

    Optional, to set a PerlCritic level. If it is not specified, the default PerlCritic profile for the system will be used.

    #TODO: List allowed values from PerlCritic.

get_authors()

Return an arrayref of all the authors found in git blame for the file analyzed.

my $authors = $git_critic->get_authors();

report_violations()

Report the violations for a given Git author.

my $violations = $git_critic->report_violations(
	author => $author,
	since  => $date,                   # to critique only recent changes
);

Parameters:

  • author (mandatory)

    The name of the author to search violations for.

  • since (optional)

    A date (format YYYY-MM-DD) for which violations of the PBPs that are older will be ignored. This allows critiquing only recent changes, instead of forcing your author to fix an entire legacy file at once if only one line needs to be modified.

  • use_cache (default: 0)

    Use a cached version of git diff when available. See Git::Repository::Plugin::Blame::Cache for more information.

force_reanalyzing()

Force reanalyzing the file specified by the current object. This is useful if the file has been modified since the Perl::Critic::Git object has been created.

$git_critic->force_reanalyzing();

ACCESSORS

get_perlcritic_violations()

Return an arrayref of all the Perl::Critic::Violation objects found by running Perl::Critic on the file specified by the current object.

my $perlcritic_violations = $git_critic->get_perlcritic_violations();

get_blame_lines()

Return an arrayref of Git::Repository::Plugin::Blame::Line objects corresponding to the lines in the file analyzed.

my $blame_lines = $self->get_blame_lines();

get_blame_line()

Return a Git::Repository::Plugin::Blame::Line object corresponding to the line number passed as parameter.

my $blame_line = $git_critic->get_blame_line( 5 );

INTERNAL METHODS

_analyze_file()

Run "git blame" and "PerlCritic" on the file specified by the current object and caches the results to speed reports later.

$git_critic->_analyze_file();

Arguments:

  • use_cache (default: 0)

    Use a cached version of git diff when available.

_is_analyzed()

Return whether the file specified by the current object has already been analyzed with "git blame" and "PerlCritic".

my $is_analyzed = $git_critic->_is_analyzed();

_get_file()

Return the path to the file to analyze for the current object.

my $file = $git_critic->_get_file();

_get_critique_level()

Return the critique level selected when creating the current object.

my $critique_level = $git_critic->_get_critique_level();

SEE ALSO

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/Perl-Critic-Git/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Perl::Critic::Git

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

ACKNOWLEDGEMENTS

I originally developed this project for ThinkGeek (http://www.thinkgeek.com/). Thanks for allowing me to open-source it!

COPYRIGHT & LICENSE

Copyright 2012-2018 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.