forked from cowens/autobox-dump
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Chas. Owens
committed
Apr 25, 2009
0 parents
commit 5117e21
Showing
10 changed files
with
293 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
blib* | ||
Makefile | ||
Makefile.old | ||
Build | ||
_build* | ||
pm_to_blib* | ||
*.tar.gz | ||
.lwpcookies | ||
autobox-expr-dump-* | ||
cover_db |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
use strict; | ||
use warnings; | ||
use Module::Build; | ||
|
||
my $builder = Module::Build->new( | ||
module_name => 'autobox::expr::dump', | ||
license => 'perl', | ||
dist_author => 'Chas. J Owens IV <chas.owens@gmail.com>', | ||
dist_version_from => 'lib/autobox/expr/dump.pm', | ||
build_requires => { | ||
'Test::More' => 0, | ||
}, | ||
add_to_cleanup => [ 'autobox-expr-dump-*' ], | ||
create_makefile_pl => 'traditional', | ||
); | ||
|
||
$builder->create_build_script(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Revision history for autobox-expr-dump | ||
|
||
0.01 Date/time | ||
First version, released on an unsuspecting world. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Build.PL | ||
Changes | ||
MANIFEST | ||
README | ||
lib/autobox/expr/dump.pm | ||
t/00-load.t | ||
t/pod-coverage.t | ||
t/pod.t |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
autobox-expr-dump | ||
|
||
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 Build.PL | ||
./Build | ||
./Build test | ||
./Build install | ||
|
||
SUPPORT AND DOCUMENTATION | ||
|
||
After installing, you can find documentation for this module with the | ||
perldoc command. | ||
|
||
perldoc autobox::expr::dump | ||
|
||
You can also look for information at: | ||
|
||
RT, CPAN's request tracker | ||
http://rt.cpan.org/NoAuth/Bugs.html?Dist=autobox-expr-dump | ||
|
||
AnnoCPAN, Annotated CPAN documentation | ||
http://annocpan.org/dist/autobox-expr-dump | ||
|
||
CPAN Ratings | ||
http://cpanratings.perl.org/d/autobox-expr-dump | ||
|
||
Search CPAN | ||
http://search.cpan.org/dist/autobox-expr-dump | ||
|
||
|
||
COPYRIGHT AND LICENCE | ||
|
||
Copyright (C) 2009 Chas. J Owens IV | ||
|
||
This program is free software; you can redistribute it and/or modify it | ||
under the same terms as Perl itself. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
package autobox::expr::dump; | ||
|
||
use warnings; | ||
use strict; | ||
|
||
=head1 NAME | ||
autobox::expr::dump - The great new autobox::expr::dump! | ||
=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 autobox::expr::dump; | ||
my $foo = autobox::expr::dump->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 FUNCTIONS | ||
=head2 function1 | ||
=cut | ||
|
||
sub function1 { | ||
} | ||
|
||
=head2 function2 | ||
=cut | ||
|
||
sub function2 { | ||
} | ||
|
||
=head1 AUTHOR | ||
Chas. J Owens IV, C<< <chas.owens at gmail.com> >> | ||
=head1 BUGS | ||
Please report any bugs or feature requests to C<bug-autobox-expr-dump at rt.cpan.org>, or through | ||
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=autobox-expr-dump>. 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 autobox::expr::dump | ||
You can also look for information at: | ||
=over 4 | ||
=item * RT: CPAN's request tracker | ||
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=autobox-expr-dump> | ||
=item * AnnoCPAN: Annotated CPAN documentation | ||
L<http://annocpan.org/dist/autobox-expr-dump> | ||
=item * CPAN Ratings | ||
L<http://cpanratings.perl.org/d/autobox-expr-dump> | ||
=item * Search CPAN | ||
L<http://search.cpan.org/dist/autobox-expr-dump> | ||
=back | ||
=head1 ACKNOWLEDGEMENTS | ||
=head1 COPYRIGHT & LICENSE | ||
Copyright 2009 Chas. J Owens IV, all rights reserved. | ||
This program is free software; you can redistribute it and/or modify it | ||
under the same terms as Perl itself. | ||
=cut | ||
|
||
1; # End of autobox::expr::dump |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#!perl -T | ||
|
||
use Test::More tests => 1; | ||
|
||
BEGIN { | ||
use_ok( 'autobox::expr::dump' ); | ||
} | ||
|
||
diag( "Testing autobox::expr::dump $autobox::expr::dump::VERSION, Perl $], $^X" ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/autobox/expr/dump.pm'); | ||
|
||
|
||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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(); |