adding basic module structure

git-svn-id: svn://svn.open-ils.org/OpenSRF/branches/sboyette@1392 9efc2488-bf62-4759-914b-345cdb29e865

diff --git a/src/perl/Changes b/src/perl/Changes
new file mode 100644 (file)
index 0000000..da86cc4
--- /dev/null
+++ b/src/perl/Changes
@@ -0,0 +1,5 @@
+Revision history for OpenSRF
+
+0.01    Date/time
+        First version, released on an unsuspecting world.
+

diff --git a/src/perl/MANIFEST b/src/perl/MANIFEST
new file mode 100644 (file)
index 0000000..19c0e9d
--- /dev/null
+++ b/src/perl/MANIFEST
@@ -0,0 +1,8 @@
+Changes
+MANIFEST
+Makefile.PL
+README
+lib/OpenSRF.pm
+t/00-load.t
+t/pod-coverage.t
+t/pod.t

diff --git a/src/perl/Makefile.PL b/src/perl/Makefile.PL
new file mode 100644 (file)
index 0000000..9f20cc2
--- /dev/null
+++ b/src/perl/Makefile.PL
@@ -0,0 +1,16 @@
+use strict;
+use warnings;
+use ExtUtils::MakeMaker;
+
+WriteMakefile(
+    NAME                => 'OpenSRF',
+    AUTHOR              => 'Equinox <foo@esilibrary.com>',
+    VERSION_FROM        => 'lib/OpenSRF.pm',
+    ABSTRACT_FROM       => 'lib/OpenSRF.pm',
+    PL_FILES            => {},
+    PREREQ_PM => {
+        'Test::More' => 0,
+    },
+    dist                => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
+    clean               => { FILES => 'OpenSRF-*' },
+);

diff --git a/src/perl/README b/src/perl/README
new file mode 100644 (file)
index 0000000..d1d3c7e
--- /dev/null
+++ b/src/perl/README
@@ -0,0 +1,52 @@
+OpenSRF
+
+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 OpenSRF
+
+You can also look for information at:
+
+    RT, CPAN's request tracker
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=OpenSRF
+
+    AnnoCPAN, Annotated CPAN documentation
+        http://annocpan.org/dist/OpenSRF
+
+    CPAN Ratings
+        http://cpanratings.perl.org/d/OpenSRF
+
+    Search CPAN
+        http://search.cpan.org/dist/OpenSRF
+
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2008 Equinox
+
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+

diff --git a/src/perl/t/00-load.t b/src/perl/t/00-load.t
new file mode 100644 (file)
index 0000000..c30401f
--- /dev/null
+++ b/src/perl/t/00-load.t
@@ -0,0 +1,9 @@
+#!perl -T
+
+use Test::More tests => 1;
+
+BEGIN {
+       use_ok( 'OpenSRF' );
+}
+
+diag( "Testing OpenSRF $OpenSRF::VERSION, Perl $], $^X" );

diff --git a/src/perl/t/boilerplate.t b/src/perl/t/boilerplate.t
new file mode 100644 (file)
index 0000000..da749c7
--- /dev/null
+++ b/src/perl/t/boilerplate.t
@@ -0,0 +1,55 @@
+#!perl -T
+
+use strict;
+use warnings;
+use Test::More 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/OpenSRF.pm');
+
+
+}
+

diff --git a/src/perl/t/pod-coverage.t b/src/perl/t/pod-coverage.t
new file mode 100644 (file)
index 0000000..fc40a57
--- /dev/null
+++ b/src/perl/t/pod-coverage.t
@@ -0,0 +1,18 @@
+use strict;
+use warnings;
+use Test::More;
+
+# 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/src/perl/t/pod.t b/src/perl/t/pod.t
new file mode 100644 (file)
index 0000000..ee8b18a
--- /dev/null
+++ b/src/perl/t/pod.t
@@ -0,0 +1,12 @@
+#!perl -T
+
+use strict;
+use warnings;
+use Test::More;
+
+# 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();