X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FLeaner.pm;h=d11c4e212cbe22f298ea38f2026880160484fed7;hb=521c714591253428d7b6e4361d3718e6fe7fbaf2;hp=1efe7a295183bf1f285b059b82cc57fe635c9b24;hpb=e3217cb5d83d1ae15f1795bef7c885740607689b;p=perl%2Fmodules%2FTest-Leaner.git

diff --git a/lib/Test/Leaner.pm b/lib/Test/Leaner.pm
index 1efe7a2..d11c4e2 100644
--- a/lib/Test/Leaner.pm
+++ b/lib/Test/Leaner.pm
@@ -4,8 +4,53 @@ use 5.006;
 use strict;
 use warnings;
 
+=head1 NAME
+
+Test::Leaner - A slimmer Test::More for when you favor performance over completeness.
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
 our $VERSION = '0.01';
 
+=head1 SYNOPSIS
+
+    use Test::Leaner tests => 10_000;
+    for (1 .. 10_000) {
+     ...
+     is $one, 1, "checking situation $_";
+    }
+
+
+=head1 DESCRIPTION
+
+When profiling some L<Test::More>-based test script that contained about 10 000 unit tests, I realized that 60% of the time was spent in L<Test::Builder> itself, even though every single test actually involved a costly C<eval STRING>.
+
+This module aims to be a partial replacement to L<Test::More> in those situations where you want to run a large number of simple tests.
+Its functions behave the same as their L<Test::More> counterparts, except for the following differences :
+
+=over 4
+
+=item *
+
+Stringification isn't forced on the test operands.
+However, L</ok> honors C<'bool'> overloading, L</is> honors C<'eq'> overloading and L</cmp_ok> honors whichever overloading category corresponds to the specified operator.
+
+=item *
+
+L</pass>, L</fail>, L</ok>, L</is>, L</isnt>, L</like>, L</unlike> and L</cmp_ok> are all guaranteed to return the truth value of the test.
+
+=item *
+
+C<use_ok>, C<require_ok>, C<can_ok>, C<isa_ok>, C<new_ok>, C<subtest>, C<explain>, C<TODO> blocks and C<todo_skip> are not implemented.
+
+=back
+
+=cut
+
 use Exporter ();
 
 BEGIN {
@@ -25,14 +70,7 @@ BEGIN {
  }
 }
 
-my $TAP_STREAM  = *STDOUT;
-my $DIAG_STREAM = *STDERR;
-
-for ($TAP_STREAM, $DIAG_STREAM) {
- my $fh = select $_;
- $|++;
- select $fh;
-}
+my ($TAP_STREAM, $DIAG_STREAM);
 
 my ($plan, $test, $failed, $no_diag, $done_testing);
 
@@ -69,6 +107,14 @@ sub sanitize_comment {
  $_[0] =~ s/\n/\n# /g;
 }
 
