view release on metacpan or  search on metacpan

t/boilerplate.t  view on Meta::CPAN

#!/usr/bin/perl

use strict;
use warnings;
use Test::More;
use Test::Warnings;

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} ||= [] }, $.;
            }
        }
    }

    for my $test ( keys %regex ) {
        ok !$violated{$test}, $test
            or diag "$test appears on lines @{$violated{$_}}";
    }
}

sub module_boilerplate_ok {
    my ($module) = @_;
    subtest $module => sub {
        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]/,
            'module description'       => qr/One-line description of module/,
            'description'    => qr/A full description of the module/,
            'subs / methods' => qr/section listing the public components/,
            'diagnostics'    => qr/A list of every error and warning message/,
            'config and environment' =>
                qr/A full explanation of any configuration/,
            'dependencies' =>
                qr/A list of all of the other modules that this module relies upon/,
            'incompatible' => qr/any modules that this module cannot be used/,
            'bugs and limitations' => qr/A list of known problems/,
            'contact details'      => qr/<contact address>/,
        );
    };
}

subtest 'README' => sub {
    not_in_file_ok(
        ( -f 'README' ? 'README' : 'README.pod' ) =>
            "The README is used..." => qr/The README is used/,
        "'version information here'" => qr/to provide version information/,
    );
};

subtest 'Changes' => sub {
    not_in_file_ok( Changes => "placeholder date/time" => qr(Date/time) );
};

module_boilerplate_ok('bin/git-amend');
module_boilerplate_ok('bin/git-branch-age');
module_boilerplate_ok('bin/git-branch-clean');
module_boilerplate_ok('bin/git-branch-grep');
module_boilerplate_ok('bin/git-branches');
module_boilerplate_ok('bin/git-brs');
module_boilerplate_ok('bin/git-changes');
module_boilerplate_ok('bin/git-committers');
module_boilerplate_ok('bin/git-cows');
module_boilerplate_ok('bin/git-feature');
module_boilerplate_ok('bin/git-files');
module_boilerplate_ok('bin/git-hook-setup');
module_boilerplate_ok('bin/git-jira');
module_boilerplate_ok('bin/git-memo');
module_boilerplate_ok('bin/git-package');
module_boilerplate_ok('bin/git-pom');
module_boilerplate_ok('bin/git-popb');
module_boilerplate_ok('bin/git-pushb');
module_boilerplate_ok('bin/git-recent');
module_boilerplate_ok('bin/git-remote-delete');
module_boilerplate_ok('bin/git-reset-to');
module_boilerplate_ok('bin/git-search');
module_boilerplate_ok('bin/git-tag-grep');
module_boilerplate_ok('bin/git-touch');
module_boilerplate_ok('bin/git-up-to-date');
module_boilerplate_ok('bin/git-watch');
module_boilerplate_ok('lib/App/Git/Workflow.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Brs.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Amend.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/BranchAge.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/BranchClean.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/BranchGrep.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Branches.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Brs.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Changes.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Committers.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Cows.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Feature.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Files.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Jira.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Memo.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Pom.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Popb.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Pushb.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Recent.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/RemoteDelete.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/ResetTo.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Search.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/TagGrep.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Touch.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/UpToDate.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Command/Watch.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Pom.pm');
module_boilerplate_ok('lib/App/Git/Workflow/Repository.pm');
module_boilerplate_ok('lib/Mock/App/Git/Workflow/Repository.pm');
module_boilerplate_ok('lib/Test/Git/Workflow/Command.pm');
done_testing;