1 package MooseX::Getopt::Basic;
4 use MooseX::Getopt::OptionTypeMap;
5 use MooseX::Getopt::Meta::Attribute;
6 use MooseX::Getopt::Meta::Attribute::NoGetopt;
9 use Getopt::Long (); # GLD uses it anyway, doesn't hurt
11 our $VERSION = '0.20';
12 our $AUTHORITY = 'cpan:STEVAN';
14 has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
15 has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
17 # _getopt_spec() and _getoptions() are overrided by MooseX::Getopt::GLD.
20 my ($class, %params) = @_;
21 return $class->_traditional_spec(%params)
25 my ($class, undef, $opt_spec) = @_;
27 Getopt::Long::GetOptions(\%options, @$opt_spec);
28 return ( \%options, undef );
31 sub new_with_options {
32 my ($class, @params) = @_;
35 if($class->meta->does_role('MooseX::ConfigFromFile')) {
39 my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] );
40 $opt_parser->getoptions( "configfile=s" => \$configfile );
42 if(!defined $configfile) {
43 my $cfmeta = $class->meta->find_attribute_by_name('configfile');
44 $configfile = $cfmeta->default if $cfmeta->has_default;
47 if(defined $configfile) {
48 $config_from_file = $class->get_config_from_file($configfile);
52 my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
54 Carp::croak("Single parameters to new_with_options() must be a HASH ref")
55 unless ref($constructor_params) eq 'HASH';
57 my %processed = $class->_parse_argv(
59 $class->_attrs_to_options( $config_from_file )
61 params => $constructor_params,
64 my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
66 # did the user request usage information?
67 if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) )
69 $processed{usage}->die();
73 ARGV => $processed{argv_copy},
74 extra_argv => $processed{argv},
75 %$constructor_params, # explicit params to ->new
76 %$params, # params from CLI
81 my ( $class, %params ) = @_;
83 local @ARGV = @{ $params{params}{argv} || \@ARGV };
85 my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params);
87 # Get a clean copy of the original @ARGV
88 my $argv_copy = [ @ARGV ];
92 my ( $parsed_options, $usage ) = eval {
93 local $SIG{__WARN__} = sub { push @err, @_ };
95 return $class->_get_options(\%params, $opt_spec);
98 die join "", grep { defined } @err, $@ if @err or $@;
100 # Get a copy of the Getopt::Long-mangled @ARGV
101 my $argv_mangled = [ @ARGV ];
103 my %constructor_args = (
105 $name_to_init_arg->{$_} => $parsed_options->{$_}
106 } keys %$parsed_options,
110 params => \%constructor_args,
111 argv_copy => $argv_copy,
112 argv => $argv_mangled,
113 ( defined($usage) ? ( usage => $usage ) : () ),
118 return "usage: %c %o";
121 sub _traditional_spec {
122 my ( $class, %params ) = @_;
124 my ( @options, %name_to_init_arg, %options );
126 foreach my $opt ( @{ $params{options} } ) {
127 push @options, $opt->{opt_string};
129 my $identifier = $opt->{name};
130 $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
132 $name_to_init_arg{$identifier} = $opt->{init_arg};
135 return ( \@options, \%name_to_init_arg );
138 sub _compute_getopt_attrs {
141 $_->does("MooseX::Getopt::Meta::Attribute::Trait")
145 !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
146 } $class->meta->get_all_attributes
149 sub _get_cmd_flags_for_attr {
150 my ( $class, $attr ) = @_;
152 my $flag = $attr->name;
156 if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
157 $flag = $attr->cmd_flag if $attr->has_cmd_flag;
158 @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
161 return ( $flag, @aliases );
164 sub _attrs_to_options {
166 my $config_from_file = shift || {};
170 foreach my $attr ($class->_compute_getopt_attrs) {
171 my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
173 my $opt_string = join(q{|}, $flag, @aliases);
175 if ($attr->name eq 'configfile') {
178 elsif ($attr->has_type_constraint) {
179 my $type = $attr->type_constraint;
180 if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
181 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
187 init_arg => $attr->init_arg,
188 opt_string => $opt_string,
189 required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
191 # this "feature" was breaking because
192 # Getopt::Long::Descriptive would return
193 # the default value as if it was a command
194 # line flag, which would then override the
195 # one passed into a constructor.
196 # See 100_gld_default_bug.t for an example
198 #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
199 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
214 MooseX::Getopt::Basic - role to implement the basic functionality of
215 L<MooseX::Getopt> without GLD.
223 with 'MooseX::Getopt';
225 has 'out' => (is => 'rw', isa => 'Str', required => 1);
226 has 'in' => (is => 'rw', isa => 'Str', required => 1);
228 # ... rest of the class here
235 my $app = My::App->new_with_options();
236 # ... rest of the script here
238 ## on the command line
239 % perl my_app_script.pl -in file.input -out file.dump
243 This is a role which provides an alternate constructor for creating
244 objects using parameters passed in from the command line.
246 This module attempts to DWIM as much as possible with the command line
247 params by introspecting your class's attributes. It will use the name
248 of your attribute as the command line option, and if there is a type
249 constraint defined, it will configure Getopt::Long to handle the option
252 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
253 attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
254 commandline option names and aliases.
256 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
257 or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
258 to have C<MooseX::Getopt> ignore your attribute in the commandline options.
260 By default, attributes which start with an underscore are not given
261 commandline argument support, unless the attribute's metaclass is set
262 to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
263 to have the leading underscore in thier name, you can do this:
265 # for read/write attributes
266 has '_foo' => (accessor => 'foo', ...);
268 # or for read-only attributes
269 has '_bar' => (reader => 'bar', ...);
271 This will mean that Getopt will not handle a --foo param, but your
272 code can still call the C<foo> method.
274 If your class also uses a configfile-loading role based on
275 L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
276 L<MooseX::Getopt>'s C<new_with_options> will load the configfile
277 specified by the C<--configfile> option (or the default you've
278 given for the configfile attribute) for you.
280 Options specified in multiple places follow the following
281 precendence order: commandline overrides configfile, which
282 overrides explicit new_with_options parameters.
284 =head2 Supported Type Constraints
290 A I<Bool> type constraint is set up as a boolean option with
291 Getopt::Long. So that this attribute description:
293 has 'verbose' => (is => 'rw', isa => 'Bool');
295 would translate into C<verbose!> as a Getopt::Long option descriptor,
296 which would enable the following command line options:
298 % my_script.pl --verbose
299 % my_script.pl --noverbose
301 =item I<Int>, I<Float>, I<Str>
303 These type constraints are set up as properly typed options with
304 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
308 An I<ArrayRef> type constraint is set up as a multiple value option
309 in Getopt::Long. So that this attribute description:
314 default => sub { [] }
317 would translate into C<includes=s@> as a Getopt::Long option descriptor,
318 which would enable the following command line options:
320 % my_script.pl --include /usr/lib --include /usr/local/lib
324 A I<HashRef> type constraint is set up as a hash value option
325 in Getopt::Long. So that this attribute description:
330 default => sub { {} }
333 would translate into C<define=s%> as a Getopt::Long option descriptor,
334 which would enable the following command line options:
336 % my_script.pl --define os=linux --define vendor=debian
340 =head2 Custom Type Constraints
342 It is possible to create custom type constraint to option spec
343 mappings if you need them. The process is fairly simple (but a
344 little verbose maybe). First you create a custom subtype, like
347 subtype 'ArrayOfInts'
349 => where { scalar (grep { looks_like_number($_) } @$_) };
351 Then you register the mapping, like so:
353 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
354 'ArrayOfInts' => '=i@'
357 Now any attribute declarations using this type constraint will
358 get the custom option spec. So that, this:
362 isa => 'ArrayOfInts',
363 default => sub { [0] }
366 Will translate to the following on the command line:
368 % my_script.pl --nums 5 --nums 88 --nums 199
370 This example is fairly trivial, but more complex validations are
371 easily possible with a little creativity. The trick is balancing
372 the type constraint validations with the Getopt::Long validations.
374 Better examples are certainly welcome :)
376 =head2 Inferred Type Constraints
378 If you define a custom subtype which is a subtype of one of the
379 standard L</Supported Type Constraints> above, and do not explicitly
380 provide custom support as in L</Custom Type Constraints> above,
381 MooseX::Getopt will treat it like the parent type for Getopt
384 For example, if you had the same custom C<ArrayOfInts> subtype
385 from the examples above, but did not add a new custom option
386 type for it to the C<OptionTypeMap>, it would be treated just
387 like a normal C<ArrayRef> type for Getopt purposes (that is,
394 =item B<new_with_options (%params)>
396 This method will take a set of default C<%params> and then collect
397 params from the command line (possibly overriding those in C<%params>)
398 and then return a newly constructed object.
400 The special parameter C<argv>, if specified should point to an array
401 reference with an array to use instead of C<@ARGV>.
403 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
404 C<new_with_options> will throw an exception.
406 If L<Getopt::Long::Descriptive> is installed and any of the following
407 command line params are passed, the program will exit with usage
408 information. You can add descriptions for each option by including a
409 B<documentation> option for each attribute to document.
415 If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
420 This accessor contains a reference to a copy of the C<@ARGV> array
421 as it originally existed at the time of C<new_with_options>.
425 This accessor contains an arrayref of leftover C<@ARGV> elements that
426 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
431 This returns the role meta object.
437 All complex software has bugs lurking in it, and this module is no
438 exception. If you find a bug please either email me, or add the bug
443 Stevan Little E<lt>stevan@iinteractive.comE<gt>
445 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
447 Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
451 Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
453 Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
455 =head1 COPYRIGHT AND LICENSE
457 Copyright 2007-2008 by Infinity Interactive, Inc.
459 L<http://www.iinteractive.com>
461 This library is free software; you can redistribute it and/or modify
462 it under the same terms as Perl itself.