package My::App;
use Moose;
- with 'MooseX::Getopt';
+ with 'MooseX::Getopt::Basic';
has 'out' => (is => 'rw', isa => 'Str', required => 1);
has 'in' => (is => 'rw', isa => 'Str', required => 1);
# ... rest of the script here
## on the command line
- % perl my_app_script.pl -in file.input -out file.dump
+ % perl my_app_script.pl --in file.input --out file.dump
=head1 DESCRIPTION
-This is a role which provides an alternate constructor for creating
-objects using parameters passed in from the command line.
-
-This module attempts to DWIM as much as possible with the command line
-params by introspecting your class's attributes. It will use the name
-of your attribute as the command line option, and if there is a type
-constraint defined, it will configure Getopt::Long to handle the option
-accordingly.
-
-You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
-attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
-commandline option names and aliases.
-
-You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
-or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
-to have C<MooseX::Getopt> ignore your attribute in the commandline options.
-
-By default, attributes which start with an underscore are not given
-commandline argument support, unless the attribute's metaclass is set
-to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
-to have the leading underscore in thier name, you can do this:
-
- # for read/write attributes
- has '_foo' => (accessor => 'foo', ...);
-
- # or for read-only attributes
- has '_bar' => (reader => 'bar', ...);
-
-This will mean that Getopt will not handle a --foo param, but your
-code can still call the C<foo> method.
-
-If your class also uses a configfile-loading role based on
-L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
-L<MooseX::Getopt>'s C<new_with_options> will load the configfile
-specified by the C<--configfile> option (or the default you've
-given for the configfile attribute) for you.
-
-Options specified in multiple places follow the following
-precendence order: commandline overrides configfile, which
-overrides explicit new_with_options parameters.
-
-=head2 Supported Type Constraints
-
-=over 4
-
-=item I<Bool>
-
-A I<Bool> type constraint is set up as a boolean option with
-Getopt::Long. So that this attribute description:
-
- has 'verbose' => (is => 'rw', isa => 'Bool');
-
-would translate into C<verbose!> as a Getopt::Long option descriptor,
-which would enable the following command line options:
-
- % my_script.pl --verbose
- % my_script.pl --noverbose
-
-=item I<Int>, I<Float>, I<Str>
-
-These type constraints are set up as properly typed options with
-Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
-
-=item I<ArrayRef>
-
-An I<ArrayRef> type constraint is set up as a multiple value option
-in Getopt::Long. So that this attribute description:
-
- has 'include' => (
- is => 'rw',
- isa => 'ArrayRef',
- default => sub { [] }
- );
-
-would translate into C<includes=s@> as a Getopt::Long option descriptor,
-which would enable the following command line options:
-
- % my_script.pl --include /usr/lib --include /usr/local/lib
-
-=item I<HashRef>
-
-A I<HashRef> type constraint is set up as a hash value option
-in Getopt::Long. So that this attribute description:
-
- has 'define' => (
- is => 'rw',
- isa => 'HashRef',
- default => sub { {} }
- );
-
-would translate into C<define=s%> as a Getopt::Long option descriptor,
-which would enable the following command line options:
-
- % my_script.pl --define os=linux --define vendor=debian
-
-=back
-
-=head2 Custom Type Constraints
-
-It is possible to create custom type constraint to option spec
-mappings if you need them. The process is fairly simple (but a
-little verbose maybe). First you create a custom subtype, like
-so:
-
- subtype 'ArrayOfInts'
- => as 'ArrayRef'
- => where { scalar (grep { looks_like_number($_) } @$_) };
-
-Then you register the mapping, like so:
-
- MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- 'ArrayOfInts' => '=i@'
- );
-
-Now any attribute declarations using this type constraint will
-get the custom option spec. So that, this:
-
- has 'nums' => (
- is => 'ro',
- isa => 'ArrayOfInts',
- default => sub { [0] }
- );
-
-Will translate to the following on the command line:
-
- % my_script.pl --nums 5 --nums 88 --nums 199
-
-This example is fairly trivial, but more complex validations are
-easily possible with a little creativity. The trick is balancing
-the type constraint validations with the Getopt::Long validations.
-
-Better examples are certainly welcome :)
-
-=head2 Inferred Type Constraints
-
-If you define a custom subtype which is a subtype of one of the
-standard L</Supported Type Constraints> above, and do not explicitly
-provide custom support as in L</Custom Type Constraints> above,
-MooseX::Getopt will treat it like the parent type for Getopt
-purposes.
-
-For example, if you had the same custom C<ArrayOfInts> subtype
-from the examples above, but did not add a new custom option
-type for it to the C<OptionTypeMap>, it would be treated just
-like a normal C<ArrayRef> type for Getopt purposes (that is,
-C<=s@>).
+This is like L<MooseX::Getopt> and can be used instead except that it
+doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short).
=head1 METHODS
=over 4
-=item B<new_with_options (%params)>
-
-This method will take a set of default C<%params> and then collect
-params from the command line (possibly overriding those in C<%params>)
-and then return a newly constructed object.
-
-The special parameter C<argv>, if specified should point to an array
-reference with an array to use instead of C<@ARGV>.
-
-If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
-C<new_with_options> will throw an exception.
-
-If L<Getopt::Long::Descriptive> is installed and any of the following
-command line params are passed, the program will exit with usage
-information. You can add descriptions for each option by including a
-B<documentation> option for each attribute to document.
+=item B<new_with_options>
- --?
- --help
- --usage
-
-If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
-C<new>.
-
-=item B<ARGV>
-
-This accessor contains a reference to a copy of the C<@ARGV> array
-as it originally existed at the time of C<new_with_options>.
-
-=item B<extra_argv>
-
-This accessor contains an arrayref of leftover C<@ARGV> elements that
-L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
-un-mangled.
+See L<MooseX::Getopt> .
=item B<meta>
Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+Shlomi Fish E<lt>shlomif@cpan.orgE<gt>
+
=head1 COPYRIGHT AND LICENSE
Copyright 2007-2008 by Infinity Interactive, Inc.
projects / gitmo/MooseX-Getopt.git / commitdiff