X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=fc48b571b4412c7294bd4af52539088deb4b1781;hp=d7898f779b86ae55198e0f81d7cd39657f866a5c;hb=986fb4690bc00c860b1f728b986e39b412100854;hpb=b4a7905195bf50b95248815d2cfe5a762d8986b5 diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index d7898f7..fc48b57 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,253 +1,70 @@ - 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 }; - -our $VERSION = '0.10'; -our $AUTHORITY = 'cpan:STEVAN'; - -has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); -has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); - -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')) { - my $configfile; - - if(defined $params->{configfile}) { - $configfile = $params->{configfile} - } - else { - my $cfmeta = $class->meta->get_attribute('configfile'); - $configfile = $cfmeta->default if $cfmeta->has_default; - } - - if(defined $configfile) { - %$params = ( - %{$class->get_config_from_file($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, undef ); - } - }; - - 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, - ( defined($usage) ? ( 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; +# ABSTRACT: A Moose role for processing command line options - foreach my $attr ($class->_compute_getopt_attrs) { - my $name = $attr->name; +use Moose::Role 0.56; - my $aliases; +with 'MooseX::Getopt::GLD'; - 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; - } +no Moose::Role; - 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; -} - -no Moose::Role; 1; - -__END__ - -=pod - -=head1 NAME - -MooseX::Getopt - A Moose role for processing command line options +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 -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, @@ -256,7 +73,7 @@ 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 +precedence order: commandline overrides configfile, which overrides explicit new_with_options parameters. =head2 Supported Type Constraints @@ -265,20 +82,20 @@ overrides explicit new_with_options parameters. =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 @@ -287,12 +104,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 @@ -303,12 +120,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 @@ -317,9 +134,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' @@ -332,7 +149,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' => ( @@ -345,7 +162,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. @@ -365,58 +182,89 @@ type for it to the C, it would be treated just like a normal C type for Getopt purposes (that is, C<=s@>). -=head1 METHODS - -=over 4 - -=item B +=method 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 -C. +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. + + -? + --? + -h + --help + --usage + +If you have L the C param is also passed to +C as the usage option. -=item B +=method 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 +=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. -=item B +B: By default, L will reject unrecognized I +(that is, options that do not correspond with attributes using the Getopt +trait). To disable this, and allow options to also be saved in C (for example to pass along to another class's C), you can either enable the +C option of L for your class: C<< use Getopt::Long +qw(:config pass_through); >> or specify a value for for L's C parameter. -This returns the role meta object. +=method B -=back +This accessor contains the L object (if +L is used). -=head1 BUGS +=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 accessor contains the boolean state of the --help, --usage and --? +options (true if any of these options were passed on the command line). -=head1 AUTHOR +=method B -Stevan Little Estevan@iinteractive.comE +This method is called internally when the C state is true. +It prints the text from the C object (see above) to stdout and then the +program terminates normally. You can apply a method modification (see +L) if different behaviour is desired, for +example to include additional text. -Brandon L. Black, Eblblack@gmail.comE +=method B + +This returns the role meta object. -=head1 COPYRIGHT AND LICENSE +=method B -Copyright 2007 by Infinity Interactive, Inc. +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. -L +=head2 More Customization Options -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L for many other customizations you +can make to how options are parsed. Simply C in your class to set these. =cut + +=head1 SEE ALSO + +L, an extension to generate man pages, with colour +