X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=eed3afc283aa26917fba15583ed3d6c84875fa33;hb=8b9e50c33133b5735d32f4b3d05eee82a919b382;hp=19bebe57209e3c1ae62181e12bbb86205ddd1a2e;hpb=fad5da09d36b09e7ce64d96246098aa258fe53d0;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 19bebe5..eed3afc 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,210 +1,12 @@ - package MooseX::Getopt; use Moose::Role; -use MooseX::Getopt::OptionTypeMap; -use MooseX::Getopt::Meta::Attribute; -use MooseX::Getopt::Meta::Attribute::NoGetopt; - -use Getopt::Long (); # GLD uses it anyway, doesn't hurt -use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; +use constant _HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; -our $VERSION = '0.08'; +our $VERSION = '0.26'; our $AUTHORITY = 'cpan:STEVAN'; -has ARGV => (is => 'rw', isa => 'ArrayRef', documentation => "hidden"); -has extra_argv => (is => 'rw', isa => 'ArrayRef', documentation => "hidden"); - -sub new_with_options { - my ($class, @params) = @_; - - my %processed = $class->_parse_argv( - options => [ - $class->_attrs_to_options( @params ) - ] - ); - - my $params = $processed{params}; - - if($class->meta->does_role('MooseX::ConfigFromFile') - && defined $params->{configfile}) { - %$params = ( - %{$class->get_config_from_file($params->{configfile})}, - %$params, - ); - } - - $class->new( - ARGV => $processed{argv_copy}, - extra_argv => $processed{argv}, - @params, # explicit params to ->new - %$params, # params from CLI - ); -} - -sub _parse_argv { - my ( $class, %params ) = @_; - - local @ARGV = @{ $params{argv} || \@ARGV }; - - my ( $opt_spec, $name_to_init_arg ) = ( HAVE_GLD ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) ); - - # Get a clean copy of the original @ARGV - my $argv_copy = [ @ARGV ]; - - my @err; - - my ( $parsed_options, $usage ) = eval { - local $SIG{__WARN__} = sub { push @err, @_ }; - - if ( HAVE_GLD ) { - return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec); - } else { - my %options; - Getopt::Long::GetOptions(\%options, @$opt_spec); - return ( \%options, MooseX::Getopt::FakeUsage->new(%params) ); - } - }; - - die join "", grep { defined } @err, $@ if @err or $@; - - # Get a copy of the Getopt::Long-mangled @ARGV - my $argv_mangled = [ @ARGV ]; - - my %constructor_args = ( - map { - $name_to_init_arg->{$_} => $parsed_options->{$_} - } keys %$parsed_options, - ); - - return ( - params => \%constructor_args, - argv_copy => $argv_copy, - argv => $argv_mangled, - usage => $usage - ); -} - -sub _usage_format { - return "usage: %c %o"; -} - -sub _traditional_spec { - my ( $class, %params ) = @_; - - 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}; - } - - return ( \@options, \%name_to_init_arg ); -} - -sub _gld_spec { - my ( $class, %params ) = @_; - - my ( @options, %name_to_init_arg ); - - foreach my $opt ( @{ $params{options} } ) { - push @options, [ - $opt->{opt_string}, - $opt->{doc} || ' ', # FIXME new GLD shouldn't need this hack - { - ( $opt->{required} ? (required => $opt->{required}) : () ), - ( exists $opt->{default} ? (default => $opt->{default}) : () ), - }, - ]; - - $name_to_init_arg{ $opt->{name} } = $opt->{init_arg}; - } - - return ( \@options, \%name_to_init_arg ); -} - -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_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ), - ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ), - } - } - - return @options; -} - -{ - package MooseX::Getopt::FakeUsage; - use Moose; - # fakes Getopt::Long::Descriptive::Usage - - has text => ( - isa => "Str", - is => "rw", - default => "In order to get a usage text please install Getopt::Long::Descriptive\n", - ); - - sub warn { - my $self = shift; - warn $self->text; - } - - sub die { - my $self = shift; - my $arg = shift || {}; - - die( - join( - "", - grep { defined } $arg->{pre_text}, $self->text, $arg->{post_text}, - ) - ); - } - - use overload ( - q{""} => "text", - ); -} +with _HAVE_GLD ? 'MooseX::Getopt::GLD' : 'MooseX::Getopt::Basic'; no Moose::Role; 1; @@ -218,63 +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 for you. +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 @@ -282,20 +91,20 @@ specified by the C<--configfile> option for you. =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 @@ -304,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 @@ -320,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 @@ -334,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' @@ -349,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' => ( @@ -362,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. @@ -388,14 +197,26 @@ 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 you have L a the C param is also passed to +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 @@ -417,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. @@ -427,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