Perl 5 version 26.3 documentation

TAP::Parser::ResultFactory

NAME

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

SYNOPSIS

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

VERSION

Version 3.38

DESCRIPTION

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.

METHODS

Class Methods

new

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

make_result

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

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

Can also be called as an instance method.

class_for

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

register_type

Takes two arguments: $type , $class

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

  1.   # create a custom result type:
  2.   package MyResult;
  3.   use strict;
  4.   use base 'TAP::Parser::Result';
  6.   # register with the factory:
  7.   TAP::Parser::ResultFactory->register_type( 'my_type' => __PACKAGE__ );
  9.   # use it:
  10.   my $r = TAP::Parser::ResultFactory->( { type => 'my_type' } );

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

SUBCLASSING

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

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

  • The factory itself is never instantiated (this may change in the future). This means that _initialize is never called.

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

  • TAP::Parser::Result subclasses will register themselves with TAP::Parser::ResultFactory directly:

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

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

    • Example

    1.   package MyResultFactory;
    3.   use strict;
    5.   use MyResult;
    7.   use base 'TAP::Parser::ResultFactory';
    9.   # force all results to be 'MyResult'
    10.   sub class_for {
    11.     return 'MyResult';
    12.   }
    14.   1;

    SEE ALSO

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