CMS/t/boilerplate.t

#!perl -T
# vi: set tabstop=4 expandtab shiftwidth=4:

use strict;
use warnings;

use Test::More tests => 11;

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]/,
    );
}

TODO: {
    #local $TODO = "Need to replace the boilerplate text";

    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('lib/CMS.pm');
    module_boilerplate_ok('lib/CMS/Config.pm');
    module_boilerplate_ok('lib/CMS/Daemon.pm');
    module_boilerplate_ok('lib/CMS/FCGI.pm');
    module_boilerplate_ok('lib/CMS/FileHelper.pm');
    module_boilerplate_ok('lib/CMS/Handler.pm');
    module_boilerplate_ok('lib/CMS/Session.pm');
    module_boilerplate_ok('lib/CMS/Sitemap.pm');
    module_boilerplate_ok('lib/CMS/Trace.pm');
}