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.25';
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 $class->_getopt_full_usage($processed{usage});
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;
131 sub _getopt_full_usage {
132 my ($self, $usage) = @_;
137 return "usage: %c %o";
140 sub _traditional_spec {
141 my ( $class, %params ) = @_;
143 my ( @options, %name_to_init_arg, %options );
145 foreach my $opt ( @{ $params{options} } ) {
146 push @options, $opt->{opt_string};
148 my $identifier = lc($opt->{name});
149 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
151 $name_to_init_arg{$identifier} = $opt->{init_arg};
154 return ( \@options, \%name_to_init_arg );
158 my ( $class, %params ) = @_;
160 my ( @options, %name_to_init_arg );
162 my $constructor_params = $params{params};
164 foreach my $opt ( @{ $params{options} } ) {
167 $opt->{doc} || ' ', # FIXME new GLD shouldn't need this hack
169 ( ( $opt->{required} && !exists($constructor_params->{$opt->{init_arg}}) ) ? (required => $opt->{required}) : () ),
171 # remove this 'feature' because it didn't work
172 # all the time, and so is better to not bother
173 # since Moose will handle the defaults just
176 #( exists $opt->{default} ? (default => $opt->{default}) : () ),
180 my $identifier = lc($opt->{name});
181 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
183 $name_to_init_arg{$identifier} = $opt->{init_arg};
186 return ( \@options, \%name_to_init_arg );
189 sub _compute_getopt_attrs {
192 $_->does("MooseX::Getopt::Meta::Attribute::Trait")
196 !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
197 } $class->meta->get_all_attributes
200 sub _get_cmd_flags_for_attr {
201 my ( $class, $attr ) = @_;
203 my $flag = $attr->name;
207 if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
208 $flag = $attr->cmd_flag if $attr->has_cmd_flag;
209 @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
212 return ( $flag, @aliases );
215 sub _attrs_to_options {
217 my $config_from_file = shift || {};
221 foreach my $attr ($class->_compute_getopt_attrs) {
222 my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
224 my $opt_string = join(q{|}, $flag, @aliases);
226 if ($attr->name eq 'configfile') {
229 elsif ($attr->has_type_constraint) {
230 my $type = $attr->type_constraint;
231 if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
232 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
238 init_arg => $attr->init_arg,
239 opt_string => $opt_string,
240 required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
242 # this "feature" was breaking because
243 # Getopt::Long::Descriptive would return
244 # the default value as if it was a command
245 # line flag, which would then override the
246 # one passed into a constructor.
247 # See 100_gld_default_bug.t for an example
249 #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
250 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
265 MooseX::Getopt - A Moose role for processing command line options
273 with 'MooseX::Getopt';
275 has 'out' => (is => 'rw', isa => 'Str', required => 1);
276 has 'in' => (is => 'rw', isa => 'Str', required => 1);
278 # ... rest of the class here
285 my $app = My::App->new_with_options();
286 # ... rest of the script here
288 ## on the command line
289 % perl my_app_script.pl -in file.input -out file.dump
293 This is a role which provides an alternate constructor for creating
294 objects using parameters passed in from the command line.
296 This module attempts to DWIM as much as possible with the command line
297 params by introspecting your class's attributes. It will use the name
298 of your attribute as the command line option, and if there is a type
299 constraint defined, it will configure Getopt::Long to handle the option
302 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
303 attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
304 commandline option names and aliases.
306 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
307 or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
308 to have C<MooseX::Getopt> ignore your attribute in the commandline options.
310 By default, attributes which start with an underscore are not given
311 commandline argument support, unless the attribute's metaclass is set
312 to L<MooseX::Getopt::Meta::Attribute>. If you don't want your accessors
313 to have the leading underscore in their name, you can do this:
315 # for read/write attributes
316 has '_foo' => (accessor => 'foo', ...);
318 # or for read-only attributes
319 has '_bar' => (reader => 'bar', ...);
321 This will mean that Getopt will not handle a --foo param, but your
322 code can still call the C<foo> method.
324 If your class also uses a configfile-loading role based on
325 L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
326 L<MooseX::Getopt>'s C<new_with_options> will load the configfile
327 specified by the C<--configfile> option (or the default you've
328 given for the configfile attribute) for you.
330 Options specified in multiple places follow the following
331 precendence order: commandline overrides configfile, which
332 overrides explicit new_with_options parameters.
334 =head2 Supported Type Constraints
340 A I<Bool> type constraint is set up as a boolean option with
341 Getopt::Long. So that this attribute description:
343 has 'verbose' => (is => 'rw', isa => 'Bool');
345 would translate into C<verbose!> as a Getopt::Long option descriptor,
346 which would enable the following command line options:
348 % my_script.pl --verbose
349 % my_script.pl --noverbose
351 =item I<Int>, I<Float>, I<Str>
353 These type constraints are set up as properly typed options with
354 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
358 An I<ArrayRef> type constraint is set up as a multiple value option
359 in Getopt::Long. So that this attribute description:
364 default => sub { [] }
367 would translate into C<includes=s@> as a Getopt::Long option descriptor,
368 which would enable the following command line options:
370 % my_script.pl --include /usr/lib --include /usr/local/lib
374 A I<HashRef> type constraint is set up as a hash value option
375 in Getopt::Long. So that this attribute description:
380 default => sub { {} }
383 would translate into C<define=s%> as a Getopt::Long option descriptor,
384 which would enable the following command line options:
386 % my_script.pl --define os=linux --define vendor=debian
390 =head2 Custom Type Constraints
392 It is possible to create custom type constraint to option spec
393 mappings if you need them. The process is fairly simple (but a
394 little verbose maybe). First you create a custom subtype, like
397 subtype 'ArrayOfInts'
399 => where { scalar (grep { looks_like_number($_) } @$_) };
401 Then you register the mapping, like so:
403 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
404 'ArrayOfInts' => '=i@'
407 Now any attribute declarations using this type constraint will
408 get the custom option spec. So that, this:
412 isa => 'ArrayOfInts',
413 default => sub { [0] }
416 Will translate to the following on the command line:
418 % my_script.pl --nums 5 --nums 88 --nums 199
420 This example is fairly trivial, but more complex validations are
421 easily possible with a little creativity. The trick is balancing
422 the type constraint validations with the Getopt::Long validations.
424 Better examples are certainly welcome :)
426 =head2 Inferred Type Constraints
428 If you define a custom subtype which is a subtype of one of the
429 standard L</Supported Type Constraints> above, and do not explicitly
430 provide custom support as in L</Custom Type Constraints> above,
431 MooseX::Getopt will treat it like the parent type for Getopt
434 For example, if you had the same custom C<ArrayOfInts> subtype
435 from the examples above, but did not add a new custom option
436 type for it to the C<OptionTypeMap>, it would be treated just
437 like a normal C<ArrayRef> type for Getopt purposes (that is,
444 =item B<new_with_options (%params)>
446 This method will take a set of default C<%params> and then collect
447 params from the command line (possibly overriding those in C<%params>)
448 and then return a newly constructed object.
450 The special parameter C<argv>, if specified should point to an array
451 reference with an array to use instead of C<@ARGV>.
453 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
454 C<new_with_options> will throw an exception.
456 If L<Getopt::Long::Descriptive> is installed and any of the following
457 command line params are passed, the program will exit with usage
458 information. You can add descriptions for each option by including a
459 B<documentation> option for each attribute to document.
465 If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
470 This accessor contains a reference to a copy of the C<@ARGV> array
471 as it originally existed at the time of C<new_with_options>.
475 This accessor contains an arrayref of leftover C<@ARGV> elements that
476 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
481 This returns the role meta object.
487 All complex software has bugs lurking in it, and this module is no
488 exception. If you find a bug please either email me, or add the bug
493 Stevan Little E<lt>stevan@iinteractive.comE<gt>
495 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
497 Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
501 Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
503 Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
505 =head1 COPYRIGHT AND LICENSE
507 Copyright 2007-2008 by Infinity Interactive, Inc.
509 L<http://www.iinteractive.com>
511 This library is free software; you can redistribute it and/or modify
512 it under the same terms as Perl itself.