-
Notifications
You must be signed in to change notification settings - Fork 31
/
Fix.pm
1090 lines (853 loc) · 28.8 KB
/
Fix.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Catmandu::Fix;
use Catmandu::Sane;
our $VERSION = '1.0201';
use Moo;
use Catmandu::Fix::Parser;
use Text::Hogan::Compiler;
use Path::Tiny ();
use File::Spec ();
use File::Temp ();
use Catmandu::Util qw(
is_string
is_array_ref
is_hash_ref
is_code_ref
is_glob_ref
is_instance
is_able
require_package
);
use namespace::clean;
with 'Catmandu::Logger';
with 'Catmandu::Emit';
has parser => (is => 'lazy');
has fixer => (is => 'lazy', init_arg => undef);
has _captures =>
(is => 'ro', lazy => 1, init_arg => undef, default => sub {+{}});
has var =>
(is => 'ro', lazy => 1, init_arg => undef, builder => '_generate_var');
has _fixes => (is => 'ro', init_arg => 'fixes', default => sub {[]});
has fixes =>
(is => 'ro', lazy => 1, init_arg => undef, builder => '_build_fixes');
has _reject_var => (
is => 'ro',
lazy => 1,
init_arg => undef,
builder => '_build_reject_var'
);
has _fixes_var =>
(is => 'ro', lazy => 1, init_arg => undef, builder => '_build_fixes_var');
has preprocess => (is => 'ro');
has _hogan =>
(is => 'ro', lazy => 1, init_arg => undef, builder => '_build_hogan');
has _hogan_vars => (is => 'ro', init_arg => 'variables');
sub _build_parser {
Catmandu::Fix::Parser->new;
}
sub _build_fixes {
my ($self) = @_;
my $fixes_arg = $self->_fixes;
my $fixes = [];
for my $fix (@$fixes_arg) {
if (is_code_ref($fix)) {
push @$fixes, require_package('Catmandu::Fix::code')->new($fix);
}
elsif (ref $fix && ref($fix) =~ /^IO::/) {
my $txt = Catmandu::Util::read_io($fix);
$txt = $self->_preprocess($txt);
push @$fixes, @{$self->parser->parse($txt)};
}
elsif (is_glob_ref($fix)) {
my $fh = Catmandu::Util::io $fix , binmode => ':encoding(UTF-8)';
my $txt = Catmandu::Util::read_io($fh);
$txt = $self->_preprocess($txt);
push @$fixes, @{$self->parser->parse($txt)};
}
elsif (ref $fix) {
push @$fixes, $fix;
}
elsif (is_string($fix)) {
if ($fix =~ /[^\s]/ && $fix !~ /\(/) {
$fix = Path::Tiny::path($fix)->slurp_utf8;
}
$fix = $self->_preprocess($fix);
push @$fixes, @{$self->parser->parse($fix)};
}
}
$fixes;
}
sub _build_fixer {
my ($self) = @_;
my $reject = $self->_reject;
my $sub = $self->_eval_sub(
$self->emit,
args => [$self->var],
captures => $self->_captures
);
sub {
my $data = $_[0];
if (is_hash_ref($data)) {
my $d = $sub->($data);
return if ref $d && $d == $reject;
return $d;
}
if (is_array_ref($data)) {
return [grep {!(ref $_ && $_ == $reject)}
map {$sub->($_)} @$data];
}
if (is_code_ref($data)) {
return sub {
while (1) {
my $d = $sub->($data->() // return);
return if ref $d && $d == $reject;
return $d;
}
};
}
if ( is_instance($data)
&& is_able($data, 'does')
&& $data->does('Catmandu::Iterable'))
{
return $data->map(sub {$sub->($_[0])})
->reject(sub {ref $_[0] && $_[0] == $reject});
}
Catmandu::BadArg->throw(
"must be hashref, arrayref, coderef or iterable object");
};
}
sub _build_reject_var {
my ($self) = @_;
$self->capture($self->_reject);
}
sub _build_fixes_var {
my ($self) = @_;
$self->capture($self->fixes);
}
sub _build_hogan {
Text::Hogan::Compiler->new;
}
sub _preprocess {
my ($self, $text) = @_;
return $text unless $self->preprocess || $self->_hogan_vars;
my $vars = $self->_hogan_vars || {};
$self->_hogan->compile($text, {numeric_string_as_string => 1})
->render($vars);
}
sub fix {
my ($self, $data) = @_;
$self->fixer->($data);
}
sub generate_var {
$_[0]->_generate_var;
}
sub generate_label {
$_[0]->_generate_label;
}
sub capture {
my ($self, $capture) = @_;
my $var = $self->_generate_var;
$self->_captures->{$var} = $capture;
$var;
}
sub emit {
my ($self) = @_;
my $var = $self->var;
my $err = $self->_generate_var;
my $reject_var = $self->_reject_var;
my $perl = "";
$perl .= "eval {";
# Loop over all the fixes and emit their code
$perl .= $self->emit_fixes($self->fixes);
$perl .= "return ${var};";
$perl .= $self->_reject_label . ": return ${reject_var};";
$perl .= "} or do {";
$perl .= $self->_emit_declare_vars($err, '$@');
$perl .= "${err}->throw if is_instance(${err},'Throwable::Error');";
$perl .= "Catmandu::FixError->throw(message => ${err}, data => ${var});";
$perl .= "};";
$self->log->debug($perl);
$perl;
}
# Emit an array of fixes
sub emit_fixes {
my ($self, $fixes) = @_;
my $perl = '';
for (my $i = 0; $i < @{$fixes}; $i++) {
my $fix = $fixes->[$i];
$perl .= $self->emit_fix($fix);
}
$perl;
}
sub emit_reject {
$_[0]->_emit_reject;
}
sub emit_fix {
my ($self, $fix) = @_;
my $perl;
if ($fix->can('emit')) {
$perl = $self->emit_block(
sub {
my ($label) = @_;
$fix->emit($self, $label);
}
);
}
elsif ($fix->can('fix')) {
my $var = $self->var;
my $ref = $self->_generate_var;
$self->_captures->{$ref} = $fix;
$perl = "${var} = ${ref}->fix(${var});";
}
else {
Catmandu::Error->throw('not a fix');
}
$perl;
}
sub emit_block {
my ($self, $cb) = @_;
my $label = $self->_generate_label;
my $perl = "${label}: {";
$perl .= $cb->($label);
$perl .= "};";
$perl;
}
sub emit_clear_hash_ref {
my ($self, $var) = @_;
"undef %{${var}} if is_hash_ref(${var});";
}
sub emit_value {
shift->_emit_value(@_);
}
sub emit_string {
shift->_emit_string(@_);
}
sub emit_match {
my ($self, $pattern) = @_;
$pattern =~ s/\//\\\//g;
$pattern =~ s/\\$/\\\\/; # pattern can't end with an escape in m/.../
"m/$pattern/";
}
sub emit_substitution {
my ($self, $pattern, $replace) = @_;
$pattern =~ s/\//\\\//g;
$pattern =~ s/\\$/\\\\/; # pattern can't end with an escape in m/.../
$replace =~ s/\//\\\//g;
$replace =~ s/\\$/\\\\/; # pattern can't end with an escape in m/.../
"s/$pattern/$replace/";
}
sub emit_declare_vars {
shift->_emit_declare_vars(@_);
}
sub emit_new_scope {
"{";
}
sub emit_end_scope {
"};";
}
sub emit_foreach {
my ($self, $var, $cb) = @_;
my $perl = "";
my $v = $self->_generate_var;
$perl .= "foreach (\@{${var}}) {";
$perl .= $self->emit_declare_vars($v, '$_');
$perl .= $cb->($v);
$perl .= "}";
$perl;
}
sub emit_foreach_key {
my ($self, $var, $cb) = @_;
my $perl = "";
my $v = $self->_generate_var;
$perl .= "foreach (keys(\%{${var}})) {";
$perl .= $self->emit_declare_vars($v, '$_');
$perl .= $cb->($v);
$perl .= "}";
$perl;
}
sub emit_walk_path {
my ($self, $var, $keys, $cb) = @_;
$keys = [@$keys]; # protect keys
if (@$keys) { # protect $var
my $v = $self->_generate_var;
$self->_emit_declare_vars($v, $var)
. $self->_emit_walk_path($v, $keys, $cb);
}
else {
$cb->($var);
}
}
sub _emit_walk_path {
my ($self, $var, $keys, $cb) = @_;
@$keys || return $cb->($var);
my $key = shift @$keys;
my $str_key = $self->emit_string($key);
my $perl = "";
if ($key =~ /^[0-9]+$/) {
$perl .= "if (is_hash_ref(${var})) {";
$perl .= "${var} = ${var}->{${str_key}};";
$perl .= $self->_emit_walk_path($var, [@$keys], $cb);
$perl .= "} elsif (is_array_ref(${var}) && \@{${var}} > ${key}) {";
$perl .= "${var} = ${var}->[${key}];";
$perl .= $self->_emit_walk_path($var, [@$keys], $cb);
$perl .= "}";
}
elsif ($key eq '*') {
my $v = $self->_generate_var;
$perl .= "if (is_array_ref(${var})) {";
$perl .= $self->emit_foreach(
$var,
sub {
return $self->_emit_walk_path(shift, $keys, $cb);
}
);
$perl .= "}";
}
else {
if ($key eq '$first') {
$perl .= "if (is_array_ref(${var}) && \@{${var}}) {";
$perl .= "${var} = ${var}->[0];";
}
elsif ($key eq '$last') {
$perl .= "if (is_array_ref(${var}) && \@{${var}}) {";
$perl .= "${var} = ${var}->[\@{${var}} - 1];";
}
else {
$perl .= "if (is_hash_ref(${var})) {";
$perl .= "${var} = ${var}->{${str_key}};";
}
$perl .= $self->_emit_walk_path($var, $keys, $cb);
$perl .= "}";
}
$perl;
}
sub emit_create_path {
my ($self, $var, $keys, $cb) = @_;
$self->_emit_create_path($var, [@$keys], $cb);
}
sub _emit_create_path {
my ($self, $var, $keys, $cb) = @_;
@$keys || return $cb->($var);
my $key = shift @$keys;
my $str_key = $self->emit_string($key);
my $perl = "";
if ($key =~ /^[0-9]+$/) {
my $v1 = $self->_generate_var;
my $v2 = $self->_generate_var;
$perl .= "if (is_hash_ref(${var})) {";
$perl .= "my ${v1} = ${var};";
$perl
.= $self->_emit_create_path("${v1}->{${str_key}}", [@$keys], $cb);
$perl .= "} elsif (is_maybe_array_ref(${var})) {";
$perl .= "my ${v2} = ${var} //= [];";
$perl .= $self->_emit_create_path("${v2}->[${key}]", [@$keys], $cb);
$perl .= "}";
}
elsif ($key eq '*') {
my $v1 = $self->_generate_var;
my $v2 = $self->_generate_var;
$perl .= "if (is_array_ref(${var})) {";
$perl .= "my ${v1} = ${var};";
$perl .= "for (my ${v2} = 0; ${v2} < \@{${v1}}; ${v2}++) {";
$perl .= $self->_emit_create_path("${v1}->[${v2}]", $keys, $cb);
$perl .= "}";
$perl .= "}";
}
else {
my $v = $self->_generate_var;
if ( $key eq '$first'
|| $key eq '$last'
|| $key eq '$prepend'
|| $key eq '$append')
{
$perl .= "if (is_maybe_array_ref(${var})) {";
$perl .= "my ${v} = ${var} //= [];";
if ($key eq '$first') {
$perl .= $self->_emit_create_path("${v}->[0]", $keys, $cb);
}
elsif ($key eq '$last') {
$perl .= "if (\@${v}) {";
$perl .= $self->_emit_create_path("${v}->[\@${v} - 1]",
[@$keys], $cb);
$perl .= "} else {";
$perl .= $self->_emit_create_path("${v}->[0]", [@$keys], $cb);
$perl .= "}";
}
elsif ($key eq '$prepend') {
$perl .= "if (\@${v}) {";
$perl .= "unshift(\@${v}, undef);";
$perl .= "}";
$perl .= $self->_emit_create_path("${v}->[0]", $keys, $cb);
}
elsif ($key eq '$append') {
$perl
.= $self->_emit_create_path("${v}->[\@${v}]", $keys, $cb);
}
$perl .= "}";
}
else {
$perl .= "if (is_maybe_hash_ref(${var})) {";
$perl .= "my ${v} = ${var} //= {};";
$perl
.= $self->_emit_create_path("${v}->{${str_key}}", $keys, $cb);
$perl .= "}";
}
}
$perl;
}
sub emit_get_key {
my ($self, $var, $key, $cb) = @_;
return $cb->($var) unless defined $key;
my $str_key = $self->emit_string($key);
my $perl = "";
if ($key =~ /^[0-9]+$/) {
$perl .= "if (is_hash_ref(${var}) && exists(${var}->{${str_key}})) {";
$perl .= $cb->("${var}->{${str_key}}");
$perl .= "} elsif (is_array_ref(${var}) && \@{${var}} > ${key}) {";
$perl .= $cb->("${var}->[${key}]");
$perl .= "}";
}
elsif ($key eq '$first') {
$perl .= "if (is_array_ref(${var}) && \@{${var}}) {";
$perl .= $cb->("${var}->[0]");
$perl .= "}";
}
elsif ($key eq '$last') {
$perl .= "if (is_array_ref(${var}) && \@{${var}}) {";
$perl .= $cb->("${var}->[\@{${var}} - 1]");
$perl .= "}";
}
elsif ($key eq '*') {
my $i = $self->_generate_var;
$perl .= "if (is_array_ref(${var})) {";
$perl .= "for (my ${i} = 0; ${i} < \@{${var}}; ${i}++) {";
$perl .= $cb->("${var}->[${i}]", $i);
$perl .= "}}";
}
else {
$perl .= "if (is_hash_ref(${var}) && exists(${var}->{${str_key}})) {";
$perl .= $cb->("${var}->{${str_key}}");
$perl .= "}";
}
$perl;
}
sub emit_set_key {
my ($self, $var, $key, $val) = @_;
return "${var} = $val;" unless defined $key;
my $perl = "";
my $str_key = $self->emit_string($key);
if ($key =~ /^[0-9]+$/) {
$perl .= "if (is_hash_ref(${var})) {";
$perl .= "${var}->{${str_key}} = $val;";
$perl .= "} elsif (is_array_ref(${var})) {";
$perl .= "${var}->[${key}] = $val;";
$perl .= "}";
}
elsif ($key eq '$first') {
$perl .= "if (is_array_ref(${var})) {";
$perl .= "${var}->[0] = $val;";
$perl .= "}";
}
elsif ($key eq '$last') {
$perl .= "if (is_array_ref(${var})) {";
$perl .= "${var}->[\@{${var}} - 1] = $val;";
$perl .= "}";
}
elsif ($key eq '$prepend') {
$perl .= "if (is_array_ref(${var})) {";
$perl .= "unshift(\@{${var}}, $val);";
$perl .= "}";
}
elsif ($key eq '$append') {
$perl .= "if (is_array_ref(${var})) {";
$perl .= "push(\@{${var}}, $val);";
$perl .= "}";
}
elsif ($key eq '*') {
my $i = $self->_generate_var;
$perl .= "if (is_array_ref(${var})) {";
$perl .= "for (my ${i} = 0; ${i} < \@{${var}}; ${i}++) {";
$perl .= "${var}->[${i}] = $val;";
$perl .= "}}";
}
else {
$perl .= "if (is_hash_ref(${var})) {";
$perl .= "${var}->{${str_key}} = $val;";
$perl .= "}";
}
$perl;
}
sub emit_delete_key {
my ($self, $var, $key, $cb) = @_;
my $str_key = $self->emit_string($key);
my $perl = "";
my $vals;
if ($cb) {
$vals = $self->_generate_var;
$perl = $self->emit_declare_vars($vals, '[]');
}
if ($key =~ /^[0-9]+$/) {
$perl .= "if (is_hash_ref(${var}) && exists(${var}->{${str_key}})) {";
$perl .= "push(\@{${vals}}, " if $cb;
$perl .= "delete(${var}->{${str_key}})";
$perl .= ")" if $cb;
$perl .= ";";
$perl .= "} elsif (is_array_ref(${var}) && \@{${var}} > ${key}) {";
$perl .= "push(\@{${vals}}, " if $cb;
$perl .= "splice(\@{${var}}, ${key}, 1)";
$perl .= ")" if $cb;
}
elsif ($key eq '$first' || $key eq '$last' || $key eq '*') {
$perl .= "if (is_array_ref(${var}) && \@{${var}}) {";
$perl .= "push(\@{${vals}}, " if $cb;
$perl .= "splice(\@{${var}}, 0, 1)" if $key eq '$first';
$perl .= "splice(\@{${var}}, \@{${var}} - 1, 1)" if $key eq '$last';
$perl .= "splice(\@{${var}}, 0, \@{${var}})" if $key eq '*';
$perl .= ")" if $cb;
}
else {
$perl .= "if (is_hash_ref(${var}) && exists(${var}->{${str_key}})) {";
$perl .= "push(\@{${vals}}, " if $cb;
$perl .= "delete(${var}->{${str_key}})";
$perl .= ")" if $cb;
}
$perl .= ";";
$perl .= "}";
if ($cb) {
$perl .= $cb->($vals);
}
$perl;
}
sub emit_retain_key {
my ($self, $var, $key) = @_;
my $perl = "";
if ($key =~ /^[0-9]+$/) {
$perl .= "if (is_hash_ref(${var})) {";
$perl .= $self->emit_foreach_key(
$var,
sub {
my $v = shift;
"delete(${var}->{${v}}) if ${v} ne ${key};";
}
);
$perl .= "} elsif (is_array_ref(${var})) {";
$perl .= "if (\@{${var}} > ${key}) {";
$perl .= "splice(\@{${var}}, 0, ${key});" if $key > 0;
$perl .= "splice(\@{${var}}, 1, \@{${var}} - 1);";
$perl .= "} else {";
$perl .= "splice(\@{${var}}, 0, \@{${var}});";
$perl .= "}";
$perl .= "}";
}
elsif ($key eq '$first') {
$perl .= "if (is_array_ref(${var}) && \@{${var}} > 1) {";
$perl .= "splice(\@{${var}}, 1, \@{${var}} - 1);";
$perl .= "}";
}
elsif ($key eq '$last') {
$perl .= "if (is_array_ref(${var}) && \@{${var}} > 1) {";
$perl .= "splice(\@{${var}}, 0, \@{${var}} - 1);";
$perl .= "}";
}
elsif ($key eq '*') {
# retain everything
}
else {
$key = $self->emit_string($key);
$perl .= "if (is_hash_ref(${var})) {";
$perl .= $self->emit_foreach_key(
$var,
sub {
my $v = shift;
"if ($v ne ${key}) {" . "delete(${var}->{${v}});" . "}";
}
);
$perl .= "}";
}
$perl;
}
sub emit_clone {
my ($self, $var) = @_;
"$var = clone($var);";
}
# Split a path on '.' or '/', but not on '\.' or '\/'.
sub split_path {
my ($self, $path) = @_;
Catmandu::Util::split_path($path);
}
1;
__END__
=pod
=head1 NAME
Catmandu::Fix - a Catmandu class used for data transformations
=head1 SYNOPSIS
# From the command line
$ catmandu convert JSON --fix 'add_field(foo,bar)' < data.json
$ catmandu convert YAML --fix 'upcase(job); remove_field(test)' < data.yml
$ catmandu convert CSV --fix 'sort_field(tags)' < data.csv
$ catmandu run /tmp/myfixes.txt
$ catmandu convert OAI --url http://biblio.ugent.be/oai --fix /tmp/myfixes.txt
# From Perl
use Catmandu;
my $fixer = Catmandu->fixer('upcase(job)','remove_field(test)');
my $fixer = Catmandu->fixer('/tmp/myfixes.txt');
# Convert data
my $arr = $fixer->fix([ ... ]);
my $hash = $fixer->fix({ ... });
my $importer = Catmandu->importer('YAML', file => 'data.yml');
my $fixed_importer = $fixer->fix($importer);
# Inline fixes
use Catmandu::Fix::upcase as => 'my_upcase';
use Catmandu::Fix::remove_field as => 'my_remove';
my $hash = { 'job' => 'librarian' , deep => { nested => '1'} };
my_upcase($hash,'job');
my_remove($hash,'deep.nested');
=head1 DESCRIPTION
A Catmandu::Fix is a Perl package that can transform data. These packages are used
for easy data manipulation by non programmers. The main intention is to use fixes
on the command line or in Fix scripts. A small DSL language is available to execute
many Fix command on a stream of data.
When a C<fix> argument is given to a L<Catmandu::Importer>, L<Catmandu::Exporter> or
L<Catmandu::Store> then the transformations are executed on every item in the stream.
=head1 FIX LANGUAGE
A Fix script is a collection of one or more Fix commands. The fixes are executed
on every record in the dataset. If this command is executed on the command line:
$ catmandu convert JSON --fix 'upcase(title); add_field(deep.nested.field,1)' < data.json
then all the title fields will be upcased and a new deeply nested field will be added:
{ "title":"foo" }
{ "title":"bar" }
becomes:
{ "title":"FOO" , "deep":{"nested":{"field":1}} }
{ "title":"BAR" , "deep":{"nested":{"field":1}} }
Using the command line, Fix commands need a semicolon (;) as separator. All these commands can
also be written into a Fix script where semicolons are not required:
$ catmandu convert JSON --fix script.fix < data.json
where C<script.fix> contains:
upcase(title)
add_field(deep.nested.field,1)
Conditionals can be used to provide the logic when to execute fixes:
if exists(error)
set_field(valid, 0)
end
if exists(error)
set_field(is_valid, 0)
elsif exists(warning)
set_field(is_valid, 1)
log(...)
else
set_field(is_valid, 1)
end
unless all_match(title, "PERL")
add_field(is_perl, "noooo")
end
exists(error) and set_field(is_valid, 0)
exists(error) && set_field(is_valid, 0)
exists(title) or log('title missing')
exists(title) || log('title missing')
Binds are used to manipulate the context in which Fixes are executed. E.g.
execute a fix on every item in a list:
# 'demo' is an array of hashes
bind list(path:demo)
add_field(foo,bar)
end
# do is an alias for bind
do list(path:demo)
add_field(foo,bar)
end
To delete records from a stream of data the C<reject> Fix can be used:
reject() # Reject all in the stream
if exists(foo)
reject() # Reject records that contain a 'foo' field
end
reject exists(foo) # Reject records that contain a 'foo' field
The opposite of C<reject> is C<select>:
select() # Keep all records in the stream
select exists(foo) # Keep only the records that contain a 'foo' field
Comments in Fix scripts are all lines (or parts of a line) that start with a hash (#):
# This is ignored
add_field(test,123) # This is also a comment
You can load fixes from another namespace with the C<use> statement:
# this will look for fixes in the Foo::Bar namespace and make them
# available prefixed by fb
use(foo.bar, as: fb)
fb.baz()
# this will look for Foo::Bar::Condition::is_baz
if fb.is_baz()
end
=head1 PATHS
Most of the Fix commandsuse paths to point to values
in a data record. E.g. 'foo.2.bar' is a key 'bar' which is the 3-rd value of the
key 'foo'.
A special case is when you want to point to all items in an array. In this case
the wildcard '*' can be used. E.g. 'foo.*' points to all the items in the 'foo'
array.
For array values there are special wildcards available:
* $append - Add a new item at the end of an array
* $prepend - Add a new item at the start of an array
* $first - Syntactic sugar for index '0' (the head of the array)
* $last - Syntactic sugar for index '-1' (the tail of the array)
E.g.
# Create { mods => { titleInfo => [ { 'title' => 'a title' }] } };
add_field('mods.titleInfo.$append.title', 'a title');
# Create { mods => { titleInfo => [ { 'title' => 'a title' } , { 'title' => 'another title' }] } };
add_field('mods.titleInfo.$append.title', 'another title');
# Create { mods => { titleInfo => [ { 'title' => 'foo' } , { 'title' => 'another title' }] } };
add_field('mods.titleInfo.$first.title', 'foo');
# Create { mods => { titleInfo => [ { 'title' => 'foo' } , { 'title' => 'bar' }] } };
add_field('mods.titleInfo.$last.title', 'bar');
=head1 OPTIONS
=head2 fixes
An array of fixes. L<Catmandu::Fix> which will execute every fix in consecutive
order. A fix can be the name of a Catmandu::Fix::* routine, or the path to a
plain text file containing all the fixes to be executed. Required.
=head2 preprocess
If set to C<1>, fix files or inline fixes will first be preprocessed as a
moustache template. See C<variables> below for an example. Default is C<0>, no
preprocessing.
=head2 variables
An optional hashref of variables that are used to preprocess the fix files or
inline fixes as a moustache template. Setting the C<variables> option also sets
C<preprocess> to 1.
my $fixer = Catmandu::Fix->new(
variables => {x => 'foo', y => 'bar'},
fixes => ['add_field({{x}},{{y}})'],
);
my $data = {};
$fixer->fix($data);
# $data is now {foo => 'bar'}
=head1 METHODS
=head2 fix(HASH)
Execute all the fixes on a HASH. Returns the fixed HASH.
=head2 fix(ARRAY)
Execute all the fixes on every element in the ARRAY. Returns an ARRAY of fixes.
=head2 fix(Catmandu::Iterator)
Execute all the fixes on every item in an L<Catmandu::Iterator>. Returns a
(lazy) iterator on all the fixes.
=head2 fix(sub {})
Executes all the fixes on a generator function. Returns a new generator with fixed data.
=head2 log
Return the current logger. See L<Catmandu> for activating the logger in your main code.
=head1 CODING
One can extend the Fix language by creating own custom-made fixes. Two methods are
available to create an own Fix function:
* Quick and easy: create a class that implements a C<fix> method.
* Advanced: create a class that emits Perl code that will be evaled by the Fix module.
Both methods will be explained shortly.
=head2 Quick and easy
A Fix function is a Perl class in the C<Catmandu::Fix> namespace that implements a C<fix> method.
The C<fix> methods accepts a Perl hash as input and returns a (fixed) Perl hash as output. As
an example, the code belows implements the C<meow> Fix which inserts a 'meow' field with value 'purrrrr'.
package Catmandu::Fix::meow;
use Moo;
sub fix {
my ($self,$data) = @_;
$data->{meow} = 'purrrrr';
$data;
}
1;
Given this Perl class, the following fix statement can be used in your application:
# Will add 'meow' = 'purrrrr' to the data
meow()
Use the quick and easy method when your fixes are not dependent on reading or writing data
from/to a JSON path. Your Perl classes need to implement their own logic to read or write data
into the given Perl hash.
Fix arguments are passed as arguments to the C<new> function of the Perl class. As in
# In the fix file...
meow('test123', -count => 4)
# ...will be translated into this pseudo code
my $fix = Catmandu::Fix::meow->new('test123', '-count', 4);
Using L<Moo> these arguments can be catched with L<Catmandu::Fix::Has> package:
package Catmandu::Fix::meow;
use Catmandu::Sane;
use Moo;
use Catmandu::Fix::Has;
has msg => (fix_arg => 1); # required parameter 1
has count => (fix_opt => 1, default => sub { 4 }); # optional parameter 'count' with default value 4
sub fix {
my ($self,$data) = @_;
$data->{meow} = $self->msg x $self->count;
$data;
}
1;
Using this code the fix statement can be used like:
# Will add 'meow' = 'purrpurrpurrpurr'
meow('purr', -count => 4)
=head2 Advanced
The advanced method is required when one needs to read or write values from/to deeply nested JSON paths.
One could parse JSON paths using the quick and easy Perl class above, but this would require a
lot of inefficient for-while loops. The advanced method emits Perl code that gets compiled.
This compiled code is evaled against all Perl hashes in the unput.The best
way to learn this method is by inspecting some example Fix commands.
To ease the implementation of Fixed that emit Perl code some helper methods are created. Many Fix functions
require a transformation of one or more values on a JSON Path. The L<Catmandu::Fix::SimpleGetValue>
provides an easy way to create such as script. In the example below we'll set the value at a JSON Path
to 'purrrrr':
package Catmandu::Fix::purrrrr;
use Catmandu::Sane;
use Moo;
use Catmandu::Fix::Has;
has path => (fix_arg => 1);
with 'Catmandu::Fix::SimpleGetValue';
sub emit_value {
my ($self, $var, $fixer) = @_;
"${var} = 'purrrrr';";
}
1;
Run this command as:
# Set the value(s) of an existing path to 'purrr'
purrrrr(my.deep.nested.path)
purrrrr(all.my.values.*)
Notice how the C<emit_value> of the Catmandu::Fix::purrrrr package returns Perl code and doesn't
operate directy on the Perl data. The parameter C<$var> contains only the name of a temporary variable
that will hold the value of the JSON path after compiling the code into Perl.