2 package MooseX::Getopt;
7 use MooseX::Getopt::OptionTypeMap;
8 use MooseX::Getopt::Meta::Attribute;
10 our $VERSION = '0.06';
11 our $AUTHORITY = 'cpan:STEVAN';
13 has ARGV => (is => 'rw', isa => 'ArrayRef');
14 has extra_argv => (is => 'rw', isa => 'ArrayRef');
16 sub new_with_options {
17 my ($class, @params) = @_;
19 my %processed = $class->_parse_argv(
21 $class->_attrs_to_options( @params )
26 ARGV => $processed{argv_copy},
27 extra_argv => $processed{argv},
28 @params, # explicit params to ->new
29 %{ $processed{params} }, # params from CLI
34 my ( $class, %params ) = @_;
36 local @ARGV = @{ $params{argv} || \@ARGV };
38 my ( @options, %name_to_init_arg, %options );
40 foreach my $opt ( @{ $params{options} } ) {
41 push @options, $opt->{opt_string};
42 $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
45 # Get a clean copy of the original @ARGV
46 my $argv_copy = [ @ARGV ];
49 local $SIG{__WARN__} = sub { die $_[0] };
50 Getopt::Long::GetOptions(\%options, @options);
53 # Get a copy of the Getopt::Long-mangled @ARGV
54 my $argv_mangled = [ @ARGV ];
57 argv_copy => $argv_copy,
58 argv => $argv_mangled,
61 $name_to_init_arg{$_} => $options{$_}
67 sub _compute_getopt_attrs {
71 $_->isa("MooseX::Getopt::Meta::Attribute")
75 !$_->isa('MooseX::Getopt::Meta::NoGetopt')
76 } $class->meta->compute_all_applicable_attributes
79 sub _attrs_to_options {
84 foreach my $attr ($class->_compute_getopt_attrs) {
85 my $name = $attr->name;
89 if ($attr->isa('MooseX::Getopt::Meta::Attribute')) {
90 $name = $attr->cmd_flag if $attr->has_cmd_flag;
91 $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases;
94 my $opt_string = $aliases
95 ? join(q{|}, $name, @$aliases)
98 if ($attr->has_type_constraint) {
99 my $type_name = $attr->type_constraint->name;
100 if (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) {
101 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name);
107 init_arg => $attr->init_arg,
108 opt_string => $opt_string,
109 required => $attr->is_required,
110 ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
125 MooseX::Getopt - A Moose role for processing command line options
133 with 'MooseX::Getopt';
135 has 'out' => (is => 'rw', isa => 'Str', required => 1);
136 has 'in' => (is => 'rw', isa => 'Str', required => 1);
138 # ... rest of the class here
145 my $app = My::App->new_with_options();
146 # ... rest of the script here
148 ## on the command line
149 % perl my_app_script.pl -in file.input -out file.dump
153 This is a role which provides an alternate constructor for creating
154 objects using parameters passed in from the command line.
156 This module attempts to DWIM as much as possible with the command line
157 params by introspecting your class's attributes. It will use the name
158 of your attribute as the command line option, and if there is a type
159 constraint defined, it will configure Getopt::Long to handle the option
162 You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute>
163 to get non-default commandline option names and aliases.
165 By default, attributes which start with an underscore are not given
166 commandline argument support, unless the attribute's metaclass is set
167 to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
168 to have the leading underscore in thier name, you can do this:
170 # for read/write attributes
171 has '_foo' => (accessor => 'foo', ...);
173 # or for read-only attributes
174 has '_bar' => (reader => 'bar', ...);
176 This will mean that Getopt will not handle a --foo param, but your
177 code can still call the C<foo> method.
179 =head2 Supported Type Constraints
185 A I<Bool> type constraint is set up as a boolean option with
186 Getopt::Long. So that this attribute description:
188 has 'verbose' => (is => 'rw', isa => 'Bool');
190 would translate into C<verbose!> as a Getopt::Long option descriptor,
191 which would enable the following command line options:
193 % my_script.pl --verbose
194 % my_script.pl --noverbose
196 =item I<Int>, I<Float>, I<Str>
198 These type constraints are set up as properly typed options with
199 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
203 An I<ArrayRef> type constraint is set up as a multiple value option
204 in Getopt::Long. So that this attribute description:
209 default => sub { [] }
212 would translate into C<includes=s@> as a Getopt::Long option descriptor,
213 which would enable the following command line options:
215 % my_script.pl --include /usr/lib --include /usr/local/lib
219 A I<HashRef> type constraint is set up as a hash value option
220 in Getopt::Long. So that this attribute description:
225 default => sub { {} }
228 would translate into C<define=s%> as a Getopt::Long option descriptor,
229 which would enable the following command line options:
231 % my_script.pl --define os=linux --define vendor=debian
235 =head2 Custom Type Constraints
237 It is possible to create custom type constraint to option spec
238 mappings if you need them. The process is fairly simple (but a
239 little verbose maybe). First you create a custom subtype, like
242 subtype 'ArrayOfInts'
244 => where { scalar (grep { looks_like_number($_) } @$_) };
246 Then you register the mapping, like so:
248 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
249 'ArrayOfInts' => '=i@'
252 Now any attribute declarations using this type constraint will
253 get the custom option spec. So that, this:
257 isa => 'ArrayOfInts',
258 default => sub { [0] }
261 Will translate to the following on the command line:
263 % my_script.pl --nums 5 --nums 88 --nums 199
265 This example is fairly trivial, but more complex validations are
266 easily possible with a little creativity. The trick is balancing
267 the type constraint validations with the Getopt::Long validations.
269 Better examples are certainly welcome :)
271 =head2 Inferred Type Constraints
273 If you define a custom subtype which is a subtype of one of the
274 standard L</Supported Type Constraints> above, and do not explicitly
275 provide custom support as in L</Custom Type Constraints> above,
276 MooseX::Getopt will treat it like the parent type for Getopt
279 For example, if you had the same custom C<ArrayOfInts> subtype
280 from the examples above, but did not add a new custom option
281 type for it to the C<OptionTypeMap>, it would be treated just
282 like a normal C<ArrayRef> type for Getopt purposes (that is,
289 =item B<new_with_options (%params)>
291 This method will take a set of default C<%params> and then collect
292 params from the command line (possibly overriding those in C<%params>)
293 and then return a newly constructed object.
295 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
296 C<new_with_options> will throw an exception.
300 This accessor contains a reference to a copy of the C<@ARGV> array
301 as it originally existed at the time of C<new_with_options>.
305 This accessor contains an arrayref of leftover C<@ARGV> elements that
306 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
311 This returns the role meta object.
317 All complex software has bugs lurking in it, and this module is no
318 exception. If you find a bug please either email me, or add the bug
323 Stevan Little E<lt>stevan@iinteractive.comE<gt>
325 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
327 =head1 COPYRIGHT AND LICENSE
329 Copyright 2007 by Infinity Interactive, Inc.
331 L<http://www.iinteractive.com>
333 This library is free software; you can redistribute it and/or modify
334 it under the same terms as Perl itself.