--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. | will give a
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "TAP::Parser::Result::Test 3"
+.TH TAP::Parser::Result::Test 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+TAP::Parser::Result::Test \- Test result token.
+.SH "VERSION"
+.IX Header "VERSION"
+Version 3.17
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This is a subclass of TAP::Parser::Result. A token of this class will be
+returned if a test line is encountered.
+.PP
+.Vb 2
+\& 1..1
+\& ok 1 \- woo hooo!
+.Ve
+.SH "OVERRIDDEN METHODS"
+.IX Header "OVERRIDDEN METHODS"
+This class is the workhorse of the TAP::Parser system. Most \s-1TAP\s0 lines will
+be test lines and if \f(CW\*(C`$result\->is_test\*(C'\fR, then you have a bunch of methods
+at your disposal.
+.Sh "Instance Methods"
+.IX Subsection "Instance Methods"
+\fI\f(CI\*(C`ok\*(C'\fI\fR
+.IX Subsection "ok"
+.PP
+.Vb 1
+\& my $ok = $result\->ok;
+.Ve
+.PP
+Returns the literal text of the \f(CW\*(C`ok\*(C'\fR or \f(CW\*(C`not ok\*(C'\fR status.
+.PP
+\fI\f(CI\*(C`number\*(C'\fI\fR
+.IX Subsection "number"
+.PP
+.Vb 1
+\& my $test_number = $result\->number;
+.Ve
+.PP
+Returns the number of the test, even if the original \s-1TAP\s0 output did not supply
+that number.
+.PP
+\fI\f(CI\*(C`description\*(C'\fI\fR
+.IX Subsection "description"
+.PP
+.Vb 1
+\& my $description = $result\->description;
+.Ve
+.PP
+Returns the description of the test, if any. This is the portion after the
+test number but before the directive.
+.PP
+\fI\f(CI\*(C`directive\*(C'\fI\fR
+.IX Subsection "directive"
+.PP
+.Vb 1
+\& my $directive = $result\->directive;
+.Ve
+.PP
+Returns either \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR if either directive was present for a test
+line.
+.PP
+\fI\f(CI\*(C`explanation\*(C'\fI\fR
+.IX Subsection "explanation"
+.PP
+.Vb 1
+\& my $explanation = $result\->explanation;
+.Ve
+.PP
+If a test had either a \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR directive, this method will return
+the accompanying explantion, if present.
+.PP
+.Vb 1
+\& not ok 17 \- 'Pigs can fly' # TODO not enough acid
+.Ve
+.PP
+For the above line, the explanation is \fInot enough acid\fR.
+.PP
+\fI\f(CI\*(C`is_ok\*(C'\fI\fR
+.IX Subsection "is_ok"
+.PP
+.Vb 1
+\& if ( $result\->is_ok ) { ... }
+.Ve
+.PP
+Returns a boolean value indicating whether or not the test passed. Remember
+that for \s-1TODO\s0 tests, the test always passes.
+.PP
+If the test is unplanned, this method will always return false. See
+\&\f(CW\*(C`is_unplanned\*(C'\fR.
+.PP
+\fI\f(CI\*(C`is_actual_ok\*(C'\fI\fR
+.IX Subsection "is_actual_ok"
+.PP
+.Vb 1
+\& if ( $result\->is_actual_ok ) { ... }
+.Ve
+.PP
+Returns a boolean value indicating whether or not the test passed, regardless
+of its \s-1TODO\s0 status.
+.PP
+\fI\f(CI\*(C`actual_passed\*(C'\fI\fR
+.IX Subsection "actual_passed"
+.PP
+Deprecated. Please use \f(CW\*(C`is_actual_ok\*(C'\fR instead.
+.PP
+\fI\f(CI\*(C`todo_passed\*(C'\fI\fR
+.IX Subsection "todo_passed"
+.PP
+.Vb 3
+\& if ( $test\->todo_passed ) {
+\& # test unexpectedly succeeded
+\& }
+.Ve
+.PP
+If this is a \s-1TODO\s0 test and an 'ok' line, this method returns true.
+Otherwise, it will always return false (regardless of passing status on
+non-todo tests).
+.PP
+This is used to track which tests unexpectedly succeeded.
+.PP
+\fI\f(CI\*(C`todo_failed\*(C'\fI\fR
+.IX Subsection "todo_failed"
+.PP
+.Vb 1
+\& # deprecated in favor of 'todo_passed'. This method was horribly misnamed.
+.Ve
+.PP
+This was a badly misnamed method. It indicates which \s-1TODO\s0 tests unexpectedly
+succeeded. Will now issue a warning and call \f(CW\*(C`todo_passed\*(C'\fR.
+.PP
+\fI\f(CI\*(C`has_skip\*(C'\fI\fR
+.IX Subsection "has_skip"
+.PP
+.Vb 1
+\& if ( $result\->has_skip ) { ... }
+.Ve
+.PP
+Returns a boolean value indicating whether or not this test has a \s-1SKIP\s0
+directive.
+.PP
+\fI\f(CI\*(C`has_todo\*(C'\fI\fR
+.IX Subsection "has_todo"
+.PP
+.Vb 1
+\& if ( $result\->has_todo ) { ... }
+.Ve
+.PP
+Returns a boolean value indicating whether or not this test has a \s-1TODO\s0
+directive.
+.PP
+\fI\f(CI\*(C`as_string\*(C'\fI\fR
+.IX Subsection "as_string"
+.PP
+.Vb 1
+\& print $result\->as_string;
+.Ve
+.PP
+This method prints the test as a string. It will probably be similar, but
+not necessarily identical, to the original test line. Directives are
+capitalized, some whitespace may be trimmed and a test number will be added if
+it was not present in the original line. If you need the original text of the
+test line, use the \f(CW\*(C`raw\*(C'\fR method.
+.PP
+\fI\f(CI\*(C`is_unplanned\*(C'\fI\fR
+.IX Subsection "is_unplanned"
+.PP
+.Vb 2
+\& if ( $test\->is_unplanned ) { ... }
+\& $test\->is_unplanned(1);
+.Ve
+.PP
+If a test number is greater than the number of planned tests, this method will
+return true. Unplanned tests will \fIalways\fR return false for \f(CW\*(C`is_ok\*(C'\fR,
+regardless of whether or not the test \f(CW\*(C`has_todo\*(C'\fR.
+.PP
+Note that if tests have a trailing plan, it is not possible to set this
+property for unplanned tests as we do not know it's unplanned until the plan
+is reached:
+.PP
+.Vb 5
+\& print <<'END';
+\& ok 1
+\& ok 2
+\& 1..1
+\& END
+.Ve
projects / catagits/Gitalist.git / blobdiff