/ 
Test2-0.000011
/ Test2::Formatter::TAP

NAME

Test2::Formatter::TAP - Standard TAP formatter

EXPERIMENTAL RELEASE

This is an experimental release. Using this right now is not recommended.

DESCRIPTION

This is what takes events and turns them into TAP.

SYNOPSIS

use Test2::Formatter::TAP;
my $tap = Test2::Formatter::TAP->new();

# Switch to utf8
$tap->encoding('utf8');

$tap->write($event, $number); # Output an event

EXPORTS

OUT_STD
OUT_ERR
OUT_TODO

These are constants to identify filehandles. These constants are used by events to direct text to the correct filehandle.

METHODS

$bool = $tap->no_numbers
$tap->set_no_numbers($bool)

Use to turn numbers on and off.

$bool = $tap->no_header($bool)
$tap->set_no_header($bool)

When true, the plan will not be rendered.

$bool = $tap->no_diag
$tap->set_no_diag($bool)

When true, diagnostics will not be rendered.

$arrayref = $tap->handles
$tap->set_handles(\@handles);

Can be used to get/set the filehandles. Indexes are identified by the OUT_STD, OUT_ERR, OUT_TODO constants.

$encoding = $tap->encoding
$tap->encoding($encoding)

Get or set the encoding. By default no encoding is set, the original settings of STDOUT and STDERR are used.

This directly modifies the stored filehandles, it does not create new ones.

$tap->write($e, $num)

Write an event to the console.

Test2::Formatter::TAP->register_event($pkg, sub { ... });

In general custom events are not supported. There are however occasions where you might want to write a custom event type that results in TAP output. In order to do this you use the register_event() class method.

package My::Event;
use Test2::Formatter::TAP qw/OUT_STD OUT_ERR/;

use base 'Test2::Event';
use Test2::Util::HashBase accessors => [qw/pass name diag note/];

Test2::Formatter::TAP->register_event(
    __PACKAGE__,
    sub {
        my $self = shift;
        my ($e, $num) = @_;
        return (
            [OUT_STD, "ok $num - " . $e->name . "\n"],
            [OUT_ERR, "# " . $e->name . " " . $e->diag . "\n"],
            [OUT_STD, "# " . $e->name . " " . $e->note . "\n"],
        );
    }
);

1;

SOURCE

The source code repository for Test2 can be found at http://github.com/Test-More/Test2/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>
Kent Fredric <kentnl@cpan.org>

COPYRIGHT

Copyright 2015 Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/