2 package MooseX::Getopt;
5 use MooseX::Getopt::OptionTypeMap;
6 use MooseX::Getopt::Meta::Attribute;
7 use MooseX::Getopt::Meta::Attribute::NoGetopt;
9 use Getopt::Long (); # GLD uses it anyway, doesn't hurt
10 use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
12 our $VERSION = '0.11';
13 our $AUTHORITY = 'cpan:STEVAN';
15 has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
16 has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
18 sub new_with_options {
19 my ($class, @params) = @_;
21 my %processed = $class->_parse_argv(
23 $class->_attrs_to_options( @params )
27 my $params = $processed{params};
29 if($class->meta->does_role('MooseX::ConfigFromFile')) {
32 if(defined $params->{configfile}) {
33 $configfile = $params->{configfile}
36 my $cfmeta = $class->meta->get_attribute('configfile');
37 $configfile = $cfmeta->default if $cfmeta->has_default;
40 if(defined $configfile) {
42 %{$class->get_config_from_file($configfile)},
49 ARGV => $processed{argv_copy},
50 extra_argv => $processed{argv},
51 @params, # explicit params to ->new
52 %$params, # params from CLI
57 my ( $class, %params ) = @_;
59 local @ARGV = @{ $params{argv} || \@ARGV };
61 my ( $opt_spec, $name_to_init_arg ) = ( HAVE_GLD ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) );
63 # Get a clean copy of the original @ARGV
64 my $argv_copy = [ @ARGV ];
68 my ( $parsed_options, $usage ) = eval {
69 local $SIG{__WARN__} = sub { push @err, @_ };
72 return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec);
75 Getopt::Long::GetOptions(\%options, @$opt_spec);
76 return ( \%options, undef );
80 die join "", grep { defined } @err, $@ if @err or $@;
82 # Get a copy of the Getopt::Long-mangled @ARGV
83 my $argv_mangled = [ @ARGV ];
85 my %constructor_args = (
87 $name_to_init_arg->{$_} => $parsed_options->{$_}
88 } keys %$parsed_options,
92 params => \%constructor_args,
93 argv_copy => $argv_copy,
94 argv => $argv_mangled,
95 ( defined($usage) ? ( usage => $usage ) : () ),
100 return "usage: %c %o";
103 sub _traditional_spec {
104 my ( $class, %params ) = @_;
106 my ( @options, %name_to_init_arg, %options );
108 foreach my $opt ( @{ $params{options} } ) {
109 push @options, $opt->{opt_string};
110 $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
113 return ( \@options, \%name_to_init_arg );
117 my ( $class, %params ) = @_;
119 my ( @options, %name_to_init_arg );
121 foreach my $opt ( @{ $params{options} } ) {
124 $opt->{doc} || ' ', # FIXME new GLD shouldn't need this hack
126 ( $opt->{required} ? (required => $opt->{required}) : () ),
127 ( exists $opt->{default} ? (default => $opt->{default}) : () ),
131 $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
134 return ( \@options, \%name_to_init_arg );
137 sub _compute_getopt_attrs {
140 $_->isa("MooseX::Getopt::Meta::Attribute")
144 !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt')
145 } $class->meta->compute_all_applicable_attributes
148 sub _attrs_to_options {
153 foreach my $attr ($class->_compute_getopt_attrs) {
154 my $name = $attr->name;
158 if ($attr->isa('MooseX::Getopt::Meta::Attribute')) {
159 $name = $attr->cmd_flag if $attr->has_cmd_flag;
160 $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases;
163 my $opt_string = $aliases
164 ? join(q{|}, $name, @$aliases)
167 if ($attr->has_type_constraint) {
168 my $type_name = $attr->type_constraint->name;
169 if (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) {
170 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name)
176 init_arg => $attr->init_arg,
177 opt_string => $opt_string,
178 required => $attr->is_required && !$attr->has_default && !$attr->has_builder,
179 ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
180 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
195 MooseX::Getopt - A Moose role for processing command line options
203 with 'MooseX::Getopt';
205 has 'out' => (is => 'rw', isa => 'Str', required => 1);
206 has 'in' => (is => 'rw', isa => 'Str', required => 1);
208 # ... rest of the class here
215 my $app = My::App->new_with_options();
216 # ... rest of the script here
218 ## on the command line
219 % perl my_app_script.pl -in file.input -out file.dump
223 This is a role which provides an alternate constructor for creating
224 objects using parameters passed in from the command line.
226 This module attempts to DWIM as much as possible with the command line
227 params by introspecting your class's attributes. It will use the name
228 of your attribute as the command line option, and if there is a type
229 constraint defined, it will configure Getopt::Long to handle the option
232 You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute>
233 to get non-default commandline option names and aliases.
235 You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetOpt>
236 to have C<MooseX::Getopt> ignore your attribute in the commandline options.
238 By default, attributes which start with an underscore are not given
239 commandline argument support, unless the attribute's metaclass is set
240 to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
241 to have the leading underscore in thier name, you can do this:
243 # for read/write attributes
244 has '_foo' => (accessor => 'foo', ...);
246 # or for read-only attributes
247 has '_bar' => (reader => 'bar', ...);
249 This will mean that Getopt will not handle a --foo param, but your
250 code can still call the C<foo> method.
252 If your class also uses a configfile-loading role based on
253 L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
254 L<MooseX::Getopt>'s C<new_with_options> will load the configfile
255 specified by the C<--configfile> option (or the default you've
256 given for the configfile attribute) for you.
258 Options specified in multiple places follow the following
259 precendence order: commandline overrides configfile, which
260 overrides explicit new_with_options parameters.
262 =head2 Supported Type Constraints
268 A I<Bool> type constraint is set up as a boolean option with
269 Getopt::Long. So that this attribute description:
271 has 'verbose' => (is => 'rw', isa => 'Bool');
273 would translate into C<verbose!> as a Getopt::Long option descriptor,
274 which would enable the following command line options:
276 % my_script.pl --verbose
277 % my_script.pl --noverbose
279 =item I<Int>, I<Float>, I<Str>
281 These type constraints are set up as properly typed options with
282 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
286 An I<ArrayRef> type constraint is set up as a multiple value option
287 in Getopt::Long. So that this attribute description:
292 default => sub { [] }
295 would translate into C<includes=s@> as a Getopt::Long option descriptor,
296 which would enable the following command line options:
298 % my_script.pl --include /usr/lib --include /usr/local/lib
302 A I<HashRef> type constraint is set up as a hash value option
303 in Getopt::Long. So that this attribute description:
308 default => sub { {} }
311 would translate into C<define=s%> as a Getopt::Long option descriptor,
312 which would enable the following command line options:
314 % my_script.pl --define os=linux --define vendor=debian
318 =head2 Custom Type Constraints
320 It is possible to create custom type constraint to option spec
321 mappings if you need them. The process is fairly simple (but a
322 little verbose maybe). First you create a custom subtype, like
325 subtype 'ArrayOfInts'
327 => where { scalar (grep { looks_like_number($_) } @$_) };
329 Then you register the mapping, like so:
331 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
332 'ArrayOfInts' => '=i@'
335 Now any attribute declarations using this type constraint will
336 get the custom option spec. So that, this:
340 isa => 'ArrayOfInts',
341 default => sub { [0] }
344 Will translate to the following on the command line:
346 % my_script.pl --nums 5 --nums 88 --nums 199
348 This example is fairly trivial, but more complex validations are
349 easily possible with a little creativity. The trick is balancing
350 the type constraint validations with the Getopt::Long validations.
352 Better examples are certainly welcome :)
354 =head2 Inferred Type Constraints
356 If you define a custom subtype which is a subtype of one of the
357 standard L</Supported Type Constraints> above, and do not explicitly
358 provide custom support as in L</Custom Type Constraints> above,
359 MooseX::Getopt will treat it like the parent type for Getopt
362 For example, if you had the same custom C<ArrayOfInts> subtype
363 from the examples above, but did not add a new custom option
364 type for it to the C<OptionTypeMap>, it would be treated just
365 like a normal C<ArrayRef> type for Getopt purposes (that is,
372 =item B<new_with_options (%params)>
374 This method will take a set of default C<%params> and then collect
375 params from the command line (possibly overriding those in C<%params>)
376 and then return a newly constructed object.
378 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
379 C<new_with_options> will throw an exception.
381 If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
386 This accessor contains a reference to a copy of the C<@ARGV> array
387 as it originally existed at the time of C<new_with_options>.
391 This accessor contains an arrayref of leftover C<@ARGV> elements that
392 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
397 This returns the role meta object.
403 All complex software has bugs lurking in it, and this module is no
404 exception. If you find a bug please either email me, or add the bug
409 Stevan Little E<lt>stevan@iinteractive.comE<gt>
411 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
413 =head1 COPYRIGHT AND LICENSE
415 Copyright 2007 by Infinity Interactive, Inc.
417 L<http://www.iinteractive.com>
419 This library is free software; you can redistribute it and/or modify
420 it under the same terms as Perl itself.