Perl 5 version documentation

TAP::Parser::SourceHandler::File

NAME

TAP::Parser::SourceHandler::File - Stream TAP from a text file.

VERSION

Version 3.42

SYNOPSIS

  1.   use TAP::Parser::Source;
  2.   use TAP::Parser::SourceHandler::File;
  4.   my $source = TAP::Parser::Source->new->raw( \'file.tap' );
  5.   $source->assemble_meta;
  7.   my $class = 'TAP::Parser::SourceHandler::File';
  8.   my $vote  = $class->can_handle( $source );
  9.   my $iter  = $class->make_iterator( $source );

DESCRIPTION

This is a raw TAP stored in a file TAP::Parser::SourceHandler - it has 2 jobs:

1. Figure out if the raw source it's given is a file containing raw TAP output. See TAP::Parser::IteratorFactory for more details.

2. Takes raw TAP from the text file given, and converts into an iterator.

Unless you're writing a plugin or subclassing TAP::Parser, you probably won't need to use this module directly.

METHODS

Class Methods

can_handle 

  1.   my $vote = $class->can_handle( $source );

Only votes if $source looks like a regular file. Casts the following votes:

  1.   0.9 if it's a .tap file
  2.   0.9 if it has an extension matching any given in user config.

make_iterator 

  1.   my $iterator = $class->make_iterator( $source );

Returns a new TAP::Parser::Iterator::Stream for the source. croak s on error.

iterator_class

The class of iterator to use, override if you're sub-classing. Defaults to TAP::Parser::Iterator::Stream.

CONFIGURATION

  1.   {
  2.    extensions => [ @case_insensitive_exts_to_match ]
  3.   }

SUBCLASSING

Please see SUBCLASSING in TAP::Parser for a subclassing overview.

SEE ALSO

TAP::Object, TAP::Parser, TAP::Parser::SourceHandler, TAP::Parser::SourceHandler::Executable, TAP::Parser::SourceHandler::Perl, TAP::Parser::SourceHandler::Handle, TAP::Parser::SourceHandler::RawTAP