Commit | Line | Data |
ef47fe44 |
1 | package MooseX::Getopt::Basic; |
669588e2 |
2 | # ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality |
3 | |
ef47fe44 |
4 | use Moose::Role; |
5 | |
30ed85f7 |
6 | use MooseX::Getopt::OptionTypeMap; |
7 | use MooseX::Getopt::Meta::Attribute; |
8 | use MooseX::Getopt::Meta::Attribute::NoGetopt; |
9 | use Carp (); |
10 | |
669588e2 |
11 | use Getopt::Long 2.37 (); |
30ed85f7 |
12 | |
13 | has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); |
14 | has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); |
15 | |
30ed85f7 |
16 | sub new_with_options { |
17 | my ($class, @params) = @_; |
18 | |
19 | my $config_from_file; |
20 | if($class->meta->does_role('MooseX::ConfigFromFile')) { |
21 | local @ARGV = @ARGV; |
22 | |
94c4db8f |
23 | # just get the configfile arg now; the rest of the args will be |
24 | # fetched later |
30ed85f7 |
25 | my $configfile; |
94c4db8f |
26 | my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through ) ] ); |
30ed85f7 |
27 | $opt_parser->getoptions( "configfile=s" => \$configfile ); |
28 | |
29 | if(!defined $configfile) { |
30 | my $cfmeta = $class->meta->find_attribute_by_name('configfile'); |
31 | $configfile = $cfmeta->default if $cfmeta->has_default; |
33edcaa4 |
32 | if (ref $configfile eq 'CODE') { |
33 | # not sure theres a lot you can do with the class and may break some assumptions |
34 | # warn? |
35 | $configfile = &$configfile($class); |
36 | } |
37 | if (defined $configfile) { |
38 | $config_from_file = eval { |
39 | $class->get_config_from_file($configfile); |
40 | }; |
41 | if ($@) { |
42 | die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/; |
43 | } |
5ab6d553 |
44 | } |
30ed85f7 |
45 | } |
33edcaa4 |
46 | else { |
47 | $config_from_file = $class->get_config_from_file($configfile); |
48 | } |
30ed85f7 |
49 | } |
50 | |
51 | my $constructor_params = ( @params == 1 ? $params[0] : {@params} ); |
8df55e62 |
52 | |
30ed85f7 |
53 | Carp::croak("Single parameters to new_with_options() must be a HASH ref") |
54 | unless ref($constructor_params) eq 'HASH'; |
55 | |
56 | my %processed = $class->_parse_argv( |
57 | options => [ |
58 | $class->_attrs_to_options( $config_from_file ) |
59 | ], |
60 | params => $constructor_params, |
61 | ); |
62 | |
63 | my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params}; |
64 | |
65 | # did the user request usage information? |
81b19ed8 |
66 | if ( $processed{usage} and $params->{help_flag} ) |
30ed85f7 |
67 | { |
33edcaa4 |
68 | $class->_getopt_full_usage($processed{usage}); |
30ed85f7 |
69 | } |
70 | |
71 | $class->new( |
72 | ARGV => $processed{argv_copy}, |
73 | extra_argv => $processed{argv}, |
81b19ed8 |
74 | ( $processed{usage} ? ( usage => $processed{usage} ) : () ), |
30ed85f7 |
75 | %$constructor_params, # explicit params to ->new |
76 | %$params, # params from CLI |
77 | ); |
78 | } |
79 | |
33edcaa4 |
80 | sub _getopt_spec { shift->_traditional_spec(@_); } |
8df55e62 |
81 | |
30ed85f7 |
82 | sub _parse_argv { |
83 | my ( $class, %params ) = @_; |
84 | |
85 | local @ARGV = @{ $params{params}{argv} || \@ARGV }; |
86 | |
87 | my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params); |
88 | |
89 | # Get a clean copy of the original @ARGV |
90 | my $argv_copy = [ @ARGV ]; |
91 | |
33edcaa4 |
92 | my @warnings; |
30ed85f7 |
93 | my ( $parsed_options, $usage ) = eval { |
33edcaa4 |
94 | local $SIG{__WARN__} = sub { push @warnings, @_ }; |
30ed85f7 |
95 | |
33edcaa4 |
96 | return $class->_getopt_get_options(\%params, $opt_spec); |
30ed85f7 |
97 | }; |
98 | |
33edcaa4 |
99 | $class->_getopt_spec_warnings(@warnings) if @warnings; |
100 | $class->_getopt_spec_exception(\@warnings, $@) if $@; |
30ed85f7 |
101 | |
102 | # Get a copy of the Getopt::Long-mangled @ARGV |
103 | my $argv_mangled = [ @ARGV ]; |
104 | |
105 | my %constructor_args = ( |
106 | map { |
107 | $name_to_init_arg->{$_} => $parsed_options->{$_} |
108 | } keys %$parsed_options, |
109 | ); |
110 | |
111 | return ( |
112 | params => \%constructor_args, |
113 | argv_copy => $argv_copy, |
114 | argv => $argv_mangled, |
115 | ( defined($usage) ? ( usage => $usage ) : () ), |
116 | ); |
117 | } |
118 | |
33edcaa4 |
119 | sub _getopt_get_options { |
120 | my ($class, $params, $opt_spec) = @_; |
121 | my %options; |
122 | Getopt::Long::GetOptions(\%options, @$opt_spec); |
123 | return ( \%options, undef ); |
124 | } |
125 | |
126 | sub _getopt_spec_warnings { } |
127 | |
128 | sub _getopt_spec_exception { |
129 | my ($self, $warnings, $exception) = @_; |
130 | die @$warnings, $exception; |
131 | } |
132 | |
133 | sub _getopt_full_usage { |
134 | my ($self, $usage) = @_; |
135 | $usage->die; |
136 | } |
137 | |
30ed85f7 |
138 | sub _usage_format { |
139 | return "usage: %c %o"; |
140 | } |
141 | |
142 | sub _traditional_spec { |
143 | my ( $class, %params ) = @_; |
144 | |
145 | my ( @options, %name_to_init_arg, %options ); |
146 | |
147 | foreach my $opt ( @{ $params{options} } ) { |
148 | push @options, $opt->{opt_string}; |
149 | |
4f214b88 |
150 | my $identifier = $opt->{name}; |
30ed85f7 |
151 | $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names |
152 | |
153 | $name_to_init_arg{$identifier} = $opt->{init_arg}; |
154 | } |
155 | |
156 | return ( \@options, \%name_to_init_arg ); |
157 | } |
158 | |
30ed85f7 |
159 | sub _compute_getopt_attrs { |
160 | my $class = shift; |
161 | grep { |
162 | $_->does("MooseX::Getopt::Meta::Attribute::Trait") |
163 | or |
164 | $_->name !~ /^_/ |
165 | } grep { |
166 | !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt') |
167 | } $class->meta->get_all_attributes |
168 | } |
169 | |
170 | sub _get_cmd_flags_for_attr { |
171 | my ( $class, $attr ) = @_; |
172 | |
173 | my $flag = $attr->name; |
174 | |
175 | my @aliases; |
176 | |
177 | if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) { |
178 | $flag = $attr->cmd_flag if $attr->has_cmd_flag; |
179 | @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases; |
180 | } |
181 | |
182 | return ( $flag, @aliases ); |
183 | } |
184 | |
185 | sub _attrs_to_options { |
186 | my $class = shift; |
187 | my $config_from_file = shift || {}; |
188 | |
189 | my @options; |
190 | |
191 | foreach my $attr ($class->_compute_getopt_attrs) { |
192 | my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr); |
193 | |
194 | my $opt_string = join(q{|}, $flag, @aliases); |
195 | |
196 | if ($attr->name eq 'configfile') { |
197 | $opt_string .= '=s'; |
198 | } |
199 | elsif ($attr->has_type_constraint) { |
200 | my $type = $attr->type_constraint; |
201 | if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) { |
202 | $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type) |
203 | } |
204 | } |
205 | |
206 | push @options, { |
207 | name => $flag, |
208 | init_arg => $attr->init_arg, |
209 | opt_string => $opt_string, |
210 | required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name}, |
211 | # NOTE: |
2557b526 |
212 | # this "feature" was breaking because |
213 | # Getopt::Long::Descriptive would return |
214 | # the default value as if it was a command |
30ed85f7 |
215 | # line flag, which would then override the |
216 | # one passed into a constructor. |
217 | # See 100_gld_default_bug.t for an example |
218 | # - SL |
219 | #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ), |
220 | ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ), |
221 | } |
222 | } |
223 | |
224 | return @options; |
225 | } |
226 | |
669588e2 |
227 | no Moose::Role; |
228 | 1; |
ef47fe44 |
229 | |
230 | =head1 SYNOPSIS |
231 | |
232 | ## In your class |
233 | package My::App; |
234 | use Moose; |
235 | |
ff71d314 |
236 | with 'MooseX::Getopt::Basic'; |
ef47fe44 |
237 | |
238 | has 'out' => (is => 'rw', isa => 'Str', required => 1); |
239 | has 'in' => (is => 'rw', isa => 'Str', required => 1); |
240 | |
241 | # ... rest of the class here |
242 | |
243 | ## in your script |
244 | #!/usr/bin/perl |
245 | |
246 | use My::App; |
247 | |
248 | my $app = My::App->new_with_options(); |
249 | # ... rest of the script here |
250 | |
251 | ## on the command line |
ff71d314 |
252 | % perl my_app_script.pl --in file.input --out file.dump |
ef47fe44 |
253 | |
254 | =head1 DESCRIPTION |
255 | |
ff71d314 |
256 | This is like L<MooseX::Getopt> and can be used instead except that it |
257 | doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short). |
ef47fe44 |
258 | |
669588e2 |
259 | =method new_with_options |
ef47fe44 |
260 | |
33edcaa4 |
261 | See L<MooseX::Getopt/new_with_options>. |
ff71d314 |
262 | |
ef47fe44 |
263 | =cut |