blib/lib/Config/Model/Warper.pm

filter: Statementstmt 81.6% 214 / 262 Branchbran 58.0% 65 / 112 Conditioncond 90.3% 28 / 31 MC/DCmcdc 68.7% 11 / 16 Subroutinesub 96.5% 28 / 29 Podpod 15.3% 2 / 13 totaltotal 75.1% 348 / 463 CC 81 SCAR 35.0
CC
81
Cov
76%
warp_error
188.6
warp_them
30.0
register_to_one_warp_master
16.3
CRAP 33.1
« blib/lib/Config/Model/CheckList.pm ↑ Summary blib/lib/Config/Model/SimpleUI.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::Warper 2.169;
11  
12 59 ▶use Mouse;
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 59 ▶use Log::Log4perl qw(get_logger :levels);
Subroutine BEGIN: called CC=1 SCAR=0.0
15 59 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
16 59 ▶use Storable qw/dclone/;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 59 ▶use Config::Model::Exception;
Subroutine BEGIN: called CC=1 SCAR=0.0
18 59 ▶use List::MoreUtils qw/any/;
Subroutine BEGIN: called CC=1 SCAR=0.0
19 59 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
20  
21 59 ▶use feature qw/postderef signatures/;
Subroutine BEGIN: called CC=1 SCAR=0.0
22 59 ▶no warnings qw/experimental::postderef experimental::signatures/;
Subroutine BEGIN: called CC=1 SCAR=0.0
23  
24 59 has 'follow' => ( is => 'ro', isa => 'HashRef[Str]' );
25 59 has 'rules' => ( is => 'ro', isa => 'ArrayRef', required => 1 );
26  
27 59 has 'warped_object' => (
28 is => 'ro',
29 isa => 'Config::Model::AnyThing',
30 handles => ['needs_check'],
31 weak_ref => 1,
32 required => 1
33 );
34  
35 has '_values' => (
36 traits => ['Hash'],
37 is => 'ro',
38 isa => 'HashRef[HashRef | Str | Undef ]',
39 465 ▶ default => sub { {} },
Subroutine __ANON__: called CC=1 SCAR=0.0
40 59 handles => {
41 _set_value => 'set',
42 _get_value => 'get',
43 _value_keys => 'keys',
44 },
45 );
46  
47 496 ▶sub _get_value_gist {
Subroutine _get_value_gist: called CC=2 SCAR=6.9
48 496 my $self = shift;
49 496 my $warper_name = shift;
50 496 my $item = $self->_get_value($warper_name);
51  
52 496 ▶ return ref($item) eq 'HASH' ? join(',', each %$item) : $item;
Branch: 1 branch
BranchTrueFalseTotal
ref $item eq 'HASH' ? : 8 488 496
53 }
54  
55 has [qw/ _computed_masters _warped_nodes _registered_values/] => (
56 is => 'rw',
57 isa => 'HashRef',
58 init_arg => undef, # can't use this param in constructor
59 1395 ▶ default => sub { {} },
Subroutine __ANON__: called CC=1 SCAR=0.0
60 59 );
61  
62 59 has allowed => ( is => 'rw', isa => 'ArrayRef' );
63 59 has morph => ( is => 'ro', isa => 'Bool' );
64  
65 59 my $logger = get_logger("Warper");
66  
67 # create the object, check args, but don't do anything else
68 465 ▶sub BUILD ($self,$) {
Subroutine BUILD: called CC=1 SCAR=0.0
Pod documented
69 465 $logger->trace( "Warper new: created for " . $self->name );
70 465 $self->check_warp_args;
71  
72 465 $self->register_to_all_warp_masters;
73 465 $self->refresh_values_from_master;
74 465 $self->do_warp;
75 465 return;
76 }
77  
78 # should be called only at startup
79 468 ▶sub register_to_all_warp_masters ($self) {
Subroutine register_to_all_warp_masters: called CC=2 SCAR=6.9
Pod undocumented
80 468 my $follow = $self->follow;
81  
82 # now, follow is only { w1 => 'warp1', w2 => 'warp2'}
83 468 foreach my $warper_name ( keys %$follow ) {
84 601 $self->register_to_one_warp_master($warper_name);
85 }
86  
87 468 return;
88 }
89  
90 601 ▶sub register_to_one_warp_master ($self, $warper_name) {
Subroutine register_to_one_warp_master: called CC=16 SCAR=27.9
Pod undocumented
91 601 my $follow = $self->follow;
92 601 my $warper_path = $follow->{$warper_name};
93 601 $logger->debug( "Warper register_to_one_warp_master: '", $self->name, "' follows '$warper_name'" );
94  
95 # need to register also to all warped_nodes found on the path
96 601 my @command = ($warper_path);
97 601 my $warper;
98 my $warped_node;
99 601 my $obj = $self->warped_object;
100 601 my $reg_values = $self->_registered_values;
101  
102 601 ▶ return if defined $reg_values->{$warper_name};
Branch: 1 branch
BranchTrueFalseTotal
if defined $reg_values->{$warper_name} 3 598 601
103  
104 598 ▶ while (@command) {
Branch: 1 branch
BranchTrueFalseTotal
if (@command) 1337 0 1337
105  
106 # may return undef object
107 1337 ( $obj, @command ) = $obj->grab(
108 step => \@command,
109 mode => 'step_by_step',
110 grab_non_available => 1,
111 );
112  
113 1337 ▶ if ( not defined $obj ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $obj) 93 1244 1337
114 93 $logger->debug("Warper register_to_one_warp_master: aborted steps. Left '@command'");
115 93 last;
116 }
117  
118 1244 my $obj_loc = $obj->location;
119  
120 1244 $logger->debug("Warper register_to_one_warp_master: step to master $obj_loc");
121  
122 1244 ▶ if ( $obj->isa('Config::Model::Value') or $obj->isa('Config::Model::CheckList')) {
Branch: 1 branch
BranchTrueFalseTotal
if ($obj->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList")) 505 739 1244
Condition100%3/3
$obj->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList")
l!l&&r!l&&!r
5032739
MC/DC100%2/2
$obj->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList")
$obj->isa("Config::Model::Value") $obj->isa("Config::Model::CheckList")
Truth table100%3/3
A or B
A= $obj->isa("Config::Model::Value")B= $obj->isa("Config::Model::CheckList")
ABresult
1X1
011
000
123 505 $warper = $obj;
124 505 ▶ if ( defined $warped_node ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $warped_node) 35 470 505
125  
126 # keep obj ref to be able to unregister later on
127 35 $self->_warped_nodes->{$warped_node}{$warper_name} = $obj;
128 }
129 505 last;
130 }
131  
132 739 ▶ if ( $obj->isa('Config::Model::WarpedNode') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($obj->isa("Config::Model::WarpedNode")) 128 611 739
133 128 $logger->debug("Warper register_to_one_warp_master: register to warped_node $obj_loc");
134 128 ▶ if ( defined $warped_node ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $warped_node) 0 128 128
135  
136 # keep obj ref to be able to unregister later on
137 0 $self->_warped_nodes->{$warped_node}{$warper_name} = $obj;
138 }
139 128 $warped_node = $obj_loc;
140 128 $obj->register( $self, $warper_name );
141 }
142 }
143  
144 598 ▶ if ( defined $warper and scalar @command ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $warper and scalar @command) 0 598 598
Condition100%2/2
defined $warper and scalar @command
!ll
93505
MC/DC100%1/1
defined $warper and scalar @command
defined $warper
Truth table100%2/2
A
A= defined $warper
Aresult
00
11
145 0 Config::Model::Exception::Model->throw(
146 object => $self->warped_object,
147 error => "Some steps are left (@command) from warper path $warper_path",
148 );
149 }
150  
151 $logger->debug(
152 598 ▶ "Warper register_to_one_warp_master:",
Branch: 1 branch
BranchTrueFalseTotal
defined $warper ? : 505 93 598
153 $self->name,
154 " is warped by $warper_name => '$warper_path' location in tree is: '",
155 defined $warper ? $warper->name : 'unknown', "'"
156 );
157  
158 598 ▶ return unless defined $warper;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $warper 93 505 598
159  
160 505 ▶ Config::Model::Exception::Model->throw(
Branch: 1 branch
BranchTrueFalseTotal
unless $warper->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList") 0 505 505
Condition66%2/3
$warper->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList")
l!l&&r!l&&!r
50320
MC/DC0%0/2
$warper->isa("Config::Model::Value") or $obj->isa("Config::Model::CheckList")
$warper->isa("Config::Model::Value") $obj->isa("Config::Model::CheckList")
Truth table66%2/3
A or B
A= $warper->isa("Config::Model::Value")B= $obj->isa("Config::Model::CheckList")
ABresult
1X1
011
000
161 object => $self->warped_object,
162 error => "warper $warper_name => '$warper_path' is not a leaf"
163 ) unless $warper->isa('Config::Model::Value') or $obj->isa('Config::Model::CheckList');
164  
165 # warp will register this value object in another value object
166 # (the warper). When the warper gets a new value, it will
167 # modify the warped object according to the data passed by the
168 # user.
169  
170 505 my $type = $warper->register( $self, $warper_name );
171  
172 505 $reg_values->{$warper_name} = $warper;
173  
174 # store current warp master value
175 505 ▶ if ( $type eq 'computed' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($type eq "computed") 1 504 505
176 1 $self->_computed_masters->{$warper_name} = $warper;
177 }
178  
179 505 return;
180 }
181  
182 3 ▶sub refresh_affected_registrations ($self, $warped_node_location) {
Subroutine refresh_affected_registrations: called CC=2 SCAR=6.9
Pod undocumented
183 3 my $wnref = $self->_warped_nodes;
184  
185 3 $logger->debug( "Warper refresh_affected_registrations: called on",
186 $self->name, " from $warped_node_location'" );
187  
188 # remove and unregister obj affected by this warped node
189 3 my $ref = delete $wnref->{$warped_node_location};
190  
191 3 foreach my $warper_name ( keys %$ref ) {
192 2 $logger->debug( "Warper refresh_affected_registrations: ",
193 $self->name, " unregisters from $warper_name'" );
194 2 delete $self->_registered_values->{$warper_name};
195 2 $ref->{$warper_name}->unregister( $self->name );
196 }
197  
198 3 $self->register_to_all_warp_masters;
199  
200 3 return;
201 }
202  
203 # should be called only at startup
204 465 ▶sub refresh_values_from_master ($self) {
Subroutine refresh_values_from_master: called CC=9 SCAR=22.5
Pod undocumented
205 # should get new value from warp master
206 465 my $follow = $self->follow;
207  
208 # now, follow is only { w1 => 'warp1', w2 => 'warp2'}
209  
210 # should try to get values only for unregister or computed warp masters
211 465 foreach my $warper_name ( keys %$follow ) {
212 595 my $warper_path = $follow->{$warper_name};
213 595 $logger->debug( "Warper trigger: ", $self->name, " following $warper_name" );
214  
215 # warper can itself be warped out (part of a warped out node).
216 # not just 'not available'.
217  
218 595 my $warper = $self->warped_object->grab(
219 step => $warper_path,
220 grab_non_available => 1,
221 mode => 'loose',
222 );
223  
224 595 ▶ if ( defined $warper and $warper->get_type eq 'leaf' ) {
Branch: 3 branches
BranchTrueFalseTotal
if (defined $warper and $warper->get_type eq 'leaf') { } 501 94 595
elsif (defined $warper and $warper->get_type eq 'check_list') { } 2 92 94
elsif (defined $warper) { } 0 92 92
Condition100%3/3
defined $warper and $warper->get_type eq "leaf"
!ll&&!rl&&r
922501
MC/DC100%2/2
defined $warper and $warper->get_type eq "leaf"
defined $warper $warper->get_type eq "leaf"
Truth table100%3/3
A and B
A= defined $warperB= $warper->get_type eq "leaf"
ABresult
0X0
100
111
225 # read the warp master values, so I can warp myself just after.
226 501 my $warper_value = $warper->fetch('allow_undef');
227 501 ▶ my $str = $warper_value // '<undef>';
Condition100%2/2
$warper_value // "<undef>"
l!l
377124
MC/DC100%1/1
$warper_value // "<undef>"
$warper_value
Truth table100%2/2
A
A= $warper_value
Aresult
11
00
228 501 $logger->debug( "Warper: '$warper_name' value is: '$str'" );
229 501 $self->_set_value( $warper_name => $warper_value );
230 }
231 ▶ elsif ( defined $warper and $warper->get_type eq 'check_list' ) {
Condition66%2/3
defined $warper and $warper->get_type eq "check_list"
!ll&&!rl&&r
9202
MC/DC50%1/2
defined $warper and $warper->get_type eq "check_list"
defined $warper $warper->get_type eq "check_list"
Truth table66%2/3
A and B
A= defined $warperB= $warper->get_type eq "check_list"
ABresult
0X0
100
111
232 2 ▶ if ($logger->is_debug) {
Branch: 1 branch
BranchTrueFalseTotal
if ($logger->is_debug) 0 2 2
233 0 my $warper_value = $warper->fetch();
234 0 $logger->debug( "Warper: '$warper_name' checked values are: '$warper_value'" );
235 }
236 # store checked values are data structure, not as string
237 2 $self->_set_value( $warper_name => scalar $warper->get_checked_list_as_hash() );
238 }
239 elsif ( defined $warper ) {
240 0 Config::Model::Exception::Model->throw(
241 error => "warp error: warp 'follow' parameter "
242 . "does not point to a leaf element",
243 object => $self->warped_object
244 );
245 }
246 else {
247 # consider that the warp master value is undef
248 92 $self->_set_value( $warper_name, '' );
249 92 $logger->debug("Warper: '$warper_name' is not available");
250 }
251 }
252  
253 465 return;
254 }
255  
256 4008 ▶sub name ($self) {
Subroutine name: called CC=1 SCAR=0.0
Pod undocumented
257 4008 return "Warper of " . $self->warped_object->name;
258 }
259  
260 # And I'm going to warp them ...
261 0 ▶sub warp_them ($self, @args) {
Subroutine warp_them: not called CC=5 SCAR=34.0
Pod undocumented
262 # retrieve current value if not provided
263 0 ▶ my $value = @args ? $args[0] : $self->fetch_no_check;
Branch: 1 branch
BranchTrueFalseTotal
@args ? : 0 0 0
264  
265 0 foreach my $ref ( @{ $self->{warp_these_objects} } ) {
266 0 my ( $warped, $warp_index ) = @$ref;
267 0 ▶ next unless defined $warped; # $warped is a weak ref and may vanish
Branch: 1 branch
BranchTrueFalseTotal
unless defined $warped 0 0 0
268  
269 # pure warp of object
270 0 ▶ $logger->debug(
Branch: 1 branch
BranchTrueFalseTotal
defined $value ? : 0 0 0
271 "Warper ", $self->name,
272 " warp_them: (value ",
273 ( defined $value ? $value : 'undefined' ),
274 ") warping '", $warped->name, "'"
275 );
276 0 $warped->warp( $value, $warp_index );
277 }
278 0 return;
279 }
280  
281 465 ▶sub check_warp_args ($self) {
Subroutine check_warp_args: called CC=7 SCAR=20.4
Pod undocumented
282 # check that rules element are array ref and store them for
283 # error checking
284 465 my $rules_ref = dclone $self->rules;
285  
286 465 ▶ if (ref $rules_ref ne 'ARRAY') {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $rules_ref ne "ARRAY") 0 465 465
287 0 Config::Model::Exception::Model->throw(
288 error => "warp error: warp 'rules' parameter is not an array ref ($rules_ref)",
289 object => $self->warped_object
290 );
291 }
292  
293 465 my $allowed = $self->allowed;
294  
295 465 foreach my $rule ($rules_ref->@*) {
296 1473 my $bool_expr = delete $rule->{when};
297 1473 ▶ Config::Model::Exception::Model->throw(
Branch: 1 branch
BranchTrueFalseTotal
unless defined $bool_expr 0 1473 1473
298 object => $self->warped_object,
299 error => "Warp rules error: no 'when' parameter found."
300 ) unless defined $bool_expr;
301  
302 1473 my $apply = delete $rule->{apply};
303 1473 ▶ Config::Model::Exception::Model->throw(
Branch: 1 branch
BranchTrueFalseTotal
unless defined $apply 0 1473 1473
304 object => $self->warped_object,
305 error => "Warp rules error: no 'apply' parameter found."
306 ) unless defined $apply;
307  
308 1473 foreach my $pkey ( keys $apply->%* ) {
309 Config::Model::Exception::Model->throw(
310 object => $self->warped_object,
311 error => "Warp rules error: "
312 . "parameter «$pkey» is not allowed, "
313 . "expected '"
314 . join( "' or '", @$allowed ) . "'"
315 1517 ▶ ) unless any {$pkey eq $_} @$allowed ;
Subroutine __ANON__: called CC=1 SCAR=0.2
Branch: 1 branch
BranchTrueFalseTotal
unless &any(sub { $pkey eq $_; } , @$allowed) 0 1517 1517
316 }
317 }
318 465 return;
319 }
320  
321 1 ▶sub _dclone_key (@args) {
Subroutine _dclone_key: called CC=2 SCAR=7.2
322 1 ▶ return map { ref $_ ? [$_->@*] : $_ } @args;
Branch: 1 branch
BranchTrueFalseTotal
ref $_ ? : 0 1 1
323 }
324  
325 # Internal. This method will change element properties (like level) according to the warp effect.
326 # For instance, if a warp rule make a node no longer available in a model, its level must change to
327 # 'hidden'
328 764 ▶sub set_parent_element_property ($self, $arg_ref) {
Subroutine set_parent_element_property: called CC=4 SCAR=13.9
Pod undocumented
329 764 my $warped_object = $self->warped_object;
330  
331 764 my @properties = qw/level/;
332  
333 764 ▶ if ( defined $warped_object->index_value ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $warped_object->index_value) 13 751 764
334 13 $logger->debug("Warper set_parent_element_property: called on hash or list, aborted");
335 13 return;
336 }
337  
338 751 my $parent = $warped_object->parent;
339 751 my $elt_name = $warped_object->element_name;
340 751 foreach my $property_name (@properties) {
341 751 my $v = $arg_ref->{$property_name};
342 751 ▶ if ( defined $v ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $v) { } 76 675 751
343 76 $logger->debug( "Warper set_parent_element_property: set '",
344 $parent->name, " $elt_name' $property_name with $v" );
345 76 $parent->set_element_property(
346 property => $property_name,
347 element => $elt_name,
348 value => $v,
349 );
350 }
351 else {
352  
353 # reset ensures that property is reset to known state by default
354 675 $logger->debug("Warper set_parent_element_property: reset $property_name");
355 675 $parent->reset_element_property(
356 property => $property_name,
357 element => $elt_name,
358 );
359 }
360 }
361 751 return;
362 }
363  
364 # try to actually warp (change properties) of a warped object.
365 322 ▶sub trigger ($self, @args) {
Subroutine trigger: called CC=15 SCAR=27.3
Pod undocumented
366 322 my %old_value_set = %{ $self->_values };
367  
368 322 ▶ if (@args) {
Branch: 1 branch
BranchTrueFalseTotal
if (@args) 322 0 322
369 322 my ( $value, $warp_name ) = @args;
370 322 ▶ $logger->debug(
Branch: 1 branch
BranchTrueFalseTotal
defined $value ? : 320 2 322
371 "Warper: trigger called on ",
372 $self->name,
373 " with value '",
374 defined $value ? $value : '<undef>',
375 "' name $warp_name"
376 );
377 322 ▶ $self->_set_value( $warp_name => $value || '' );
Condition100%2/2
$value || ''
l!l
3166
MC/DC100%1/1
$value || ''
$value
Truth table100%2/2
A
A= $value
Aresult
11
00
378 }
379  
380 # read warp master values that are computed
381 322 my $cm = $self->_computed_masters;
382 322 foreach my $name ( keys %$cm ) {
383 0 $self->_set_value( $name => $cm->{$name}->fetch );
384 }
385  
386 # check if new values are different from old values
387 322 my $same = 1;
388 322 foreach my $name ( $self->_value_keys ) {
389 496 my $old = $old_value_set{$name};
390 496 my $new = $self->_get_value_gist($name);
391 496 ▶ $same = 0
Branch: 3 branches
BranchTrueFalseTotal
if $old ? 1 : 0 xor $new ? 1 : 0 or $old and $new and $new ne $old 296 200 496
$old ? : 422 74 496
$new ? : 484 12 496
Condition92%12/13
$old ? 1 : 0 xor $new ? 1 : 0 or $old and $new and $new ne $old
l!l&&r!l&&!r
64232200
$old ? 1 : 0 xor $new ? 1 : 0
l&&rl&&!r!l&&r!l&&!r
42116311
$old and $new and $new ne $old
!ll&&!rl&&r
11189232
$old and $new
!ll&&!rl&&r
110421
MC/DC60%3/5
$old ? 1 : 0 xor $new ? 1 : 0 or $old and $new and $new ne $old
$old ? 1 : 0 $new ? 1 : 0 $old $new $new ne $old
Truth table50%5/10
A xor B or C and D and E
A= $old ? 1 : 0B= $new ? 1 : 0C= $oldD= $newE= $new ne $old
ABCDEresult
10XXX1
01XXX1
111111
001111
110XX0
1110X0
111100
000XX0
0010X0
001100
392 if ( $old ? 1 : 0 xor $new ? 1 : 0 )
393 or ( $old and $new and $new ne $old );
394 }
395  
396 322 ▶ if ($same) {
Branch: 1 branch
BranchTrueFalseTotal
if ($same) 26 296 322
397 ## no critic (TestingAndDebugging::ProhibitNoWarnings)
398 59 ▶ no warnings "uninitialized";
Subroutine BEGIN: called CC=1 SCAR=0.0
399 26 ▶ if ( $logger->is_debug ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($logger->is_debug) 0 26 26
400 $logger->debug(
401 "Warper: warp skipped because no change in value set ",
402 "(old: '", join( "' '", %old_value_set ),
403 0 "' new: '", join( "' '", %{ $self->_values() } ), "')"
404 );
405 }
406 26 return;
407 }
408  
409 296 $self->do_warp;
410 295 return;
411 }
412  
413 # undef values are changed to '' so compute_bool no longer returns
414 # undef. It returns either 1 or 0
415 1641 ▶sub compute_bool ($self, $expr) {
Subroutine compute_bool: called CC=4 SCAR=13.9
Pod undocumented
416 1641 $logger->trace("Warper compute_bool: called for '$expr'");
417  
418 # my $warp_value_set = $self->_values ;
419 1641 $logger->debug( "Warper compute_bool: data:\n",
420 Data::Dumper->Dump( [ $self->_values ], ['data'] ) );
421  
422 # checklist: $stuff.is_set(&index)
423 # get_value of a checklist gives { 'val1' => 1, 'val2' => 0,...}
424 1641 $expr =~ s/(\$\w+)\.is_set\(([&$"'\w]+)\)/$1.'->{'.$2.'}'/eg; #'
425  
426 1641 $expr =~ s/&(\w+)/\$warped_obj->$1/g;
427  
428 1641 my @init_code;
429 my %eval_data ;
430 1641 foreach my $warper_name ( $self->_value_keys ) {
431 2256 $eval_data{$warper_name} = $self->_get_value($warper_name) ;
432 2256 push @init_code, "my \$$warper_name = \$eval_data{'$warper_name'} ;";
433 }
434  
435 1641 my $perl_code = join( "\n", @init_code, $expr );
436 1641 $logger->trace("Warper compute_bool: eval code '$perl_code'");
437  
438 1641 my $ret;
439 {
440 1641 my $warped_obj = $self->warped_object ;
441 ## no critic (TestingAndDebugging::ProhibitNoWarnings)
442 59 ▶ no warnings "uninitialized";
Subroutine BEGIN: called CC=1 SCAR=0.0
443 1641 $ret = eval($perl_code); ## no critic (ProhibitStringyEval)
444 }
445  
446 1641 ▶ if ($@) {
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 1641 1641
447 0 Config::Model::Exception::Model->throw(
448 object => $self->warped_object,
449 error => "Warp boolean expression failed:\n$@" . "eval'ed code is: \n$perl_code"
450 );
451 }
452  
453 1641 ▶ $logger->debug( "compute_bool: eval result: ", ( $ret ? 'true' : 'false' ) );
Branch: 1 branch
BranchTrueFalseTotal
$ret ? : 333 1308 1641
454 1641 return $ret;
455 }
456  
457 764 ▶sub do_warp ($self) {
Subroutine do_warp: called CC=11 SCAR=24.2
Pod undocumented
458 764 my $warp_value_set = $self->_values;
459 764 my $rules = $self->rules;
460  
461 # try all boolean expression with warp_value_set to get the
462 # correct rule
463  
464 764 my $found_apply = {};
465 764 my $found_bool = ''; # this variable may be used later in error message
466  
467 764 foreach my $rule (@$rules) {
468 1641 foreach my $param (qw/when apply/) {
469 3282 ▶ unless ($rule->{$param}) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($rule->{$param}) 0 3282 3282
470 0 my $dump = Data::Dumper->Dump( [$rule], ['rule']);
471 0 Config::Model::Exception::Model->throw(
472 object => $self->warped_object,
473 error => "Warp failed: missing '$param' parameter in $dump"
474 );
475 }
476 }
477  
478 1641 my $bool_expr = $rule->{when};
479 1641 my $res = $self->compute_bool($bool_expr);
480 1641 ▶ next unless $res;
Branch: 1 branch
BranchTrueFalseTotal
unless $res 1308 333 1641
481  
482 333 $found_bool = $bool_expr;
483 333 $found_apply = $rule->{apply};
484 333 $logger->trace(
485 "do_warp found rule for '$bool_expr':\n",
486 Data::Dumper->Dump( [$found_apply], ['found_apply'] ) );
487 333 last;
488 }
489  
490 764 ▶ if ( $logger->is_info ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($logger->is_info) 7 757 764
491 7 ▶ my @warp_str = map { defined $_ ? $_ : 'undef' } keys %$warp_value_set;
Branch: 1 branch
BranchTrueFalseTotal
defined $_ ? : 7 0 7
492  
493 7 ▶ $logger->info(
Branch: 1 branch
BranchTrueFalseTotal
scalar %$found_apply ? : 1 6 7
494 "do_warp: warp called from '$found_bool' on '",
495 $self->warped_object->name,
496 "' with elements '",
497 join( "','", @warp_str ),
498 "', warp rule is ",
499 ( scalar %$found_apply ? "" : 'not ' ),
500 "found"
501 );
502 }
503  
504 764 $logger->trace( "do_warp: call set_parent_element_property on '",
505 $self->name, "' with ", Data::Dumper->Dump( [$found_apply], ['found_apply'] ) );
506  
507 764 $self->set_parent_element_property($found_apply);
508  
509 764 $logger->debug(
510 "do_warp: call set_properties on '",
511 $self->warped_object->name,
512 "' with ", Data::Dumper->Dump( [$found_apply], ['found_apply'] ) );
513 764 eval { $self->warped_object->set_properties(%$found_apply); };
514  
515 764 ▶ if ($@) {
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 1 763 764
516 1 ▶ my @warp_str = map { defined $_ ? $_ : 'undef' } keys %$warp_value_set;
Branch: 1 branch
BranchTrueFalseTotal
defined $_ ? : 1 0 1
517 1 my $e = $@;
518 1 ▶ my $msg = ref $e ? $e->as_string : $e;
Branch: 1 branch
BranchTrueFalseTotal
ref $e ? : 1 0 1
519 1 Config::Model::Exception::Model->throw(
520 object => $self->warped_object,
521 error => "Warp failed when following '"
522 . join( "','", @warp_str )
523 . "' from \"$found_bool\". Check model rules:\n\t"
524 . $msg
525 );
526 }
527 763 return;
528 }
529  
530 # Usually a warp error occurs when the item is not actually available
531 # or when a setting is wrong. Then guiding the user toward a warp
532 # master value that has a rule attached to it is a good idea.
533  
534 # But sometime, the user wants to remove and item. In this case it
535 # must be warped out by setting a warp master value that has not rule
536 # attached. This case is indicated when $want_remove is set to 1
537 7 ▶sub warp_error ($self) {
Subroutine warp_error: called CC=14 SCAR=52.4
Pod documented
538 7 ▶ return '' unless defined $self->{warp};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"warp"} 7 0 7
539 0 my $follow = $self->{warp}{follow};
540 0 my @rules = @{ $self->{warp}{rules} };
541  
542 # follow is either ['warp1','warp2',...]
543 # or { warp1 => {....} , ...} or 'warp'
544 0 ▶ my @warper_paths =
Branch: 2 branches
BranchTrueFalseTotal
ref $follow eq 'ARRAY' ? : 0 0 0
ref $follow eq 'HASH' ? : 0 0 0
545 ref($follow) eq 'ARRAY' ? @$follow
546 : ref($follow) eq 'HASH' ? values %$follow
547 : ($follow);
548  
549 0 ▶ my $str =
Branch: 1 branch
BranchTrueFalseTotal
@warper_paths > 1 ? : 0 0 0
550 "You may solve the problem by modifying "
551 . ( @warper_paths > 1 ? "one or more of " : '' )
552 . "the following configuration parameters:\n";
553  
554 0 my $expected_error = 'Config::Model::Exception::UnavailableElement';
555  
556 0 foreach my $warper_path (@warper_paths) {
557 0 my $warper_value;
558 my $warper;
559  
560 # try
561 0 eval {
562 0 $warper = $self->get_warper_object($warper_path);
563 0 $warper_value = $warper->fetch;
564 };
565 0 my $e = $@;
566 # catch
567 0 ▶ if ( ref($e) eq $expected_error ) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $e eq $expected_error) 0 0 0
568 0 $str .= "\t'$warper_path' which is unavailable\n";
569 0 next;
570 }
571  
572 0 ▶ $warper_value = 'undef' unless defined $warper_value;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $warper_value 0 0 0
573  
574 my @choice =
575 0 ▶ defined $warper->choice ? @{ $warper->choice }
Branch: 1 branch
BranchTrueFalseTotal
$warper->{'value_type'} eq 'boolean' ? : 0 0 0
576 0 ▶ : $warper->{value_type} eq 'boolean' ? ( 0, 1 )
Branch: 1 branch
BranchTrueFalseTotal
defined $warper->choice ? : 0 0 0
577 : ();
578  
579 0 my @try = sort grep { $_ ne $warper_value } @choice;
580  
581 0 $str .= "\t'" . $warper->location . "': Try ";
582  
583 0 ▶ my $a = $warper->{value_type} =~ /^[aeiou]/ ? 'an' : 'a';
Branch: 1 branch
BranchTrueFalseTotal
$warper->{'value_type'} =~ /^[aeiou]/ ? : 0 0 0
584  
585 0 ▶ $str .=
Branch: 1 branch
BranchTrueFalseTotal
@try ? : 0 0 0
586 @try
587 ? "'" . join( "' or '", @try ) . "' instead of "
588 : "$a $warper->{value_type} value different from ";
589  
590 0 $str .= "'$warper_value'\n";
591  
592 0 ▶ if ( defined $warper->{compute} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $warper->{"compute"}) 0 0 0
593 0 $str .= "\n\tHowever, '" . $warper->name . "' " . $warper->compute_info . "\n";
594 }
595 }
596  
597 0 ▶ $str .= "Warp parameters:\n" . Data::Dumper->Dump( [ $self->{warp} ], ['warp'] )
Branch: 1 branch
BranchTrueFalseTotal
if $logger->is_debug 0 0 0
598 if $logger->is_debug;
599  
600 0 return $str;
601 }
602  
603 59 __PACKAGE__->meta->make_immutable;
604  
605 # ABSTRACT: Warp tree properties
606  
607 59 1;
608  
609 __END__
« blib/lib/Config/Model/CheckList.pm ↑ Summary blib/lib/Config/Model/SimpleUI.pm »