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.08';
13 our $AUTHORITY = 'cpan:STEVAN';
15 has ARGV => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
16 has extra_argv => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
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')
30 && defined $params->{configfile}) {
32 %{$class->get_config_from_file($params->{configfile})},
38 ARGV => $processed{argv_copy},
39 extra_argv => $processed{argv},
40 @params, # explicit params to ->new
41 %$params, # params from CLI
46 my ( $class, %params ) = @_;
48 local @ARGV = @{ $params{argv} || \@ARGV };
50 my ( $opt_spec, $name_to_init_arg ) = ( HAVE_GLD ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) );
52 # Get a clean copy of the original @ARGV
53 my $argv_copy = [ @ARGV ];
57 my ( $parsed_options, $usage ) = eval {
58 local $SIG{__WARN__} = sub { push @err, @_ };
61 return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec);
64 Getopt::Long::GetOptions(\%options, @$opt_spec);
65 return ( \%options, MooseX::Getopt::FakeUsage->new(%params) );
69 die join "", grep { defined } @err, $@ if @err or $@;
71 # Get a copy of the Getopt::Long-mangled @ARGV
72 my $argv_mangled = [ @ARGV ];
74 my %constructor_args = (
76 $name_to_init_arg->{$_} => $parsed_options->{$_}
77 } keys %$parsed_options,
81 params => \%constructor_args,
82 argv_copy => $argv_copy,
83 argv => $argv_mangled,
89 return "usage: %c %o";
92 sub _traditional_spec {
93 my ( $class, %params ) = @_;
95 my ( @options, %name_to_init_arg, %options );
97 foreach my $opt ( @{ $params{options} } ) {
98 push @options, $opt->{opt_string};
99 $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
102 return ( \@options, \%name_to_init_arg );
106 my ( $class, %params ) = @_;
108 my ( @options, %name_to_init_arg );
110 foreach my $opt ( @{ $params{options} } ) {
113 $opt->{doc} || ' ', # FIXME new GLD shouldn't need this hack
115 ( $opt->{required} ? (required => $opt->{required}) : () ),
116 ( exists $opt->{default} ? (default => $opt->{default}) : () ),
120 $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
123 return ( \@options, \%name_to_init_arg );
126 sub _compute_getopt_attrs {
129 $_->isa("MooseX::Getopt::Meta::Attribute")
133 !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt')
134 } $class->meta->compute_all_applicable_attributes
137 sub _attrs_to_options {
142 foreach my $attr ($class->_compute_getopt_attrs) {
143 my $name = $attr->name;
147 if ($attr->isa('MooseX::Getopt::Meta::Attribute')) {
148 $name = $attr->cmd_flag if $attr->has_cmd_flag;
149 $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases;
152 my $opt_string = $aliases
153 ? join(q{|}, $name, @$aliases)
156 if ($attr->has_type_constraint) {
157 my $type_name = $attr->type_constraint->name;
158 if (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) {
159 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name)
165 init_arg => $attr->init_arg,
166 opt_string => $opt_string,
167 required => $attr->is_required,
168 ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
169 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
177 package MooseX::Getopt::FakeUsage;
179 # fakes Getopt::Long::Descriptive::Usage
184 default => "In order to get a usage text please install Getopt::Long::Descriptive\n",
194 my $arg = shift || {};
199 grep { defined } $arg->{pre_text}, $self->text, $arg->{post_text},
217 MooseX::Getopt - A Moose role for processing command line options
225 with 'MooseX::Getopt';
227 has 'out' => (is => 'rw', isa => 'Str', required => 1);
228 has 'in' => (is => 'rw', isa => 'Str', required => 1);
230 # ... rest of the class here
237 my $app = My::App->new_with_options();
238 # ... rest of the script here
240 ## on the command line
241 % perl my_app_script.pl -in file.input -out file.dump
245 This is a role which provides an alternate constructor for creating
246 objects using parameters passed in from the command line.
248 This module attempts to DWIM as much as possible with the command line
249 params by introspecting your class's attributes. It will use the name
250 of your attribute as the command line option, and if there is a type
251 constraint defined, it will configure Getopt::Long to handle the option
254 You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute>
255 to get non-default commandline option names and aliases.
257 You can use 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 for you.
279 =head2 Supported Type Constraints
285 A I<Bool> type constraint is set up as a boolean option with
286 Getopt::Long. So that this attribute description:
288 has 'verbose' => (is => 'rw', isa => 'Bool');
290 would translate into C<verbose!> as a Getopt::Long option descriptor,
291 which would enable the following command line options:
293 % my_script.pl --verbose
294 % my_script.pl --noverbose
296 =item I<Int>, I<Float>, I<Str>
298 These type constraints are set up as properly typed options with
299 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
303 An I<ArrayRef> type constraint is set up as a multiple value option
304 in Getopt::Long. So that this attribute description:
309 default => sub { [] }
312 would translate into C<includes=s@> as a Getopt::Long option descriptor,
313 which would enable the following command line options:
315 % my_script.pl --include /usr/lib --include /usr/local/lib
319 A I<HashRef> type constraint is set up as a hash value option
320 in Getopt::Long. So that this attribute description:
325 default => sub { {} }
328 would translate into C<define=s%> as a Getopt::Long option descriptor,
329 which would enable the following command line options:
331 % my_script.pl --define os=linux --define vendor=debian
335 =head2 Custom Type Constraints
337 It is possible to create custom type constraint to option spec
338 mappings if you need them. The process is fairly simple (but a
339 little verbose maybe). First you create a custom subtype, like
342 subtype 'ArrayOfInts'
344 => where { scalar (grep { looks_like_number($_) } @$_) };
346 Then you register the mapping, like so:
348 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
349 'ArrayOfInts' => '=i@'
352 Now any attribute declarations using this type constraint will
353 get the custom option spec. So that, this:
357 isa => 'ArrayOfInts',
358 default => sub { [0] }
361 Will translate to the following on the command line:
363 % my_script.pl --nums 5 --nums 88 --nums 199
365 This example is fairly trivial, but more complex validations are
366 easily possible with a little creativity. The trick is balancing
367 the type constraint validations with the Getopt::Long validations.
369 Better examples are certainly welcome :)
371 =head2 Inferred Type Constraints
373 If you define a custom subtype which is a subtype of one of the
374 standard L</Supported Type Constraints> above, and do not explicitly
375 provide custom support as in L</Custom Type Constraints> above,
376 MooseX::Getopt will treat it like the parent type for Getopt
379 For example, if you had the same custom C<ArrayOfInts> subtype
380 from the examples above, but did not add a new custom option
381 type for it to the C<OptionTypeMap>, it would be treated just
382 like a normal C<ArrayRef> type for Getopt purposes (that is,
389 =item B<new_with_options (%params)>
391 This method will take a set of default C<%params> and then collect
392 params from the command line (possibly overriding those in C<%params>)
393 and then return a newly constructed object.
395 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
396 C<new_with_options> will throw an exception.
400 This accessor contains a reference to a copy of the C<@ARGV> array
401 as it originally existed at the time of C<new_with_options>.
405 This accessor contains an arrayref of leftover C<@ARGV> elements that
406 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
411 This returns the role meta object.
417 All complex software has bugs lurking in it, and this module is no
418 exception. If you find a bug please either email me, or add the bug
423 Stevan Little E<lt>stevan@iinteractive.comE<gt>
425 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
427 =head1 COPYRIGHT AND LICENSE
429 Copyright 2007 by Infinity Interactive, Inc.
431 L<http://www.iinteractive.com>
433 This library is free software; you can redistribute it and/or modify
434 it under the same terms as Perl itself.