X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=eed3afc283aa26917fba15583ed3d6c84875fa33;hb=8b9e50c33133b5735d32f4b3d05eee82a919b382;hp=2602a4a9fcd062c8e089e5a812b90ef4d019fefc;hpb=6ac028c4d869259041b7c526071cf614ffb033fa;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 2602a4a..eed3afc 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,118 +1,12 @@ - package MooseX::Getopt; use Moose::Role; -use Getopt::Long (); - -use MooseX::Getopt::OptionTypeMap; -use MooseX::Getopt::Meta::Attribute; -use MooseX::Getopt::Meta::Attribute::NoGetopt; +use constant _HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; -our $VERSION = '0.07'; +our $VERSION = '0.26'; our $AUTHORITY = 'cpan:STEVAN'; -has ARGV => (is => 'rw', isa => 'ArrayRef'); -has extra_argv => (is => 'rw', isa => 'ArrayRef'); - -sub new_with_options { - my ($class, @params) = @_; - - my %processed = $class->_parse_argv( - options => [ - $class->_attrs_to_options( @params ) - ] - ); - - $class->new( - ARGV => $processed{argv_copy}, - extra_argv => $processed{argv}, - @params, # explicit params to ->new - %{ $processed{params} }, # params from CLI - ); -} - -sub _parse_argv { - my ( $class, %params ) = @_; - - local @ARGV = @{ $params{argv} || \@ARGV }; - - my ( @options, %name_to_init_arg, %options ); - - foreach my $opt ( @{ $params{options} } ) { - push @options, $opt->{opt_string}; - $name_to_init_arg{ $opt->{name} } = $opt->{init_arg}; - } - - # Get a clean copy of the original @ARGV - my $argv_copy = [ @ARGV ]; - - { - local $SIG{__WARN__} = sub { die $_[0] }; - Getopt::Long::GetOptions(\%options, @options); - } - - # Get a copy of the Getopt::Long-mangled @ARGV - my $argv_mangled = [ @ARGV ]; - - return ( - argv_copy => $argv_copy, - argv => $argv_mangled, - params => { - map { - $name_to_init_arg{$_} => $options{$_} - } keys %options, - } - ); -} - -sub _compute_getopt_attrs { - my $class = shift; - grep { - $_->isa("MooseX::Getopt::Meta::Attribute") - or - $_->name !~ /^_/ - && - !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt') - } $class->meta->compute_all_applicable_attributes -} - -sub _attrs_to_options { - my $class = shift; - - my @options; - - foreach my $attr ($class->_compute_getopt_attrs) { - my $name = $attr->name; - - my $aliases; - - if ($attr->isa('MooseX::Getopt::Meta::Attribute')) { - $name = $attr->cmd_flag if $attr->has_cmd_flag; - $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases; - } - - my $opt_string = $aliases - ? join(q{|}, $name, @$aliases) - : $name; - - if ($attr->has_type_constraint) { - my $type_name = $attr->type_constraint->name; - if (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) { - $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name); - } - } - - push @options, { - name => $name, - init_arg => $attr->init_arg, - opt_string => $opt_string, - required => $attr->is_required, - ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ), - } - } - - return @options; -} +with _HAVE_GLD ? 'MooseX::Getopt::GLD' : 'MooseX::Getopt::Basic'; no Moose::Role; 1; @@ -126,58 +20,70 @@ MooseX::Getopt - A Moose role for processing command line options =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 -This is a role which provides an alternate constructor for creating -objects using parameters passed in from the command line. +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 +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 attribute metaclass L -to get non-default commandline option names and aliases. +You can use the trait L or the +attribute metaclass L to get non-default +commandline option names and aliases. -You can use the attribute metaclass L +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: +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', ...); + has '_bar' => (reader => 'bar', ...); + +This will mean that Getopt will not handle a --foo param, but your +code can still call the C method. -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 @@ -185,20 +91,20 @@ code can still call the C method. =item I -A I type constraint is set up as a boolean option with +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, +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 - + % my_script.pl --noverbose + =item I, I, I -These type constraints are set up as properly typed options with +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 @@ -207,12 +113,12 @@ 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', + is => 'rw', + isa => 'ArrayRef', default => sub { [] } ); -would translate into C as a Getopt::Long option descriptor, +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 @@ -223,12 +129,12 @@ 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', + is => 'rw', + isa => 'HashRef', default => sub { {} } ); -would translate into C as a Getopt::Long option descriptor, +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 @@ -237,9 +143,9 @@ which would enable the following command line options: =head2 Custom Type Constraints -It is possible to create custom type constraint to option spec +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 +little verbose maybe). First you create a custom subtype, like so: subtype 'ArrayOfInts' @@ -252,7 +158,7 @@ Then you register the mapping, like so: 'ArrayOfInts' => '=i@' ); -Now any attribute declarations using this type constraint will +Now any attribute declarations using this type constraint will get the custom option spec. So that, this: has 'nums' => ( @@ -265,7 +171,7 @@ 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 +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. @@ -291,13 +197,28 @@ C<=s@>). =item B -This method will take a set of default C<%params> and then collect +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. + + --? + --help + --usage + +If you have L the C param is also passed to +C. + =item B This accessor contains a reference to a copy of the C<@ARGV> array @@ -317,7 +238,7 @@ This returns the role meta object. =head1 BUGS -All complex software has bugs lurking in it, and this module is no +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. @@ -327,9 +248,19 @@ Stevan Little Estevan@iinteractive.comE Brandon L. Black, Eblblack@gmail.comE +Yuval Kogman, Enothingmuch@woobling.orgE + +=head1 CONTRIBUTORS + +Ryan D Johnson, Eryan@innerfence.comE + +Drew Taylor, Edrew@drewtaylor.comE + +Tomas Doran, (t0m) C<< >> + =head1 COPYRIGHT AND LICENSE -Copyright 2007 by Infinity Interactive, Inc. +Copyright 2007-2008 by Infinity Interactive, Inc. L