bin/clarid-tools

filter: Statementstmt 78.0% 57 / 73 Branchbran 53.8% 14 / 26 Conditioncond 36.8% 7 / 19 MC/DCmcdc 9.0% 1 / 11 Subroutinesub 100% 11 / 11 Podpod n/a totaltotal 64.2% 90 / 140 CC 9 SCAR 16.6
CC
9
Cov
66%
_extract_log_path
10.9
_log_invocation
2.0
BEGIN
1.0
CRAP 5.3
« blib/lib/ClarID/Tools/Command/qrcode.pm ↑ Summary lib/ClarID/Tools/Validator.pm »
1 #!/usr/bin/env perl
2 #
3 # ClarID-Tools CLI
4 #
5 # Last Modified: Aug/08/2025
6 #
7 # $VERSION taken from ClarID::Tools
8 #
9 # Copyright (C) 2025 Manuel Rueda - CNAG
10 #
11 # License: Artistic License 2.0
12 #
13 # If this program helps you in your research, please cite.
14  
15 55 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
16 55 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 55 ▶use FindBin qw($Bin);
Subroutine BEGIN: called CC=1 SCAR=0.0
18 55 ▶use lib "$Bin/../lib";
Subroutine BEGIN: called CC=1 SCAR=0.0
19 55 ▶use ClarID::Tools;
Subroutine BEGIN: called CC=1 SCAR=0.0
20 55 ▶use JSON::XS qw(encode_json);
Subroutine BEGIN: called CC=1 SCAR=0.0
21 55 ▶use POSIX qw(strftime);
Subroutine BEGIN: called CC=1 SCAR=0.0
22 55 ▶use Cwd qw(getcwd);
Subroutine BEGIN: called CC=1 SCAR=0.0
23  
24 55 ▶use Path::Tiny;
Subroutine BEGIN: called CC=1 SCAR=0.0
25  
26 55 my ( $LOG_PATH, $ARGV_ORIG ) = _extract_log_path();
27 55 _log_invocation( $LOG_PATH, $ARGV_ORIG );
28  
29 # Shared usage text
30 55 my $USAGE = <<'END_USAGE';
31 Error: no command given.
32  
33 Usage:
34 clarid-tools <command> [options]
35 clarid-tools help [all|code|validate|qrcode]
36 clarid-tools --version
37  
38 Commands:
39 code Encode or decode IDs using your codebook
40 validate Validate a codebook against its JSON schema
41 qrcode Encode or decode ClarIDs to/from QR codes
42  
43 Run `clarid-tools help all` to see every option at once.
44 END_USAGE
45  
46 # Dispatch
47 # NOTE: we read @ARGV *after* stripping -log so users can put -log anywhere
48 55 ▶my $cmd = shift @ARGV // '';
Condition50%1/2
shift @ARGV // ""
l!l
550
MC/DC0%0/1
shift @ARGV // ""
shift @ARGV
Truth table50%1/2
A
A= shift @ARGV
Aresult
11
00
49  
50 # version flag
51 55 ▶if ( $cmd eq '-v' || $cmd eq '--v' || $cmd eq '--version' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($cmd eq "-v" or $cmd eq "--v" or $cmd eq "--version") 0 55 55
Condition33%2/6
$cmd eq "-v" or $cmd eq "--v" or $cmd eq "--version"
l!l&&r!l&&!r
0055
$cmd eq "-v" or $cmd eq "--v"
l!l&&r!l&&!r
0055
MC/DC0%0/3
$cmd eq "-v" or $cmd eq "--v" or $cmd eq "--version"
$cmd eq "-v" $cmd eq "--v" $cmd eq "--version"
Truth table25%1/4
A or B or C
A= $cmd eq "-v"B= $cmd eq "--v"C= $cmd eq "--version"
ABCresult
1XX1
01X1
0011
0000
52 0 printf "clarid-tools version %s\n", ClarID::Tools->VERSION;
53 0 exit;
54 }
55  
56 55 ▶if ( $cmd =~ /^-?-?help$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($cmd =~ /^-?-?help$/) 0 55 55
57 0 ▶ my $sub = shift @ARGV // 'all';
Condition0%0/2
shift @ARGV // "all"
l!l
00
MC/DC0%0/1
shift @ARGV // "all"
shift @ARGV
Truth table0%0/2
A
A= shift @ARGV
Aresult
11
00
58 0 ▶ if ( $sub eq 'all' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($sub eq 'all') { } 0 0 0
59 0 for my $c (qw(code validate qrcode)) {
60 0 print "\n=== clarid-tools $c options ===\n\n";
61 0 system( $^X, $0, $c, '--help' );
62 }
63 }
64 else {
65 0 exec $^X, $0, $sub, '--help';
66 }
67 0 exit;
68 }
69  
70 # No command or unknown
71 55 ▶if ( !$cmd || $cmd !~ /^(?:code|validate|qrcode)$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($cmd and $cmd =~ /^(?:code|validate|qrcode)$/) 0 55 55
Condition33%1/3
$cmd and $cmd =~ /^(?:code|validate|qrcode)$/
!ll&&!rl&&r
0055
MC/DC0%0/2
$cmd and $cmd =~ /^(?:code|validate|qrcode)$/
$cmd $cmd =~ /^(?:code|validate|qrcode)$/
Truth table33%1/3
A and B
A= $cmdB= $cmd =~ /^(?:code|validate|qrcode)$/
ABresult
0X0
100
111
72 0 die $USAGE;
73 }
74  
75 # Delegate to subcommands
76 55 ▶if ( $cmd eq 'code' ) {
Branch: 3 branches
BranchTrueFalseTotal
if ($cmd eq 'code') { } 49 6 55
elsif ($cmd eq 'validate') { } 6 0 6
elsif ($cmd eq 'qrcode') { } 0 0 0
77 49 require ClarID::Tools::Command::code;
78 49 ClarID::Tools::Command::code->new_with_options->execute;
79 }
80 elsif ( $cmd eq 'validate' ) {
81 6 require ClarID::Tools::Command::validate;
82 6 ClarID::Tools::Command::validate->new_with_options->execute;
83 }
84 elsif ( $cmd eq 'qrcode' ) {
85 0 require ClarID::Tools::Command::qrcode;
86 0 ClarID::Tools::Command::qrcode->new_with_options->execute;
87 }
88  
89 # --- logging glue ----------------------------------------------------
90 55 ▶sub _extract_log_path {
Subroutine _extract_log_path: called CC=8 SCAR=23.9
91  
92 # Returns (log_path_or_undef, \@argv_original)
93 55 my @orig = @ARGV;
94  
95 # We must handle -log, --log, and --log=FILE, anywhere in ARGV
96 55 ▶ for ( my $i = 0 ; $i < @ARGV ; $i++ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < @ARGV) 974 54 1028
97 974 my $arg = $ARGV[$i];
98  
99 # --log=/path/file
100 974 ▶ if ( $arg =~ /^--log=(.*)$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($arg =~ /^--log=(.*)$/) 0 974 974
101 0 ▶ my $path = $1 ne '' ? $1 : './clarid-cli.log';
Branch: 1 branch
BranchTrueFalseTotal
$1 ne '' ? : 0 0 0
102 0 splice @ARGV, $i, 1;
103 0 return ( $path, \@orig );
104 }
105  
106 # -log or --log [optional path]
107 974 ▶ if ( $arg eq '-log' || $arg eq '--log' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($arg eq "-log" or $arg eq "--log") 1 973 974
Condition66%2/3
$arg eq "-log" or $arg eq "--log"
l!l&&r!l&&!r
01973
MC/DC50%1/2
$arg eq "-log" or $arg eq "--log"
$arg eq "-log" $arg eq "--log"
Truth table66%2/3
A or B
A= $arg eq "-log"B= $arg eq "--log"
ABresult
1X1
011
000
108 1 my $path = './clarid-cli.log';
109 1 ▶ if ( defined $ARGV[ $i + 1 ] && $ARGV[ $i + 1 ] !~ /^-/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $ARGV[$i + 1] and not $ARGV[$i + 1] =~ /^-/) { } 1 0 1
Condition33%1/3
defined $ARGV[$i + 1] and not $ARGV[$i + 1] =~ /^-/
!ll&&!rl&&r
001
MC/DC0%0/2
defined $ARGV[$i + 1] and not $ARGV[$i + 1] =~ /^-/
defined $ARGV[$i + 1] not $ARGV[$i + 1] =~ /^-/
Truth table33%1/3
A and not(B)
A= defined $ARGV[$i + 1]B= not $ARGV[$i + 1] =~ /^-/
ABresult
0X0
100
111
110 1 $path = $ARGV[ $i + 1 ];
111 1 splice @ARGV, $i, 2; # remove flag and path
112 }
113 else {
114 0 splice @ARGV, $i, 1; # remove flag only
115 }
116 1 return ( $path, \@orig );
117 }
118 }
119 54 return ( undef, \@orig );
120 }
121  
122 55 ▶sub _log_invocation {
Subroutine _log_invocation: called CC=2 SCAR=6.9
123 55 my ( $log_file, $argv_snapshot ) = @_;
124 55 ▶ return unless $log_file;
Branch: 1 branch
BranchTrueFalseTotal
unless $log_file 54 1 55
125  
126 # Never crash CLI on logging errors
127 1 eval {
128 1 my $rec = {
129 ts => strftime( '%Y-%m-%dT%H:%M:%SZ', gmtime ),
130 cmd => $0,
131 argv => $argv_snapshot, # original ARGV (including -log)
132 cwd => getcwd(),
133 pid => $$,
134 version => ClarID::Tools->VERSION,
135 };
136 1 my $json = JSON::XS->new->utf8->canonical->encode($rec); # utf-8
137 1 path($log_file)->spew($json);
138 };
139 1 return;
140 }
141  
142 1;
« blib/lib/ClarID/Tools/Command/qrcode.pm ↑ Summary lib/ClarID/Tools/Validator.pm »