+=head1 FUNCTIONS
+
+The following functions from L<Test::More> are implemented and exported by default.
+
+=head2 C<< plan [ tests => $count | 'no_plan' | skip_all => $reason ] >>
+
+=cut
+
 sub plan {
  my ($key, $value) = @_;
 
@@ -164,11 +210,19 @@ sub import {
  goto &Exporter::import;
 }
 
+=head2 C<skip_all $reason>
+
+=cut
+
 sub skip_all {
  @_ = (skip_all => $_[0]);
  goto &plan;
 }
 
+=head2 C<< skip $reason => $count >>
+
+=cut
+
 sub skip {
  my ($reason, $count) = @_;
 
@@ -200,6 +254,10 @@ sub skip {
  last SKIP;
 }
 
+=head2 C<done_testing [ $count ]>
+
+=cut
+
 sub done_testing {
  my ($count) = @_;
 
@@ -227,6 +285,10 @@ sub done_testing {
  return 1;
 }
 
+=head2 C<ok $ok [, $desc ]>
+
+=cut
+
 sub ok ($;$) {
  my ($ok, $desc) = @_;
 
@@ -250,16 +312,28 @@ sub ok ($;$) {
  return $ok;
 }
 
+=head2 C<pass [ $desc ]>
+
+=cut
+
 sub pass (;$) {
  unshift @_, 1;
  goto &ok;
 }
 
+=head2 C<fail [ $desc ]>
+
+=cut
+
 sub fail (;$) {
  unshift @_, 0;
  goto &ok;
 }
 
+=head2 C<is $got, $expected [, $desc ]>
+
+=cut
+
 sub is ($$;$) {
  my ($got, $expected, $desc) = @_;
  no warnings 'uninitialized';
@@ -270,6 +344,10 @@ sub is ($$;$) {
  goto &ok;
 }
 
+=head2 C<isnt $got, $expected [, $desc ]>
+
+=cut
+
 sub isnt ($$;$) {
  my ($got, $expected, $desc) = @_;
  no warnings 'uninitialized';
@@ -332,12 +410,22 @@ IS_BINOP
  }
 }
 
+=head2 C<like $got, $regexp_expected [, $desc ]>
+
+=head2 C<unlike $got, $regexp_expected, [, $desc ]>
+
+=cut
+
 {
  no warnings 'once';
  *like   = _create_binop_handler('=~');
  *unlike = _create_binop_handler('!~');
 }
 
+=head2 C<cmp_ok $got, $op, $expected [, $desc ]>
+
+=cut
+
 sub cmp_ok ($$$;$) {
  my ($got, $op, $expected, $desc) = @_;
  my $handler = $binop_handlers{$op};
@@ -367,16 +455,28 @@ sub _diag_fh {
  return 0;
 };
 
+=head2 C<diag @text>
+
+=cut
+
 sub diag {
  unshift @_, $DIAG_STREAM;
  goto &_diag_fh;
 }
 
+=head2 C<note @text>
+
+=cut
+
 sub note {
  unshift @_, $TAP_STREAM;
  goto &_diag_fh;
 }
 
+=head2 C<BAIL_OUT [ $desc ]>
+
+=cut
+
 sub BAIL_OUT {
  my ($desc) = @_;
 
@@ -411,4 +511,89 @@ END {
  }
 }
 
+=pod
+
+L<Test::Leaner> also provides some functions of its own, which are never exported.
+
+=head2 C<tap_stream [ $fh ]>
+
+Read/write accessor for the filehandle to which the tests are outputted.
+On write, it also turns autoflush on onto C<$fh>.
+
+Note that it can only be used as a write accessor before you start any thread, as L<threads::shared> cannot reliably share filehandles.
+
+Defaults to C<STDOUT>.
+
+=cut
+
+sub tap_stream (;*) {
+ if (@_) {
+  $TAP_STREAM = $_[0];
+
+  my $fh = select $TAP_STREAM;
+  $|++;
+  select $fh;
+ }
+
+ return $TAP_STREAM;
+}
+
+tap_stream *STDOUT;
+
+=head2 C<diag_stream [ $fh ]>
+
+Read/write accessor for the filehandle to which the diagnostics are printed.
+On write, it also turns autoflush on onto C<$fh>.
+
+Just like L</tap_stream>, it can only be used as a write accessor before you start any thread, as L<threads::shared> cannot reliably share filehandles.
+
+Defaults to C<STDERR>.
+
+=cut
+
+sub diag_stream (;*) {
+ if (@_) {
+  $DIAG_STREAM = $_[0];
+
+  my $fh = select $DIAG_STREAM;
+  $|++;
+  select $fh;
+ }
+
+ return $DIAG_STREAM;
+}
+
+diag_stream *STDERR;
+
+=head1 DEPENDENCIES
+
+L<perl> 5.6.
+
+L<Exporter>, L<Test::More>
+
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+You can contact me by mail or on C<irc.perl.org> (vincent).
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-test-leaner at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Leaner>.
+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 Test::Leaner
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2010 Vincent Pit, 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 Test::Leaner