X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FLeaner.pm;h=7fe001a248b394eec4daa55d02b9fdbe95432190;hb=718844cc10b90e9ae4acc24a82539ea99c8a4cbb;hp=336bf31c3d56ca17a9712de6074b411adfc490a1;hpb=04fdbaf85a26eafd9d5d1e15c3ee46ef360de509;p=perl%2Fmodules%2FTest-Leaner.git

diff --git a/lib/Test/Leaner.pm b/lib/Test/Leaner.pm
index 336bf31..7fe001a 100644
--- a/lib/Test/Leaner.pm
+++ b/lib/Test/Leaner.pm
@@ -4,8 +4,58 @@ 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 *
+
+L</cmp_ok> throws an exception if the given operator isn't a valid Perl binary operator (except C<'='> and variants).
+It also tests in scalar context, so C<'..'> will be treated as the flip-flop operator and not the range operator.
+
+=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,8 +75,7 @@ BEGIN {
  }
 }
 
-my $TAP_STREAM  = *STDOUT;
-my $DIAG_STREAM = *STDERR;
+my ($TAP_STREAM, $DIAG_STREAM);
 
 my ($plan, $test, $failed, $no_diag, $done_testing);
 
@@ -57,12 +106,20 @@ sub croak {
  die @_, " at $file line $line.\n";
 }
 
-sub sanitize_comment {
+sub _sanitize_comment {
  $_[0] =~ s/\n+\z//;
  $_[0] =~ s/#/\\#/g;
  $_[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) = @_;
 
@@ -88,7 +145,7 @@ sub plan {
   $plan       = SKIP_ALL;
   $plan_str   = '1..0 # SKIP';
   if (defined $value) {
-   sanitize_comment($value);
+   _sanitize_comment($value);
    $plan_str .= " $value" if length $value;
   }
  } else {
@@ -96,12 +153,6 @@ sub plan {
   croak("plan() doesn't understand @args");
  }
 
- {
-  my $fh = select $TAP_STREAM;
-  $|++;
-  select $fh;
- }
-
  if (defined $plan_str) {
   local $\;
   print $TAP_STREAM "$plan_str\n";
@@ -114,7 +165,6 @@ sub plan {
 
 our @EXPORT = qw<
  plan
- skip_all
  skip
  done_testing
  pass
@@ -143,6 +193,7 @@ sub import {
     push @imports, @{ $_[$i+1] };
     $splice  = 2;
    } elsif ($item eq 'no_diag') {
+    lock $plan if THREADSAFE;
     $no_diag = 1;
     $splice  = 1;
    }
@@ -163,10 +214,9 @@ sub import {
  goto &Exporter::import;
 }
 
-sub skip_all {
- @_ = (skip_all => $_[0]);
- goto &plan;
-}
+=head2 C<< skip $reason => $count >>
+
+=cut
 
 sub skip {
  my ($reason, $count) = @_;
@@ -187,7 +237,7 @@ sub skip {
 
   my $skip_str = "ok $test # skip";
   if (defined $reason) {
-   sanitize_comment($reason);
+   _sanitize_comment($reason);
    $skip_str  .= " $reason" if length $reason;
   }
 
@@ -199,6 +249,10 @@ sub skip {
  last SKIP;
 }
 
+=head2 C<done_testing [ $count ]>
+
+=cut
+
 sub done_testing {
  my ($count) = @_;
 
@@ -226,6 +280,10 @@ sub done_testing {
  return 1;
 }
 
+=head2 C<ok $ok [, $desc ]>
+
+=cut
+
 sub ok ($;$) {
  my ($ok, $desc) = @_;
 
@@ -239,7 +297,7 @@ sub ok ($;$) {
   ++$failed;
  }
  if (defined $desc) {
-  sanitize_comment($desc);
+  _sanitize_comment($desc);
   $test_str .= " - $desc" if length $desc;
  }
 
@@ -249,16 +307,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';
@@ -269,6 +339,10 @@ sub is ($$;$) {
  goto &ok;
 }
 
+=head2 C<isnt $got, $expected [, $desc ]>
+
+=cut
+
 sub isnt ($$;$) {
  my ($got, $expected, $desc) = @_;
  no warnings 'uninitialized';
@@ -281,12 +355,17 @@ sub isnt ($$;$) {
 
 my %binops = (
  'or'  => 'or',
- 'and' => 'and',
  'xor' => 'xor',
+ 'and' => 'and',
 
  '||'  => 'hor',
+ ('//' => 'dor') x ($] >= 5.010),
  '&&'  => 'hand',
 
+ '|'   => 'bor',
+ '^'   => 'bxor',
+ '&'   => 'band',
+
  'lt'  => 'lt',
  'le'  => 'le',
  'gt'  => 'gt',
@@ -305,7 +384,21 @@ my %binops = (
 
  '=~'  => 'like',
  '!~'  => 'unlike',
- '~~'  => 'smartmatch',
+ ('~~' => 'smartmatch') x ($] >= 5.010),
+
+ '+'   => 'add',
+ '-'   => 'substract',
+ '*'   => 'multiply',
+ '/'   => 'divide',
+ '%'   => 'modulo',
+ '<<'  => 'lshift',
+ '>>'  => 'rshift',
+
+ '.'   => 'concat',
+ '..'  => 'flipflop',
+ '...' => 'altflipflop',
+ ','   => 'comma',
+ '=>'  => 'fatcomma',
 );
 
 my %binop_handlers;
@@ -319,7 +412,7 @@ sub _create_binop_handler {
   eval <<"IS_BINOP";
 sub is_$name (\$\$;\$) {
  my (\$got, \$expected, \$desc) = \@_;
- \@_ = ((\$got $op \$expected), \$desc);
+ \@_ = (scalar(\$got $op \$expected), \$desc);
  goto &ok;
 }
 IS_BINOP
@@ -331,12 +424,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};
@@ -357,7 +460,7 @@ sub _diag_fh {
  return if $no_diag;
 
  my $msg = join '', map { defined($_) ? $_ : 'undef' } @_;
- sanitize_comment($msg);
+ _sanitize_comment($msg);
  return unless length $msg;
 
  local $\;
@@ -366,16 +469,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) = @_;
 
@@ -383,7 +498,7 @@ sub BAIL_OUT {
 
  my $bail_out_str = 'Bail out!';
  if (defined $desc) {
-  sanitize_comment($desc);
+  _sanitize_comment($desc);
   $bail_out_str  .= "  $desc" if length $desc; # Two spaces
  }
 
@@ -410,4 +525,94 @@ 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;
+
+=head2 C<THREADSAFE>
+
+This constant evaluates to true if and only if L<Test::Leaner> is thread-safe, i.e. when this version of C<perl> is at least 5.8, has been compiled with C<useithreads> defined, and L<threads> has been loaded B<before> L<Test::Leaner>.
+In that case, it also needs a working L<threads::shared>.
+
+=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