2 package MooseX::Getopt;
6 our $AUTHORITY = 'cpan:STEVAN';
8 use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
10 my @roles = ('MooseX::Getopt::Basic');
11 if (HAVE_GLD()) { push @roles, 'MooseX::Getopt::GLD' }
23 MooseX::Getopt - A Moose role for processing command line options
31 with 'MooseX::Getopt';
33 has 'out' => (is => 'rw', isa => 'Str', required => 1);
34 has 'in' => (is => 'rw', isa => 'Str', required => 1);
36 # ... rest of the class here
43 my $app = My::App->new_with_options();
44 # ... rest of the script here
46 ## on the command line
47 % perl my_app_script.pl -in file.input -out file.dump
51 This is a role which provides an alternate constructor for creating
52 objects using parameters passed in from the command line.
54 This module attempts to DWIM as much as possible with the command line
55 params by introspecting your class's attributes. It will use the name
56 of your attribute as the command line option, and if there is a type
57 constraint defined, it will configure Getopt::Long to handle the option
60 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
61 attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
62 commandline option names and aliases.
64 You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
65 or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
66 to have C<MooseX::Getopt> ignore your attribute in the commandline options.
68 By default, attributes which start with an underscore are not given
69 commandline argument support, unless the attribute's metaclass is set
70 to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
71 to have the leading underscore in thier name, you can do this:
73 # for read/write attributes
74 has '_foo' => (accessor => 'foo', ...);
76 # or for read-only attributes
77 has '_bar' => (reader => 'bar', ...);
79 This will mean that Getopt will not handle a --foo param, but your
80 code can still call the C<foo> method.
82 If your class also uses a configfile-loading role based on
83 L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
84 L<MooseX::Getopt>'s C<new_with_options> will load the configfile
85 specified by the C<--configfile> option (or the default you've
86 given for the configfile attribute) for you.
88 Options specified in multiple places follow the following
89 precendence order: commandline overrides configfile, which
90 overrides explicit new_with_options parameters.
92 =head2 Supported Type Constraints
98 A I<Bool> type constraint is set up as a boolean option with
99 Getopt::Long. So that this attribute description:
101 has 'verbose' => (is => 'rw', isa => 'Bool');
103 would translate into C<verbose!> as a Getopt::Long option descriptor,
104 which would enable the following command line options:
106 % my_script.pl --verbose
107 % my_script.pl --noverbose
109 =item I<Int>, I<Float>, I<Str>
111 These type constraints are set up as properly typed options with
112 Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
116 An I<ArrayRef> type constraint is set up as a multiple value option
117 in Getopt::Long. So that this attribute description:
122 default => sub { [] }
125 would translate into C<includes=s@> as a Getopt::Long option descriptor,
126 which would enable the following command line options:
128 % my_script.pl --include /usr/lib --include /usr/local/lib
132 A I<HashRef> type constraint is set up as a hash value option
133 in Getopt::Long. So that this attribute description:
138 default => sub { {} }
141 would translate into C<define=s%> as a Getopt::Long option descriptor,
142 which would enable the following command line options:
144 % my_script.pl --define os=linux --define vendor=debian
148 =head2 Custom Type Constraints
150 It is possible to create custom type constraint to option spec
151 mappings if you need them. The process is fairly simple (but a
152 little verbose maybe). First you create a custom subtype, like
155 subtype 'ArrayOfInts'
157 => where { scalar (grep { looks_like_number($_) } @$_) };
159 Then you register the mapping, like so:
161 MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
162 'ArrayOfInts' => '=i@'
165 Now any attribute declarations using this type constraint will
166 get the custom option spec. So that, this:
170 isa => 'ArrayOfInts',
171 default => sub { [0] }
174 Will translate to the following on the command line:
176 % my_script.pl --nums 5 --nums 88 --nums 199
178 This example is fairly trivial, but more complex validations are
179 easily possible with a little creativity. The trick is balancing
180 the type constraint validations with the Getopt::Long validations.
182 Better examples are certainly welcome :)
184 =head2 Inferred Type Constraints
186 If you define a custom subtype which is a subtype of one of the
187 standard L</Supported Type Constraints> above, and do not explicitly
188 provide custom support as in L</Custom Type Constraints> above,
189 MooseX::Getopt will treat it like the parent type for Getopt
192 For example, if you had the same custom C<ArrayOfInts> subtype
193 from the examples above, but did not add a new custom option
194 type for it to the C<OptionTypeMap>, it would be treated just
195 like a normal C<ArrayRef> type for Getopt purposes (that is,
202 =item B<new_with_options (%params)>
204 This method will take a set of default C<%params> and then collect
205 params from the command line (possibly overriding those in C<%params>)
206 and then return a newly constructed object.
208 The special parameter C<argv>, if specified should point to an array
209 reference with an array to use instead of C<@ARGV>.
211 The paramater C<disable_gld>, if specified and a true value will disable
212 the use of L<Getopt::Long::Descriptive> .
214 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
215 C<new_with_options> will throw an exception.
217 If L<Getopt::Long::Descriptive> is installed and any of the following
218 command line params are passed, the program will exit with usage
219 information. You can add descriptions for each option by including a
220 B<documentation> option for each attribute to document.
226 If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
231 This accessor contains a reference to a copy of the C<@ARGV> array
232 as it originally existed at the time of C<new_with_options>.
236 This accessor contains an arrayref of leftover C<@ARGV> elements that
237 L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
242 This returns the role meta object.
246 A constant for internal use.
252 All complex software has bugs lurking in it, and this module is no
253 exception. If you find a bug please either email me, or add the bug
258 Stevan Little E<lt>stevan@iinteractive.comE<gt>
260 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
262 Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
266 Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
268 Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
270 =head1 COPYRIGHT AND LICENSE
272 Copyright 2007-2008 by Infinity Interactive, Inc.
274 L<http://www.iinteractive.com>
276 This library is free software; you can redistribute it and/or modify
277 it under the same terms as Perl itself.