File Coverage

inc/Test/Base.pm
Criterion Covered Total %
statement 224 364 61.5
branch 53 178 29.7
condition 18 74 24.3
subroutine 40 60 66.6
pod 0 26 0.0
total 335 702 47.7


line stmt bran cond sub pod time code
1             #line 1
2             # TODO:
3             #
4 2     2   1335 package Test::Base;
  2         6  
  2         114  
5 2     2   1288 use 5.006001;
  2         132  
  2         16  
6 2     2   22 use Spiffy 0.30 -Base;
  2     2   3  
  2     2   80  
  2         12  
  2         6  
  2         74  
  2         13  
  2         4  
  2         17  
7             use Spiffy ':XXX';
8             our $VERSION = '0.55';
9              
10             my @test_more_exports;
11 2     2   309 BEGIN {
12             @test_more_exports = qw(
13             ok isnt like unlike is_deeply cmp_ok
14             skip todo_skip pass fail
15             eq_array eq_hash eq_set
16             plan can_ok isa_ok diag
17             use_ok
18             $TODO
19             );
20             }
21 2     2   2193  
  2         7  
  2         23  
22 2     2   14 use Test::More import => \@test_more_exports;
  2         4  
  2         1133  
23             use Carp;
24              
25             our @EXPORT = (@test_more_exports, qw(
26             is no_diff
27              
28             blocks next_block first_block
29             delimiters spec_file spec_string
30             filters filters_delay filter_arguments
31             run run_compare run_is run_is_deeply run_like run_unlike
32             WWW XXX YYY ZZZ
33             tie_output no_diag_on_only
34              
35             find_my_self default_object
36              
37             croak carp cluck confess
38             ));
39              
40             field '_spec_file';
41             field '_spec_string';
42             field _filters => [qw(norm trim)];
43             field _filters_map => {};
44             field spec =>
45             -init => '$self->_spec_init';
46             field block_list =>
47             -init => '$self->_block_list_init';
48             field _next_list => [];
49             field block_delim =>
50             -init => '$self->block_delim_default';
51             field data_delim =>
52             -init => '$self->data_delim_default';
53             field _filters_delay => 0;
54             field _no_diag_on_only => 0;
55              
56             field block_delim_default => '===';
57             field data_delim_default => '---';
58              
59             my $default_class;
60             my $default_object;
61             my $reserved_section_names = {};
62 14     14 0 28  
63 14   66     78 sub default_object {
64 14         27 $default_object ||= $default_class->new;
65             return $default_object;
66             }
67              
68             my $import_called = 0;
69 2     2   17 sub import() {
70 2 50       15 $import_called = 1;
71             my $class = (grep /^-base$/i, @_)
72             ? scalar(caller)
73 2 50       8 : $_[0];
74 2         5 if (not defined $default_class) {
75             $default_class = $class;
76             }
77             # else {
78             # croak "Can't use $class after using $default_class"
79             # unless $default_class->isa($class);
80             # }
81 2 50       17  
82 2         4 unless (grep /^-base$/i, @_) {
83 2         9 my @args;
84 0 0       0 for (my $ii = 1; $ii <= $#_; ++$ii) {
85 0         0 if ($_[$ii] eq '-package') {
86             ++$ii;
87 0         0 } else {
88             push @args, $_[$ii];
89             }
90 2 50       7 }
91             Test::More->import(import => \@test_more_exports, @args)
92             if @args;
93             }
94 2         15
95 2         44 _strict_warnings();
96             goto &Spiffy::import;
97             }
98              
99             # Wrap Test::Builder::plan
100             my $plan_code = \&Test::Builder::plan;
101             my $Have_Plan = 0;
102 2     2   11 {
  2         3  
  2         13351  
103             no warnings 'redefine';
104 2     2   10 *Test::Builder::plan = sub {
105 2         14 $Have_Plan = 1;
106             goto &$plan_code;
107             };
108             }
109              
110             my $DIED = 0;
111             $SIG{__DIE__} = sub { $DIED = 1; die @_ };
112 8     8 0 12  
  8         18  
113 56     56 0 83 sub block_class { $self->find_class('Block') }
  56         138  
