2 package MooseX::Getopt;
5 use MooseX::Getopt::OptionTypeMap;
6 use MooseX::Getopt::Meta::Attribute;
7 use MooseX::Getopt::Meta::Attribute::NoGetopt;
11 use Getopt::Long (); # GLD uses it anyway, doesn't hurt
12 use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
14 our $VERSION = '0.24';
15 our $AUTHORITY = 'cpan:STEVAN';
17 has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
18 has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
20 sub new_with_options {
21 my ($class, @params) = @_;
24 if($class->meta->does_role('MooseX::ConfigFromFile')) {
28 my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] );
29 $opt_parser->getoptions( "configfile=s" => \$configfile );
31 if(!defined $configfile) {
32 my $cfmeta = $class->meta->find_attribute_by_name('configfile');
33 $configfile = $cfmeta->default if $cfmeta->has_default;
34 if (ref $configfile eq 'CODE') {
35 # not sure theres a lot you can do with the class and may break some assumptions
37 $configfile = &$configfile($class);
39 if (defined $configfile) {
40 $config_from_file = eval {
41 $class->get_config_from_file($configfile);
44 die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/;
49 $config_from_file = $class->get_config_from_file($configfile);
53 my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
55 Carp::croak("Single parameters to new_with_options() must be a HASH ref")
56 unless ref($constructor_params) eq 'HASH';
58 my %processed = $class->_parse_argv(
60 $class->_attrs_to_options( $config_from_file )
62 params => $constructor_params,
65 my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
67 # did the user request usage information?
68 if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) )
70 $processed{usage}->die();
74 ARGV => $processed{argv_copy},
75 extra_argv => $processed{argv},
76 %$constructor_params, # explicit params to ->new
77 %$params, # params from CLI
82 my ( $class, %params ) = @_;
84 local @ARGV = @{ $params{params}{argv} || \@ARGV };
86 my ( $opt_spec, $name_to_init_arg ) = ( HAVE_GLD ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) );
88 # Get a clean copy of the original @ARGV
89 my $argv_copy = [ @ARGV ];
92 my ( $parsed_options, $usage ) = eval {
93 local $SIG{__WARN__} = sub { push @warnings, @_ };
96 return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec);
99 Getopt::Long::GetOptions(\%options, @$opt_spec);
100 return ( \%options, undef );
104 $class->_getopt_spec_warnings(@warnings) if @warnings;
105 $class->_getopt_spec_exception(\@warnings, $@) if $@;
107 # Get a copy of the Getopt::Long-mangled @ARGV
108 my $argv_mangled = [ @ARGV ];
110 my %constructor_args = (
112 $name_to_init_arg->{$_} => $parsed_options->{$_}
113 } keys %$parsed_options,
117 params => \%constructor_args,
118 argv_copy => $argv_copy,
119 argv => $argv_mangled,
120 ( defined($usage) ? ( usage => $usage ) : () ),
124 sub _getopt_spec_warnings { }
126 sub _getopt_spec_exception {
127 my ($self, $warnings, $exception) = @_;
128 die @$warnings, $exception;
132 return "usage: %c %o";
135 sub _traditional_spec {
136 my ( $class, %params ) = @_;
138 my ( @options, %name_to_init_arg, %options );
140 foreach my $opt ( @{ $params{options} } ) {
141 push @options, $opt->{opt_string};
143 my $identifier = lc($opt->{name});
144 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
146 $name_to_init_arg{$identifier} = $opt->{init_arg};
149 return ( \@options, \%name_to_init_arg );
153 my ( $class, %params ) = @_;
155 my ( @options, %name_to_init_arg );
157 my $constructor_params = $params{params};
159 foreach my $opt ( @{ $params{options} } ) {
162 $opt->{doc} || ' ', # FIXME new GLD shouldn't need this hack
164 ( ( $opt->{required} && !exists($constructor_params->{$opt->{init_arg}}) ) ? (required => $opt->{required}) : () ),
166 # remove this 'feature' because it didn't work
167 # all the time, and so is better to not bother
168 # since Moose will handle the defaults just
171 #( exists $opt->{default} ? (default => $opt->{default}) : () ),
175 my $identifier = lc($opt->{name});
176 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
178 $name_to_init_arg{$identifier} = $opt->{init_arg};
181 return ( \@options, \%name_to_init_arg );
184 sub _compute_getopt_attrs {
187 $_->does("MooseX::Getopt::Meta::Attribute::Trait")
191 !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
192 } $class->meta->get_all_attributes
195 sub _get_cmd_flags_for_attr {
196 my ( $class, $attr ) = @_;
198 my $flag = $attr->name;
202 if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
203 $flag = $attr->cmd_flag if $attr->has_cmd_flag;
204 @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
207 return ( $flag, @aliases );
210 sub _attrs_to_options {
212 my $config_from_file = shift || {};
216 foreach my $attr ($class->_compute_getopt_attrs) {
217 my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
219 my $opt_string = join(q{|}, $flag, @aliases);
221 if ($attr->name eq 'configfile') {
224 elsif ($attr->has_type_constraint) {
225 my $type = $attr->type_constraint;
226 if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
227 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
233 init_arg => $attr->init_arg,
234 opt_string => $opt_string,
235 required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
237 # this "feature" was breaking because
238 # Getopt::Long::Descriptive would return
239 # the default value as if it was a command
240 # line flag, which would then override the
241 # one passed into a constructor.
242 # See 100_gld_default_bug.t for an example
244 #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
245 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
260 MooseX::Getopt - A Moose role for processing command line options
268 with 'MooseX::Getopt';
270 has 'out' => (is => 'rw', isa => 'Str', required => 1);
271 has 'in' => (is => 'rw', isa => 'Str', required => 1);
273 # ... rest of the class here
280 my $app = My::App->new_with_options();
281 # ... rest of the script here
283 ## on the command line
284 % perl my_app_script.pl -in file.input -out file.dump
288 This is a role which provides an alternate constructor for creating
289 objects using parameters passed in from the command line.
291 This module attempts to DWIM as much as possible with the command line
292 params by introspecting your class's attributes. It will use the name
293 of your attribute as the command line option, and if there is a type
294 constraint defined, it will configure Getopt::Long to handle the option
297 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
298 attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
299 commandline option names and aliases.
301 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
302 or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
303 to have C<MooseX::Getopt> ignore your attribute in the commandline options.
305 By default, attributes which start with an underscore are not given
306 commandline argument support, unless the attribute's metaclass is set
307 to L<MooseX::Getopt::Meta::Attribute>. If you don't want your accessors
308 to have the leading underscore in their name, you can do this:
310 # for read/write attributes
311 has '_foo' => (accessor => 'foo', ...);
313 # or for read-only attributes
314 has '_bar' => (reader => 'bar', ...);
316 This will mean that Getopt will not handle a --foo param, but your
317 code can still call the C<foo> method.
319 If your class also uses a configfile-loading role based on
320 L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
321 L<MooseX::Getopt>'s C<new_with_options> will load the configfile
322 specified by the C<--configfile> option (or the default you've
323 given for the configfile attribute) for you.
325 Options specified in multiple places follow the following
326 precendence order: commandline overrides configfile, which
327 overrides explicit new_with_options parameters.
329 =head2 Supported Type Constraints
335 A I<Bool> type constraint is set up as a boolean option with
336 Getopt::Long. So that this attribute description:
338 has 'verbose' => (is => 'rw', isa => 'Bool');
340 would translate into C<verbose!> as a Getopt::Long option descriptor,
341 which would enable the following command line options:
343 % my_script.pl --verbose
344 % my_script.pl --noverbose
346 =item I<Int>, I<Float>, I<Str>
348 These type constraints are set up as properly typed options with
349 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
353 An I<ArrayRef> type constraint is set up as a multiple value option
354 in Getopt::Long. So that this attribute description:
359 default => sub { [] }
362 would translate into C<includes=s@> as a Getopt::Long option descriptor,
363 which would enable the following command line options:
365 % my_script.pl --include /usr/lib --include /usr/local/lib
369 A I<HashRef> type constraint is set up as a hash value option
370 in Getopt::Long. So that this attribute description:
375 default => sub { {} }
378 would translate into C<define=s%> as a Getopt::Long option descriptor,
379 which would enable the following command line options:
381 % my_script.pl --define os=linux --define vendor=debian
385 =head2 Custom Type Constraints
387 It is possible to create custom type constraint to option spec
388 mappings if you need them. The process is fairly simple (but a
389 little verbose maybe). First you create a custom subtype, like
392 subtype 'ArrayOfInts'
394 => where { scalar (grep { looks_like_number($_) } @$_) };
396 Then you register the mapping, like so:
398 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
399 'ArrayOfInts' => '=i@'
402 Now any attribute declarations using this type constraint will
403 get the custom option spec. So that, this:
407 isa => 'ArrayOfInts',
408 default => sub { [0] }
411 Will translate to the following on the command line:
413 % my_script.pl --nums 5 --nums 88 --nums 199
415 This example is fairly trivial, but more complex validations are
416 easily possible with a little creativity. The trick is balancing
417 the type constraint validations with the Getopt::Long validations.
419 Better examples are certainly welcome :)
421 =head2 Inferred Type Constraints
423 If you define a custom subtype which is a subtype of one of the
424 standard L</Supported Type Constraints> above, and do not explicitly
425 provide custom support as in L</Custom Type Constraints> above,
426 MooseX::Getopt will treat it like the parent type for Getopt
429 For example, if you had the same custom C<ArrayOfInts> subtype
430 from the examples above, but did not add a new custom option
431 type for it to the C<OptionTypeMap>, it would be treated just
432 like a normal C<ArrayRef> type for Getopt purposes (that is,
439 =item B<new_with_options (%params)>
441 This method will take a set of default C<%params> and then collect
442 params from the command line (possibly overriding those in C<%params>)
443 and then return a newly constructed object.
445 The special parameter C<argv>, if specified should point to an array
446 reference with an array to use instead of C<@ARGV>.
448 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
449 C<new_with_options> will throw an exception.
451 If L<Getopt::Long::Descriptive> is installed and any of the following
452 command line params are passed, the program will exit with usage
453 information. You can add descriptions for each option by including a
454 B<documentation> option for each attribute to document.
460 If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
465 This accessor contains a reference to a copy of the C<@ARGV> array
466 as it originally existed at the time of C<new_with_options>.
470 This accessor contains an arrayref of leftover C<@ARGV> elements that
471 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
476 This returns the role meta object.
482 All complex software has bugs lurking in it, and this module is no
483 exception. If you find a bug please either email me, or add the bug
488 Stevan Little E<lt>stevan@iinteractive.comE<gt>
490 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
492 Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
496 Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
498 Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
500 =head1 COPYRIGHT AND LICENSE
502 Copyright 2007-2008 by Infinity Interactive, Inc.
504 L<http://www.iinteractive.com>
506 This library is free software; you can redistribute it and/or modify
507 it under the same terms as Perl itself.