内容

名称

TAP::Parser::SourceHandler - 不同 TAP 源处理程序的基类

版本

版本 3.44

概要

# abstract class - don't use directly!
# see TAP::Parser::IteratorFactory for general usage

# must be sub-classed for use
package MySourceHandler;
use base 'TAP::Parser::SourceHandler';
sub can_handle    { return $confidence_level }
sub make_iterator { return $iterator }

# see example below for more details

描述

这是一个 TAP::Parser::Source 处理程序的抽象基类。

TAP::Parser::SourceHandler 会执行所有必要的操作，以从原始源生成和捕获 TAP 流，并将其打包到 TAP::Parser::Iterator 中，供解析器使用。

SourceHandlers 必须实现 TAP::Parser::IteratorFactory 使用的源检测和处理接口。该接口非常简单，只有两个方法："can_handle" 和 "make_source"。

除非您正在编写新的 TAP::Parser::SourceHandler、插件或子类化 TAP::Parser，否则您可能不需要直接使用此模块。

方法

类方法

can_handle

抽象方法.

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

$source 是一个 TAP::Parser::Source。

返回一个介于 0 和 1 之间的数字，反映原始源代码被处理的置信度。例如，0 表示源代码无法处理它，0.5 表示它可能能够处理，1 表示它肯定能够处理。有关如何使用它的详细信息，请参阅 "TAP::Parser::IteratorFactory 中的 detect_source"。

make_iterator

抽象方法.

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

$source 是一个 TAP::Parser::Source。

返回一个新的 TAP::Parser::Iterator 对象，供 TAP::Parser 使用。在错误时 croak。

子类化

有关子类化概述，请参阅 "TAP::Parser 中的 SUBCLASSING"，以及与该模块一起提供的任何子类作为示例。以下是一个简要概述。

首先熟悉 TAP::Parser::Source 和 TAP::Parser::IteratorFactory。 TAP::Parser::SourceHandler::RawTAP 是最容易用作示例的子类。

重要的是要注意，如果您希望您的子类被 TAP::Parser 自动使用，您需要确保它以某种方式被加载。如果您使用的是 prove，您可以编写一个 App::Prove 插件。如果您直接使用 TAP::Parser 或 TAP::Harness（例如，通过自定义脚本、ExtUtils::MakeMaker 或 Module::Build），您可以使用 config 选项，这将导致 "TAP::Parser::IteratorFactory 中的 load_sources" 加载您的子类。

不要忘记使用 "TAP::Parser::IteratorFactory 中的 register_handler" 注册您的类。

示例

package MySourceHandler;

use strict;

use MySourceHandler; # see TAP::Parser::SourceHandler
use TAP::Parser::IteratorFactory;

use base 'TAP::Parser::SourceHandler';

TAP::Parser::IteratorFactory->register_handler( __PACKAGE__ );

sub can_handle {
    my ( $class, $src ) = @_;
    my $meta   = $src->meta;
    my $config = $src->config_for( $class );

    if ($config->{accept_all}) {
        return 1.0;
    } elsif (my $file = $meta->{file}) {
        return 0.0 unless $file->{exists};
        return 1.0 if $file->{lc_ext} eq '.tap';
        return 0.9 if $file->{shebang} && $file->{shebang} =~ /^#!.+tap/;
        return 0.5 if $file->{text};
        return 0.1 if $file->{binary};
    } elsif ($meta->{scalar}) {
        return 0.8 if $$raw_source_ref =~ /\d\.\.\d/;
        return 0.6 if $meta->{has_newlines};
    } elsif ($meta->{array}) {
        return 0.8 if $meta->{size} < 5;
        return 0.6 if $raw_source_ref->[0] =~ /foo/;
        return 0.5;
    } elsif ($meta->{hash}) {
        return 0.6 if $raw_source_ref->{foo};
        return 0.2;
    }

    return 0;
}

sub make_iterator {
    my ($class, $source) = @_;
    # this is where you manipulate the source and
    # capture the stream of TAP in an iterator
    # either pick a TAP::Parser::Iterator::* or write your own...
    my $iterator = TAP::Parser::Iterator::Array->new([ 'foo', 'bar' ]);
    return $iterator;
}

1;

作者

TAPx 开发者。

源代码检测部分由 Steve Purkis 添加

另请参阅

TAP::Object、TAP::Parser、TAP::Parser::Source、TAP::Parser::Iterator、TAP::Parser::IteratorFactory、TAP::Parser::SourceHandler::Executable、TAP::Parser::SourceHandler::Perl、TAP::Parser::SourceHandler::File、TAP::Parser::SourceHandler::Handle、TAP::Parser::SourceHandler::RawTAP