Permalink
Browse files

first commit

Signed-off-by: Alec Chen <alec@cpan.org>
  • Loading branch information...
0 parents commit fe461ef3f08e4c02733c47e2dc985b4b84f7a36b @alecchen committed Sep 8, 2009
Showing with 296 additions and 0 deletions.
  1. +5 −0 Changes
  2. +8 −0 MANIFEST
  3. +13 −0 Makefile.PL
  4. +55 −0 README
  5. +11 −0 ignore.txt
  6. +110 −0 lib/Term/Pulse.pm
  7. +9 −0 t/00-load.t
  8. +55 −0 t/boilerplate.t
  9. +18 −0 t/pod-coverage.t
  10. +12 −0 t/pod.t
@@ -0,0 +1,5 @@
+Revision history for Term-Pulse
+
+0.01 Date/time
+ First version, released on an unsuspecting world.
+
@@ -0,0 +1,8 @@
+Changes
+MANIFEST
+Makefile.PL
+README
+lib/Term/Pulse.pm
+t/00-load.t
+t/pod-coverage.t
+t/pod.t
@@ -0,0 +1,13 @@
+use inc::Module::Install;
+
+name 'Term-Pulse';
+all_from 'lib/Term/Pulse.pm';
+author q{Alec Chen <alec@cpan.org>};
+license 'perl';
+
+build_requires 'Test::More';
+
+auto_install;
+
+WriteAll;
+
55 README
@@ -0,0 +1,55 @@
+Term-Pulse
+
+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 Term::Pulse
+
+You can also look for information at:
+
+ RT, CPAN's request tracker
+ http://rt.cpan.org/NoAuth/Bugs.html?Dist=Term-Pulse
+
+ AnnoCPAN, Annotated CPAN documentation
+ http://annocpan.org/dist/Term-Pulse
+
+ CPAN Ratings
+ http://cpanratings.perl.org/d/Term-Pulse
+
+ Search CPAN
+ http://search.cpan.org/dist/Term-Pulse/
+
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2009 Alec Chen
+
+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.
+
@@ -0,0 +1,11 @@
+blib*
+Makefile
+Makefile.old
+Build
+_build*
+pm_to_blib*
+*.tar.gz
+.lwpcookies
+Term-Pulse-*
+cover_db
+.git
@@ -0,0 +1,110 @@
+package Term::Pulse;
+
+use warnings;
+use strict;
+
+=head1 NAME
+
+Term::Pulse - The great new Term::Pulse!
+
+=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 Term::Pulse;
+
+ my $foo = Term::Pulse->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
+
+Alec Chen, C<< <alec at cpan.org> >>
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-term-pulse at rt.cpan.org>, or through
+the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Term-Pulse>. 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 Term::Pulse
+
+
+You can also look for information at:
+
+=over 4
+
+=item * RT: CPAN's request tracker
+
+L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Term-Pulse>
+
+=item * AnnoCPAN: Annotated CPAN documentation
+
+L<http://annocpan.org/dist/Term-Pulse>
+
+=item * CPAN Ratings
+
+L<http://cpanratings.perl.org/d/Term-Pulse>
+
+=item * Search CPAN
+
+L<http://search.cpan.org/dist/Term-Pulse/>
+
+=back
+
+
+=head1 ACKNOWLEDGEMENTS
+
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2009 Alec Chen.
+
+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 Term::Pulse
@@ -0,0 +1,9 @@
+#!perl -T
+
+use Test::More tests => 1;
+
+BEGIN {
+ use_ok( 'Term::Pulse' );
+}
+
+diag( "Testing Term::Pulse $Term::Pulse::VERSION, Perl $], $^X" );
@@ -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/Term/Pulse.pm');
+
+
+}
+
@@ -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 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();

0 comments on commit fe461ef

Please sign in to comment.