File Coverage

blib/lib/Test/More/Prefix.pm

Criterion	Covered	Total	%
statement	12	15	80.0
branch	1	2	50.0
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	17	21	80.9

package Test::More::Prefix;
$Test::More::Prefix::VERSION = '0.005';
=head1 NAME

Test::More::Prefix - Prefix some test output

=head1 DESCRIPTION

Inject a prefix in to Test::Builder's informational output. Useful for
providing context in noisy and repetitive tests

=head1 SYNOPSIS

 use Test::More;
 use Test::More::Prefix qw/test_prefix/;

 note "Bar"; # Print '# Bar'

 test_prefix("Foo");
 note "Baz"; # Print '# Foo: Baz'

 test_prefix('');
 note "Bat"; # Print '# Bat'

=head1 IMPLEMENTATION

=head2 Test::Builder

For versions of L<Test::Simple> which use the original L<Test::Builder>
underneath, intercepts calls to L<Test::Builder>'s internal C<_print_comment>
command and adds your prefix to all defined lines.

=head2 Test::Stream

For versions of L<Test::Simple> which use this new-fangled L<Test::Stream>
stuff, we wrap setting of L<TB2::Event::Log>'s C<message> attribute to prepend
the prefix. This means that more of the possible output contains the prefix.

=head1 FUNCTIONS

=head2 test_prefix

Set the prefix. Accepts a string.

=head1 AUTHOR

Peter Sergeant - C<[e-mail]> on behalf of
L<Net-A-Porter|http://www.net-a-porter.com/>.

=cut

use strict;
use warnings;
use Test::More;

sub import {
    my ( $class, @args ) = @_;
    if ( $INC{'Test/Stream.pm'} ) {
        require Test::More::Prefix::TB2;
        Test::More::Prefix::TB2->import(@args);
    } else {
        require Test::More::Prefix::TB1;
        Test::More::Prefix::TB1->import(@args);
    }
}

1;