Skip to content

Commit

Permalink
First commit, built with Module::Starter
Browse files Browse the repository at this point in the history
  • Loading branch information
pdl committed Jan 10, 2012
0 parents commit 95de5f7
Show file tree
Hide file tree
Showing 11 changed files with 320 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Revision history for Parse-Zezenen-RecDescent-0.01

0.01 Date/time
First version, released on an unsuspecting world.

9 changes: 9 additions & 0 deletions MANIFEST
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Changes
lib/Parse/Zezenen/RecDescent.pm
Makefile.PL
MANIFEST This list of files
README
t/00-load.t
t/manifest.t
t/pod-coverage.t
t/pod.t
20 changes: 20 additions & 0 deletions Makefile.PL
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
use 5.006;
use strict;
use warnings;
use ExtUtils::MakeMaker;

WriteMakefile(
NAME => 'Parse::Zezenen::RecDescent',
AUTHOR => q{Daniel Perrett <perrettdl@googlemail.com>},
VERSION_FROM => 'lib/Parse/Zezenen/RecDescent.pm',
ABSTRACT_FROM => 'lib/Parse/Zezenen/RecDescent.pm',
($ExtUtils::MakeMaker::VERSION >= 6.3002
? ('LICENSE'=> 'perl')
: ()),
PL_FILES => {},
PREREQ_PM => {
'Test::More' => 0,
},
dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
clean => { FILES => 'Parse-Zezenen-RecDescent-0.01-*' },
);
55 changes: 55 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Parse-Zezenen-RecDescent-0.01

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 Parse::Zezenen::RecDescent

You can also look for information at:

RT, CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Parse-Zezenen-RecDescent-0.01

AnnoCPAN, Annotated CPAN documentation
http://annocpan.org/dist/Parse-Zezenen-RecDescent-0.01

CPAN Ratings
http://cpanratings.perl.org/d/Parse-Zezenen-RecDescent-0.01

Search CPAN
http://search.cpan.org/dist/Parse-Zezenen-RecDescent-0.01/


LICENSE AND COPYRIGHT

Copyright (C) 2012 Daniel Perrett

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

12 changes: 12 additions & 0 deletions ignore.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
blib*
Makefile
Makefile.old
Build
Build.bat
_build*
pm_to_blib*
*.tar.gz
.lwpcookies
cover_db
pod2htm*.tmp
Parse-Zezenen-RecDescent-0.01-*
111 changes: 111 additions & 0 deletions lib/Parse/Zezenen/RecDescent.pm
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
package Parse::Zezenen::RecDescent;

use 5.006;
use strict;
use warnings;

=head1 NAME
Parse::Zezenen::RecDescent - The great new Parse::Zezenen::RecDescent!
=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 Parse::Zezenen::RecDescent;
my $foo = Parse::Zezenen::RecDescent->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
Daniel Perrett, C<< <perrettdl at googlemail.com> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-parse-zezenen-recdescent-0.01 at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-Zezenen-RecDescent-0.01>. 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 Parse::Zezenen::RecDescent
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Parse-Zezenen-RecDescent-0.01>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Parse-Zezenen-RecDescent-0.01>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Parse-Zezenen-RecDescent-0.01>
=item * Search CPAN
L<http://search.cpan.org/dist/Parse-Zezenen-RecDescent-0.01/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2012 Daniel Perrett.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut

1; # End of Parse::Zezenen::RecDescent
9 changes: 9 additions & 0 deletions t/00-load.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!perl -T

use Test::More tests => 1;

BEGIN {
use_ok( 'Parse::Zezenen::RecDescent' ) || print "Bail out!\n";
}

diag( "Testing Parse::Zezenen::RecDescent $Parse::Zezenen::RecDescent::VERSION, Perl $], $^X" );
56 changes: 56 additions & 0 deletions t/boilerplate.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#!perl -T

use 5.006;
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/Parse/Zezenen/RecDescent.pm');


}

13 changes: 13 additions & 0 deletions t/manifest.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!perl -T

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

unless ( $ENV{RELEASE_TESTING} ) {
plan( skip_all => "Author tests not required for installation" );
}

eval "use Test::CheckManifest 0.9";
plan skip_all => "Test::CheckManifest 0.9 required" if $@;
ok_manifest();
18 changes: 18 additions & 0 deletions t/pod-coverage.t
Original file line number Diff line number Diff line change
@@ -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();
12 changes: 12 additions & 0 deletions t/pod.t
Original file line number Diff line number Diff line change
@@ -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();

0 comments on commit 95de5f7

Please sign in to comment.