blib/lib/Config/Model/ObjTreeScanner.pm

filter: Statementstmt 95.2% 120 / 126 Branchbran 68.5% 37 / 54 Conditioncond 62.0% 18 / 29 MC/DCmcdc 5.2% 1 / 19 Subroutinesub 100% 22 / 22 Podpod 85.7% 6 / 7 totaltotal 79.3% 204 / 257 CC 43 SCAR 21.6
CC
43
Cov
84%
scan_element
17.0
new
14.2
scan_node
6.3
CRAP 8.7
« blib/lib/Config/Model/ValueComputer.pm ↑ Summary blib/lib/Config/Model/HashId.pm »
1 #
2 # This file is part of Config-Model
3 #
4 # This software is Copyright (c) 2005-2022 by Dominique Dumont.
5 #
6 # This is free software, licensed under:
7 #
8 # The GNU Lesser General Public License, Version 2.1, February 1999
9 #
10 package Config::Model::ObjTreeScanner 2.169;
11  
12 59 ▶use 5.20.0;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 59 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 59 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 59 ▶use Config::Model::Exception;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 59 ▶use Scalar::Util qw/blessed/;
Subroutine BEGIN: called CC=1 SCAR=0.0
18 59 ▶use Log::Log4perl qw(get_logger :levels);
Subroutine BEGIN: called CC=1 SCAR=0.0
19 59 ▶use Carp qw/carp croak confess cluck/;
Subroutine BEGIN: called CC=1 SCAR=0.0
20 59 ▶use Carp::Assert::More;
Subroutine BEGIN: called CC=1 SCAR=0.0
21  
22 59 ▶use feature qw/postderef signatures/;
Subroutine BEGIN: called CC=1 SCAR=0.0
23 59 ▶no warnings qw/experimental::signatures experimental::postderef/;
Subroutine BEGIN: called CC=1 SCAR=0.0
24  
25 59 my $logger = get_logger("ObjTreeScanner");
26  
27 my @value_cb =
28 59 map { $_ . '_value_cb' } qw/boolean dir enum file string uniline integer number reference/;
29  
30 247 ▶sub new ($type, %args) {
Subroutine new: called CC=12 SCAR=26.6
Pod documented
31 247 my $self = { auto_vivify => 1, check => 'yes' };
32 247 bless $self, $type;
33  
34 $self->{leaf_cb} = delete $args{leaf_cb}
35 247 ▶ or croak __PACKAGE__, "->new: missing leaf_cb parameter";
Branch: 1 branch
BranchTrueFalseTotal
$self->{"leaf_cb"} = delete $args{"leaf_cb"} or croak(__PACKAGE__, "->new: missing leaf_cb parameter") 247 0 247
36  
37 # TODO: switch to warning in 2027
38 247 ▶ if (delete $args{fallback}) {
Branch: 1 branch
BranchTrueFalseTotal
if (delete $args{"fallback"}) 0 247 247
39 0 my ($package, $filename, $line) = caller;
40 0 $logger->info("fallback parameter is deprecated. Called from $filename:$line");
41 }
42  
43 # we may use leaf_cb
44 247 $self->create_default_callbacks();
45  
46 # get all call_backs
47 247 foreach my $param (
48 qw/check node_element_cb hash_element_cb
49 list_element_cb check_list_element_cb node_content_cb
50 node_content_hook list_element_hook hash_element_hook
51 auto_vivify up_cb/, @value_cb
52 ) {
53 4940 ▶ $self->{$param} = $args{$param} if defined $args{$param};
Branch: 1 branch
BranchTrueFalseTotal
if defined $args{$param} 1406 3534 4940
54 4940 delete $args{$param}; # may exists but be undefined
55 croak __PACKAGE__, "->new: missing $param parameter"
56 4940 ▶ unless defined $self->{$param};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{$param} 0 4940 4940
57 }
58  
59 # setup ordered hash fallbacks
60 247 ▶ $self->{ordered_hash_element_cb} = delete $args{ordered_hash_element_cb} // $self->{hash_element_cb};
Condition66%2/3
delete $args{"ordered_hash_element_cb"} // $self->{"hash_element_cb"}
l!l&&r!l&&!r
452020
MC/DC0%0/2
delete $args{"ordered_hash_element_cb"} // $self->{"hash_element_cb"}
delete $args{"ordered_hash_element_cb"} $self->{"hash_element_cb"}
Truth table66%2/3
A // B
A= delete $args{"ordered_hash_element_cb"}B= $self->{"hash_element_cb"}
ABresult
1X1
011
000
61 247 ▶ $self->{ordered_hash_element_hook} = delete $args{ordered_hash_element_hook} // $self->{hash_element_hook};
Condition66%2/3
delete $args{"ordered_hash_element_hook"} // $self->{"hash_element_hook"}
l!l&&r!l&&!r
12460
MC/DC0%0/2
delete $args{"ordered_hash_element_hook"} // $self->{"hash_element_hook"}
delete $args{"ordered_hash_element_hook"} $self->{"hash_element_hook"}
Truth table66%2/3
A // B
A= delete $args{"ordered_hash_element_hook"}B= $self->{"hash_element_hook"}
ABresult
1X1
011
000
62  
63 # this parameter is optional and does not need a fallback
64 247 ▶ $self->{node_dispatch_cb} = delete $args{node_dispatch_cb} || {};
Condition100%2/2
delete $args{'node_dispatch_cb'} || {}
l!l
1246
MC/DC100%1/1
delete $args{'node_dispatch_cb'} || {}
delete $args{'node_dispatch_cb'}
Truth table100%2/2
A
A= delete $args{'node_dispatch_cb'}
Aresult
11
00
65  
66 croak __PACKAGE__, "->new: node_dispatch_cb is not a hash ref"
67 247 ▶ unless ref( $self->{node_dispatch_cb} ) eq 'HASH';
Branch: 1 branch
BranchTrueFalseTotal
unless ref $self->{"node_dispatch_cb"} eq "HASH" 0 247 247
68  
69 croak __PACKAGE__, "->new: unexpected check: $self->{check}"
70 247 ▶ unless $self->{check} =~ /yes|no|skip/;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"check"} =~ /yes|no|skip/u 0 247 247
71  
72 247 ▶ croak __PACKAGE__, "->new: unexpected parameter: ", join( ' ', keys %args )
Branch: 1 branch
BranchTrueFalseTotal
if scalar %args 0 247 247
73 if scalar %args;
74  
75 247 return $self;
76 }
77  
78 # internal
79 247 ▶sub create_default_callbacks ($self) {
Subroutine create_default_callbacks: called CC=5 SCAR=16.2
Pod undocumented
80 247 foreach my $item (qw/node_content_hook hash_element_hook list_element_hook/) {
81 741 ▶ $self->{$item} = sub { };
Subroutine __ANON__: called CC=1 SCAR=0.0
82 }
83  
84 1000 ▶ my $node_content_cb = sub ($scanner, $data_r, $node, @elements) {
Subroutine __ANON__: called CC=2 SCAR=6.9
85 1000 foreach my $item (@elements) { $scanner->scan_element( $data_r, $node, $item ) };
86 247 };
87  
88 258 ▶ my $node_element_cb = sub ($scanner, $data_r, $node, $element_name, $key, $next_node) {
Subroutine __ANON__: called CC=1 SCAR=0.0
89 258 $scanner->scan_node( $data_r, $next_node );
90 247 };
91  
92 75 ▶ my $hash_element_cb = sub ($scanner, $data_r, $node, $element_name, @keys) {
Subroutine __ANON__: called CC=2 SCAR=6.9
93 75 foreach my $item (@keys) {
94 74 $scanner->scan_hash( $data_r, $node, $element_name, $item );
95 }
96 247 };
97  
98 247 $self->{list_element_cb} = $hash_element_cb;
99 247 $self->{hash_element_cb} = $hash_element_cb;
100 247 $self->{node_element_cb} = $node_element_cb;
101 247 $self->{node_content_cb} = $node_content_cb;
102 247 ▶ $self->{up_cb} = sub { }; # do nothing
Subroutine __ANON__: called CC=1 SCAR=0.0
103  
104 247 ▶ my $l = $self->{string_value_cb} ||= $self->{leaf_cb};
Condition33%1/3
$self->{"string_value_cb"} ||= $self->{"leaf_cb"}
l!l&&r!l&&!r
02470
MC/DC0%0/2
$self->{"string_value_cb"} ||= $self->{"leaf_cb"}
$self->{"string_value_cb"} $self->{"leaf_cb"}
Truth table33%1/3
A ||= B
A= $self->{"string_value_cb"}B= $self->{"leaf_cb"}
ABresult
1X1
011
000
105  
106 247 foreach my $cb (@value_cb, "check_list_element_cb") {
107 2470 ▶ $self->{$cb} ||= $l;
Condition66%2/3
$self->{$cb} ||= $l
l!l&&r!l&&!r
24722230
MC/DC0%0/2
$self->{$cb} ||= $l
$self->{$cb} $l
Truth table66%2/3
A ||= B
A= $self->{$cb}B= $l
ABresult
1X1
011
000
108 }
109  
110 247 return;
111 }
112  
113 1319 ▶sub scan_node ($self, $data_r, $node) {
Subroutine scan_node: called CC=6 SCAR=18.4
Pod documented
114 1319 ▶ Config::Model::Exception::Internal->throw( error => "'$node' is not a Config::Model object" )
Branch: 1 branch
BranchTrueFalseTotal
unless builtin::blessed($node) and $node->isa("Config::Model::AnyThing") 0 1319 1319
Condition33%1/3
builtin::blessed($node) and $node->isa("Config::Model::AnyThing")
!ll&&!rl&&r
001319
MC/DC0%0/2
builtin::blessed($node) and $node->isa("Config::Model::AnyThing")
builtin::blessed($node) $node->isa("Config::Model::AnyThing")
Truth table33%1/3
A and B
A= builtin::blessed($node)B= $node->isa("Config::Model::AnyThing")
ABresult
0X0
100
111
115 unless blessed($node)
116 and $node->isa("Config::Model::AnyThing");
117  
118 # skip exploration of warped out node
119 1319 ▶ if ($node->isa('Config::Model::WarpedNode') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($node->isa("Config::Model::WarpedNode")) 277 1042 1319
120 277 $node = $node->get_actual_node;
121 277 ▶ return unless defined $node;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $node 0 277 277
122 }
123  
124 1319 my $config_class = $node->config_class_name;
125 1319 my $node_dispatch_cb = $self->{node_dispatch_cb}{$config_class};
126  
127 1319 ▶ my $actual_cb = $node_dispatch_cb || $self->{node_content_cb};
Condition66%2/3
$node_dispatch_cb || $self->{'node_content_cb'}
l!l&&r!l&&!r
413150
MC/DC0%0/2
$node_dispatch_cb || $self->{'node_content_cb'}
$node_dispatch_cb $self->{'node_content_cb'}
Truth table66%2/3
A || B
A= $node_dispatch_cbB= $self->{'node_content_cb'}
ABresult
1X1
011
000
128  
129 1319 my @element_list = $node->get_element_name( check => $self->{check} );
130  
131 1319 $self->{node_content_hook}->( $self, $data_r, $node, @element_list );
132  
133 # we could add here a "last element" call-back, but it's not
134 # very useful if the last element is a hash.
135 1319 $actual_cb->( $self, $data_r, $node, @element_list );
136  
137 1315 $self->{up_cb}->( $self, $data_r, $node );
138 1315 return;
139 }
140  
141 9025 ▶sub scan_element ($self, $data_r, $node, $element_name) {
Subroutine scan_element: called CC=16 SCAR=28.3
Pod documented
142 9025 my $element_type = $node->element_type($element_name);
143  
144 9025 my $autov = $self->{auto_vivify};
145  
146 9025 ▶ if ( $element_type eq 'hash' ) {
Branch: 6 branches
BranchTrueFalseTotal
if ($element_type eq 'hash') { } 408 8617 9025
elsif ($element_type eq 'list') { } 502 8115 8617
elsif ($element_type eq 'check_list') { } 99 8016 8115
elsif ($element_type eq 'node') { } 404 7612 8016
elsif ($element_type eq 'warped_node') { } 278 7334 7612
elsif ($element_type eq 'leaf') { } 7334 0 7334
147 408 my $ordered = $node->fetch_element($element_name)->ordered();
148 408 ▶ my $hook = $ordered ? 'ordered_hash_element_hook' : 'hash_element_hook';
Branch: 1 branch
BranchTrueFalseTotal
$ordered ? : 73 335 408
149 408 ▶ my $cb = $ordered ? 'ordered_hash_element_cb' : 'hash_element_cb';
Branch: 1 branch
BranchTrueFalseTotal
$ordered ? : 73 335 408
150 408 my @keys = $self->get_keys( $node, $element_name );
151  
152 408 $self->{$hook}->( $self, $data_r, $node, $element_name, @keys );
153 408 $self->{$cb}->( $self, $data_r, $node, $element_name, @keys );
154 }
155 elsif ( $element_type eq 'list' ) {
156 502 my @keys = $self->get_keys( $node, $element_name );
157 502 $self->{list_element_hook}->( $self, $data_r, $node, $element_name, @keys );
158 502 $self->{list_element_cb}->( $self, $data_r, $node, $element_name, @keys );
159 }
160 elsif ( $element_type eq 'check_list' ) {
161 99 my $cl_elt = $node->fetch_element( name => $element_name, check => $self->{check} );
162 99 $self->{check_list_element_cb}->( $self, $data_r, $node, $element_name, undef, $cl_elt );
163 }
164 elsif ( $element_type eq 'node' ) {
165 my $next_obj =
166 ( $autov or $node->is_element_defined($element_name) )
167 ? $node->fetch_element( name => $element_name, check => $self->{check} )
168 404 ▶ : undef;
Branch: 1 branch
BranchTrueFalseTotal
$autov || $node->is_element_defined($element_name) ? : 404 0 404
Condition66%2/3
$autov or $node->is_element_defined($element_name)
l!l&&r!l&&!r
1472570
MC/DC0%0/2
$autov or $node->is_element_defined($element_name)
$autov $node->is_element_defined($element_name)
Truth table66%2/3
A or B
A= $autovB= $node->is_element_defined($element_name)
ABresult
1X1
011
000
169  
170 404 $self->{node_element_cb}->( $self, $data_r, $node, $element_name, undef, $next_obj );
171 }
172 elsif ( $element_type eq 'warped_node' ) {
173 my $next_obj =
174 ( $autov or $node->is_element_defined($element_name) )
175 ? $node->fetch_element( name => $element_name, check => $self->{check} )
176 278 ▶ : undef;
Branch: 1 branch
BranchTrueFalseTotal
$autov || $node->is_element_defined($element_name) ? : 278 0 278
Condition66%2/3
$autov or $node->is_element_defined($element_name)
l!l&&r!l&&!r
612170
MC/DC0%0/2
$autov or $node->is_element_defined($element_name)
$autov $node->is_element_defined($element_name)
Truth table66%2/3
A or B
A= $autovB= $node->is_element_defined($element_name)
ABresult
1X1
011
000
177 278 ▶ $self->{node_element_cb}->( $self, $data_r, $node, $element_name, undef, $next_obj ) if $next_obj;
Branch: 1 branch
BranchTrueFalseTotal
if $next_obj 278 0 278
178 }
179 elsif ( $element_type eq 'leaf' ) {
180 7334 my $next_obj = $node->fetch_element( name => $element_name, check => $self->{check} );
181  
182 7334 ▶ if (my $type = $next_obj->value_type) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $type = $next_obj->value_type) 7334 0 7334
183 7334 my $cb_name = $type . '_value_cb';
184 7334 my $cb = $self->{$cb_name};
185 7334 ▶ croak "scan_element: No call_back specified for '$cb_name'"
Branch: 1 branch
BranchTrueFalseTotal
unless defined $cb 0 7334 7334
186 unless defined $cb;
187 7334 $cb->( $self, $data_r, $node, $element_name, undef, $next_obj );
188 }
189 }
190 else {
191 0 croak "Unexpected element_type: $element_type";
192 }
193 9021 return;
194 }
195  
196 806 ▶sub scan_hash ($self, $data_r, $node, $element_name, $key) {
Subroutine scan_hash: called CC=4 SCAR=14.0
Pod documented
197 806 assert_like( $node->element_type($element_name), qr/(hash|list)/ );
198  
199 806 my $item = $node->fetch_element( name => $element_name, check => $self->{check} );
200  
201 806 my $cargo_type = $item->cargo_type($element_name);
202 806 my $next_obj = $item->fetch_with_id( index => $key, check => $self->{check} );
203  
204 806 ▶ if ( $cargo_type =~ /node$/ ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($cargo_type =~ /node$/u) { } 419 387 806
elsif ($cargo_type eq 'leaf') { } 387 0 387
205 419 $self->{node_element_cb}->( $self, $data_r, $node, $element_name, $key, $next_obj );
206 }
207 elsif ( $cargo_type eq 'leaf' ) {
208 387 my $cb_name = $next_obj->value_type . '_value_cb';
209 387 my $cb = $self->{$cb_name};
210 387 ▶ croak "scan_hash: No call_back specified for '$cb_name'"
Branch: 1 branch
BranchTrueFalseTotal
unless defined $cb 0 387 387
211 unless defined $cb;
212 387 $cb->( $self, $data_r, $node, $element_name, $key, $next_obj );
213 }
214 else {
215 0 croak "Unexpected cargo_type: $cargo_type";
216 }
217 805 return;
218 }
219  
220 109 ▶sub scan_list {
Subroutine scan_list: called CC=1 SCAR=0.0
Pod documented
221 109 goto &scan_hash;
222 }
223  
224 913 ▶sub get_keys ($self, $node, $element_name) {
Subroutine get_keys: called CC=3 SCAR=12.7
Pod documented
225 913 my $element_type = $node->element_type($element_name);
226 913 my $item = $node->fetch_element( name => $element_name, check => $self->{check} );
227  
228 913 ▶ return $item->fetch_all_indexes
Branch: 1 branch
BranchTrueFalseTotal
if $element_type eq "hash" or $element_type eq "list" 913 0 913
Condition66%2/3
$element_type eq "hash" or $element_type eq "list"
l!l&&r!l&&!r
4095040
MC/DC0%0/2
$element_type eq "hash" or $element_type eq "list"
$element_type eq "hash" $element_type eq "list"
Truth table66%2/3
A or B
A= $element_type eq "hash"B= $element_type eq "list"
ABresult
1X1
011
000
229 if $element_type eq 'hash'
230 || $element_type eq 'list';
231  
232 0 Config::Model::Exception::Internal->throw(
233 error => "called get_keys on non hash or non list" . " element $element_name",
234 object => $node
235 );
236  
237 0 return;
238 }
239  
240 59 1;
241  
242 # ABSTRACT: Scan config tree and perform call-backs for each element or node
243  
244 __END__
« blib/lib/Config/Model/ValueComputer.pm ↑ Summary blib/lib/Config/Model/HashId.pm »