blib/lib/Data/Show.pm

filter: Statementstmt 85.4% 288 / 337 Branchbran 59.8% 73 / 122 Conditioncond 38.9% 30 / 77 MC/DCmcdc 13.3% 6 / 45 Subroutinesub 91.3% 53 / 58 Podpod 33.3% 1 / 3 totaltotal 70.2% 451 / 642 CC 100 SCAR 24.3
CC
100
Cov
73%
_open_target
26.5
_load_plugin
22.9
show
22.8
CRAP 11.4
↑ Summary
1 package Data::Show;
2  
3 =encoding utf-8
4 =cut
5  
6 12 ▶use 5.010;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 12 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 11 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 11 ▶use utf8;
Subroutine BEGIN: called CC=1 SCAR=0.0
10 11 ▶use PPR;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 11 our $VERSION = '0.004002';
13  
14 # Be a ninja...
15 11 our @CARP_NOT;
16  
17 # Useful pieces of information...
18 11 ▶my $IS_UTF8_TERM; BEGIN { $IS_UTF8_TERM = grep {$_ && /utf-8/i} @ENV{qw<LC_ALL LC_TYPE LANG>}; }
Subroutine BEGIN: called CC=2 SCAR=7.0
Condition66%2/3
$_ && /utf-8/i
!ll&&!rl&&r
3201
MC/DC50%1/2
$_ && /utf-8/i
$_ /utf-8/i
Truth table66%2/3
A && B
A= $_B= /utf-8/i
ABresult
0X0
100
111
19 11 ▶my $IS_LIGHT_BG; BEGIN { $IS_LIGHT_BG = ($ENV{COLORFGBG} // q{}) =~ m{\A 0;15 \z}x; }
Subroutine BEGIN: called CC=2 SCAR=7.6
Condition50%1/2
$ENV{"COLORFGBG"} // ""
l!l
011
MC/DC0%0/1
$ENV{"COLORFGBG"} // ""
$ENV{"COLORFGBG"}
Truth table50%1/2
A
A= $ENV{"COLORFGBG"}
Aresult
11
00
20 11 ▶my $CAN_ANSICOLOR; BEGIN { $CAN_ANSICOLOR = eval { require Term::ANSIColor; 1 } ? 1 : 0; }
Subroutine BEGIN: called CC=2 SCAR=7.0
Branch: 1 branch
BranchTrueFalseTotal
eval { do { require Term::ANSIColor; 1 } } ? : 11 0 11
21  
22 # Various defaults...
23 11 ▶my $MAXWIDTH; BEGIN { $MAXWIDTH = 78; }
Subroutine BEGIN: called CC=1 SCAR=0.0
24 11 ▶my $INITIAL_DEFAULT_PLUGIN; BEGIN { $INITIAL_DEFAULT_PLUGIN = 'Data::Show::Plugin::Data::Pretty'; }
Subroutine BEGIN: called CC=1 SCAR=0.0
25 11 ▶my $FINAL_CANDIDATE_PLUGIN; BEGIN { $FINAL_CANDIDATE_PLUGIN = 'Data::Show::Plugin'; }
Subroutine BEGIN: called CC=1 SCAR=0.0
26 11 ▶my $DEFAULT_TARGET; BEGIN { $DEFAULT_TARGET = \*STDERR; }
Subroutine BEGIN: called CC=1 SCAR=0.0
27 11 ▶my $RC_FILE_NAME; BEGIN { $RC_FILE_NAME = '.datashow'; }
Subroutine BEGIN: called CC=1 SCAR=0.0
28 11 ▶my @PLUGIN_API; BEGIN { @PLUGIN_API = qw< stringify format >; }
Subroutine BEGIN: called CC=1 SCAR=0.0
29 11 ▶my @ARGUMENT_DEFAULTS; BEGIN { @ARGUMENT_DEFAULTS = (
Subroutine BEGIN: called CC=1 SCAR=0.0
30 to => $DEFAULT_TARGET,
31 with => $INITIAL_DEFAULT_PLUGIN,
32 as => 'show',
33 fallback => q{},
34 warnings => 'off',
35 termwidth => $MAXWIDTH,
36  
37 grid => 'off',
38 style => 'auto',
39  
40 # DARK BACKGROUND LIGHT BACKGROUND
41 showstyle => 'bold bright_cyan , bold bright_blue',
42 datastyle => 'bold white , bold black',
43 codestyle => 'cyan , blue',
44 filestyle => 'blue , red',
45 linestyle => 'blue , red',
46 gridstyle => 'blue , red',
47 );
48 }
49 11 ▶my %GRID; BEGIN {
Subroutine BEGIN: called CC=2 SCAR=6.9
50 11 ▶ @GRID{split //, q{┏┯┓┗┷┛━┃┠─┬┴┨│} }
Branch: 1 branch
BranchTrueFalseTotal
$IS_UTF8_TERM ? : 1 10 11
51 = split //, ( $IS_UTF8_TERM ? q{┏┯┓┗┷┛━┃┠─┬┴┨│}
52 : q{ _ |_|_||---|:}
53 );
54 }
55  
56  
57 # Useful regexes...
58 11 ▶my $OWS; BEGIN { $OWS = qr{ (?: \s++ | \# [^\n]*+ )*+ }x; }
Subroutine BEGIN: called CC=1 SCAR=0.0
59 11 ▶my $IDENT; BEGIN { $IDENT = qr{ [^\W\d]\w* (?: :: [^\W\d]\w* )* | [_\W] }x; }
Subroutine BEGIN: called CC=1 SCAR=0.0
60 11 ▶my $COLOUR_CHAR; BEGIN { $COLOUR_CHAR = qr{ (?: \e[^m]*m )* [^\n] (?: \e[^m]*m )* }x; }
Subroutine BEGIN: called CC=1 SCAR=0.0
61 11 ▶my $VALID_ARG; BEGIN { $VALID_ARG = qr{ \A (?: to | with | fallback
Subroutine BEGIN: called CC=1 SCAR=0.0
62 | base | warnings | as
63 | style | grid | termwidth
64 | datastyle | filestyle | linestyle
65 | codestyle | showstyle | gridstyle
66 ) \z }x; }
67  
68 # Track lexically scoped output targets and styles...
69 11 my @OUTPUT_FH;
70 11 my @STYLE;
71  
72 # Export the module's API, or that of a plugin (as requested)...
73 11 ▶sub import {
Subroutine import: called CC=11 SCAR=25.7
74 # Track load context...
75 11 my ($package, $file, $line) = _get_context();
76  
77 # Remove the module name from the argument list...
78 11 shift @_;
79  
80 # Handle the special case of a 'base' argument (by adding it as the caller's base class)...
81 11 ▶ if (@_ > 0 && $_[0] eq 'base') {
Branch: 1 branch
BranchTrueFalseTotal
if (@_ > 0 and $_[0] eq "base") 0 11 11
Condition66%2/3
@_ > 0 and $_[0] eq "base"
!ll&&!rl&&r
470
MC/DC0%0/2
@_ > 0 and $_[0] eq "base"
@_ > 0 $_[0] eq "base"
Truth table66%2/3
A and B
A= @_ > 0B= $_[0] eq "base"
ABresult
0X0
100
111
82 0 ▶ die "If 'base' is specified, it must be the only argument at $file line $line\n" if @_ > 2;
Branch: 1 branch
BranchTrueFalseTotal
if @_ > 2 0 0 0
83 11 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
84 0 ▶ push @{caller().'::ISA'}, _load_plugin( $_[1] // 'Data::Show::Plugin', $file, $line, 'warn' );
Condition0%0/2
$_[1] // "Data::Show::Plugin"
l!l
00
MC/DC0%0/1
$_[1] // "Data::Show::Plugin"
$_[1]
Truth table0%0/2
A
A= $_[1]
Aresult
11
00
85 0 return;
86 }
87  
88 # Check for missing named args and improve the usual warning for that problem...
89 11 ▶ die "No value specified for named argument '$_[-1]' at $file line $line\n"
Branch: 1 branch
BranchTrueFalseTotal
if @_ % 2 != 0 0 11 11
90 if @_ % 2 != 0;
91  
92 # Unpack args (including defaults from config file)....
93 11 state $defaults_ref = _load_defaults($file, $line);
94 11 my %opt = (%{$defaults_ref}, @_);
95  
96 # Punish invalid arguments...
97 11 _validate_args(\%opt, "at $file line $line", "named argument");
98  
99 # Any 'to' arg must be a filehandle, filename, or scalar ref (and open it if necessary)...
100 11 ▶ $opt{to} = _open_target( $opt{to} // $DEFAULT_TARGET, $file, $line, $opt{warnings} ne 'off' );
Condition33%1/3
$opt{"to"} // $DEFAULT_TARGET
l!l&&r!l&&!r
1100
MC/DC0%0/2
$opt{"to"} // $DEFAULT_TARGET
$opt{"to"} $DEFAULT_TARGET
Truth table33%1/3
A // B
A= $opt{"to"}B= $DEFAULT_TARGET
ABresult
1X1
011
000
101  
102 # Unpack fallback arguments into an arrayref...
103 11 $opt{fallback} = [ split m{ \s*,\s* }x, $opt{fallback} ];
104  
105 # Resolve style options according to terminal background (i.e. dark or light)
106 11 for my $option (@opt{ grep /\A.+style\z/, keys %opt}) {
107 66 ▶ $option = [split /\s*,\s*/, $option]->[$IS_LIGHT_BG ? -1 : 0];
Branch: 1 branch
BranchTrueFalseTotal
$IS_LIGHT_BG ? : 0 66 66
108 }
109  
110 # Install Data::Show::Plugin base class as well...
111 11 $INC{'Data/Show/Plugin.pm'} = $INC{'Data/Show.pm'};
112  
113 # Track lexical options...
114 $^H{'Data::Show/with'} = _load_plugin( $opt{with}, $file, $line,
115 11 $opt{warnings} ne 'off', $opt{fallback} );
116 11 $^H{'Data::Show/termwidth'} = $opt{termwidth};
117 11 $^H{'Data::Show/to'} = @OUTPUT_FH;
118 11 $^H{'Data::Show/style'} = @STYLE;
119 11 ▶ my $existing_as = $^H{'Data::Show/as'} // '(?!)';
Condition100%2/2
$^H{"Data::Show/as"} // "(?!)"
l!l
110
MC/DC100%1/1
$^H{"Data::Show/as"} // "(?!)"
$^H{"Data::Show/as"}
Truth table100%2/2
A
A= $^H{"Data::Show/as"}
Aresult
11
00
120 11 $^H{'Data::Show/as'} = "$existing_as|$opt{as}";
121 11 push @OUTPUT_FH, $opt{to};
122 push @STYLE, { add_grid => $opt{grid},
123 mode => $opt{style},
124 11 ▶ map { m/(.+)style/ ? ($1 => $opt{$_}) : () } keys %opt
Branch: 1 branch
BranchTrueFalseTotal
/(.+)style/ ? : 66 88 154
125 };
126  
127 # Install the function...
128 11 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
129 11 *{caller() . '::' . $opt{as}} = \&show;
130 }
131  
132 # A "no Data::Show" turns show() into a no-op...
133 1 ▶sub unimport {
Subroutine unimport: called CC=1 SCAR=0.0
134 # Track disabling lexically...
135 1 $^H{'Data::Show/noshow'} = 1;
136  
137 # Install the function...
138 11 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
139 1 *{caller() . '::show'} = \&show;
140 }
141  
142 11 ▶sub _validate_args {
Subroutine _validate_args: called CC=5 SCAR=20.9
143 11 my ($opt_ref, $where, $what) = @_;
144  
145 # Collect and report non-valid arguments...
146 11 my @unknown_args = grep { !m{$VALID_ARG} } keys %{$opt_ref};
147 die "Unknown $what" . (@unknown_args == 1 ? '' : 's') . " $where:\n",
148 0 ▶ join q{}, map { " $_\n" } @unknown_args
Branch: 2 branches
BranchTrueFalseTotal
if @unknown_args 0 11 11
@unknown_args == 1 ? : 0 0 0
149 if @unknown_args;
150  
151 # By the time we're validating, we shouldn't see a 'base' option...
152 11 ▶ return if !exists $opt_ref->{base};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $opt_ref->{"base"} 11 0 11
153 0 ▶ die $what eq 'named argument' ? "If 'base' is specified, it must be the only argument $where\n"
Branch: 1 branch
BranchTrueFalseTotal
$what eq 'named argument' ? : 0 0 0
154 : "Can't specify 'base' as a $what $where\n"
155 }
156  
157 # Ensure output filehandles are valid (or fall back to the default)...
158 11 ▶sub _open_target {
Subroutine _open_target: called CC=9 SCAR=32.8
159 11 my ($target, $file, $line, $warnings) = @_;
160  
161 # Track already opened targets, and reuse them...
162 11 state %already_open;
163 11 ▶ return $already_open{$target} if $already_open{$target};
Branch: 1 branch
BranchTrueFalseTotal
if $already_open{$target} 1 10 11
164  
165 # Handle stringy filenames and in-memory targets...
166 10 my $to_type = ref($target);
167 10 ▶ if (!$to_type && ref(\$target) ne 'GLOB' || $to_type eq 'SCALAR') {
Branch: 2 branches
BranchTrueFalseTotal
if (not $to_type and ref \$target ne 'GLOB' or $to_type eq 'SCALAR') { } 0 10 10
elsif (_is_writeable($target)) { } 10 0 10
Condition33%2/6
not $to_type and ref \$target ne "GLOB" or $to_type eq "SCALAR"
l!l&&r!l&&!r
0010
not $to_type and ref \$target ne "GLOB"
!ll&&!rl&&r
1000
MC/DC0%0/3
not $to_type and ref \$target ne "GLOB" or $to_type eq "SCALAR"
not $to_type ref \$target ne "GLOB" $to_type eq "SCALAR"
Truth table20%1/5
not(A) and B or C
A= not $to_typeB= ref \$target ne "GLOB"C= $to_type eq "SCALAR"
ABCresult
11X1
0X11
1011
0X00
1000
168 0 ▶ if (open my $fh, '>', $target) {
Branch: 1 branch
BranchTrueFalseTotal
if (open my $fh, '>', $target) { } 0 0 0
169 0 return ($already_open{$target} = $fh);
170 }
171 else {
172 0 ▶ warn "Could not open named 'to' argument for output at $file line $line\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings 0 0 0
173 if $warnings;
174 0 return ($already_open{$target} = $DEFAULT_TARGET);
175 }
176 }
177  
178 # Handle filehandle-y targets...
179 elsif (_is_writeable($target)) {
180 10 return ($already_open{$target} = $target);
181 }
182 else {
183 0 ▶ warn "Named 'to' argument is not a writeable target at $file line $line\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings 0 0 0
184 if $warnings;
185 0 return ($already_open{$target} = $DEFAULT_TARGET);
186 }
187 }
188  
189 # -w is not reliable, so do this instead...
190 10 ▶sub _is_writeable {
Subroutine _is_writeable: called CC=1 SCAR=0.0
191 11 ▶ return eval { no warnings; print {$_[0]} q{} };
Subroutine BEGIN: called CC=1 SCAR=0.0
192 }
193  
194  
195 # Extract call context, adjusting for evals...
196 109 ▶sub _get_context {
Subroutine _get_context: called CC=4 SCAR=21.7
197 # Start in the current caller's caller...
198 109 my ($package, $file, $line, $hints_ref) = (caller(1))[0..2,10];
199  
200 # Keep looking up as long as next caller is a string eval...
201 109 ▶ if ($file =~ m{\A \( eval \s+ \d+ \)}x) {
Branch: 1 branch
BranchTrueFalseTotal
if ($file =~ /\A \( eval \s+ \d+ \)/x) 0 109 109
202 0 for my $uplevel (2..1_000_000) {
203 0 my ($uppackage, $upfile, $upline) = caller($uplevel);
204 0 $upfile =~ s{.*/}{};
205 0 $file .= ", at $upfile line $upline";
206 0 ▶ last if $upfile !~ m{\A \( eval \s+ \d+ \)}x;
Branch: 1 branch
BranchTrueFalseTotal
unless $upfile =~ /\A \( eval \s+ \d+ \)/x 0 0 0
207 }
208 }
209  
210 109 return ($package, $file, $line, $hints_ref);
211 }
212  
213 # Strip repeated arguments from return list...
214 11 ▶sub _uniq {
Subroutine _uniq: called CC=1 SCAR=0.0
215 11 my %seen;
216 11 return grep {!$seen{$_}++} @_;
217 }
218  
219 # Load requested plugin (or fall back on a safe default)...
220 11 my %STANDARD_PLUGIN; # (Populated below)
221 11 ▶sub _load_plugin {
Subroutine _load_plugin: called CC=18 SCAR=31.3
222 11 my ($plugin, $file, $line, $warnings, $fallback_ref) = @_;
223  
224 # Build initial fallback list...
225 11 ▶ my @fallbacks = _uniq( @{ $fallback_ref // [] } );
Condition50%1/2
$fallback_ref // []
l!l
110
MC/DC0%0/1
$fallback_ref // []
$fallback_ref
Truth table50%1/2
A
A= $fallback_ref
Aresult
11
00
226  
227 # Remember and normalize the original plugin requested (even after we start falling back)...
228 11 my $starting_plugin = $plugin;
229 11 ▶ if ($starting_plugin !~ m{ \A Data::Show::Plugin \b }x) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($starting_plugin =~ / \A Data::Show::Plugin \b /x) 6 5 11
230 6 $starting_plugin = "Data::Show::Plugin::$plugin";
231 }
232  
233 # Track outcomes...
234 11 my @failed_loads;
235 11 state %loaded;
236  
237 # Loop to accommodate fallbacks (if required)...
238 CANDIDATE:
239 11 while (1) {
240 # Normalize plugin name under the Data::Show::Plugin:: hierarchy...
241 16 ▶ if ($plugin !~ m{ \A Data::Show::Plugin \b }x) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($plugin =~ / \A Data::Show::Plugin \b /x) 11 5 16
242 11 $plugin = "Data::Show::Plugin::$plugin";
243 }
244  
245 # Only load (or try to load) each plugin once (if already loaded, just return its name)...
246 16 ▶ last CANDIDATE if exists $loaded{$plugin};
Branch: 1 branch
BranchTrueFalseTotal
if exists $loaded{$plugin} 1 15 16
247  
248 # Handle standard plugins...
249 15 ▶ if (my $standard = $STANDARD_PLUGIN{$plugin}) {
Branch: 2 branches
BranchTrueFalseTotal
if (my $standard = $STANDARD_PLUGIN{$plugin}) { } 14 1 15
elsif (_load_external_plugin($plugin, $warnings)) { } 0 1 1
250  
251 # Validate the plugin's preconditions...
252 14 for my $requirement (@{$standard->{requires}}) {
253  
254 # If plugin can't be used, fall back to the next best alternative (if any)...
255 16 ▶ if (!eval "require $requirement; 1") {
Branch: 1 branch
BranchTrueFalseTotal
unless (eval "require $requirement; 1") 4 12 16
256 4 ▶ warn "$plugin requires $requirement, which could not be loaded.\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings 0 4 4
257 if $warnings;
258 4 push @failed_loads, $plugin;
259 4 ▶ if ($plugin = shift(@fallbacks) // $standard->{fallback}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($plugin = shift @fallbacks // $standard->{'fallback'}) { } 4 0 4
Condition33%1/3
shift @fallbacks // $standard->{"fallback"}
l!l&&r!l&&!r
040
MC/DC0%0/2
shift @fallbacks // $standard->{"fallback"}
shift @fallbacks $standard->{"fallback"}
Truth table33%1/3
A // B
A= shift @fallbacksB= $standard->{"fallback"}
ABresult
1X1
011
000
260 4 next CANDIDATE;
261 }
262 else {
263 0 $plugin = $FINAL_CANDIDATE_PLUGIN;
264 0 last CANDIDATE;
265 }
266 }
267 }
268  
269 # Instantiate the plugin class, inserting the plugin-specific source code...
270 10 ▶ eval qq{
Subroutine BEGIN: called CC=1 SCAR=0.2
Subroutine BEGIN: called CC=1 SCAR=0.2
Subroutine stringify: called CC=1 SCAR=0.2
Branch: 1 branch
BranchTrueFalseTotal
eval qq[\n package $plugin;\n BEGIN { our \@ISA = 'Data::Show::Plugin'; }\n $standard->{"source"};\n 1;\n ] or die "Internal error: $@" 10 0 10
Condition0%0/2
eval { do { pp($_[1]) } } // '<Data::Dump cannot show a ' . lc(ref $_[1]) . " reference>\n"
l!l
00
MC/DC0%0/1
eval { do { pp($_[1]) } } // '<Data::Dump cannot show a ' . lc(ref $_[1]) . " reference>\n"
eval { do { pp($_[1]) } }
Truth table0%0/2
A
A= eval { do { pp($_[1]) } }
Aresult
11
00
271 package $plugin;
272 BEGIN { our \@ISA = 'Data::Show::Plugin'; }
273 $standard->{source};
274 1;
275 } or die "Internal error: $@"; # This can never happen! ;-)
276  
277 # And we're done...
278 10 last CANDIDATE;
279 }
280  
281 # Otherwise, if we can load the (non-standard) module then we're also done...
282 elsif (_load_external_plugin($plugin, $warnings)) {
283 0 last CANDIDATE;
284 }
285  
286 # Otherwise, fall back to a specified alternative, or else try the standard fallback(s)...
287 else {
288 1 ▶ warn "Could not install $plugin at $file line $line\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings 0 1 1
289 if $warnings;
290 1 push @failed_loads, $plugin;
291 1 ▶ $plugin = shift(@fallbacks) // $INITIAL_DEFAULT_PLUGIN;
Condition33%1/3
shift @fallbacks // $INITIAL_DEFAULT_PLUGIN
l!l&&r!l&&!r
100
MC/DC0%0/2
shift @fallbacks // $INITIAL_DEFAULT_PLUGIN
shift @fallbacks $INITIAL_DEFAULT_PLUGIN
Truth table33%1/3
A // B
A= shift @fallbacksB= $INITIAL_DEFAULT_PLUGIN
ABresult
1X1
011
000
292 1 next CANDIDATE;
293 }
294 }
295  
296 # Report substitution-on-failure (if any)...
297 11 ▶ warn "Used $plugin in place of $starting_plugin at $file line $line\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings and $plugin ne $starting_plugin 0 11 11
Condition33%1/3
$warnings and $plugin ne $starting_plugin
!ll&&!rl&&r
1100
MC/DC0%0/2
$warnings and $plugin ne $starting_plugin
$warnings $plugin ne $starting_plugin
Truth table33%1/3
A and B
A= $warningsB= $plugin ne $starting_plugin
ABresult
0X0
100
111
298 if $warnings && $plugin ne $starting_plugin;
299  
300 # Remember the outcome(s) to speed things up next time...
301 11 $loaded{$_} = $plugin for $plugin, @failed_loads;
302  
303 11 return $plugin;
304 }
305  
306 # Load or otherwise verify the availability of a non-standard plugin...
307 1 ▶sub _load_external_plugin {
Subroutine _load_external_plugin: called CC=3 SCAR=11.4
308 29 my ($plugin, $warnings) = @_;
309  
310 # Load it (or fail silently)...
311 29 eval "require $plugin";
312  
313 # Are all the essential methods present in the plugin class???
314 29 my @missing_methods = grep { !$plugin->can($_) } @PLUGIN_API;
315 warn "Requested plugin class $plugin does not provide the following essential methods:\n",
316 15 ▶ (map { " $_()" } @missing_methods), "\n"
Branch: 1 branch
BranchTrueFalseTotal
if $warnings and @missing_methods 0 15 15
Condition33%1/3
$warnings and @missing_methods
!ll&&!rl&&r
100
MC/DC0%0/2
$warnings and @missing_methods
$warnings @missing_methods
Truth table33%1/3
A and B
A= $warningsB= @missing_methods
ABresult
0X0
100
111
317 if $warnings && @missing_methods;
318  
319 # Succeed if all the essential methods are available...
320 15 return !@missing_methods;
321 }
322  
323 # Locate and process config file(s) and/or environment variable, if any...
324 10 ▶sub _load_defaults {
Subroutine _load_defaults: called CC=2 SCAR=6.9
325 10 my ($file, $line) = @_;
326  
327 # Build up defaults, starting with the built-in defaults...
328 24 my %defaults = @ARGUMENT_DEFAULTS;
329  
330 # Overwrite previous defaults with any readable global or local config file(s)...
331 24 for my $config_file (grep {-r} "$ENV{HOME}/$RC_FILE_NAME", "./$RC_FILE_NAME") {
332 14 %defaults = ( %defaults, _load_config($config_file) );
333 }
334  
335 10 return \%defaults;
336 }
337  
338 0 ▶sub _load_config {
Subroutine _load_config: not called CC=5 SCAR=20.1
339 14 my ($filename) = @_;
340  
341 # Grab contents of file...
342 14 ▶ open my $fh, '<:utf8', $filename or return;
Branch: 1 branch
BranchTrueFalseTotal
open my $fh, "<:utf8", $filename or return 0 14 14
343 14 local $/;
344 14 ▶ my $config = readline($fh) // return;
Condition0%0/2
readline $fh // (return)
l!l
00
MC/DC0%0/1
readline $fh // (return)
readline $fh
Truth table0%0/2
A
A= readline $fh
Aresult
11
00
345  
346 # Remove empty lines (including comment lines)...
347 14 $config =~ s{ ^ \s* (?: \# [^\n]* )? (?:\n|\z) }{}gxms;
348  
349 # Extract keys and values of each option...
350 14 my %opt = $config =~ m{ ^ \h* ([^:=]*?) \h* [:=] \h* ([^\n]*) (?:\n|\z) }gxms;
351  
352 # Convert a "*NAME" string to the corresponding named filehandle...
353 0 ▶ if (exists $opt{to} && $opt{to} =~ m{ \A \* (.*) }x) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt{"to"} and $opt{"to"} =~ / \A \* (.*) /x) 0 14 14
Condition0%0/3
exists $opt{"to"} and $opt{"to"} =~ / \A \* (.*) /x
!ll&&!rl&&r
000
MC/DC0%0/2
exists $opt{"to"} and $opt{"to"} =~ / \A \* (.*) /x
exists $opt{"to"} $opt{"to"} =~ / \A \* (.*) /x
Truth table0%0/3
A and B
A= exists $opt{"to"}B= $opt{"to"} =~ / \A \* (.*) /x
ABresult
0X0
100
111
354 11 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
355 11 ▶ no warnings 'once';
Subroutine BEGIN: called CC=1 SCAR=0.0
356 0 $opt{to} = \*{$1};
357 }
358  
359 # Validate config...
360 0 _validate_args(\%opt, "in $filename", "configuration option");
361  
362 0 return %opt;
363 }
364  
365 # The whole point of the module...
366 98 ▶sub show {
Subroutine show: called CC=16 SCAR=31.3
Pod documented
367 # Find the various contexts of this call...
368 98 my ($package, $file, $line, $hints_ref) = _get_context();
369 98 my $call_context = wantarray();
370  
371 # Skip almost everything if "no Data::Show"...
372 98 ▶ if (!$hints_ref->{'Data::Show/noshow'}) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($hints_ref->{"Data::Show/noshow"}) 84 14 98
373  
374 # Identify current lexically-scoped config (should already have been loaded by import())...
375 84 ▶ my $plugin_class = $hints_ref->{'Data::Show/with'} // $FINAL_CANDIDATE_PLUGIN;
Condition33%1/3
$hints_ref->{"Data::Show/with"} // $FINAL_CANDIDATE_PLUGIN
l!l&&r!l&&!r
8400
MC/DC0%0/2
$hints_ref->{"Data::Show/with"} // $FINAL_CANDIDATE_PLUGIN
$hints_ref->{"Data::Show/with"} $FINAL_CANDIDATE_PLUGIN
Truth table33%1/3
A // B
A= $hints_ref->{"Data::Show/with"}B= $FINAL_CANDIDATE_PLUGIN
ABresult
1X1
011
000
376 84 my %style = %{ $STYLE[ $hints_ref->{'Data::Show/style'} ] };
377 84 my $termwidth = $hints_ref->{'Data::Show/termwidth'};
378  
379 # Warn about side-effects of multi-arg calls to show() in scalar context...
380 84 ▶ if (defined $call_context && !$call_context && @_ > 1) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $call_context and not $call_context and @_ > 1) 0 84 84
Condition33%2/6
defined $call_context and not $call_context and @_ > 1
!ll&&!rl&&r
8400
defined $call_context and not $call_context
!ll&&!rl&&r
8400
MC/DC0%0/3
defined $call_context and not $call_context and @_ > 1
defined $call_context not $call_context @_ > 1
Truth table25%1/4
A and not(B) and C
A= defined $call_contextB= not $call_contextC= @_ > 1
ABCresult
0XX0
10X0
1100
1111
381 0 warn "Call to show() may not be not transparent at $file line $line\n";
382 }
383  
384 # Serialize Contextual::Return objects (can break some dumpers in the Data::Dump family)...
385 84 my @data = map { ref() =~ m{\AContextual::Return::Value}
386 0 ▶ ? do {my $v = $_->Contextual::Return::DUMP(); $v =~ s[\}\n][\},\n]gxms; eval $v; }
Branch: 1 branch
BranchTrueFalseTotal
ref($_) =~ /\AContextual::Return::Value/ ? : 0 166 166
387 : $_
388 } @_;
389  
390 # Extract the originating source line(s)...
391 my ($pre_source, $source, $post_source, $startline)
392 84 = _get_source($file, $line, $hints_ref->{'Data::Show/as'});
393  
394 # What kind of data is it???
395 84 my $is_single_hash = _data_is_single_hash($source, \@data, $hints_ref->{'Data::Show/as'});
396 84 my $is_single_arg = @data == 1;
397  
398 # Stringify the data...
399 84 ▶ my $data = $plugin_class->stringify( $is_single_hash ? {@data}
Branch: 2 branches
BranchTrueFalseTotal
$is_single_hash ? : 6 78 84
$is_single_arg ? : 54 24 78
400 : $is_single_arg ? $data[0]
401 : \@data
402 );
403  
404 # Some stringifiers add an (unwanted) empty first line, so remove it...
405 84 $data =~ s{ \A \h* \n }{}xms;
406  
407 # Change delimters of any stringified arguments that were passed to the stringifier via refs...
408 84 ▶ if ($is_single_hash) { $data =~ s{ \A (\s*) \{ (.*) \} (\s*) \z }{$1($2)$3}xms; }
Branch: 2 branches
BranchTrueFalseTotal
if ($is_single_hash) { } 6 78 84
elsif (not $is_single_arg) { } 24 54 78
409 24 elsif (!$is_single_arg) { $data =~ s{ \A (\s*) \[ (.*) \] (\s*) \z }{$1($2)$3}xms; }
410  
411 # Where are we printing to???
412 84 ▶ my $fh = exists $hints_ref->{'Data::Show/to'} ? $OUTPUT_FH[$hints_ref->{'Data::Show/to'}]
Branch: 1 branch
BranchTrueFalseTotal
exists $hints_ref->{'Data::Show/to'} ? : 84 0 84
413 : $DEFAULT_TARGET;
414  
415 # Disable styling if not outputting to a terminal or if styling is unavailable...
416 84 ▶ if (!-t $fh || $style{mode} eq 'auto' && !$CAN_ANSICOLOR) {
Branch: 1 branch
BranchTrueFalseTotal
if (not -t $fh or $style{"mode"} eq "auto" and not $CAN_ANSICOLOR) 84 0 84
Condition16%1/6
not -t $fh or $style{"mode"} eq "auto" and not $CAN_ANSICOLOR
l!l&&r!l&&!r
8400
$style{"mode"} eq "auto" and not $CAN_ANSICOLOR
!ll&&!rl&&r
000
MC/DC0%0/3
not -t $fh or $style{"mode"} eq "auto" and not $CAN_ANSICOLOR
not -t $fh $style{"mode"} eq "auto" not $CAN_ANSICOLOR
Truth table25%1/4
not(A) or B and not(C)
A= not -t $fhB= $style{"mode"} eq "auto"C= not $CAN_ANSICOLOR
ABCresult
1XX1
0111
00X0
0100
417 84 $style{mode} = 'off'
418 }
419  
420 # Show the data with its context header (with style!)...
421 11 ▶ no warnings 'utf8';
Subroutine BEGIN: called CC=1 SCAR=0.0
422 84 print {$fh}
423 $plugin_class->format(
424 $file, $startline, $pre_source, $source, $post_source, $data, \%style, $termwidth,
425 );
426 }
427  
428 # Return the entire argument list if possible, otherwise simulate scalar context...
429 98 ▶ return @_ if $call_context;
Branch: 1 branch
BranchTrueFalseTotal
if $call_context 0 98 98
430 98 return $_[0];
431 }
432  
433 # Return the source code at a given file and line...
434 84 ▶sub _get_source {
Subroutine _get_source: called CC=10 SCAR=28.4
435 84 my ($file, $line, $subname) = @_;
436  
437 # Optimize look-up via a cache...
438 84 state %source_cache;
439  
440 # Load the entire source of requested file...
441 84 ▶ if (!$source_cache{$file}) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($source_cache{$file}) 6 78 84
442 # Load the source of an eval()...
443 6 ▶ if ($file =~ m{\A \( eval \s+ \d+ \)}x) {
Branch: 2 branches
BranchTrueFalseTotal
if ($file =~ /\A \( eval \s+ \d+ \)/x) { } 0 6 6
elsif (open my $filehandle, '<', $file) { } 6 0 6
444 0 $source_cache{$file} = (caller(2))[6];
445 }
446  
447 # Otherwise, read in the source from the file...
448 elsif (open my $filehandle, '<', $file) {
449 6 $source_cache{$file} = do { local $/, readline($filehandle) };
450 }
451  
452 else {
453 # Otherwise, see if it's a #line trick in the main file...
454 0 ▶ if (!defined $source_cache{$0} && open my $selfhandle, '<', $0) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $source_cache{$0} and open my $selfhandle, "<", $0) 0 0 0
Condition0%0/3
not defined $source_cache{$0} and open my $selfhandle, "<", $0
!ll&&!rl&&r
000
MC/DC0%0/2
not defined $source_cache{$0} and open my $selfhandle, "<", $0
not defined $source_cache{$0} open my $selfhandle, "<", $0
Truth table0%0/3
not(A) and B
A= not defined $source_cache{$0}B= open my $selfhandle, "<", $0
ABresult
0X0
100
111
455 0 $source_cache{$0} = do { local $/, readline($selfhandle) };
456 }
457  
458 0 $source_cache{$file} = $source_cache{$0};
459 $source_cache{$file} =~ s{ \A .*? ^ \# \h* line \h+ (\d+) \h+ \Q$file\E \h* \n }
460 0 { "\n" x ($1-1) }xmse
461 0 ▶ or $source_cache{$file} = q{};
Branch: 1 branch
BranchTrueFalseTotal
$source_cache{$file} =~ s/ \A .*? ^ \# \h* line \h+ (\d+) \h+ \Q$file\E \h* \n /"\n" x ($1 - 1);/emsx or $source_cache{$file} = "" 0 0 0
462 0 $source_cache{$file} =~ s{ \A .*? ^ \# \h* line \h+ (\d+) \h+ [^\n]* \n .* }{}xms;
463 }
464 }
465  
466 # This pattern detects when we have a complete show() call...
467 84 state %SHOW_PATTERN_FOR;
468 84 ▶ my $SHOW_PATTERN = $SHOW_PATTERN_FOR{$subname}
Condition100%2/2
$SHOW_PATTERN_FOR{$subname} //= qr/ (?<pre> [^\n]*? ) (?> (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlParenthesesList) ) (?<post> [^\n]* ) | (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlCommaList) ) (?> (?<post> (?&PerlOWS) (?: ; | \Z ) ) | (?<post>) (?= (?&PerlOWS) \} ) ) ) $PPR::GRAMMAR /msx
l!l
786
MC/DC100%1/1
$SHOW_PATTERN_FOR{$subname} //= qr/ (?<pre> [^\n]*? ) (?> (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlParenthesesList) ) (?<post> [^\n]* ) | (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlCommaList) ) (?> (?<post> (?&PerlOWS) (?: ; | \Z ) ) | (?<post>) (?= (?&PerlOWS) \} ) ) ) $PPR::GRAMMAR /msx
$SHOW_PATTERN_FOR{$subname}
Truth table100%2/2
A
A= $SHOW_PATTERN_FOR{$subname}
Aresult
11
00
469 //= qr{ (?<pre> [^\n]*? )
470 (?>
471 (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlParenthesesList) )
472 (?<post> [^\n]* )
473 |
474 (?<call> \b(?:$subname)\b (?&PerlOWS) (?&PerlCommaList) )
475 (?> (?<post> (?&PerlOWS) (?: ; | \Z ) )
476 | (?<post>) (?= (?&PerlOWS) \} )
477 )
478 )
479 $PPR::GRAMMAR
480 }xms;
481  
482 # Locate the call in the source code (allowing for inaccuracies in caller() line results)...
483 11 ▶ use re 'eval';
Subroutine BEGIN: called CC=1 SCAR=0.0
484 84 our $prelim_lines; local $prelim_lines = $line-1;
485 84 my $found = $source_cache{$file} =~ m{
486 \A
487 (?<showlines>
488 (?<prelines> (?: [^\n]* \n ){0,$prelim_lines}? (?&PerlOWS) )
489 (?> $SHOW_PATTERN )
490 )
491 708 ▶ (??{ ($+{showlines} =~ tr/\n//) >= $prelim_lines ? q{} : '(?!)' })
Branch: 1 branch
BranchTrueFalseTotal
$+{'showlines'} =~ tr/\n// >= $Data::Show::prelim_lines ? : 84 624 708
492 }xms;
493 84 my %cap = %+;
494  
495 # Extract source code of call (the else should only very rarely need to be invoked)...
496 84 ▶ if ($found) {
Branch: 1 branch
BranchTrueFalseTotal
if ($found) { } 84 0 84
497 84 return @cap{qw<pre call post>}, 1 + ($+{prelines} =~ tr/\n//);
498 }
499 else {
500 0 return q{}, [0, split /\n/, $source_cache{$file}]->[$line], q{}, $line;
501 }
502  
503 }
504  
505 # Attempt to detect a show() argument list that consists of a single hash...
506 84 ▶sub _data_is_single_hash {
Subroutine _data_is_single_hash: called CC=4 SCAR=13.9
507 84 my ($context, $data_ref, $subname) = @_;
508 84 ▶ $context //= q{};
Condition50%1/2
$context //= ""
l!l
840
MC/DC0%0/1
$context //= ""
$context
Truth table50%1/2
A
A= $context
Aresult
11
00
509  
510 # What does a single hash arg look like???
511 84 state %SINGLE_HASH_FOR;
512 84 ▶ my $SINGLE_HASH = $SINGLE_HASH_FOR{$subname}
Condition100%2/2
$SINGLE_HASH_FOR{$subname} //= qr/ \b(?:$subname) (?&PerlOWS) (?: (?&PerlVariableHash) | \( (?&PerlOWS) (?&PerlVariableHash) (?&PerlOWS) \) ) (?&PerlOWS) \z $PPR::GRAMMAR /x
l!l
786
MC/DC100%1/1
$SINGLE_HASH_FOR{$subname} //= qr/ \b(?:$subname) (?&PerlOWS) (?: (?&PerlVariableHash) | \( (?&PerlOWS) (?&PerlVariableHash) (?&PerlOWS) \) ) (?&PerlOWS) \z $PPR::GRAMMAR /x
$SINGLE_HASH_FOR{$subname}
Truth table100%2/2
A
A= $SINGLE_HASH_FOR{$subname}
Aresult
11
00
513 //= qr{ \b(?:$subname) (?&PerlOWS)
514 (?: (?&PerlVariableHash)
515 | \( (?&PerlOWS) (?&PerlVariableHash) (?&PerlOWS) \)
516 )
517 (?&PerlOWS) \z
518 $PPR::GRAMMAR
519 }x;
520  
521 # Must be only one argument (plus the invocant) and must look like a single hash...
522 84 ▶ return @{$data_ref} % 2 == 0 && $context =~ $SINGLE_HASH;
Condition100%3/3
@{$data_ref;} % 2 == 0 && $context =~ /$SINGLE_HASH/
!ll&&!rl&&r
60186
MC/DC100%2/2
@{$data_ref;} % 2 == 0 && $context =~ /$SINGLE_HASH/
@{$data_ref;} % 2 == 0 $context =~ /$SINGLE_HASH/
Truth table100%3/3
A && B
A= @{$data_ref;} % 2 == 0B= $context =~ /$SINGLE_HASH/
ABresult
0X0
100
111
523 }
524  
525  
526 # Base class for plugins...
527 package Data::Show::Plugin;
528  
529 # When imported, make the imported plugin a base class of the importing class...
530 0 ▶sub import {
Subroutine import: not called CC=1 SCAR=1.2
531 0 my ($package) = @_;
532 11 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
533 0 @{caller().'::ISA'} = $package;
534 }
535  
536 # Visually distinguish the context string and data...
537 70 ▶sub format {
Subroutine format: called CC=15 SCAR=27.8
Pod undocumented
538 70 my ($class, $file, $line, $pre_source, $source, $post_source, $data, $style, $termwidth) = @_;
539 70 ▶ $_ //= q{} for $pre_source, $source, $post_source;
Condition50%1/2
$_ //= ""
l!l
2100
MC/DC0%0/1
$_ //= ""
$_
Truth table50%1/2
A
A= $_
Aresult
11
00
540  
541 # Track previous file context between calls...
542 70 state $prevfile = q{};
543 70 my $is_new_context = $file ne $prevfile;
544 70 $prevfile = $file;
545  
546 # Compute line numbering width...
547 70 my $line_num_len = length( $line + ($pre_source . $source . $post_source) =~ tr/\n// );
548 70 my $data_box_len = $termwidth - 4;
549 70 my $code_box_len = $data_box_len - $line_num_len - 1;
550  
551 # ASCII-only decoration if explicitly requested, or if Term::ANSIcolor is unavailable...
552 my $decorate_data = $style->{mode} eq 'context'
553 70 ▶ || $style->{mode} eq 'off' ? \&_monochrome : \&_polychrome;
Branch: 1 branch
BranchTrueFalseTotal
$style->{'mode'} eq 'context' || $style->{'mode'} eq 'off' ? : 70 0 70
Condition33%1/3
$style->{"mode"} eq "context" or $style->{"mode"} eq "off"
l!l&&r!l&&!r
0700
MC/DC0%0/2
$style->{"mode"} eq "context" or $style->{"mode"} eq "off"
$style->{"mode"} eq "context" $style->{"mode"} eq "off"
Truth table33%1/3
A or B
A= $style->{"mode"} eq "context"B= $style->{"mode"} eq "off"
ABresult
1X1
011
000
554 70 ▶ my $decorate_context = $style->{mode} eq 'off' ? \&_monochrome : \&_polychrome;
Branch: 1 branch
BranchTrueFalseTotal
$style->{'mode'} eq 'off' ? : 70 0 70
555  
556 # Set up grid components (if requested)...
557 70 my ($gridhead, $gridtail, $gridfsep, $gridcsep, $gridside, $gridline, $gridplus) = (q{}) x 7;
558 70 my $padding = q{ } x $data_box_len;
559  
560 70 ▶ if ($style->{add_grid} ne 'off') {
Branch: 1 branch
BranchTrueFalseTotal
if ($style->{"add_grid"} ne "off") 28 42 70
561 # $is_new_context !$is_new_context
562 # Top line of grid: ┏━━━━━━━━━━━━━┓ ┏━━━┯━━━━━━━━━━┓
563 28 $gridhead = $GRID{'┏'} . ($GRID{'━'} x ($termwidth-2)) . $GRID{'┓'} . "\n";
564 28 ▶ substr($gridhead, $line_num_len+1, 1) = $GRID{'┯'} if !$is_new_context;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_new_context 26 2 28
565  
566 # Post-filename separator: ┠───┬─────────┨ <not used>
567 28 $gridfsep = $GRID{'┠'} . ($GRID{'─'} x ($termwidth-2)) . $GRID{'┨'} . "\n";
568 28 substr($gridfsep, $line_num_len+1, 1) = $GRID{'┬'};
569  
570 # Post-code separator: ┠───┴─────────┨ ┠───┴─────────┨
571 28 $gridcsep = $GRID{'┠'} . ($GRID{'─'} x ($termwidth-2)) . $GRID{'┨'} . "\n";
572 28 substr($gridcsep, $line_num_len+1, 1) = $GRID{'┴'};
573  
574 # Bottom line of grid: ┗━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━┛
575 28 $gridtail = $GRID{'┗'} . ($GRID{'━'} x ($termwidth-2)) . $GRID{'┛'} . "\n";
576  
577 # Verticals of grid...
578 28 $gridside = $GRID{'┃'};
579 28 $gridplus = $GRID{'┃'} . q{ };
580 28 $gridline = $GRID{'│'};
581  
582 # Decorate them all in the same style...
583 28 for my $border ($gridhead, $gridtail, $gridfsep, $gridcsep, $gridside, $gridplus, $gridline) {
584 196 $border = $decorate_context->($border, $style->{grid});
585 }
586 }
587  
588 # Style the source code...
589 0 $source = join("\n", map {$decorate_context->($_, $style->{code})} split "\n", $pre_source)
590 85 . join("\n", map {$decorate_context->($_, $style->{show})} split "\n", $source)
591 70 . join("\n", map {$decorate_context->($_, $style->{code})} split "\n", $post_source);
592 70 $source =~ s{ ^ }{ }gxms;
593  
594 # Install the line numbers and grid/format each source line...
595 $source = join "\n",
596 map {
597 70 ▶ $style->{add_grid} eq 'off'
Branch: 1 branch
BranchTrueFalseTotal
$style->{'add_grid'} eq 'off' ? : 51 34 85
598 ? m{ [^\n]* }xms
599 : ($_ . $padding) =~ m{ $COLOUR_CHAR {$code_box_len} }xms;
600 $gridside
601 . $decorate_context->( sprintf('%*d', $line_num_len, $line++), $style->{line} )
602 85 . $gridline . q{ } . $& . q{ } . $gridside
603 }
604 split "\n", $source;
605  
606 # Trim, grid, and format each data line...
607 $data = join "\n",
608 map {
609 70 ▶ $style->{add_grid} eq 'off' ? m{ [^\n]* }xms
Branch: 1 branch
BranchTrueFalseTotal
$style->{'add_grid'} eq 'off' ? : 114 88 202
610 : ($_ . $padding) =~ m{ $COLOUR_CHAR {$data_box_len} }xms;
611 202 $gridplus . $decorate_data->( $&, $style->{data} ) . q{ } . $gridside
612 }
613 split "\n", $data;
614  
615 # Delineate source lines and data lines if no better styling has been specified...
616 70 ▶ if (!$CAN_ANSICOLOR && $style->{add_grid} eq 'off') {
Branch: 1 branch
BranchTrueFalseTotal
if (not $CAN_ANSICOLOR and $style->{"add_grid"} eq "off") 0 70 70
Condition33%1/3
not $CAN_ANSICOLOR and $style->{"add_grid"} eq "off"
!ll&&!rl&&r
7000
MC/DC0%0/2
not $CAN_ANSICOLOR and $style->{"add_grid"} eq "off"
not $CAN_ANSICOLOR $style->{"add_grid"} eq "off"
Truth table33%1/3
not(A) and B
A= not $CAN_ANSICOLORB= $style->{"add_grid"} eq "off"
ABresult
0X0
100
111
617 0 $file =~ s{ ^ }{### }gxms;
618 0 $source =~ s{ ^ }{### }gxms;
619 0 $data =~ s{ ^ }{>>> }gxms;
620 }
621  
622 return $gridhead
623 . ($is_new_context
624 70 ▶ ? do {
Branch: 1 branch
BranchTrueFalseTotal
$is_new_context ? : 5 65 70
625 5 ▶ $style->{add_grid} eq 'off'
Branch: 1 branch
BranchTrueFalseTotal
$style->{'add_grid'} eq 'off' ? : 3 2 5
626 ? $file =~ m{ [^\n]* }xms
627 : ($file . $padding) =~ m{ $COLOUR_CHAR {$data_box_len} }xms;
628 $gridplus
629 . $decorate_context->( $&, $style->{file} )
630 5 . q{ } . $gridside . "\n"
631 . $gridfsep
632 }
633 : q{}
634 )
635 . "$source\n"
636 . $gridcsep
637 . "$data\n"
638 . $gridtail
639 . "\n";
640 }
641  
642  
643 # Utility functions...
644  
645 638 ▶sub _monochrome { $_[0] }
Subroutine _monochrome: called CC=1 SCAR=0.0
646  
647 0 ▶sub _polychrome { &Term::ANSIColor::colored }
Subroutine _polychrome: not called CC=1 SCAR=6.9
648  
649 0 ▶sub _antichrome { &Term::ANSIColor::colorstrip }
Subroutine _antichrome: not called CC=1 SCAR=6.9
650  
651 0 ▶sub _max {
Subroutine _max: not called CC=2 SCAR=17.9
652 0 my ($x, $y) = @_;
653 0 ▶ return $x > $y ? $x : $y;
Branch: 1 branch
BranchTrueFalseTotal
$x > $y ? : 0 0 0
654 }
655  
656 # Convert the data to a printable form (using Data::Dumper)...
657 56 ▶sub stringify {
Subroutine stringify: called CC=1 SCAR=0.0
Pod undocumented
658 56 my ($class, $data) = @_;
659  
660 # Choose conservative defaults (derive a subclass to change these)...
661 11 ▶ use Data::Dumper 'Dumper';
Subroutine BEGIN: called CC=1 SCAR=0.0
662 11 ▶ no warnings 'once';
Subroutine BEGIN: called CC=1 SCAR=0.0
663 56 local $Data::Dumper::Deparse = 0;
664 56 local $Data::Dumper::Sortkeys = 1;
665 56 local $Data::Dumper::Deepcopy = 1;
666 56 local $Data::Dumper::Terse = 1;
667  
668 # Convert data to a string representation...
669 56 my $stringification = Dumper($data);
670  
671 # Remove the annoying "$VAR1 = ", and realign subsequent indented lines...
672 # $stringification =~ s{ ^ .{8} }{}gxms;
673  
674 # Remove the annoying trailing ';'...
675 56 $stringification =~ s{ ; (\s*) \z }{$1}gxms;
676  
677 56 return $stringification;
678 }
679  
680  
681 # Template for constructing standard plugins...
682 11 ▶my $NULL_FORMATTER; BEGIN { $NULL_FORMATTER = q{
Subroutine BEGIN: called CC=1 SCAR=0.0
683 sub format {
684 my ($class, $data) = @_;
685 $data =~ s{\s*\z}{};
686 return "$data\n\n";
687 }
688 }}
689 132 ▶sub _build_plugin {
Subroutine _build_plugin: called CC=2 SCAR=6.9
690 # (SHOUTY parameters get interpolated, mousy prarameters don't)...
691 132 my ($NAME, $FALLBACK, $DUMP, $no_formatting) = @_;
692  
693 # Handle non-formatting plugins, and optimize argument look-up...
694 132 ▶ my $FORMATTER = $no_formatting ? $NULL_FORMATTER : q{};
Branch: 1 branch
BranchTrueFalseTotal
$no_formatting ? : 22 110 132
695 132 my $DATA = '$_[1]';
696  
697 return
698 132 "Data::Show::Plugin::$NAME" => {
699 requires => [$NAME],
700 fallback => $FALLBACK,
701 source => qq{
702 $FORMATTER
703 sub stringify {
704 use $NAME q{$DUMP};
705 return (eval { $DUMP($DATA) }
706 // '<$NAME cannot show a ' . lc(ref($DATA)) . " reference>\n")
707 . "\n";
708 }
709 },
710 };
711 }
712  
713 # Initialize the data needed to instantiate the built-in plugins on-demand...
714 11 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
715 11 %STANDARD_PLUGIN = (
716  
717 # DUMPER MODULE FALLBACK DUMP FUNC VARIATIONS
718 _build_plugin( 'Data::Dmp' => 'Data::Pretty', 'dmp' ),
719 _build_plugin( 'Data::Dump' => 'Data::Dumper', 'pp', ),
720 _build_plugin( 'Data::Dump::Color' => 'Data::Dump', 'pp', 'preformatted' ),
721 _build_plugin( 'Data::Dumper::Compact' => 'Data::Dump', 'ddc' ),
722 _build_plugin( 'Data::Dumper::Concise' => 'Data::Dumper', 'Dumper' ),
723 _build_plugin( 'Data::Dumper::Table' => 'Dumpvalue', 'Tabulate' ),
724 _build_plugin( 'Data::Pretty' => 'Data::Dump', 'pp', ),
725 _build_plugin( 'Data::TreeDumper' => 'Dumpvalue', 'DumpTree' ),
726 _build_plugin( 'YAML' => 'YAML::Tiny', 'Dump' ),
727 _build_plugin( 'YAML::PP' => 'YAML::Tiny', 'Dump' ),
728 _build_plugin( 'YAML::Tiny' => 'Dumpvalue', 'Dump' ),
729 _build_plugin( 'YAML::Tiny::Color' => 'YAML::Tiny', 'Dump', 'preformatted' ),
730  
731 "Data::Show::Plugin::Data::Dumper" => {
732 requires => ['Data::Dumper'],
733 fallback => 'DumpValue',
734 source => q{}, # ...because Data::Show::Plugin base class already uses Data::Dumper
735 },
736  
737 'Data::Show::Plugin::Data::Printer' => {
738 requires => ['Data::Printer'],
739 fallback => 'Dumpvalue',
740 source => qq{
741 sub stringify {
742 use Data::Printer;
743 return np(\$_[1], colored=>$CAN_ANSICOLOR) . "\n";
744 }
745 },
746 },
747  
748 'Data::Show::Plugin::Dumpvalue' => {
749 requires => ['Dumpvalue'],
750 source => q{
751 sub stringify {
752 my ($class, $data) = @_;
753  
754 # Create a singleton Dumpvalue object to do the stringification...
755 use Dumpvalue;
756 state $DUMPER = Dumpvalue->new(subdump=>1, globPrint=>1);
757  
758 # Dumpvalue only dumps to STDOUT, so co-opt that filehandle to capture the output...
759 open +(local *STDOUT), '>', \\my $dump;
760  
761 # Stringify the data to the captured STDOUT...
762 $DUMPER->dumpValue($data);
763  
764 # Return the intercepted stringification...
765 return $dump;
766 }
767 },
768 },
769  
770 # This plugin restores the previous (pre-version-0.003) output format for the module...
771 'Data::Show::Plugin::Legacy' => {
772 requires => ['Data::Dump', 'PPR', 'List::Util'],
773 fallback => 'Data::Dump',
774 source => q{
775 sub format {
776 my ($class, $file, $line,
777 $pre_source, $source, $post_source,
778 $data, $style, $termwidth) = @_;
779  
780 use List::Util 'max';
781  
782 # Configuration for layout of representation...
783 state $DEFAULT_INDENT = 4;
784 state $MAX_DESC = 30;
785 state $MAX_FILENAME = 20;
786 state $TITLE_POS = 3;
787  
788 # Extract description of arglist from source...
789 $source =~ s{\\A show \b \\s*}{}x;
790 $source =~ s{\\s+}{ }gx;
791 $source =~ s{\\A \\( (.*) \\) \\Z}{$1}x;
792 if (length($source) > $MAX_DESC) {
793 $source = substr($source,0,$MAX_DESC-3) . q{...};
794 }
795  
796 # Trim filename and format context info and description...
797 $file =~ s{.*[/\\\\]}{}xms;
798 if (length($file) > $MAX_FILENAME) {
799 $file =~ s/ (_[^\\W_]) [^\\W_]* /$1/gxms;
800 }
801 if (length($file) > $MAX_FILENAME) {
802 $file =~ s/\\A (.{1,8}) .*? (.{1,8}) \\Z/$1...$2/gxms;
803 }
804 my $context = "[ '$file', line $line ]";
805  
806 # Insert title into header...
807 my $header = '=' x $termwidth;
808 substr($header, $TITLE_POS, length($source)+6) = "( $source )";
809 substr($header, -(length($context)+$TITLE_POS), length($context)) = $context;
810  
811 # Indent data...
812 $data =~ s{^}{ }gxms;
813  
814 # Assemble and send off...
815 return "$header\\n\\n$data\\n\\n";
816 }
817  
818 # Original stringifier was Data::Dump...
819 sub stringify {
820 use Data::Dump 'pp';
821 return pp($_[1]);
822 }
823 },
824 },
825 );
826 }
827  
828  
829 11 1; # Magic true value required at end of module
830 __END__
↑ Summary