summaryrefslogtreecommitdiff
path: root/xt/boilerplate.t
diff options
context:
space:
mode:
authorjake <jake@jakes-mail.top>2022-09-03 17:13:08 -0400
committerjake <jake@jakes-mail.top>2022-09-03 17:13:08 -0400
commit934fd7f7c56cb22173d32dcd7ffb1389cddd2011 (patch)
treee32f575f86e0dce69bfc4c02993ba64fe68c2a44 /xt/boilerplate.t
initial commitHEADmaster
Diffstat (limited to 'xt/boilerplate.t')
-rw-r--r--xt/boilerplate.t57
1 files changed, 57 insertions, 0 deletions
diff --git a/xt/boilerplate.t b/xt/boilerplate.t
new file mode 100644
index 0000000..4ff3f03
--- /dev/null
+++ b/xt/boilerplate.t
@@ -0,0 +1,57 @@
+#!perl
+use 5.010;
+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/webx_type.pm');
+
+
+}
+