TAP::Parser::Result(3p) Perl Programmers Reference Guide

TAP::Parser::Result(3p) Perl Programmers Reference Guide #

TAP::Parser::Result(3p) Perl Programmers Reference Guide

NNAAMMEE #

 TAP::Parser::Result - Base class for TAP::Parser output objects

VVEERRSSIIOONN #

 Version 3.44

SSYYNNOOPPSSIISS #

   # abstract class - not meant to be used directly
   # see TAP::Parser::ResultFactory for preferred usage

   # directly:
   use TAP::Parser::Result;
   my $token  = {...};
   my $result = TAP::Parser::Result->new( $token );

DDEESSCCRRIIPPTTIIOONN #

 This is a simple base class used by TAP::Parser to store objects that
 represent the current bit of test output data from TAP (usually a single
 line).  Unless you're subclassing, you probably won't need to use this
 module directly.

MMEETTHHOODDSS #

 _"_n_e_w_"

   # see TAP::Parser::ResultFactory for preferred usage

   # to use directly:
   my $result = TAP::Parser::Result->new($token);

 Returns an instance the appropriate class for the test token passed in.

BBoooolleeaann mmeetthhooddss The following methods all return a boolean value and are to be overridden in the appropriate subclass.

 •   "is_plan"

     Indicates whether or not this is the test plan line.

      1..3

 •   "is_pragma"

     Indicates whether or not this is a pragma line.

      pragma +strict

 •   "is_test"

     Indicates whether or not this is a test line.

      ok 1 Is OK!

 •   "is_comment"

     Indicates whether or not this is a comment.

      # this is a comment

 •   "is_bailout"

     Indicates whether or not this is bailout line.

      Bail out! We're out of dilithium crystals.

 •   "is_version"

     Indicates whether or not this is a TAP version line.

      TAP version 4

 •   "is_unknown"

     Indicates whether or not the current line could be parsed.

      ... this line is junk ...

 •   "is_yaml"

     Indicates whether or not this is a YAML chunk.

 _"_r_a_w_"

   print $result->raw;

 Returns the original line of text which was parsed.

 _"_t_y_p_e_"

   my $type = $result->type;

 Returns the "type" of a token, such as "comment" or "test".

 _"_a_s___s_t_r_i_n_g_"

   print $result->as_string;

 Prints a string representation of the token.  This might not be the exact
 output, however.  Tests will have test numbers added if not present, TODO
 and SKIP directives will be capitalized and, in general, things will be
 cleaned up.  If you need the original text for the token, see the "raw"
 method.

 _"_i_s___o_k_"

   if ( $result->is_ok ) { ... }

 Reports whether or not a given result has passed.  Anything which is nnoott
 a test result returns true.  This is merely provided as a convenient
 shortcut.

 _"_p_a_s_s_e_d_"

 Deprecated.  Please use "is_ok" instead.

 _"_h_a_s___d_i_r_e_c_t_i_v_e_"

   if ( $result->has_directive ) {
      ...
   }

 Indicates whether or not the given result has a TODO or SKIP directive.

 _"_h_a_s___t_o_d_o_"

  if ( $result->has_todo ) {
      ...
  }

 Indicates whether or not the given result has a TODO directive.

 _"_h_a_s___s_k_i_p_"

  if ( $result->has_skip ) {
      ...
  }

 Indicates whether or not the given result has a SKIP directive.

 _"_s_e_t___d_i_r_e_c_t_i_v_e_"

 Set the directive associated with this token. Used internally to fake
 TODO tests.

SSUUBBCCLLAASSSSIINNGG #

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

 Remember: if you want your subclass to be automatically used by the
 parser, you'll have to register it with "register_type" in
 TAP::Parser::ResultFactory.

 If you're creating a completely new result _t_y_p_e, you'll probably need to
 subclass TAP::Parser::Grammar too, or else it'll never get used.

EExxaammppllee package MyResult;

   use strict;

   use base 'TAP::Parser::Result';

   # register with the factory:
   TAP::Parser::ResultFactory->register_type( 'my_type' => __PACKAGE__ );

   sub as_string { 'My results all look the same' }

SSEEEE AALLSSOO #

 TAP::Object, TAP::Parser, TAP::Parser::ResultFactory,
 TAP::Parser::Result::Bailout, TAP::Parser::Result::Comment,
 TAP::Parser::Result::Plan, TAP::Parser::Result::Pragma,
 TAP::Parser::Result::Test, TAP::Parser::Result::Unknown,
 TAP::Parser::Result::Version, TAP::Parser::Result::YAML,

perl v5.36.3 2023-02-15 TAP::Parser::Result(3p)