NAME

Archive::TAP::Convert - Read from a TAP archive and convert it for displaying

VERSION

version 0.007

SYNOPSIS

Either:

  use Archive::TAP::Convert qw(convert_from_taparchive);

  my $html = convert_from_taparchive(
                archive   => '/must/be/the/complete/path/to/test.tar.gz',
                formatter => 'TAP::Formatter::HTML',
             );

Or:

  use Archive::TAP::Convert qw(convert_from_taparchive);
  use TAP::Formatter::HTML; # or ::JUnit, ::Console, etc.

  my $formatter = TAP::Formatter::HTML->new;
  # possibly configure formatter

  my $html = convert_from_taparchive(
                archive   => '/must/be/the/complete/path/to/test.tar.gz',
                formatter => $formatter,
             );

ABOUT

This is a software library for the perl programming language.

The modul can be of help for you if you have TAP archives (e.g. created with prove -a and now you wish to have the content of this archives in a special format like HTML or JUnit (or whatever format).

EXPORTED METHODS

convert_from_taparchive

The method takes three arguments. Only archive is required. It takes the full path to your TAP archive. The formatter defaults to TAP::Formatter::HTML, but you can define any other formatter by string or even pass a reference to an existing formatter-object. The method will return the content of the TAP archive, parsed according to the formatter you have specified.

 my $html = convert_from_taparchive(
                archive      => '/must/be/the/complete/path/to/test.tar.gz',
                formatter    =>'TAP::Formatter::HTML',
                force_inline => 1,
            );

You can give any optional true value to force_inline and it will pack all Javascript and CSS inside the HTML instead of linking to to files from TAP::Formatter::HTML. This defaults to zero, meaning do not inline.

BUGS AND LIMITATIONS

No known issues.

SEE ALSO

• Might also be interesting for you: Archive::TAP::Peek

• The previous name of this module was: Convert::TAP::Archive (deprecated)

• Used in this module: Test::Harness

• Available formatters: TAP::Formatter::Base and its implementations for HTML, JUnit or Console.

CONTRIBUTORS

• Xavier Caron (XAV / maspalio)

AUTHOR

Boris Däppen <bdaeppen.perl@gmail.com>, Renée Bäcker <module@renee-baecker.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Boris Däppen, Renée Bäcker, plusW.

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