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

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

NNAAMMEE #

 TAP::Parser::ResultFactory - Factory for creating TAP::Parser output
 objects

SSYYNNOOPPSSIISS #

   use TAP::Parser::ResultFactory;
   my $token   = {...};
   my $factory = TAP::Parser::ResultFactory->new;
   my $result  = $factory->make_result( $token );

VVEERRSSIIOONN #

 Version 3.44

DDEESSCCRRIIPPTTIIOONN #

 This is a simple factory class which returns a TAP::Parser::Result
 subclass representing the current bit of test data from TAP (usually a
 single line).  It is used primarily by TAP::Parser::Grammar.  Unless
 you're subclassing, you probably won't need to use this module directly.

MMEETTHHOODDSS #

CCllaassss MMeetthhooddss _"_n_e_w_"

 Creates a new factory class.  _N_o_t_e_: You currently don't need to
 instantiate a factory in order to use it.

 _"_m_a_k_e___r_e_s_u_l_t_"

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

   my $result = TAP::Parser::ResultFactory->make_result($token);

 Can also be called as an instance method.

 _"_c_l_a_s_s___f_o_r_"

 Takes one argument: $type.  Returns the class for this $type, or "croak"s
 with an error.

 _"_r_e_g_i_s_t_e_r___t_y_p_e_"

 Takes two arguments: $type, $class

 This lets you override an existing type with your own custom type, or
 register a completely new type, eg:

   # create a custom result type:
   package MyResult;
   use strict;
   use base 'TAP::Parser::Result';

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

   # use it:
   my $r = TAP::Parser::ResultFactory->( { type => 'my_type' } );

 Your custom type should then be picked up automatically by the
 TAP::Parser.

SSUUBBCCLLAASSSSIINNGG #

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

 There are a few things to bear in mind when creating your own
 "ResultFactory":

 1.  The factory itself is never instantiated (this _m_a_y change in the
     future).  This means that "_initialize" is never called.

 2.  "TAP::Parser::Result->new" is never called, $tokens are reblessed.
     This _w_i_l_l change in a future version!

 3.  TAP::Parser::Result subclasses will register themselves with
     TAP::Parser::ResultFactory directly:

       package MyFooResult;
       TAP::Parser::ResultFactory->register_type( foo => __PACKAGE__ );

     Of course, it's up to you to decide whether or not to ignore them.

EExxaammppllee package MyResultFactory;

   use strict;

   use MyResult;

   use base 'TAP::Parser::ResultFactory';

   # force all results to be 'MyResult'
   sub class_for {
     return 'MyResult';
   }

   1;

SSEEEE AALLSSOO #

 TAP::Parser, TAP::Parser::Result, TAP::Parser::Grammar

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