Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

TAP::Parser::IteratorFactory

NAME
VERSION
SYNOPSIS
DESCRIPTION
METHODS
SUBCLASSING
AUTHORS
ATTRIBUTION
SEE ALSO

NAME

TAP::Parser::IteratorFactory − Figures out which SourceHandler objects to use for a given Source

VERSION

Version 3.23

SYNOPSIS

  use TAP::Parser::IteratorFactory;
  my $factory = TAP::Parser::IteratorFactory−>new({ %config });
  my $iterator  = $factory−>make_iterator( $filename );

DESCRIPTION

This is a factory class that takes a TAP::Parser::Source and runs it through all the registered TAP::Parser::SourceHandlers to see which one should handle the source.

If you’re a plugin author, you’ll be interested in how to "register_handler"s, how "detect_source" works.

METHODS

Class Methods
"new"

Creates a new factory class:

my $sf = TAP::Parser::IteratorFactory−>new( $config );

$config is optional. If given, sets "config" and calls "load_handlers".

"register_handler"

Registers a new TAP::Parser::SourceHandler with this factory.

__PACKAGE__−>register_handler( $handler_class );

"handlers"

List of handlers that have been registered.

Instance Methods
"config"

my $cfg = $sf−>config;
$sf−>config({ Perl => { %config } });

Chaining getter/setter for the configuration of the available source handlers. This is a hashref keyed on handler class whose values contain config to be passed onto the handlers during detection & creation. Class names may be fully qualified or abbreviated, eg:

  # these are equivalent
  $sf−>config({ 'TAP::Parser::SourceHandler::Perl' => { %config } });
  $sf−>config({ 'Perl' => { %config } });

"load_handlers"

$sf−>load_handlers;

Loads the handler classes defined in "config". For example, given a config:

  $sf−>config({
    MySourceHandler => { some => 'config' },
  });

"load_handlers" will attempt to load the "MySourceHandler" class by looking in @INC for it in this order:

TAP::Parser::SourceHandler::MySourceHandler
MySourceHandler

"croak"s on error.

"make_iterator"

my $iterator = $src_factory−>make_iterator( $source );

Given a TAP::Parser::Source, finds the most suitable TAP::Parser::SourceHandler to use to create a TAP::Parser::Iterator (see "detect_source"). Dies on error.

"detect_source"

Given a TAP::Parser::Source, detects what kind of source it is and returns one TAP::Parser::SourceHandler (the most confident one). Dies on error.

The detection algorithm works something like this:

  for (@registered_handlers) {
    # ask them how confident they are about handling this source
    $confidence{$handler} = $handler−>can_handle( $source )
  }
  # choose the most confident handler

Ties are handled by choosing the first handler.

SUBCLASSING

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

Example
If we’ve done things right, you’ll probably want to write a new source, rather than sub-classing this (see TAP::Parser::SourceHandler for that).

But in case you find the need to...

  package MyIteratorFactory;
  use strict;
  use vars '@ISA';
  use TAP::Parser::IteratorFactory;
  @ISA = qw( TAP::Parser::IteratorFactory );
  # override source detection algorithm
  sub detect_source {
    my ($self, $raw_source_ref, $meta) = @_;
    # do detective work, using $meta and whatever else...
  }
  1;

AUTHORS

Steve Purkis

ATTRIBUTION

Originally ripped off from Test::Harness.

Moved out of TAP::Parser & converted to a factory class to support extensible TAP source detective work by Steve Purkis.

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.