Perl version

Modules

  • ABCDE
  • FGHIL
  • MNOPS
  • TUX

TAP::Parser::Result::Plan

Perl 5 version 20.1 documentation
Recently read

TAP::Parser::Result::Plan

NAME

TAP::Parser::Result::Plan - Plan result token.

VERSION

Version 3.30

DESCRIPTION

This is a subclass of TAP::Parser::Result. A token of this class will be returned if a plan line is encountered.

  1. 1..1
  2. ok 1 - woo hooo!

1..1 is the plan. Gotta have a plan.

OVERRIDDEN METHODS

Mainly listed here to shut up the pitiful screams of the pod coverage tests. They keep me awake at night.

  • as_string
  • raw

Instance Methods

plan

  1. if ( $result->is_plan ) {
  2. print $result->plan;
  3. }

This is merely a synonym for as_string .

tests_planned

  1. my $planned = $result->tests_planned;

Returns the number of tests planned. For example, a plan of 1..17 will cause this method to return '17'.

directive

  1. my $directive = $plan->directive;

If a SKIP directive is included with the plan, this method will return it.

  1. 1..0 # SKIP: why bother?

has_skip

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

Returns a boolean value indicating whether or not this test has a SKIP directive.

explanation

  1. my $explanation = $plan->explanation;

If a SKIP directive was included with the plan, this method will return the explanation, if any.

todo_list

  1. my $todo = $result->todo_list;
  2. for ( @$todo ) {
  3. ...
  4. }