1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
package TAP::Parser::Result;
use strict;
use vars qw($VERSION);
use TAP::Parser::Result::Bailout ();
use TAP::Parser::Result::Comment ();
use TAP::Parser::Result::Plan ();
use TAP::Parser::Result::Test ();
use TAP::Parser::Result::Unknown ();
use TAP::Parser::Result::Version ();
use TAP::Parser::Result::YAML ();
BEGIN {
no strict 'refs';
foreach my $token (qw( plan comment test bailout version unknown yaml )) {
my $method = "is_$token";
*$method = sub { return $token eq shift->type };
}
}
##############################################################################
=head1 NAME
TAP::Parser::Result - TAP::Parser output
=head1 VERSION
Version 3.05
=cut
$VERSION = '3.05';
=head2 DESCRIPTION
This is merely a factory class which returns an object representing the
current bit of test data from TAP (usually a line). It's for internal use
only and should not be relied upon.
=cut
# note that this is bad. Makes it very difficult to subclass, but then, it
# would be a lot of work to subclass this system.
my %class_for = (
plan => 'TAP::Parser::Result::Plan',
test => 'TAP::Parser::Result::Test',
comment => 'TAP::Parser::Result::Comment',
bailout => 'TAP::Parser::Result::Bailout',
version => 'TAP::Parser::Result::Version',
unknown => 'TAP::Parser::Result::Unknown',
yaml => 'TAP::Parser::Result::YAML',
);
##############################################################################
=head2 METHODS
=head3 C<new>
my $result = TAP::Parser::Result->new($token);
Returns an instance the appropriate class for the test token passed in.
=cut
sub new {
my ( $class, $token ) = @_;
my $type = $token->{type};
return bless $token => $class_for{$type}
if exists $class_for{$type};
require Carp;
# this should never happen!
Carp::croak("Could not determine class for\n$token->{type}");
}
=head2 Boolean methods
The following methods all return a boolean value and are to be overridden in
the appropriate subclass.
=over 4
=item * C<is_plan>
Indicates whether or not this is the test plan line.
1..3
=item * C<is_test>
Indicates whether or not this is a test line.
is $foo, $bar, $description;
=item * C<is_comment>
Indicates whether or not this is a comment.
# this is a comment
=item * C<is_bailout>
Indicates whether or not this is bailout line.
Bail out! We're out of dilithium crystals.
=item * C<is_version>
Indicates whether or not this is a TAP version line.
TAP version 4
=item * C<is_unknown>
Indicates whether or not the current line could be parsed.
... this line is junk ...
=item * C<is_yaml>
Indicates whether or not this is a YAML chunk.
=back
=cut
##############################################################################
=head3 C<raw>
print $result->raw;
Returns the original line of text which was parsed.
=cut
sub raw { shift->{raw} }
##############################################################################
=head3 C<type>
my $type = $result->type;
Returns the "type" of a token, such as C<comment> or C<test>.
=cut
sub type { shift->{type} }
##############################################################################
=head3 C<as_string>
print $result->as_string;
Prints a string representation of the token. This might not be the exact
output, however. Tests will have test numbers added if not present, TODO and
SKIP directives will be capitalized and, in general, things will be cleaned
up. If you need the original text for the token, see the C<raw> method.
=cut
sub as_string { shift->{raw} }
##############################################################################
=head3 C<is_ok>
if ( $result->is_ok ) { ... }
Reports whether or not a given result has passed. Anything which is B<not> a
test result returns true. This is merely provided as a convenient shortcut.
=cut
sub is_ok {1}
##############################################################################
=head3 C<passed>
Deprecated. Please use C<is_ok> instead.
=cut
sub passed {
warn 'passed() is deprecated. Please use "is_ok()"';
shift->is_ok;
}
##############################################################################
=head3 C<has_directive>
if ( $result->has_directive ) {
...
}
Indicates whether or not the given result has a TODO or SKIP directive.
=cut
sub has_directive {
my $self = shift;
return ( $self->has_todo || $self->has_skip );
}
##############################################################################
=head3 C<has_todo>
if ( $result->has_todo ) {
...
}
Indicates whether or not the given result has a TODO directive.
=cut
sub has_todo { 'TODO' eq ( shift->{directive} || '' ) }
##############################################################################
=head3 C<has_skip>
if ( $result->has_skip ) {
...
}
Indicates whether or not the given result has a SKIP directive.
=cut
sub has_skip { 'SKIP' eq ( shift->{directive} || '' ) }
=head3 C<set_directive>
Set the directive associated with this token. Used internally to fake
TODO tests.
=cut
sub set_directive {
my ( $self, $dir ) = @_;
$self->{directive} = $dir;
}
1;
|
