Permalink
Browse files

documentation updates.

  • Loading branch information...
gugod committed May 1, 2009
1 parent aea6bdd commit 38196a934238c01ce91577535d5083be8e22f7fc
Showing with 98 additions and 31 deletions.
  1. +3 −0 Changes
  2. +1 −1 Makefile.PL
  3. +71 −0 bin/autoprove
  4. +23 −30 lib/Test/Continuous.pm
View
@@ -1,5 +1,8 @@
Revision history for Test-Continuously
+0.64:
+- now ship with an "autoprove" program as the runner.
+
0.63:
- refactor of previous release such that it does not
require an TAP Archive class to work.
View
@@ -30,7 +30,7 @@ features(
tests 't/*.t';
author_tests 'xt/*.t';
-auto_install;
+install_script 'bin/autoprove';
WriteAll;
View
@@ -0,0 +1,71 @@
+#!/usr/bin/env perl
+
+use Test::Continuous;
+
+Test::Continuous::runtests;
+
+__END__
+
+=head1 NAME
+
+autoprove - automatically prove your application with tests
+
+=head1 SYNOPSIS
+
+Simply run this command and leave it in the foreground:
+
+ $ autoprove
+
+You may add a few 'prove' options:
+
+ $ autoprove --shuffle --fork
+
+And/or specify only the test programs that you want to run automatically:
+
+ $ autoprove t/mytest.t t/another.t
+
+=head1 DESCRIPTION
+
+This program is a CLI front-end to the module L<Test::Continuous>. It is basically
+equivalent of running:
+
+ perl -MTest::Continuous -e runtests
+
+But simpler.
+
+=head1 AUTHOR
+
+Kang-min Liu C<< <gugod@gugod.org> >>
+
+=head1 LICENCE AND COPYRIGHT
+
+Copyright (c) 2008,2009 Kang-min Liu C<< <gugod@gugod.org> >>.
+
+This module is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself. See L<perlartistic>.
+
+=head1 DISCLAIMER OF WARRANTY
+
+BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
+EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
+ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
+YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
+NECESSARY SERVICING, REPAIR, OR CORRECTION.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
+LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
+OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
+THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+=cut
+
View
@@ -5,8 +5,8 @@ package Test::Continuous;
use 5.008;
-our $VERSION = '0.63';
-
+our $VERSION = '0.64';
+
use Exporter::Lite;
use App::Prove;
use File::Find;
@@ -123,18 +123,18 @@ Test::Continuous - Run your tests suite continusouly when developing.
=head1 VERSION
-This document describes Test::Continuous version 0.63
+This document describes Test::Continuous version 0.64
=head1 SYNOPSIS
Very simple usage:
% cd MyModule/
- % perl -MTest::Continuous -e runtests
+ % autoprove
If you want to provide prove arguments:
- % perl -MTest::Continuous -e runtests -- --shuffle
+ % autoprove --shuffle
=head1 DESCRIPTION
@@ -153,18 +153,22 @@ the same concept of implementation in Ruby's world.
=item runtests
-This is the only function that you should be calling, directly
-from command line:
+This function starts monitoring the mtime of all files under current
+working directy. If there's any update, it'll run your module test
+under t/ directory with L<App::Prove>.
+
+You could call it from command line like this:
perl -MTest::Continuous -e runtests
-It'll start monitoring the mtime of all files under current working
-directy. If there's any update, it'll run your module test under t/
-directory with L<App::Prove>.
+However, it's recommended to use L<autoprove> program shipped with
+this distribution to do this instead.
-Test result are displayed on terminal. Also dispatched to Growl if
-C<Log::Dispatch::MacGrowl> is installed. Big plus for perl programmers
-on Mac.
+Test results are displayed on terminal. If
+L<Log::Dispatch::DesktopNotification> is installed, test results will
+also be notified through that channel. If running on Mac, it'll be
+Growl, if it's on Linux desktop, it's done with
+L<Log::Dispatch::Gtk2::Notify>.
C<Test::Continuous> will auto detect the subset of tests to run.
For example, say you have two test files C<feature-foo.t> and
@@ -176,42 +180,31 @@ is modified.
If a C<.t> file is modified, only that test file will be ran.
-Dynamic module dependency is more difficult to detect and needs
-further research.
-
=back
=head1 CONFIGURATION AND ENVIRONMENT
Test::Continuous requires no configuration files or environment variables.
+Although it's based on L<App::Prove>, your C<.proverc> is not loaded.
+
=head1 DEPENDENCIES
-L<App::Prove>, L<Log::Dispatch>, L<Log::Dispatch::MacGrowl>,
+L<App::Prove>, L<Log::Dispatch>, L<Log::Dispatch::DesktopNotification>,
L<Module::ExtractUse>
=head1 INCOMPATIBILITIES
-None reported.
+It might not be compatible with all Test::Harness::* classes. Testing with
+remote harness classes are bascially working, but has some glitches. Helps are
+appreciated.
=head1 BUGS AND LIMITATIONS
-No bugs have been reported.
-
Please report any bugs or feature requests to
C<bug-test-continuous@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.
-=head1 TODO
-
-=over
-
-=item A good name for executable.
-
-=item Accept a per-module config file to tweak different parameters to prove command.
-
-=back
-
=head1 AUTHOR
Kang-min Liu C<< <gugod@gugod.org> >>

0 comments on commit 38196a9

Please sign in to comment.