114             sub filter_class { $self->find_class('Filter') }
115 64     64 0 73  
116 64         81 sub find_class {
117 64         151 my $suffix = shift;
118 64 100       238 my $class = ref($self) . "::$suffix";
119 2         15 return $class if $class->can('new');
120 2 50       13 $class = __PACKAGE__ . "::$suffix";
121 2         131 return $class if $class->can('new');
122 2 50       25 eval "require $class";
123 0         0 return $class if $class->can('new');
124             die "Can't find a class for $suffix";
125             }
126 0     0 0 0  
127 0 0       0 sub check_late {
128 0         0 if ($self->{block_list}) {
129 0         0 my $caller = (caller(1))[3];
130 0         0 $caller =~ s/.*:://;
131             croak "Too late to call $caller()"
132             }
133             }
134              
135 14 50   14 0 82 sub find_my_self() {
136             my $self = ref($_[0]) eq $default_class
137             ? splice(@_, 0, 1)
138 14         54 : default_object();
139             return $self, @_;
140             }
141              
142 2     2 0 19 sub blocks() {
143             (my ($self), @_) = find_my_self(@_);
144 2 50       10  
145             croak "Invalid arguments passed to 'blocks'"
146 2 50 33     12 if @_ > 1;
147             croak sprintf("'%s' is invalid argument to blocks()", shift(@_))
148             if @_ && $_[0] !~ /^[a-zA-Z]\w*$/;
149 2         77  
150             my $blocks = $self->block_list;
151 2   50     30
152 0         0 my $section_name = shift || '';
153 2 50       27 my @blocks = $section_name
154             ? (grep { exists $_->{$section_name} } @$blocks)
155             : (@$blocks);
156 2 50       25  
157             return scalar(@blocks) unless wantarray;
158 0 0       0
159             return (@blocks) if $self->_filters_delay;
160 0         0  
161 0 0       0 for my $block (@blocks) {
162             $block->run_filters
163             unless $block->is_filtered;
164             }
165 0         0  
166             return (@blocks);
167             }
168              
169 0     0 0 0 sub next_block() {
170 0         0 (my ($self), @_) = find_my_self(@_);
171 0 0       0 my $list = $self->_next_list;
172 0         0 if (@$list == 0) {
  0         0  
173 0         0 $list = [@{$self->block_list}, undef];
174             $self->_next_list($list);
175 0         0 }
176 0 0 0     0 my $block = shift @$list;
177 0         0 if (defined $block and not $block->is_filtered) {
178             $block->run_filters;
179 0         0 }
180             return $block;
181             }
182              
183 0     0 0 0 sub first_block() {
184 0         0 (my ($self), @_) = find_my_self(@_);
185 0         0 $self->_next_list([]);
186             $self->next_block;
187             }
188              
189 0     0 0 0 sub filters_delay() {
190 0 0       0 (my ($self), @_) = find_my_self(@_);
191             $self->_filters_delay(defined $_[0] ? shift : 1);
192             }
193              
194 0     0 0 0 sub no_diag_on_only() {
195 0 0       0 (my ($self), @_) = find_my_self(@_);
196             $self->_no_diag_on_only(defined $_[0] ? shift : 1);
197             }
198              
199 0     0 0 0 sub delimiters() {
200 0         0 (my ($self), @_) = find_my_self(@_);
201 0         0 $self->check_late;
202 0   0     0 my ($block_delimiter, $data_delimiter) = @_;
203 0   0     0 $block_delimiter ||= $self->block_delim_default;
204 0         0 $data_delimiter ||= $self->data_delim_default;
205 0         0 $self->block_delim($block_delimiter);
206 0         0 $self->data_delim($data_delimiter);
207             return $self;
208             }
209              
210 0     0 0 0 sub spec_file() {
211 0         0 (my ($self), @_) = find_my_self(@_);
212 0         0 $self->check_late;
213 0         0 $self->_spec_file(shift);
214             return $self;
215             }
216              
217 0     0 0 0 sub spec_string() {
218 0         0 (my ($self), @_) = find_my_self(@_);
219 0         0 $self->check_late;
220 0         0 $self->_spec_string(shift);
221             return $self;
222             }
223              
224 2     2 0 13 sub filters() {
225 2 50       10 (my ($self), @_) = find_my_self(@_);
226 2         69 if (ref($_[0]) eq 'HASH') {
227             $self->_filters_map(shift);
228             }
229 0         0 else {
230 0         0 my $filters = $self->_filters;
231             push @$filters, @_;
232 2         6 }
233             return $self;
234             }
235              
236 0     0 0 0 sub filter_arguments() {
237             $Test::Base::Filter::arguments;
238             }
239 0     0 0 0  
240 0 0 0     0 sub have_text_diff {
  0         0  
  0         0  
241             eval { require Text::Diff; 1 } &&
242             $Text::Diff::VERSION >= 0.35 &&
243             $Algorithm::Diff::VERSION >= 1.15;
244             }
245              
246 8     8 0 26 sub is($$;$) {
247 8         19 (my ($self), @_) = find_my_self(@_);
248 8         23 my ($actual, $expected, $name) = @_;
249 8 50 33     142 local $Test::Builder::Level = $Test::Builder::Level + 1;
      33        
      33        
      33        
      33        
250             if ($ENV{TEST_SHOW_NO_DIFFS} or
251             not defined $actual or
252             not defined $expected or
253             $actual eq $expected or
254             not($self->have_text_diff) or
255             $expected !~ /\n./s
256 8         42 ) {
257             Test::More::is($actual, $expected, $name);
258             }
259 0 0       0 else {
260 0         0 $name = '' unless defined $name;
261             ok $actual eq $expected,
262             $name . "\n" . Text::Diff::diff(\$expected, \$actual);
263             }
264             }
265              
266 0     0 0 0 sub run(&;$) {
267 0         0 (my ($self), @_) = find_my_self(@_);
268 0         0 my $callback = shift;
  0         0  
269 0 0       0 for my $block (@{$self->block_list}) {
270 0         0 $block->run_filters unless $block->is_filtered;
  0         0  
271             &{$callback}($block);
272             }
273             }
274              
275 2     2   5 my $name_error = "Can't determine section names";
276 2 50       10 sub _section_names {
277 0 0       0 return @_ if @_ == 2;
278             my $block = $self->first_block
279 0         0 or croak $name_error;
280 0 0       0 my @names = grep {
281 0         0 $_ !~ /^(ONLY|LAST|SKIP)$/;
282 0 0       0 } @{$block->{_section_order}[0] || []};
283             croak "$name_error. Need two sections in first block"
284 0         0 unless @names == 2;
285             return @names;
286             }
287 2     2   3  
288 2 50       15 sub _assert_plan {
289             plan('no_plan') unless $Have_Plan;
290             }
291 2     2   8  
292 2 0 33     24 sub END {
      33        
293             run_compare() unless $Have_Plan or $DIED or not $import_called;
294             }
295              
296 0     0 0 0 sub run_compare() {
297 0         0 (my ($self), @_) = find_my_self(@_);
298 0         0 $self->_assert_plan;
299 0         0 my ($x, $y) = $self->_section_names(@_);
300 0         0 local $Test::Builder::Level = $Test::Builder::Level + 1;
  0         0  
301 0 0 0     0 for my $block (@{$self->block_list}) {
302 0 0       0 next unless exists($block->{$x}) and exists($block->{$y});
303 0 0       0 $block->run_filters unless $block->is_filtered;
    0          
304 0 0       0 if (ref $block->$x) {
305             is_deeply($block->$x, $block->$y,
306             $block->name ? $block->name : ());
307             }
308 0 0       0 elsif (ref $block->$y eq 'Regexp') {
309 0 0       0 my $regexp = ref $y ? $y : $block->$y;
310             like($block->$x, $regexp, $block->name ? $block->name : ());
311             }
312 0 0       0 else {
313             is($block->$x, $block->$y, $block->name ? $block->name : ());
314             }
315             }
316             }
317              
318 2     2 0 6 sub run_is() {
319 2         17 (my ($self), @_) = find_my_self(@_);
320 2         18 $self->_assert_plan;
321 2         6 my ($x, $y) = $self->_section_names(@_);
322 2         4 local $Test::Builder::Level = $Test::Builder::Level + 1;
  2         55  
323 8 50 33     53 for my $block (@{$self->block_list}) {
324 8 50       238 next unless exists($block->{$x}) and exists($block->{$y});
325 8 50       27 $block->run_filters unless $block->is_filtered;
326             is($block->$x, $block->$y,
327             $block->name ? $block->name : ()
328             );
329             }
330             }
331              
332 0     0 0 0 sub run_is_deeply() {
333 0         0 (my ($self), @_) = find_my_self(@_);
334 0         0 $self->_assert_plan;
335 0         0 my ($x, $y) = $self->_section_names(@_);
  0         0  
336 0 0 0     0 for my $block (@{$self->block_list}) {
337 0 0       0 next unless exists($block->{$x}) and exists($block->{$y});
338 0 0       0 $block->run_filters unless $block->is_filtered;
339             is_deeply($block->$x, $block->$y,
340             $block->name ? $block->name : ()
341             );
342             }
343             }
344              
345 0     0 0 0 sub run_like() {
346 0         0 (my ($self), @_) = find_my_self(@_);
347 0         0 $self->_assert_plan;
348 0         0 my ($x, $y) = $self->_section_names(@_);
  0         0  
349 0 0 0     0 for my $block (@{$self->block_list}) {
350 0 0       0 next unless exists($block->{$x}) and defined($y);
351 0 0       0 $block->run_filters unless $block->is_filtered;
352 0 0       0 my $regexp = ref $y ? $y : $block->$y;
353             like($block->$x, $regexp,
354             $block->name ? $block->name : ()
355             );
356             }
357             }
358              
359 0     0 0 0 sub run_unlike() {
360 0         0 (my ($self), @_) = find_my_self(@_);
361 0         0 $self->_assert_plan;
362 0         0 my ($x, $y) = $self->_section_names(@_);
  0         0  
363 0 0 0     0 for my $block (@{$self->block_list}) {
364 0 0       0 next unless exists($block->{$x}) and defined($y);
365 0 0       0 $block->run_filters unless $block->is_filtered;
366 0 0       0 my $regexp = ref $y ? $y : $block->$y;
367             unlike($block->$x, $regexp,
368             $block->name ? $block->name : ()
369             );
370             }
371             }
372 2     2   5  
373 2         4 sub _pre_eval {
374 2 50       17 my $spec = shift;
375             return $spec unless $spec =~
376 0         0 s/\A\s*<<<(.*?)>>>\s*$//sm;
377 0         0 my $eval_code = $1;
378 0 0       0 eval "package main; $eval_code";
379 0         0 croak $@ if $@;
380             return $spec;
381             }
382 2     2   5  
383 2         57 sub _block_list_init {
384 2         11 my $spec = $self->spec;
385 2         59 $spec = $self->_pre_eval($spec);
386 2         221 my $cd = $self->block_delim;
387 2         11 my @hunks = ($spec =~ /^(\Q${cd}\E.*?(?=^\Q${cd}\E|\z))/msg);
388 2         53 my $blocks = $self->_choose_blocks(@hunks);
389 2         4 $self->block_list($blocks); # Need to set early for possible filter use
390 2         7 my $seq = 1;
391 8         217 for my $block (@$blocks) {
392 8         182 $block->blocks_object($self);
393             $block->seq_num($seq++);
394 2         15 }
395             return $blocks;
396             }
397 2     2   7  
398 2         4 sub _choose_blocks {
399 2         16 my $blocks = [];
400 8         28 for my $hunk (@_) {
401 8 50       31 my $block = $self->_make_block($hunk);
402 0 0       0 if (exists $block->{ONLY}) {
403             diag "I found ONLY: maybe you're debugging?"
404 0         0 unless $self->_no_diag_on_only;
405             return [$block];
406 8 50       18 }
407 8         15 next if exists $block->{SKIP};
408 8 50       23 push @$blocks, $block;
409 0         0 if (exists $block->{LAST}) {
410             return $blocks;
411             }
412 2         6 }
413             return $blocks;
414             }
415 16     16   19  
416 16         20 sub _check_reserved {
417 16 50 33     96 my $id = shift;
418             croak "'$id' is a reserved name. Use something else.\n"
419             if $reserved_section_names->{$id} or
420             $id =~ /^_/;
421             }
422 8     8   10  
423 8         12 sub _make_block {
424 8         223 my $hunk = shift;
425 8         204 my $cd = $self->block_delim;
426 8         24 my $dd = $self->data_delim;
427 8 50       100 my $block = $self->block_class->new;
428 8         18 $hunk =~ s/\A\Q${cd}\E[ \t]*(.*)\s+// or die;
429 8         133 my $name = $1;
430 8         17 my @parts = split /^\Q${dd}\E +\(?(\w+)\)? *(.*)?\n/m, $hunk;
431 8   50     41 my $description = shift @parts;
432 8 50       22 $description ||= '';
433 8         12 unless ($description =~ /\S/) {
434             $description = $name;
435 8         48 }
436 8         24 $description =~ s/\s*\z//;
437             $block->set_value(description => $description);
438 8         9
439 8         13 my $section_map = {};
440 8         28 my $section_order = [];
441 16         38 while (@parts) {
442 16         41 my ($type, $filters, $value) = splice(@parts, 0, 3);
443 16 50       38 $self->_check_reserved($type);
444 16 50       30 $value = '' unless defined $value;
445 16 50       33 $filters = '' unless defined $filters;
446 0 0       0 if ($filters =~ /:(\s|\z)/) {
447             croak "Extra lines not allowed in '$type' section"
448 0         0 if $value =~ /\S/;
449 0 0       0 ($filters, $value) = split /\s*:(?:\s+|\z)/, $filters, 2;
450 0         0 $value = '' unless defined $value;
451             $value =~ s/^\s*(.*?)\s*$/$1/;
452 16         71 }
453             $section_map->{$type} = {
454             filters => $filters,
455 16         30 };
456 16         42 push @$section_order, $type;
457             $block->set_value($type, $value);
458 8         21 }
459 8         20 $block->set_value(name => $name);
460 8         20 $block->set_value(_section_map => $section_map);
461 8         22 $block->set_value(_section_order => $section_order);
462             return $block;
463             }
464 2     2   5  
465 2 50       55 sub _spec_init {
466             return $self->_spec_string
467 2         8 if $self->_spec_string;
468 2         6 local $/;
469 2 50       77 my $spec;
470 0 0       0 if (my $spec_file = $self->_spec_file) {
471 0         0 open FILE, $spec_file or die $!;
472 0         0 $spec = ;
473             close FILE;
474             }
475 2         4 else {
476             $spec = do {
477 2     2   16 package main;
  2         4  
  2         998  
478 2         49 no warnings 'once';
479             ;
480             };
481 2         20 }
482             return $spec;
483             }
484              
485 2     2   13 sub _strict_warnings() {
486 2         1301 require Filter::Util::Call;
487             my $done = 0;
488             Filter::Util::Call::filter_add(
489 2 50   2   7 sub {
490 2         5 return 0 if $done;
491 2         25 my ($data, $end) = ('', '');
492 28 50       54 while (my $status = Filter::Util::Call::filter_read()) {
493 28 100       57 return $status if $status < 0;
494 2         4 if (/^__(?:END|DATA)__\r?$/) {
495 2         5 $end = $_;
496             last;
497 26         35 }
498 26         77 $data .= $_;
499             $_ = '';
500 2         6 }
501 2         46 $_ = "use strict;use warnings;$data$end";
502             $done = 1;
503 2         20 }
504             );
505             }
506              
507 0     0 0 0 sub tie_output() {
508 0 0       0 my $handle = shift;
509 0         0 die "No buffer to tie" unless @_;
510             tie $handle, 'Test::Base::Handle', $_[0];
511             }
512 0     0 0 0  
513 0         0 sub no_diff {
514             $ENV{TEST_SHOW_NO_DIFFS} = 1;
515             }
516              
517             package Test::Base::Handle;
518              
519 0     0   0 sub TIEHANDLE() {
520 0         0 my $class = shift;
521             bless \ $_[0], $class;
522             }
523 0     0   0  
524 0         0 sub PRINT {
525             $$self .= $_ for @_;
526             }
527              
528             #===============================================================================
529             # Test::Base::Block
530             #
531             # This is the default class for accessing a Test::Base block object.
532             #===============================================================================
533             package Test::Base::Block;
534             our @ISA = qw(Spiffy);
535              
536             our @EXPORT = qw(block_accessor);
537 0     0   0  
538 0         0 sub AUTOLOAD {
539             return;
540             }
541              
542 12     12   20 sub block_accessor() {
543 2     2   13 my $accessor = shift;
  2         10  
  2         403  
544 12 50       50 no strict 'refs';
545             return if defined &$accessor;
546 64     64   76 *$accessor = sub {
547 64 50       135 my $self = shift;
548 0         0 if (@_) {
549             Carp::croak "Not allowed to set values for '$accessor'";
550 64 50       70 }
  64         219  
551             my @list = @{$self->{$accessor} || []};
552 64 100       243 return wantarray
553             ? (@list)
554 12         79 : $list[0];
555             };
556             }
557              
558             block_accessor 'name';
559             block_accessor 'description';
560             Spiffy::field 'seq_num';
561             Spiffy::field 'is_filtered';
562             Spiffy::field 'blocks_object';
563             Spiffy::field 'original_values' => {};
564 112     112   131  
565 2     2   11 sub set_value {
  2         6  
  2         470  
566 112         130 no strict 'refs';
567 112 100       331 my $accessor = shift;
568             block_accessor $accessor
569 112         528 unless defined &$accessor;
570             $self->{$accessor} = [@_];
571             }
572 8     8   12  
573 8         22 sub run_filters {
574 8         28 my $map = $self->_section_map;
575 8 50       194 my $order = $self->_section_order;
576             Carp::croak "Attempt to filter a block twice"
577 8         18 if $self->is_filtered;
578 16         42 for my $type (@$order) {
579 16         51 my $filters = $map->{$type}{filters};
580 16         444 my @value = $self->$type;
581 16         47 $self->original_values->{$type} = $value[0];
582 64 50       155 for my $filter ($self->_get_filters($type, $filters)) {
583             $Test::Base::Filter::arguments =
584 64         102 $filter =~ s/=(.*)$// ? $1 : undef;
585 2     2   13 my $function = "main::$filter";
  2         5  
  2         1227  
586 64 100       276 no strict 'refs';
587 8         27 if (defined &$function) {
588 8         11 local $_ = join '', @value;
589 8         48 my $old = $_;
590 8 50 33     279 @value = &$function(@value);
      33        
591             if (not(@value) or
592             @value == 1 and $value[0] =~ /\A(\d+|)\z/
593 0 0 0     0 ) {
594 0         0 if ($value[0] && $_ eq $old) {
595             Test::Base::diag("Filters returning numbers are supposed to do munging \$_: your filter '$function' apparently doesn't.");
596 0         0 }
597             @value = ($_);
598             }
599             }
600 56         1654 else {
601 56 50       173 my $filter_object = $self->blocks_object->filter_class->new;
602             die "Can't find a function or method for '$filter' filter\n"
603 56         1377 unless $filter_object->can($filter);
604 56         182 $filter_object->current_block($self);
605             @value = $filter_object->$filter(@value);
606             }
607             # Set the value after each filter since other filters may be
608 64         166 # introspecting.
609             $self->set_value($type, @value);
610             }
611 8         230 }
612             $self->is_filtered(1);
613             }
614 16     16   26  
615 16         24 sub _get_filters {
616 16   50     63 my $type = shift;
617 16         75 my $string = shift || '';
618 16         32 $string =~ s/\s*(.*?)\s*/$1/;
619 16   50     400 my @filters = ();
620 16 50       84 my $map_filters = $self->blocks_object->_filters_map->{$type} || [];
621 16         36 $map_filters = [ $map_filters ] unless ref $map_filters;
622 16         19 my @append = ();
623 16         416 for (
624             @{$self->blocks_object->_filters},
625             @$map_filters,
626             split(/\s+/, $string),
627 64         67 ) {
628 64 50       117 my $filter = $_;
629 64 50       148 last unless length $filter;
    50          
630 0         0 if ($filter =~ s/^-//) {
  0         0  
631             @filters = grep { $_ ne $filter } @filters;
632             }
633 0         0 elsif ($filter =~ s/^\+//) {
634             push @append, $filter;
635             }
636 64         123 else {
637             push @filters, $filter;
638             }
639 16         68 }
640             return @filters, @append;
641             }
642              
643             {
644             %$reserved_section_names = map {
645             ($_, 1);
646             } keys(%Test::Base::Block::), qw( new DESTROY );
647             }
648              
649             __DATA__