X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=49ac04895c93b81f508c10c69a273812e9bbe495;hb=96df119bc747eb5823ba0490cf7d71d2dc457f6a;hp=cb0d141a4ff844c2d0604c25461531bc791d62ff;hpb=3cc60720e3d5ebb69597dca707763a661ccca1ea;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index cb0d141..49ac048 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,180 +1,115 @@ package MooseX::Getopt; + +our $VERSION = '0.150001'; +our $AUTHORITY = 'cpan:STEVAN'; + use Moose::Role; +use Moose::Util::TypeConstraints; + use MooseX::Getopt::OptionTypeMap; + +use MooseX::Getopt::Session; + 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.08'; -our $AUTHORITY = 'cpan:STEVAN'; +use Getopt::Long (); -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, undef ); - } - }; +use constant _default_getopt_session => 'MooseX::Getopt::Session'; - die join "", grep { defined } @err, $@ if @err or $@; - # Get a copy of the Getopt::Long-mangled @ARGV - my $argv_mangled = [ @ARGV ]; +has getopt => ( + is => 'rw', + isa => 'MooseX::Getopt::Session', + metaclass => 'NoGetopt', + handles => [ 'ARGV', 'extra_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 new_with_options { + my $class = shift; -sub _usage_format { - return "usage: %c %o"; -} + return $class->new( $class->get_options_from_argv(@_) ); +}; -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}; - } +sub get_options_from_argv { + my $class = shift; - return ( \@options, \%name_to_init_arg ); -} + Moose->throw_error( + "Single parameters to get_options_from_argv() must be a HASH ref" + ) if ref $_[0] and ref $_ ne 'HASH'; -sub _gld_spec { - my ( $class, %params ) = @_; + my $options = { + %{ $class->get_options_from_configfile }, + @_ == 1 ? %{ $_[0] } : @_ + }; - my ( @options, %name_to_init_arg ); + my $getopt = defined $options->{getopt} + ? $options->{getopt} + : $class->_default_getopt_session->new( + classes_filter => sub { $_ eq $class }, + options => $options, + ); - 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}) : () ), - }, - ]; + # Call Getopt parser only once. + $getopt->build_options if not $getopt->has_status; - $name_to_init_arg{ $opt->{name} } = $opt->{init_arg}; - } + my $new_options = { + %$options, # explicit options to ->new + %{ $getopt->options }, # options from CLI + getopt => $getopt, + }; - return ( \@options, \%name_to_init_arg ); -} + return $new_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 { + +sub get_options_from_configfile { my $class = shift; - my @options; + my $options = {}; - foreach my $attr ($class->_compute_getopt_attrs) { - my $name = $attr->name; + if ( $class->meta->does_role('MooseX::ConfigFromFile') ) { + local @ARGV = @ARGV; - my $aliases; + my $configfile; + my $opt_parser = Getopt::Long::Parser->new( config => ['pass_through'] ); + $opt_parser->getoptions( "configfile=s" => \$configfile ); - 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; - } + if ( not defined $configfile ) { + my $cfmeta = $class->meta->find_attribute_by_name('configfile'); + $configfile = $cfmeta->default if $cfmeta->has_default; + }; - my $opt_string = $aliases - ? join(q{|}, $name, @$aliases) - : $name; + if ( defined $configfile ) { + $options = $class->get_config_from_file($configfile); + }; + }; - 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) - } - } + return $options; +}; - 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; -} +sub _compute_getopt_attrs { + my $class = shift; + + return grep { + $_->does('MooseX::Getopt::Meta::Attribute::Trait') + or $_->name !~ /^_/ + } grep { + !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt') + } $class->meta->compute_all_applicable_attributes; +}; + no Moose::Role; 1; + __END__ =pod @@ -185,43 +120,45 @@ 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 @@ -231,17 +168,22 @@ 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', ...); + 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 @@ -249,34 +191,39 @@ 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, I, I + +These type constaints 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', + 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 @@ -287,12 +234,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 @@ -301,9 +248,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' @@ -316,7 +263,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' => ( @@ -329,7 +276,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. @@ -349,13 +296,49 @@ type for it to the C, it would be treated just like a normal C type for Getopt purposes (that is, C<=s@>). +=head2 Session + +L can handle more than one class which contain +attributes filled from CLI. In this case, you need to use explicite +L object and then the Getopt attributes will be +searched in any class which does L. + + package My::App; + use Moose; + with 'MooseX::Getopt'; + has 'send' => (is => 'rw', predicate => 'has_send'); + + package My::App::Send; + use Moose; + with 'MooseX::Getopt'; + has 'to' => (is => 'rw', isa => 'Str', default => 'localhost'); + sub send { my $self = shift; warn "Sending mail to ", $self->to; } + + # ... rest of the class here + + ## in your script + #!/usr/bin/perl + + my $getopt = MooseX::Getopt::Session->new; + + my $app = My::App->new_with_options( getopt => $getopt ); + if ($app->has_send) { + # Use the same command line + my $sender = My::App::Send->new_with_options( getopt => $getopt ); + $sender->send; + } + # ... rest of the script here + + ## on the command line + % perl my_app_script.pl --send --to server.example.net + =head1 METHODS =over 4 =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. @@ -365,10 +348,22 @@ C will throw an exception. If you have L a the C param is also passed to C. +=item B + +This method returns the list of parameters collected from command line +without creating the new object. + +=item B + +This method returns the list of parameters collected with +L mechanism. + =item B -This accessor contains a reference to a copy of the C<@ARGV> array -as it originally existed at the time of C. +This accessor contains a reference to a copy of the C<@ARGV> array as it +originally existed at the time of C. + +The C is delegated from L object. =item B @@ -376,15 +371,35 @@ 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. +The C is delegated from L object. + +=item B + +This accessor contains a L object. This object can +be shared between more than one class which does L. The new +object is created by default. + =item B This returns the role meta object. =back +=head1 SEE ALSO + +=over 4 + +=item L + +=item L + +=item L + +=back + =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. @@ -394,9 +409,17 @@ Stevan Little Estevan@iinteractive.comE Brandon L. Black, Eblblack@gmail.comE +Yuval Kogman, Enothingmuch@woobling.orgE + +Piotr Roszatycki, Edexter@cpan.orgE + +=head1 CONTRIBUTORS + +Ryan D Johnson, Eryan@innerfence.comE + =head1 COPYRIGHT AND LICENSE -Copyright 2007 by Infinity Interactive, Inc. +Copyright 2007-2008 by Infinity Interactive, Inc. L