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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
package TAP::Parser::Source;
use strict;
use warnings;
use File::Basename qw( fileparse );
use base 'TAP::Object';
use constant BLK_SIZE => 512;
=head1 NAME
TAP::Parser::Source - a TAP source & meta data about it
=head1 VERSION
Version 3.36
=cut
our $VERSION = '3.36';
=head1 SYNOPSIS
use TAP::Parser::Source;
my $source = TAP::Parser::Source->new;
$source->raw( \'reference to raw TAP source' )
->config( \%config )
->merge( $boolean )
->switches( \@switches )
->test_args( \@args )
->assemble_meta;
do { ... } if $source->meta->{is_file};
# see assemble_meta for a full list of data available
=head1 DESCRIPTION
A TAP I<source> is something that produces a stream of TAP for the parser to
consume, such as an executable file, a text file, an archive, an IO handle, a
database, etc. C<TAP::Parser::Source>s encapsulate these I<raw> sources, and
provide some useful meta data about them. They are used by
L<TAP::Parser::SourceHandler>s, which do whatever is required to produce &
capture a stream of TAP from the I<raw> source, and package it up in a
L<TAP::Parser::Iterator> for the parser to consume.
Unless you're writing a new L<TAP::Parser::SourceHandler>, a plugin or
subclassing L<TAP::Parser>, you probably won't need to use this module directly.
=head1 METHODS
=head2 Class Methods
=head3 C<new>
my $source = TAP::Parser::Source->new;
Returns a new C<TAP::Parser::Source> object.
=cut
# new() implementation supplied by TAP::Object
sub _initialize {
my ($self) = @_;
$self->meta( {} );
$self->config( {} );
return $self;
}
##############################################################################
=head2 Instance Methods
=head3 C<raw>
my $raw = $source->raw;
$source->raw( $some_value );
Chaining getter/setter for the raw TAP source. This is a reference, as it may
contain large amounts of data (eg: raw TAP).
=head3 C<meta>
my $meta = $source->meta;
$source->meta({ %some_value });
Chaining getter/setter for meta data about the source. This defaults to an
empty hashref. See L</assemble_meta> for more info.
=head3 C<has_meta>
True if the source has meta data.
=head3 C<config>
my $config = $source->config;
$source->config({ %some_value });
Chaining getter/setter for the source's configuration, if any has been provided
by the user. How it's used is up to you. This defaults to an empty hashref.
See L</config_for> for more info.
=head3 C<merge>
my $merge = $source->merge;
$source->config( $bool );
Chaining getter/setter for the flag that dictates whether STDOUT and STDERR
should be merged (where appropriate). Defaults to undef.
=head3 C<switches>
my $switches = $source->switches;
$source->config([ @switches ]);
Chaining getter/setter for the list of command-line switches that should be
passed to the source (where appropriate). Defaults to undef.
=head3 C<test_args>
my $test_args = $source->test_args;
$source->config([ @test_args ]);
Chaining getter/setter for the list of command-line arguments that should be
passed to the source (where appropriate). Defaults to undef.
=cut
sub raw {
my $self = shift;
return $self->{raw} unless @_;
$self->{raw} = shift;
return $self;
}
sub meta {
my $self = shift;
return $self->{meta} unless @_;
$self->{meta} = shift;
return $self;
}
sub has_meta {
return scalar %{ shift->meta } ? 1 : 0;
}
sub config {
my $self = shift;
return $self->{config} unless @_;
$self->{config} = shift;
return $self;
}
sub merge {
my $self = shift;
return $self->{merge} unless @_;
$self->{merge} = shift;
return $self;
}
sub switches {
my $self = shift;
return $self->{switches} unless @_;
$self->{switches} = shift;
return $self;
}
sub test_args {
my $self = shift;
return $self->{test_args} unless @_;
$self->{test_args} = shift;
return $self;
}
=head3 C<assemble_meta>
my $meta = $source->assemble_meta;
Gathers meta data about the L</raw> source, stashes it in L</meta> and returns
it as a hashref. This is done so that the L<TAP::Parser::SourceHandler>s don't
have to repeat common checks. Currently this includes:
is_scalar => $bool,
is_hash => $bool,
is_array => $bool,
# for scalars:
length => $n
has_newlines => $bool
# only done if the scalar looks like a filename
is_file => $bool,
is_dir => $bool,
is_symlink => $bool,
file => {
# only done if the scalar looks like a filename
basename => $string, # including ext
dir => $string,
ext => $string,
lc_ext => $string,
# system checks
exists => $bool,
stat => [ ... ], # perldoc -f stat
empty => $bool,
size => $n,
text => $bool,
binary => $bool,
read => $bool,
write => $bool,
execute => $bool,
setuid => $bool,
setgid => $bool,
sticky => $bool,
is_file => $bool,
is_dir => $bool,
is_symlink => $bool,
# only done if the file's a symlink
lstat => [ ... ], # perldoc -f lstat
# only done if the file's a readable text file
shebang => $first_line,
}
# for arrays:
size => $n,
=cut
sub assemble_meta {
my ($self) = @_;
return $self->meta if $self->has_meta;
my $meta = $self->meta;
my $raw = $self->raw;
# rudimentary is object test - if it's blessed it'll
# inherit from UNIVERSAL
$meta->{is_object} = UNIVERSAL::isa( $raw, 'UNIVERSAL' ) ? 1 : 0;
if ( $meta->{is_object} ) {
$meta->{class} = ref($raw);
}
else {
my $ref = lc( ref($raw) );
$meta->{"is_$ref"} = 1;
}
if ( $meta->{is_scalar} ) {
my $source = $$raw;
$meta->{length} = length($$raw);
$meta->{has_newlines} = $$raw =~ /\n/ ? 1 : 0;
# only do file checks if it looks like a filename
if ( !$meta->{has_newlines} and $meta->{length} < 1024 ) {
my $file = {};
$file->{exists} = -e $source ? 1 : 0;
if ( $file->{exists} ) {
$meta->{file} = $file;
# avoid extra system calls (see `perldoc -f -X`)
$file->{stat} = [ stat(_) ];
$file->{empty} = -z _ ? 1 : 0;
$file->{size} = -s _;
$file->{text} = -T _ ? 1 : 0;
$file->{binary} = -B _ ? 1 : 0;
$file->{read} = -r _ ? 1 : 0;
$file->{write} = -w _ ? 1 : 0;
$file->{execute} = -x _ ? 1 : 0;
$file->{setuid} = -u _ ? 1 : 0;
$file->{setgid} = -g _ ? 1 : 0;
$file->{sticky} = -k _ ? 1 : 0;
$meta->{is_file} = $file->{is_file} = -f _ ? 1 : 0;
$meta->{is_dir} = $file->{is_dir} = -d _ ? 1 : 0;
# symlink check requires another system call
$meta->{is_symlink} = $file->{is_symlink}
= -l $source ? 1 : 0;
if ( $file->{is_symlink} ) {
$file->{lstat} = [ lstat(_) ];
}
# put together some common info about the file
( $file->{basename}, $file->{dir}, $file->{ext} )
= map { defined $_ ? $_ : '' }
fileparse( $source, qr/\.[^.]*/ );
$file->{lc_ext} = lc( $file->{ext} );
$file->{basename} .= $file->{ext} if $file->{ext};
if ( !$file->{is_dir} && $file->{read} ) {
eval { $file->{shebang} = $self->shebang($$raw); };
if ( my $e = $@ ) {
warn $e;
}
}
}
}
}
elsif ( $meta->{is_array} ) {
$meta->{size} = $#$raw + 1;
}
elsif ( $meta->{is_hash} ) {
; # do nothing
}
return $meta;
}
=head3 C<shebang>
Get the shebang line for a script file.
my $shebang = TAP::Parser::Source->shebang( $some_script );
May be called as a class method
=cut
{
# Global shebang cache.
my %shebang_for;
sub _read_shebang {
my ( $class, $file ) = @_;
open my $fh, '<', $file or die "Can't read $file: $!\n";
# Might be a binary file - so read a fixed number of bytes.
my $got = read $fh, my ($buf), BLK_SIZE;
defined $got or die "I/O error: $!\n";
return $1 if $buf =~ /(.*)/;
return;
}
sub shebang {
my ( $class, $file ) = @_;
$shebang_for{$file} = $class->_read_shebang($file)
unless exists $shebang_for{$file};
return $shebang_for{$file};
}
}
=head3 C<config_for>
my $config = $source->config_for( $class );
Returns L</config> for the $class given. Class names may be fully qualified
or abbreviated, eg:
# these are equivalent
$source->config_for( 'Perl' );
$source->config_for( 'TAP::Parser::SourceHandler::Perl' );
If a fully qualified $class is given, its abbreviated version is checked first.
=cut
sub config_for {
my ( $self, $class ) = @_;
my ($abbrv_class) = ( $class =~ /(?:\:\:)?(\w+)$/ );
my $config = $self->config->{$abbrv_class} || $self->config->{$class};
return $config;
}
1;
__END__
=head1 AUTHORS
Steve Purkis.
=head1 SEE ALSO
L<TAP::Object>,
L<TAP::Parser>,
L<TAP::Parser::IteratorFactory>,
L<TAP::Parser::SourceHandler>
=cut
|