From: Shlomi Fish Date: Sun, 23 Aug 2009 21:42:48 +0000 (+0300) Subject: Docs of MooseX::Getopt::Basic now refer elsewhere. X-Git-Tag: 0.22~5 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ff71d314a11f54b1da6c6aa7b04009bd5b6cc96d;p=gitmo%2FMooseX-Getopt.git Docs of MooseX::Getopt::Basic now refer elsewhere. We are now refering in lib/MooseX/Getopt/Basic.pm to MooseX::Getopt, and explaining when it is to be used. --- diff --git a/lib/MooseX/Getopt/Basic.pm b/lib/MooseX/Getopt/Basic.pm index 5473d04..88fa48b 100644 --- a/lib/MooseX/Getopt/Basic.pm +++ b/lib/MooseX/Getopt/Basic.pm @@ -220,7 +220,7 @@ L without GLD. 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); @@ -236,195 +236,20 @@ L without GLD. # ... 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 or the -attribute metaclass L to get non-default -commandline option names and aliases. - -You can use the trait L -or the attribute metaclass L -to have C 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. 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 method. - -If your class also uses a configfile-loading role based on -L, such as L, -L's C 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 - -A I 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 as a Getopt::Long option descriptor, -which would enable the following command line options: - - % my_script.pl --verbose - % my_script.pl --noverbose - -=item I, I, I - -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 - -An I 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 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 - -A I 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 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 above, and do not explicitly -provide custom support as in L above, -MooseX::Getopt will treat it like the parent type for Getopt -purposes. - -For example, if you had the same custom C subtype -from the examples above, but did not add a new custom option -type for it to the C, it would be treated just -like a normal C type for Getopt purposes (that is, -C<=s@>). +This is like L and can be used instead except that it +doesn't make use of L (or "GLD" for short). =head1 METHODS =over 4 -=item B - -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, if specified should point to an array -reference with an array to use instead of C<@ARGV>. - -If L fails (due to invalid arguments), -C will throw an exception. - -If L 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 option for each attribute to document. +=item B - --? - --help - --usage - -If you have L a the C param is also passed to -C. - -=item B - -This accessor contains a reference to a copy of the C<@ARGV> array -as it originally existed at the time of C. - -=item B - -This accessor contains an arrayref of leftover C<@ARGV> elements that -L did not parse. Note that the real C<@ARGV> is left -un-mangled. +See L . =item B @@ -452,6 +277,8 @@ Ryan D Johnson, Eryan@innerfence.comE Drew Taylor, Edrew@drewtaylor.comE +Shlomi Fish Eshlomif@cpan.orgE + =head1 COPYRIGHT AND LICENSE Copyright 2007-2008 by Infinity Interactive, Inc.