File Coverage

inc/Spiffy.pm
Criterion Covered Total %
statement 212 437 48.5
branch 49 202 24.2
condition 25 62 40.3
subroutine 36 61 59.0
pod 8 27 29.6
total 330 789 41.8


line stmt bran cond sub pod time code
1             #line 1
2 5     5   24 package Spiffy;
  5         10  
  5         175  
3 5     5   81 use strict;
  5         15  
  5         170  
4 5     5   24 use 5.006001;
  5         8  
  5         144  
5 5     5   26 use warnings;
  5         8  
  5         2041  
6             use Carp;
7             require Exporter;
8             our $VERSION = '0.30';
9             our @EXPORT = ();
10             our @EXPORT_BASE = qw(field const stub super);
11             our @EXPORT_OK = (@EXPORT_BASE, qw(id WWW XXX YYY ZZZ));
12             our %EXPORT_TAGS = (XXX => [qw(WWW XXX YYY ZZZ)]);
13              
14             my $stack_frame = 0;
15             my $dump = 'yaml';
16             my $bases_map = {};
17              
18             sub WWW; sub XXX; sub YYY; sub ZZZ;
19              
20             # This line is here to convince "autouse" into believing we are autousable.
21 0 0 0 0 0 0 sub can {
22             ($_[1] eq 'import' and caller()->isa('autouse'))
23             ? \&Exporter::import # pacify autouse's equality test
24             : $_[0]->SUPER::can($_[1]) # normal case
25             }
26              
27             # TODO
28             #
29             # Exported functions like field and super should be hidden so as not to
30             # be confused with methods that can be inherited.
31             #
32              
33 4     4 0 12 sub new {
34 4   33     23 my $class = shift;
35 4         13 $class = ref($class) || $class;
36 4         19 my $self = bless {}, $class;
37 0         0 while (@_) {
38 0         0 my $method = shift;
39             $self->$method(shift);
40 4         35 }
41             return $self;
42             }
43              
44             my $filtered_files = {};
45             my $filter_dump = 0;
46             my $filter_save = 0;
47             our $filter_result = '';
48 5     5   24 sub import {
  5         10  
  5         136  
49 5     5   24 no strict 'refs';
  5         9  
  5         6122  
50 15     15   201 no warnings;
51             my $self_package = shift;
52              
53             # XXX Using parse_arguments here might cause confusion, because the
54             # subclass's boolean_arguments and paired_arguments can conflict, causing
55 15         27 # difficult debugging. Consider using something truly local.
56             my ($args, @export_list) = do {
57 15     15   5052 local *boolean_arguments = sub {
58             qw(
59             -base -Base -mixin -selfless
60             -XXX -dumper -yaml
61             -filter_dump -filter_save
62 15         2142 )
63 15     15   60 };
  15         33  
64 15         180 local *paired_arguments = sub { qw(-package) };
65             $self_package->parse_arguments(@_);
66 15 50       72 };
67             return spiffy_mixin_import(scalar(caller(0)), $self_package, @export_list)
68             if $args->{-mixin};
69 15 50       46  
70 15 50       49 $filter_dump = 1 if $args->{-filter_dump};
71 15 50       41 $filter_save = 1 if $args->{-filter_save};
72 15 50       41 $dump = 'yaml' if $args->{-yaml};
73             $dump = 'dumper' if $args->{-dumper};
74 15         59  
75             local @EXPORT_BASE = @EXPORT_BASE;
76 15 50       60  
77 0 0       0 if ($args->{-XXX}) {
  0         0  
78             push @EXPORT_BASE, @{$EXPORT_TAGS{XXX}}
79             unless grep /^XXX$/, @EXPORT_BASE;
80             }
81              
82 15 100 66     159 spiffy_filter()
      66        
83             if ($args->{-selfless} or $args->{-Base}) and
84             not $filtered_files->{(caller($stack_frame))[1]}++;
85 15   33     175  
86 15 100 66     102 my $caller_package = $args->{-package} || caller($stack_frame);
  5         63  
87             push @{"$caller_package\::ISA"}, $self_package
88             if $args->{-Base} or $args->{-base};
89 15         32  
  15         46  
90 20 50       159 for my $class (@{all_my_bases($self_package)}) {
91 275         1393 next unless $class->isa('Spiffy');
92 275         270 my @export = grep {
  20         213  
93 5         23 not defined &{"$caller_package\::$_"};
94             } ( @{"$class\::EXPORT"},
95 20 100 66     37 ($args->{-Base} or $args->{-base})
96             ? @{"$class\::EXPORT_BASE"} : (),
97 135         527 );
98 135         127 my @export_ok = grep {
  20         80  
99 20         33 not defined &{"$caller_package\::$_"};
100             } @{"$class\::EXPORT_OK"};
101              
102             # Avoid calling the expensive Exporter::export
103 20         42 # if there is nothing to do (optimization)
  370         650  
104 20 50       92 my %exportable = map { ($_, 1) } @export, @export_ok;
105             next unless keys %exportable;
106 20         39  
  20         83  
107 20         27 my @export_save = @{"$class\::EXPORT"};
  20         80  
108 20         39 my @export_ok_save = @{"$class\::EXPORT_OK"};
  20         95  
109 20         43 @{"$class\::EXPORT"} = @export;
  20         72  
110 5         36 @{"$class\::EXPORT_OK"} = @export_ok;
111 20         44 my @list = grep {
112 5 50       31 (my $v = $_) =~ s/^[\!\:]//;
  0         0  
113             $exportable{$v} or ${"$class\::EXPORT_TAGS"}{$v};
114 20         2877 } @export_list;
115 20         44 Exporter::export($class, $caller_package, @list);
  20         263  
116 20         41 @{"$class\::EXPORT"} = @export_save;
  20         648  
117             @{"$class\::EXPORT_OK"} = @export_ok_save;
118             }
119             }
120              
121 5     5 0 5437 sub spiffy_filter {
122 5         19981 require Filter::Util::Call;
123             my $done = 0;
124             Filter::Util::Call::filter_add(
125 5 50   5   21 sub {
126 5         10 return 0 if $done;
127 5         102 my ($data, $end) = ('', '');
128 3370 50       12393 while (my $status = Filter::Util::Call::filter_read()) {
129 3370 100       6692 return $status if $status < 0;
130 5         20 if (/^__(?:END|DATA)__\r?$/) {
131 5         17 $end = $_;
132             last;
133 3365         3731 }
134 3365         12171 $data .= $_;
135             $_ = '';
136 5         10 }
137 5         10 $_ = $data;
138 5         1219 my @my_subs;
139             s[^(sub\s+\w+\s+\{)(.*\n)]
140 5         3080 [${1}my \$self = shift;$2]gm;
141             s[^(sub\s+\w+)\s*\(\s*\)(\s+\{.*\n)]
142 5         462 [${1}${2}]gm;
143 0         0 s[^my\s+sub\s+(\w+)(\s+\{)(.*)((?s:.*?\n))\}\n]
  0         0  
144 5         17 [push @my_subs, $1; "\$$1 = sub$2my \$self = shift;$3$4\};\n"]gem;
145 5 50       32 my $preclare = '';
146 0         0 if (@my_subs) {
147 0         0 $preclare = join ',', map "\$$_", @my_subs;
148             $preclare = "my($preclare);";
149 5         214 }
150 5 50       78 $_ = "use strict;use warnings;$preclare${_};1;\n$end";
  0         0  
  0         0  
151 5 50       22 if ($filter_dump) { print; exit }
  0         0  
  0         0  
152 5         501 if ($filter_save) { $filter_result = $_; $_ = $filter_result; }
153             $done = 1;
154 5         46 }
155             );
156             }
157              
158 0     0 0 0 sub base {
159 0         0 push @_, -base;
160             goto &import;
161             }
162              
163 20     20 0 39 sub all_my_bases {
164             my $class = shift;
165 20 100       90  
166             return $bases_map->{$class}
167             if defined $bases_map->{$class};
168 10         24  
169 5     5   37 my @bases = ($class);
  5         19  
  5         1251  
170 10         19 no strict 'refs';
  10         47  
171 5         12 for my $base_class (@{"${class}::ISA"}) {
  5         27  
172             push @bases, @{all_my_bases($base_class)};
173 10         19 }
174 10         23 my $used = {};
  15         84  
175             $bases_map->{$class} = [grep {not $used->{$_}++} @bases];
176             }
177              
178             my %code = (
179             sub_start =>
180             "sub {\n",
181             set_default =>
182             " \$_[0]->{%s} = %s\n unless exists \$_[0]->{%s};\n",
183             init =>
184             " return \$_[0]->{%s} = do { my \$self = \$_[0]; %s }\n" .
185             " unless \$#_ > 0 or defined \$_[0]->{%s};\n",
186             weak_init =>
187             " return do {\n" .
188             " \$_[0]->{%s} = do { my \$self = \$_[0]; %s };\n" .
189             " Scalar::Util::weaken(\$_[0]->{%s}) if ref \$_[0]->{%s};\n" .
190             " \$_[0]->{%s};\n" .
191             " } unless \$#_ > 0 or defined \$_[0]->{%s};\n",
192             return_if_get =>
193             " return \$_[0]->{%s} unless \$#_ > 0;\n",
194             set =>
195             " \$_[0]->{%s} = \$_[1];\n",
196             weaken =>
197             " Scalar::Util::weaken(\$_[0]->{%s}) if ref \$_[0]->{%s};\n",
198             sub_end =>
199             " return \$_[0]->{%s};\n}\n",
200             );
201              
202 85     85 1 168 sub field {
203 85         97 my $package = caller;
204 5     5   23 my ($args, @values) = do {
  5         9  
  5         1933  
205 85     85   347 no warnings;
  85         150  
206 85     85   265 local *boolean_arguments = sub { (qw(-weak)) };
  85         171  
207 85         258 local *paired_arguments = sub { (qw(-package -init)) };
208             Spiffy->parse_arguments(@_);
209 85         167 };
210 85 50       234 my ($field, $default) = @values;
211 85 50 66     299 $package = $args->{-package} if defined $args->{-package};
212             die "Cannot have a default for a weakened field ($field)"
213 85 50       115 if defined $default && $args->{-weak};
  85         475  
214 85 50       193 return if defined &{"${package}::$field"};
215 85 100 100     515 require Scalar::Util if $args->{-weak};
    100 66        
216             my $default_string =
217             ( ref($default) eq 'ARRAY' and not @$default )
218             ? '[]'
219             : (ref($default) eq 'HASH' and not keys %$default )
220             ? '{}'
221             : default_as_code($default);
222 85         138  
223 85 100       243 my $code = $code{sub_start};
224 20 50       51 if ($args->{-init}) {
225 20         100 my $fragment = $args->{-weak} ? $code{weak_init} : $code{init};
226             $code .= sprintf $fragment, $field, $args->{-init}, ($field) x 4;
227 85 100       260 }
228             $code .= sprintf $code{set_default}, $field, $default_string, $field
229 85         226 if defined $default;
230 85         169 $code .= sprintf $code{return_if_get}, $field;
231 85 50       193 $code .= sprintf $code{set}, $field;
232             $code .= sprintf $code{weaken}, $field, $field
233 85         172 if $args->{-weak};
234             $code .= sprintf $code{sub_end}, $field;
235 85 0 0 0   10143  
  0 0 0     0  
  0 0 0     0  
  0 0 0     0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0 0       0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
  0         0  
236 85 50       223 my $sub = eval $code;
237 5     5   26 die $@ if $@;
  5         15  
  5         1146  
238 85         102 no strict 'refs';
  85         428  
239 85 50       382 *{"${package}::$field"} = $sub;
240             return $code if defined wantarray;
241             }
242              
243 70     70 0 6678 sub default_as_code {
244 70         64234 require Data::Dumper;
245 70         180 local $Data::Dumper::Sortkeys = 1;
246 70         3690 my $code = Data::Dumper::Dumper(shift);
247 70         188 $code =~ s/^\$VAR1 = //;
248 70         168 $code =~ s/;$//;
249             return $code;
250             }
251              
252 0     0 1 0 sub const {
253 0         0 my $package = caller;
254 5     5   26 my ($args, @values) = do {
  5         8  
  5         568  
255 0     0   0 no warnings;
  0         0  
256 0         0 local *paired_arguments = sub { (qw(-package)) };
257             Spiffy->parse_arguments(@_);
258 0         0 };
259 0 0       0 my ($field, $default) = @values;
260 5     5   25 $package = $args->{-package} if defined $args->{-package};
  5         12  
  5         604  
261 0 0       0 no strict 'refs';
  0         0  
262 0     0   0 return if defined &{"${package}::$field"};
  0         0  
263 0         0 *{"${package}::$field"} = sub { $default }
264             }
265              
266 0     0 1 0 sub stub {
267 0         0 my $package = caller;
268 5     5   25 my ($args, @values) = do {
  5         9  
  5         520  
269 0     0   0 no warnings;
  0         0  
270 0         0 local *paired_arguments = sub { (qw(-package)) };
271             Spiffy->parse_arguments(@_);
272 0         0 };
273 0 0       0 my ($field, $default) = @values;
274 5     5   26 $package = $args->{-package} if defined $args->{-package};
  5         7  
  5         2473  
275 0 0       0 no strict 'refs';
  0         0  
276 0         0 return if defined &{"${package}::$field"};
277             *{"${package}::$field"} =
278 0     0   0 sub {
279 0         0 require Carp;
280             Carp::confess
281             "Method $field in package $package must be subclassed";
282 0         0 }
283             }
284              
285 100     100 1 146 sub parse_arguments {
286 100         209 my $class = shift;
287 100         278 my ($args, @values) = ({}, ());
  220         606  
288 100         293 my %booleans = map { ($_, 1) } $class->boolean_arguments;
  185         472  
289 100         281 my %pairs = map { ($_, 1) } $class->paired_arguments;
290 155         199 while (@_) {
291 155 100 66     1270 my $elem = shift;
    100 66        
      66        
292 5 50 33     60 if (defined $elem and defined $booleans{$elem}) {
293             $args->{$elem} = (@_ and $_[0] =~ /^[01]$/)
294             ? shift
295             : 1;
296             }
297 20         75 elsif (defined $elem and defined $pairs{$elem} and @_) {
298             $args->{$elem} = shift;
299             }
300 130         366 else {
301             push @values, $elem;
302             }
303 100 50       1011 }
304             return wantarray ? ($args, @values) : $args;
305             }
306 0     0 1 0  
307 0     0 1 0 sub boolean_arguments { () }
308             sub paired_arguments { () }
309              
310             # get a unique id for any node
311 0 0   0 0 0 sub id {
312 0 0       0 if (not ref $_[0]) {
313 0 0       0 return 'undef' if not defined $_[0];
314 0         0 \$_[0] =~ /\((\w+)\)$/o or die;
315             return "$1-S";
316 0         0 }
317 0 0       0 require overload;
318 0         0 overload::StrVal($_[0]) =~ /\((\w+)\)$/o or die;
319             return $1;
320             }
321              
322             #===============================================================================
323             # It's super, man.
324             #===============================================================================
325             package DB;
326 5     5   26 {
  5         7  
  5         1183  
327             no warnings 'redefine';
328 0 0   0 0 0 sub super_args {
329 0         0 my @dummy = caller(@_ ? $_[0] : 2);
330             return @DB::args;
331             }
332             }
333              
334             package Spiffy;
335 0     0 1 0 sub super {
336 0         0 my $method;
337 0         0 my $frame = 1;
338 0 0       0 while ($method = (caller($frame++))[3]) {
339             $method =~ s/.*::// and last;
340 0         0 }
341 0 0       0 my @args = DB::super_args($frame);
342 0 0       0 @_ = @_ ? ($args[0], @_) : @args;
343 0         0 my $class = ref $_[0] ? ref $_[0] : $_[0];
344 0         0 my $caller_class = caller;
345 0 0 0     0 my $seen = 0;
346 0         0 my @super_classes = reverse grep {
347 0         0 ($seen or $seen = ($_ eq $caller_class)) ? 0 : 1;
348 0         0 } reverse @{all_my_bases($class)};
349 5     5   23 for my $super_class (@super_classes) {
  5         10  
  5         936  
350 0 0       0 no strict 'refs';
351 0 0       0 next if $super_class eq $class;
  0         0  
352 0 0       0 if (defined &{"${super_class}::$method"}) {
  0         0  
  0         0  
353             ${"$super_class\::AUTOLOAD"} = ${"$class\::AUTOLOAD"}
354 0         0 if $method eq 'AUTOLOAD';
  0         0  
355             return &{"${super_class}::$method"};
356             }
357 0         0 }
358             return;
359             }
360              
361             #===============================================================================
362             # This code deserves a spanking, because it is being very naughty.
363             # It is exchanging base.pm's import() for its own, so that people
364             # can use base.pm with Spiffy modules, without being the wiser.
365             #===============================================================================
366             my $real_base_import;
367             my $real_mixin_import;
368              
369 5 50   5   40 BEGIN {
370 5   50     103 require base unless defined $INC{'base.pm'};
371 5         10 $INC{'mixin.pm'} ||= 'Spiffy/mixin.pm';
372 5         14 $real_base_import = \&base::import;
373 5     5   41 $real_mixin_import = \&mixin::import;
  5         14  
  5         295  
374 5         80 no warnings;
375 5         225 *base::import = \&spiffy_base_import;
376             *mixin::import = \&spiffy_mixin_import;
377             }
378              
379             # my $i = 0;
380             # while (my $caller = caller($i++)) {
381             # next unless $caller eq 'base' or $caller eq 'mixin';
382             # croak <
383             # Spiffy.pm must be loaded before calling 'use base' or 'use mixin' with a
384             # Spiffy module. See the documentation of Spiffy.pm for details.
385             # END
386             # }
387              
388 17     17 0 82620 sub spiffy_base_import {
389 17         40 my @base_classes = @_;
390 5     5   26 shift @base_classes;
  5         9  
  5         1570  
391 17         123 no strict 'refs';
392             goto &$real_base_import
393 17 50       48 unless grep {
  17 50       31  
394 17         7075 eval "require $_" unless %{"$_\::"};
395             $_->isa('Spiffy');
396 0           } @base_classes;
397 0           my $inheritor = caller(0);
398 0 0         for my $base_class (@base_classes) {
399 0 0         next if $inheritor->isa($base_class);
400             croak "Can't mix Spiffy and non-Spiffy classes in 'use base'.\n",
401             "See the documentation of Spiffy.pm for details\n "
402 0           unless $base_class->isa('Spiffy');
403 0           $stack_frame = 1; # tell import to use different caller
404 0           import($base_class, '-base');
405             $stack_frame = 0;
406             }
407             }
408              
409 0     0 1   sub mixin {
410 0           my $self = shift;
411 0           my $target_class = ref($self);
412             spiffy_mixin_import($target_class, @_)
413             }
414              
415 0     0 0   sub spiffy_mixin_import {
416 0 0         my $target_class = shift;
417             $target_class = caller(0)
418 0 0         if $target_class eq 'mixin';
419             my $mixin_class = shift
420 0           or die "Nothing to mixin";
421 0           eval "require $mixin_class";
422 0           my @roles = @_;
423 0           my $pseudo_class = join '-', $target_class, $mixin_class, @roles;
424 5     5   28 my %methods = spiffy_mixin_methods($mixin_class, @roles);
  5         9  
  5         201  
425 5     5   46 no strict 'refs';
  5         16  
  5         711  
426 0           no warnings;
  0            
  0            
427 0           @{"$pseudo_class\::ISA"} = @{"$target_class\::ISA"};
  0            
428 0           @{"$target_class\::ISA"} = ($pseudo_class);
429 0           for (keys %methods) {
  0            
430             *{"$pseudo_class\::$_"} = $methods{$_};
431             }
432             }
433              
434 0     0 0   sub spiffy_mixin_methods {
435 5     5   23 my $mixin_class = shift;
  5         36  
  5         2165  
436 0           no strict 'refs';
437 0           my %methods = spiffy_all_methods($mixin_class);
438 0 0         map {
439 0           $methods{$_}
440 0 0         ? ($_, \ &{"$methods{$_}\::$_"})
441             : ($_, \ &{"$mixin_class\::$_"})
442             } @_
443             ? (get_roles($mixin_class, @_))
444             : (keys %methods);
445             }
446              
447 0     0 0   sub get_roles {
448 0           my $mixin_class = shift;
449 0           my @roles = @_;
450 0           while (grep /^!*:/, @roles) {
451 0           @roles = map {
452             s/!!//g;
453 0           /^!:(.*)/ ? do {
454 0           my $m = "_role_$1";
455             map("!$_", $mixin_class->$m);
456 0 0         } :
    0          
457 0           /^:(.*)/ ? do {
458 0           my $m = "_role_$1";
459             ($mixin_class->$m);
460             } :
461             ($_)
462             } @roles;
463 0 0 0       }
464 0           if (@roles and $roles[0] =~ /^!/) {
465 0           my %methods = spiffy_all_methods($mixin_class);
466             unshift @roles, keys(%methods);
467 0           }
468 0           my %roles;
469 0           for (@roles) {
470 0 0         s/!!//g;
471             delete $roles{$1}, next
472 0           if /^!(.*)/;
473             $roles{$_} = 1;
474 0           }
475             keys %roles;
476             }
477              
478 5     5   26 sub spiffy_all_methods {
  5         7  
  5         17099  
479 0     0 0   no strict 'refs';
480 0 0         my $class = shift;
481 0           return if $class eq 'Spiffy';
482 0           my %methods = map {
483             ($_, $class)
484 0 0         } grep {
  0            
485 0           defined &{"$class\::$_"} and not /^_/
486 0           } keys %{"$class\::"};
487 0           my %super_methods;
  0            
488 0 0         %super_methods = spiffy_all_methods(${"$class\::ISA"}[0])
489 0           if @{"$class\::ISA"};
  0            
490             %{{%super_methods, %methods}};
491             }
492              
493              
494             # END of naughty code.
495             #===============================================================================
496             # Debugging support
497             #===============================================================================
498 5     5   35 sub spiffy_dump {
  5         9  
  5         1791  
499 0 0   0 0   no warnings;
500 0           if ($dump eq 'dumper') {
501 0           require Data::Dumper;
502 0           $Data::Dumper::Sortkeys = 1;
503 0           $Data::Dumper::Indent = 1;
504             return Data::Dumper::Dumper(@_);
505 0           }
506 0           require YAML;
507 0           $YAML::UseVersion = 0;
508             return YAML::Dump(@_) . "...\n";
509             }
510              
511 0     0 0   sub at_line_number {
512 0           my ($file_path, $line_number) = (caller(1))[1,2];
513             " at $file_path line $line_number\n";
514             }
515              
516 0     0 0   sub WWW {
517 0 0         warn spiffy_dump(@_) . at_line_number;
518             return wantarray ? @_ : $_[0];
519             }
520              
521 0     0 0   sub XXX {
522             die spiffy_dump(@_) . at_line_number;
523             }
524              
525 0     0 0   sub YYY {
526 0 0         print spiffy_dump(@_) . at_line_number;
527             return wantarray ? @_ : $_[0];
528             }
529              
530 0     0 0   sub ZZZ {
531 0           require Carp;
532             Carp::confess spiffy_dump(@_);
533             }
534              
535             1;
536              
537             __END__