22

✏️ Editing: boilerplate.t

#!perl -T

use 5.006;
use strict;
use warnings;
use Path::Class;
use Test::More;

sub not_in_file_ok {
    my ($filename, %regex) = @_;
    open( my $fh, '<', $filename )
        or die "couldn't open $filename for reading: $!";

my %violated;

while (my $line = <$fh>) {
        while (my ($desc, $regex) = each %regex) {
            if ($line =~ $regex) {
                push @{$violated{$desc}||=[]}, $.;
            }
        }
    }

if (%violated) {
        fail("$filename contains boilerplate text");
        diag "$_ appears on lines @{$violated{$_}}" for keys %violated;
    } else {
        pass("$filename contains no boilerplate text");
    }
}

sub module_boilerplate_ok {
    my ($module) = @_;
    not_in_file_ok($module =>
        'the great new $MODULENAME'   => qr/ - The great new /,
        'boilerplate description'     => qr/Quick summary of what the module/,
        'stub function definition'    => qr/function[12]/,
    );
}

not_in_file_ok('README.md' =>
"The README is used..."       => qr/The README is used/,
"'version information here'"  => qr/to provide version information/,
);

not_in_file_ok(Changes =>
"placeholder date/time"       => qr(Date/time)
);

module_boilerplate_ok(file qw(lib Crypt SSLeay Conn.pm));
module_boilerplate_ok(file qw(lib Crypt SSLeay CTX.pm));
module_boilerplate_ok(file qw(lib Crypt SSLeay Err.pm));
module_boilerplate_ok(file qw(lib Crypt SSLeay MainContext.pm));
module_boilerplate_ok(file qw(lib Crypt SSLeay Version.pm));
module_boilerplate_ok(file qw(lib Crypt SSLeay X509.pm));

module_boilerplate_ok(file qw(lib Net SSL.pm));

done_testing;

MR SKB