[Bps-public-commit] app-wsgetmail branch, master, created. 665f34d79f5f102f73e5230d83bb0f5813005f8a
Aaron Trevena
ast at bestpractical.com
Wed May 20 07:34:28 EDT 2020
The branch, master has been created
at 665f34d79f5f102f73e5230d83bb0f5813005f8a (commit)
- Log -----------------------------------------------------------------
commit 665f34d79f5f102f73e5230d83bb0f5813005f8a
Author: Aaron Trevena <aaron at aarontrevena.co.uk>
Date: Wed May 20 12:34:11 2020 +0100
initial skeleton
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..300ae96
--- /dev/null
+++ b/Changes
@@ -0,0 +1,5 @@
+Revision history for App-wsgetmail
+
+0.01 Date/time
+ First version, released on an unsuspecting world.
+
diff --git a/MANIFEST b/MANIFEST
new file mode 100644
index 0000000..705c14a
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,9 @@
+Changes
+lib/App/wsgetmail.pm
+Makefile.PL
+MANIFEST This list of files
+README
+t/00-load.t
+t/manifest.t
+t/pod-coverage.t
+t/pod.t
diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644
index 0000000..7f38018
--- /dev/null
+++ b/Makefile.PL
@@ -0,0 +1,45 @@
+use 5.006;
+use strict;
+use warnings;
+use ExtUtils::MakeMaker;
+
+my %WriteMakefileArgs = (
+ NAME => 'App::wsgetmail',
+ AUTHOR => q{Aaron Trevena <ast at bestpractical.com>},
+ VERSION_FROM => 'lib/App/wsgetmail.pm',
+ ABSTRACT_FROM => 'lib/App/wsgetmail.pm',
+ LICENSE => 'artistic_2',
+ MIN_PERL_VERSION => '5.006',
+ CONFIGURE_REQUIRES => {
+ 'ExtUtils::MakeMaker' => '0',
+ },
+ TEST_REQUIRES => {
+ 'Test::More' => '0',
+ },
+ PREREQ_PM => {
+ #'ABC' => '1.6',
+ #'Foo::Bar::Module' => '5.0401',
+ },
+ dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
+ clean => { FILES => 'App-wsgetmail-*' },
+);
+
+# Compatibility with old versions of ExtUtils::MakeMaker
+unless (eval { ExtUtils::MakeMaker->VERSION('6.64'); 1 }) {
+ my $test_requires = delete $WriteMakefileArgs{TEST_REQUIRES} || {};
+ @{$WriteMakefileArgs{PREREQ_PM}}{keys %$test_requires} = values %$test_requires;
+}
+
+unless (eval { ExtUtils::MakeMaker->VERSION('6.55_03'); 1 }) {
+ my $build_requires = delete $WriteMakefileArgs{BUILD_REQUIRES} || {};
+ @{$WriteMakefileArgs{PREREQ_PM}}{keys %$build_requires} = values %$build_requires;
+}
+
+delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
+ unless eval { ExtUtils::MakeMaker->VERSION('6.52'); 1 };
+delete $WriteMakefileArgs{MIN_PERL_VERSION}
+ unless eval { ExtUtils::MakeMaker->VERSION('6.48'); 1 };
+delete $WriteMakefileArgs{LICENSE}
+ unless eval { ExtUtils::MakeMaker->VERSION('6.31'); 1 };
+
+WriteMakefile(%WriteMakefileArgs);
diff --git a/README b/README
new file mode 100644
index 0000000..38cb7ec
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+App-wsgetmail
+
+The README is used to introduce the module and provide instructions on
+how to install the module, any machine dependencies it may have (for
+example C compilers and installed libraries) and any other information
+that should be provided before the module is installed.
+
+A README file is required for CPAN modules since CPAN extracts the README
+file from a module distribution so that people browsing the archive
+can use it to get an idea of the module's uses. It is usually a good idea
+to provide version information here so that people can decide whether
+fixes for the module are worth downloading.
+
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+ perldoc App::wsgetmail
+
+You can also look for information at:
+
+ RT, CPAN's request tracker (report bugs here)
+ https://rt.cpan.org/NoAuth/Bugs.html?Dist=App-wsgetmail
+
+ AnnoCPAN, Annotated CPAN documentation
+ http://annocpan.org/dist/App-wsgetmail
+
+ CPAN Ratings
+ https://cpanratings.perl.org/d/App-wsgetmail
+
+ Search CPAN
+ https://metacpan.org/release/App-wsgetmail
+
+
+LICENSE AND COPYRIGHT
+
+This software is Copyright (c) 2020 by Aaron Trevena.
+
+This is free software, licensed under:
+
+ The Artistic License 2.0 (GPL Compatible)
+
diff --git a/ignore.txt b/ignore.txt
new file mode 100644
index 0000000..91d3464
--- /dev/null
+++ b/ignore.txt
@@ -0,0 +1,18 @@
+Makefile
+Makefile.old
+Build
+Build.bat
+META.*
+MYMETA.*
+.build/
+_build/
+cover_db/
+blib/
+inc/
+.lwpcookies
+.last_cover_stats
+nytprof.out
+pod2htm*.tmp
+pm_to_blib
+App-wsgetmail-*
+App-wsgetmail-*.tar.gz
diff --git a/lib/App/wsgetmail.pm b/lib/App/wsgetmail.pm
new file mode 100644
index 0000000..c9dc090
--- /dev/null
+++ b/lib/App/wsgetmail.pm
@@ -0,0 +1,109 @@
+package App::wsgetmail;
+
+use 5.006;
+use strict;
+use warnings;
+
+=head1 NAME
+
+App::wsgetmail - The great new App::wsgetmail!
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
+our $VERSION = '0.01';
+
+
+=head1 SYNOPSIS
+
+Quick summary of what the module does.
+
+Perhaps a little code snippet.
+
+ use App::wsgetmail;
+
+ my $foo = App::wsgetmail->new();
+ ...
+
+=head1 EXPORT
+
+A list of functions that can be exported. You can delete this section
+if you don't export anything, such as for a purely object-oriented module.
+
+=head1 SUBROUTINES/METHODS
+
+=head2 function1
+
+=cut
+
+sub function1 {
+}
+
+=head2 function2
+
+=cut
+
+sub function2 {
+}
+
+=head1 AUTHOR
+
+Aaron Trevena, C<< <ast at bestpractical.com> >>
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-app-wsgetmail at rt.cpan.org>, or through
+the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-wsgetmail>. I will be notified, and then you'll
+automatically be notified of progress on your bug as I make changes.
+
+
+
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+ perldoc App::wsgetmail
+
+
+You can also look for information at:
+
+=over 4
+
+=item * RT: CPAN's request tracker (report bugs here)
+
+L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=App-wsgetmail>
+
+=item * AnnoCPAN: Annotated CPAN documentation
+
+L<http://annocpan.org/dist/App-wsgetmail>
+
+=item * CPAN Ratings
+
+L<https://cpanratings.perl.org/d/App-wsgetmail>
+
+=item * Search CPAN
+
+L<https://metacpan.org/release/App-wsgetmail>
+
+=back
+
+
+=head1 ACKNOWLEDGEMENTS
+
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is Copyright (c) 2020 by Aaron Trevena.
+
+This is free software, licensed under:
+
+ The Artistic License 2.0 (GPL Compatible)
+
+
+=cut
+
+1; # End of App::wsgetmail
diff --git a/t/00-load.t b/t/00-load.t
new file mode 100644
index 0000000..f17a642
--- /dev/null
+++ b/t/00-load.t
@@ -0,0 +1,13 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+plan tests => 1;
+
+BEGIN {
+ use_ok( 'App::wsgetmail' ) || print "Bail out!\n";
+}
+
+diag( "Testing App::wsgetmail $App::wsgetmail::VERSION, Perl $], $^X" );
diff --git a/t/manifest.t b/t/manifest.t
new file mode 100644
index 0000000..e0b558e
--- /dev/null
+++ b/t/manifest.t
@@ -0,0 +1,15 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+ plan( skip_all => "Author tests not required for installation" );
+}
+
+my $min_tcm = 0.9;
+eval "use Test::CheckManifest $min_tcm";
+plan skip_all => "Test::CheckManifest $min_tcm required" if $@;
+
+ok_manifest();
diff --git a/t/pod-coverage.t b/t/pod-coverage.t
new file mode 100644
index 0000000..f5728a5
--- /dev/null
+++ b/t/pod-coverage.t
@@ -0,0 +1,24 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+ plan( skip_all => "Author tests not required for installation" );
+}
+
+# Ensure a recent version of Test::Pod::Coverage
+my $min_tpc = 1.08;
+eval "use Test::Pod::Coverage $min_tpc";
+plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
+ if $@;
+
+# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version,
+# but older versions don't recognize some common documentation styles
+my $min_pc = 0.18;
+eval "use Pod::Coverage $min_pc";
+plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
+ if $@;
+
+all_pod_coverage_ok();
diff --git a/t/pod.t b/t/pod.t
new file mode 100644
index 0000000..4d3a0ce
--- /dev/null
+++ b/t/pod.t
@@ -0,0 +1,16 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+ plan( skip_all => "Author tests not required for installation" );
+}
+
+# Ensure a recent version of Test::Pod
+my $min_tp = 1.22;
+eval "use Test::Pod $min_tp";
+plan skip_all => "Test::Pod $min_tp required for testing POD" if $@;
+
+all_pod_files_ok();
diff --git a/xt/boilerplate.t b/xt/boilerplate.t
new file mode 100644
index 0000000..5040b18
--- /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/App/wsgetmail.pm');
+
+
+}
+
-----------------------------------------------------------------------
More information about the Bps-public-commit
mailing list