| 1 | package My::Opts; | ||
| 2 | |||
| 3 | use FindBin qw( $RealBin ); | ||
| 4 | use lib "$RealBin/lib"; | ||
| 5 | |||
| 6 | use v5.32; | ||
| 7 | use Mojo::Base -strict; | ||
| 8 | use File::Basename qw(basename); | ||
| 9 | use Getopt::Long qw( GetOptions ); | ||
| 10 | use Mojo::Util qw( dumper ); | ||
| 11 | use My::Array(); | ||
| 12 | |||
| 13 | =head2 new | ||
| 14 | |||
| 15 | Input: | ||
| 16 | [ | ||
| 17 | { | ||
| 18 | desc => "Option1", | ||
| 19 | spec => "opt1=s", | ||
| 20 | }, | ||
| 21 | { | ||
| 22 | desc => "Option2", | ||
| 23 | spec => "opt2=s", | ||
| 24 | required => 1, | ||
| 25 | default => 123, | ||
| 26 | }, | ||
| 27 | ] | ||
| 28 | |||
| 29 | =cut | ||
| 30 | |||
| 31 | =head2 new | ||
| 32 | |||
| 33 | Create a new options object. | ||
| 34 | |||
| 35 | =cut | ||
| 36 | |||
| 37 | sub new { | ||
| 38 | my ( $class, $spec ) = @_; | ||
| 39 | |||
| 40 | my $s = bless { | ||
| 41 | _args => \@ARGV, | ||
| 42 | _spec => $spec, | ||
| 43 | }, $class; | ||
| 44 | |||
| 45 | $s->_init(); | ||
| 46 | $s; | ||
| 47 | } | ||
| 48 | |||
| 49 | sub _init { | ||
| 50 | my ( $s ) = @_; | ||
| 51 | |||
| 52 | $s->_parse(); | ||
| 53 | |||
| 54 | GetOptions( $s, $s->{_opts_spec}->@* ) or die "\n[$!]\n"; | ||
| 55 | |||
| 56 | # Check required options. | ||
| 57 | my @missing_required = | ||
| 58 | map { $_->{key} } | ||
| 59 | grep { not defined $s->{$_->{key}} } | ||
| 60 | grep { $_->{_spec}{required} } $s->{_parsed}->@*; | ||
| 61 | if ( @missing_required ) { | ||
| 62 | local $" = "', '"; | ||
| 63 | say ""; | ||
| 64 | say $s->colored_msg( | ||
| 65 | "ERROR: Missing required parameter(s): '@missing_required'" ); | ||
| 66 | say ""; | ||
| 67 | exit 1; | ||
| 68 | } | ||
| 69 | |||
| 70 | # Set Defaults. | ||
| 71 | my @key_default = | ||
| 72 | map { [ | ||
| 73 | $_->{key}, | ||
| 74 | $_->{_spec}{default}, | ||
| 75 | ] } | ||
| 76 | grep { not defined $s->{$_->{key}} } | ||
| 77 | grep { $_->{_spec}{default} } $s->{_parsed}->@*; | ||
| 78 | |||
| 79 | for (@key_default) { | ||
| 80 | my ($key,$default) = @$_; | ||
| 81 | $s->{$key} = $default; | ||
| 82 | } | ||
| 83 | |||
| 84 | $s->debug() if $s->{debug}; | ||
| 85 | $s->list_options() if $s->{list_options}; | ||
| 86 | } | ||
| 87 | |||
| 88 | sub _parse { | ||
| 89 | my ( $s ) = @_; | ||
| 90 | |||
| 91 | my $parsed = $s->{_parsed} = $s->__parse(); | ||
| 92 | |||
| 93 | $s->{_opts_spec} = [ map { $_->{spec} } @$parsed ]; | ||
| 94 | $s->{_opts_list} = [ sort map { $_->{list}->@* } @$parsed ]; | ||
| 95 | |||
| 96 | $s; | ||
| 97 | } | ||
| 98 | |||
| 99 | sub __parse { | ||
| 100 | my ( $s ) = @_; | ||
| 101 | |||
| 102 | my @parsed = map { | ||
| 103 | my $opt_spec = $_->{spec}; | ||
| 104 | my $opt_desc = $_->{desc}; | ||
| 105 | my @opt_list = split /\|/, $opt_spec; | ||
| 106 | my $arg = $1 if $opt_list[-1] =~ s/ (\W+.*) //x; | ||
| 107 | my $key = $opt_list[0]; | ||
| 108 | |||
| 109 | for ( @opt_list ) { | ||
| 110 | s/ (?=^\w{2,}) /--/x; # Long options. | ||
| 111 | s/ (?=^\w$) /-/x; # Short options. | ||
| 112 | } | ||
| 113 | |||
| 114 | { | ||
| 115 | _spec => $_, | ||
| 116 | key => $key, | ||
| 117 | spec => $opt_spec, | ||
| 118 | list => \@opt_list, | ||
| 119 | arg => $arg // "", | ||
| 120 | desc => $opt_desc // "...", | ||
| 121 | }; | ||
| 122 | |||
| 123 | } $s->{_spec}->@*; | ||
| 124 | |||
| 125 | \@parsed; | ||
| 126 | } | ||
| 127 | |||
| 128 | =head2 debug | ||
| 129 | |||
| 130 | Show the options. | ||
| 131 | |||
| 132 | =cut | ||
| 133 | |||
| 134 | sub debug { | ||
| 135 | my ( $s ) = @_; | ||
| 136 | delete $s->{_parsed} unless $s->{debug} > 1; | ||
| 137 | say dumper $s; | ||
| 138 | exit 1; | ||
| 139 | } | ||
| 140 | |||
| 141 | =head2 list_options | ||
| 142 | |||
| 143 | Show all options. | ||
| 144 | |||
| 145 | Nice for generating bash completions. | ||
| 146 | |||
| 147 | =cut | ||
| 148 | |||
| 149 | sub list_options { | ||
| 150 | my ( $s ) = @_; | ||
| 151 | say for $s->{_opts_list}->@*; | ||
| 152 | exit 1; | ||
| 153 | } | ||
| 154 | |||
| 155 | =head2 build_help_options | ||
| 156 | |||
| 157 | Builds the text for the options | ||
| 158 | section of a help menu. | ||
| 159 | |||
| 160 | =cut | ||
| 161 | |||
| 162 | sub build_help_options { | ||
| 163 | my ( $s ) = @_; | ||
| 164 | my $indent = " " x 6; | ||
| 165 | my $parsed = $s->{_parsed}; | ||
| 166 | |||
| 167 | my @line = map { | ||
| 168 | my $arg = _expand_arg( $_->{arg} ); | ||
| 169 | my $opts_list = join ", ", $_->{list}->@*; | ||
| 170 | [ "$opts_list$arg", $_->{desc}, ] | ||
| 171 | } @$parsed; | ||
| 172 | |||
| 173 | my $max = My::Array->max_lengths( \@line ); | ||
| 174 | my $format = $s->_make_format( $max ); | ||
| 175 | my $output = join "\n$indent", map { sprintf $format, @$_; } @line; | ||
| 176 | |||
| 177 | $output; | ||
| 178 | } | ||
| 179 | |||
| 180 | sub _expand_arg { | ||
| 181 | local ( $_ ) = @_; | ||
| 182 | |||
| 183 | my $required = s/=//; | ||
| 184 | my $optional = s/:(\d+)/DEFAULT=$1/ or s/://; | ||
| 185 | |||
| 186 | my %means = ( | ||
| 187 | s => "STRING", | ||
| 188 | i => "INTEGER", | ||
| 189 | '+' => "INCREMENT", | ||
| 190 | ); | ||
| 191 | |||
| 192 | my $arg = $means{$_} // $_; | ||
| 193 | |||
| 194 | $arg = "[$arg]" if $optional; | ||
| 195 | $arg = " $arg" if $arg ne ""; | ||
| 196 | |||
| 197 | $arg; | ||
| 198 | } | ||
| 199 | |||
| 200 | sub _make_format { | ||
| 201 | my ( $s, $max ) = @_; | ||
| 202 | join " # ", map { "%-${_}s" } @$max; | ||
| 203 | } | ||
| 204 | |||
| 205 | =head2 colored_msg | ||
| 206 | |||
| 207 | Returned a colored message. | ||
| 208 | |||
| 209 | =cut | ||
| 210 | |||
| 211 | sub colored_msg { | ||
| 212 | my ( $s, $msg, $script_path ) = @_; | ||
| 213 | my $script = basename($script_path // $0); | ||
| 214 | |||
| 215 | package My { use Mojo::Base -base }; | ||
| 216 | my $my = My->with_roles( "+ColoredHelp" )->new; | ||
| 217 | $my->color_msg( $msg, $script ); | ||
| 218 | } | ||
| 219 | |||
| 220 | 1; |