/usr/share/perl5/Test/Perl/Critic/Progressive.pm is in libtest-perl-critic-progressive-perl 0.03-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | ##############################################################################
# $URL: http://perlcritic.tigris.org/svn/perlcritic/tags/Test-Perl-Critic-Progressive-0.03/lib/Test/Perl/Critic/Progressive.pm $
# $Date: 2008-07-27 16:01:56 -0700 (Sun, 27 Jul 2008) $
# $Author: thaljef $
# $Revision: 2620 $
##############################################################################
package Test::Perl::Critic::Progressive;
use 5.006001;
use strict;
use warnings;
use Carp qw(croak confess);
use Data::Dumper qw(Dumper);
use English qw(-no_match_vars);
use File::Spec qw();
use FindBin qw($Bin);
use Perl::Critic qw();
use Perl::Critic::Utils qw(policy_short_name policy_long_name);
use Test::Builder qw();
use base 'Exporter';
#---------------------------------------------------------------------------
our $VERSION = '0.03';
#---------------------------------------------------------------------------
our @EXPORT_OK = qw(
get_critic_args
get_history_file
get_total_step_size
get_step_size_per_policy
progressive_critic_ok
set_critic_args
set_history_file
set_total_step_size
set_step_size_per_policy
);
our %EXPORT_TAGS = ( all => \@EXPORT_OK );
#---------------------------------------------------------------------------
my $TOTAL_STEP_SIZE = undef;
my $DEFAULT_STEP_SIZE = 0;
my %STEP_SIZE_PER_POLICY = ();
my $HISTORY_FILE = undef;
my $DEFAULT_HISTORY_FILE = File::Spec->catfile($Bin, '.perlcritic-history');
my $CRITIC = undef;
my %CRITIC_ARGS = ();
my $TEST = Test::Builder->new();
#---------------------------------------------------------------------------
# Public functions
sub progressive_critic_ok {
my @dirs = @_;
if (not @dirs) {
@dirs = _starting_points();
}
my @files = _all_code_files( @dirs );
croak qq{No perl files found\n} if not @files;
my $caller = caller;
$TEST->exported_to($caller);
$TEST->plan( tests => 1 );
$CRITIC = Perl::Critic->new( get_critic_args() );
my @violations = map { $CRITIC->critique($_) } @files;
my $ok = _evaluate_test( @violations );
$TEST->ok($ok, __PACKAGE__);
return $ok;
}
#---------------------------------------------------------------------------
# Pulbic accessor functions
sub get_history_file {
return defined $HISTORY_FILE ?
$HISTORY_FILE : $DEFAULT_HISTORY_FILE;
}
#---------------------------------------------------------------------------
sub set_history_file {
$HISTORY_FILE = shift;
return 1;
}
#---------------------------------------------------------------------------
sub get_critic_args {
return %CRITIC_ARGS;
}
#---------------------------------------------------------------------------
sub set_critic_args {
%CRITIC_ARGS = @_;
return 1;
}
#---------------------------------------------------------------------------
sub get_total_step_size {
return defined $TOTAL_STEP_SIZE ?
$TOTAL_STEP_SIZE : $DEFAULT_STEP_SIZE;
}
#---------------------------------------------------------------------------
sub set_total_step_size {
$TOTAL_STEP_SIZE = shift;
return 1;
}
#---------------------------------------------------------------------------
sub get_step_size_per_policy {
return %STEP_SIZE_PER_POLICY;
}
#---------------------------------------------------------------------------
sub set_step_size_per_policy {
my %args = @_;
my %step_sizes = ();
for my $policy_name ( keys %args ) {
$step_sizes{policy_long_name($policy_name)} = $args{$policy_name};
}
%STEP_SIZE_PER_POLICY = %step_sizes;
return 1;
}
#---------------------------------------------------------------------------
# Private functions
sub _evaluate_test {
my (@viols) = @_;
my $ok = 1;
my $results = {};
my $history_data = _read_history( get_history_file() );
my $last_critique = $history_data->[-1];
my $has_run_before = defined $last_critique;
my $last_total_violations = 0;
my $current_total_violations = 0;
for my $policy ( $CRITIC->policies() ) {
my $policy_name = ref $policy;
my $policy_violations = grep {$_->policy() eq $policy_name} @viols;
$results->{$policy_name} = $policy_violations;
my $last_policy_violations = $last_critique->{$policy_name};
next if not defined $last_policy_violations;
$last_total_violations += $last_policy_violations;
$current_total_violations += $policy_violations;
my $policy_step_size = defined $STEP_SIZE_PER_POLICY{$policy_name} ?
$STEP_SIZE_PER_POLICY{$policy_name} : $DEFAULT_STEP_SIZE;
my $target = $policy_step_size > $last_policy_violations ?
0 : $last_policy_violations - $policy_step_size;
if ( $policy_violations > $target ) {
my $short_name = policy_short_name($policy_name);
my $diagf = '%s: Got %i violation(s). Expected no more than %i.';
$TEST->diag( sprintf $diagf, $short_name, $policy_violations, $target );
$ok = 0; # Failed the test!
}
}
if ( $has_run_before ) {
my $target = get_total_step_size() > $last_total_violations ?
0 : $last_total_violations - get_total_step_size();
if ( $current_total_violations > $target ) {
my $got = $current_total_violations;
$TEST->diag('Too many Perl::Critic violations...');
$TEST->diag("Got a total of $got. Expected no more than $target.");
$ok = 0;
}
}
if ( !$has_run_before || ($ok && $last_total_violations > 0) ) {
push @{$history_data}, $results;
_write_history_file( get_history_file(), $history_data);
}
return $ok;
}
#---------------------------------------------------------------------------
sub _all_code_files {
my @dirs = @_;
if (not @dirs) {
@dirs = _starting_points();
}
return Perl::Critic::Utils::all_perl_files(@dirs);
}
#---------------------------------------------------------------------------
sub _starting_points {
return -e 'blib' ? 'blib' : grep { -e $_ } qw(lib bin script scripts);
}
#---------------------------------------------------------------------------
sub _read_history {
my ($history_file) = @_;
return [] if not -e $history_file;
my $history_data = eval { do $history_file };
croak qq{Can't read history from "$history_file": $EVAL_ERROR}
if $EVAL_ERROR;
return $history_data;
}
#---------------------------------------------------------------------------
sub _open_history_file {
my ($history_file) = @_;
open my $history_fh, '>', $history_file
or confess qq{Can't open "$history_file": $OS_ERROR};
return $history_fh;
}
#---------------------------------------------------------------------------
sub _write_history_file {
my ($history_file, $history_data) = @_;
my $history_fh = _open_history_file($history_file);
print {$history_fh} Dumper($history_data)
or confess qq{Can't write to "$history_file": $OS_ERROR};
close $history_fh
or confess qq{Can't close "$history_file": $OS_ERROR};
return 1;
}
#---------------------------------------------------------------------------
1;
__END__
=pod
=for stopwords AntHill CruiseControl
=head1 NAME
Test::Perl::Critic::Progressive - Gradually enforce coding standards.
=head1 SYNOPSIS
To test one or more files, and/or all files in one or more directories:
use Test::Perl::Critic::Progressive qw( progressive_critic_ok );
progressive_critic_ok($file1, $file2, $dir1, $dir2);
To test all Perl files in a distribution:
use Test::Perl::Critic::Progressive qw( progressive_critic_ok );
progressive_critic_ok();
Recommended usage for public CPAN distributions:
use strict;
use warnings;
use Test::More;
eval { require Test::Perl::Critic::Progressive };
plan skip_all => 'T::P::C::Progressive required for this test' if $@;
Test::Perl::Critic::Progressive::progressive_critic_ok();
=head1 DESCRIPTION
Applying coding standards to large amounts of legacy code is a daunting task.
Often times, legacy code is so non-compliant that it seems downright
impossible. But, if you consistently chip away at the problem, you will
eventually succeed! Test::Perl::Critic::Progressive uses the L<Perl::Critic>
engine to prevent further deterioration of your code and
B<gradually> steer it towards conforming with your chosen coding standards.
The most effective way to use Test::Perl::Critic::Progressive is as a unit
test that is run under a continuous-integration system like CruiseControl or
AntHill. Each time a developer commits changes to the code, this test will
fail and the build will break unless it has the same (or fewer) Perl::Critic
violations than the last successful test.
See the L<"NOTES"> for more details about how this test works.
=head1 SUBROUTINES
All of the following subroutines can be exported upon request. Or you
can export all of them at once using the C<':all'> tag.
=over
=item C< progressive_critic_ok(@FILES [, @DIRECTORIES ]) >
=item C< progressive_critic_ok() >
Uses Perl::Critic to analyze each of the given @FILES, and/or all Perl files
beneath the given list of C<@DIRECTORIES>. If no arguments are given, it
analyzes all the Perl files in the F<blib/> directory. If the F<blib/>
directory does not exist, then it tries the F<lib/>, F<bin/>, F<script/>, and
F<scripts/> directory. The results of the analysis will be stored as
F<.perlcritic-history> in the same directory where your test script is
located.
The first time you run this test, it will always pass. But on each subsequent
run, the test will pass only if the number of violations found B<is less than
or equal to> the number of violations found during the last passing test. If
it does pass, then the history file will be updated with the new analysis
results. Once all the violations are removed from the code, this test will
always pass, unless a new violation is introduced.
This subroutine emits its own L<Test::More> plan, so you do not need to
specify an expected number of tests yourself.
=item C< get_history_file() >
=item C< set_history_file($FILE) >
These functions get or set the full path to the history file. This is
where Test::Perl::Critic::Progressive will store the results of each passing
analysis. If the C<$FILE> does not exist, it will be created anew. The
default is C<$Bin/.perlcritic-history> where C<$Bin> is the directory that
the calling test script is located in.
=item C< get_total_step_size() >
=item C< set_total_step_size($INTEGER) >
These functions get or set the minimum acceptable decrease in the B<total>
number of violations between each test. The default value is zero, which
means that you are not required to remove any violations, but you are also not
allowed to add any. If you set the step size to a positive number, the test
will require you to remove C<$INTEGER> violations each time the test is run.
In this case, the particular type of violation that you eliminate doesn't
matter. The larger the step size, the faster you'll have to eliminate
violations.
=item C< get_step_size_per_policy() >
=item C< set_step_size_per_policy(%ARGS) >
These functions get or set the minimum acceptable decrease in the number of
violations of a B<specific policy> between each test. The C<%ARGS> should be
C<< $POLICY_NAME => $INTEGER >> pairs, like this:
my %step_sizes = (
'ValuesAndExpressions::ProhibitLeadingZeros' => 2,
'Variables::ProhibitConditionalDeclarations' => 1,
'InputOutput::ProhibitTwoArgOpen' => 3,
);
set_step_size_per_policy( %step_sizes );
progressive_critic_ok();
The default step size for any given Policy is zero, which means that you are
not required to remove any violations, but you are also not allowed to add
any. But if you wish to focus on eliminating certain types of violations,
then increasing the per-policy step size will force you to B<decrease> the
number of violations of that particular Policy, while ignoring other types of
violations. The larger the step size, the faster you'll have to eliminate
violations.
=item C< get_critic_args() >
=item C< set_critic_args(%ARGS) >
These functions get or set the arguments given to L<Perl::Critic>. By
default, Test::Perl::Critic::Progressive invokes Perl::Critic with its default
configuration. But if you have developed your code against a custom
Perl::Critic configuration, you will want to configure this test to do the
same.
Any C<%ARGS> given to C<set_critic_args> will be passed directly into the
L<Perl::Critic> constructor. So if you have developed your code using a
custom F<.perlcriticrc> file, you can direct Test::Perl::Critic::Progressive
to use a custom file too.
use Test::Perl::Critic::Progressive ( ':all' );
set_critic_args(-profile => 't/perlcriticrc);
progressive_critic_ok();
Now place a copy of your own F<.perlcriticrc> file in the distribution as
F<t/perlcriticrc>. Now, C<progressive_critic_ok> will use this same
Perl::Critic configuration. See the L<Perl::Critic> documentation for details
on the F<.perlcriticrc> file format.
Any argument that is supported by the L<Perl::Critic> constructor can be
passed through this interface. For example, you can also set the minimum
severity level, or include & exclude specific policies like this:
use Test::Perl::Critic::Progressive ( ':all' );
set_critic_args( -severity => 2, -exclude => ['MixedCaseVars'] );
progressive_critic_ok();
See the L<Perl::Critic> documentation for complete details on its options and
arguments.
=back
=head1 NOTES
The test is evaluated in two ways. First, the number of violations for each
Policy must be B<less than or equal to> the number of the violations found
during the last passing test, minus the step size B<for that Policy>. Second,
the total number of violations must be B<less than or equal> the total number
of violations found during the last passing test, minus the B<total> step
size. This prevents you from simply substituting one kind of violation for
another.
You can use the total step size and the per-policy step size at the same time.
For example, you can set the total step size to 5, and set the per-policy step
size for the C<TestingAndDebugging::RequireStrictures> Policy to 3. In which
case, you'll have to remove 5 violations between each test, but 3 of them must
be violations of C<TestingAndDebugging::RequireStrictures>.
Over time, you'll probably add new Policies to your L<Perl::Critic> setup.
When Test::Perl::Critic::Progressive uses a Policy for the first time, any
newly discovered violations of that Policy will not be considered in the test.
However, they will be considered in subsequent tests.
If you are building a CPAN distribution, you'll want to add
F<^t/.perlcritic-history$> to the F<MANIFEST.SKIP> file. And if you are using
a revision control system like CVS or Subversion, you'll probably want to
configure it to ignore the F<t/.perlcritic-history> file as well.
=head1 BUGS
If you find any bugs, please submit them to
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Perl-Critic-Progressive>.
Thanks.
=head1 SEE ALSO
L<criticism>
L<Perl::Critic>
L<Test::Perl::Critic>
L<http://www.perlcritic.com>
=head1 AUTHOR
Jeffrey Ryan Thalhammer <thaljef@cpan.org>
=head1 COPYRIGHT
Copyright (c) 2007-2008 Jeffrey Ryan Thalhammer. 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.
=cut
##############################################################################
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 78
# indent-tabs-mode: nil
# c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab :
|