X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=cd0cd8bd5660e0462e2a0cd8fe6f0302d779748a;hb=449f00873d6a740b73bcb55c8d3afbbc1640036e;hp=fc64f066ce8c57278be5620ea627de1329d31420;hpb=5dac17c3fb3f25ba558e70565462826017f0c91c;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index fc64f06..cd0cd8b 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,114 +1,257 @@ - package MooseX::Getopt; -use Moose::Role; - -use Getopt::Long; - -use MooseX::Getopt::OptionTypes; -use MooseX::Getopt::Meta::Attribute; - -sub new_with_options { - my ($class, %params) = @_; - - my (%options, %constructor_options); - foreach my $attr ($class->meta->compute_all_applicable_attributes) { - my $name = $attr->name; - - if ($attr->isa('MooseX::Getopt::Meta::Attribute') && $attr->has_cmd_flag) { - $name = $attr->cmd_flag; - } - - my $init_arg = $attr->init_arg; - - # create a suitable default value - $constructor_options{$init_arg} = ''; - - if ($attr->has_type_constraint) { - my $type_name = $attr->type_constraint->name; - if (MooseX::Getopt::OptionTypes->has_option_type($type_name)) { - $name .= MooseX::Getopt::OptionTypes->get_option_type($type_name); - } - } - - $options{$name} = \($constructor_options{$init_arg}); - } - - GetOptions(%options); - - # filter out options which - # were not passed at all - %constructor_options = map { - $constructor_options{$_} ne '' - ? ($_ => $constructor_options{$_}) - : () - } keys %constructor_options; - - $class->new(%params, %constructor_options); -} - -1; +# ABSTRACT: A Moose role for processing command line options -__END__ +use Moose::Role 0.56; -=pod +with 'MooseX::Getopt::GLD'; -=head1 NAME +no Moose::Role; -MooseX::Getopt - +1; =head1 SYNOPSIS - ## In your class + ## In your class package My::App; use Moose; - + with 'MooseX::Getopt'; - + has 'out' => (is => 'rw', isa => 'Str', required => 1); has 'in' => (is => 'rw', isa => 'Str', required => 1); - + # ... rest of the class here - + ## in your script #!/usr/bin/perl - + use My::App; - + my $app = My::App->new_with_options(); # ... rest of the script here - + ## on the command line % perl my_app_script.pl -in file.input -out file.dump =head1 DESCRIPTION -=head1 METHODS +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 your accessors +to have the leading underscore in their 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 B +=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 -=item B +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 -=head1 BUGS +=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@>). + +=method B -All complex software has bugs lurking in it, and this module is no -exception. If you find a bug please either email me, or add the bug -to cpan-RT. +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. -=head1 AUTHOR +The special parameter C, if specified should point to an array +reference with an array to use instead of C<@ARGV>. -Stevan Little Estevan@iinteractive.comE +If L fails (due to invalid arguments), +C will throw an exception. -=head1 COPYRIGHT AND LICENSE +If L is installed and any of the following +command line params are passed, the program will exit with usage +information (and the option's state will be stored in the help_flag +attribute). You can add descriptions for each option by including a +B option for each attribute to document. -Copyright 2007 by Infinity Interactive, Inc. + --? + --help + --usage -L +If you have L the C param is also passed to +C as the usage option. -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +=method B + +This accessor contains a reference to a copy of the C<@ARGV> array +as it originally existed at the time of C. + +=method 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. + +B: By default, L will reject unrecognized arguments +(that is, arguments that do not correspond with attributes using the Getopt +trait). To disable this, and allow the population of C, enable the +C option of L for your class: C + +=method B + +This accessor contains the L object (if +L is used). + +=method B + +This accessor contains the boolean state of the --help, --usage and --? +options (true if any of these options were passed on the command line). + +=method B + +This returns the role meta object. + +=method B + +This does most of the work of C, analyzing the parameters +and argv, except for actually calling the constructor. It returns a +L object. C uses this +method internally, so modifying this method via subclasses/roles will affect +C. + +=head2 More Customization Options + +See L for many other customizations you +can make to how options are parsed. Simply C in your class to set these. + +=back =cut