diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2017-10-05 17:04:35 +1300 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-10-05 17:04:35 +1300 |
commit | 1cd8d85025254f2069416e05b762e3a4ee63ee5e (patch) | |
tree | 54a689d5461ae5145fe90dbdc9b84039c003867f /xt | |
parent | Remove croncryptsh (diff) | |
download | Mail-Run-Crypt-1cd8d85025254f2069416e05b762e3a4ee63ee5e.tar.gz Mail-Run-Crypt-1cd8d85025254f2069416e05b762e3a4ee63ee5e.zip |
Add Module::Starter boilerplate for perlmodding
Diffstat (limited to 'xt')
-rw-r--r-- | xt/boilerplate.t | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/xt/boilerplate.t b/xt/boilerplate.t new file mode 100644 index 0000000..4a007ec --- /dev/null +++ b/xt/boilerplate.t @@ -0,0 +1,57 @@ +#!perl -T +use 5.006; +use strict; +use warnings; +use Test::More; + +plan tests => 3; + +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 => + "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/Mail/Cron/Crypt.pm'); + + +} + |