X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=3a087cf32cec36a0c87ed315449f381739c55fb1;hb=550da40200cbc32e0f608ccd8ab6ec5ce4ccce75;hp=3c0f3089293d7bd9eb20d39d4980093f981e4c34;hpb=fb24d659d6127c45e832292d4f06561efc059982;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 3c0f308..3a087cf 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -2,23 +2,57 @@ package MooseX::Getopt; use Moose::Role; +use Moose::Util::TypeConstraints; + use MooseX::Getopt::OptionTypeMap; + +use MooseX::Getopt::Parser::Long; +use maybe 'MooseX::Getopt::Parser::Descriptive'; + 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.12_01'; +our $VERSION = '0.15'; our $AUTHORITY = 'cpan:STEVAN'; -has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); -has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); + +has ARGV => ( + is => 'rw', + isa => 'ArrayRef', + metaclass => 'NoGetopt', +); + +has extra_argv => ( + is => 'rw', + isa => 'ArrayRef', + metaclass => 'NoGetopt', +); + +has getopt_parser => ( + is => 'rw', + does => 'MooseX::Getopt::Parser', + metaclass => 'NoGetopt', +); sub new_with_options { my ($class, @params) = @_; my $config_from_file; + + my $constructor_params = ( @params == 1 ? $params[0] : {@params} ); + + my $getopt_parser; + if (defined $constructor_params->{getopt_parser}) { + $getopt_parser = $constructor_params->{getopt_parser}; + $getopt_parser = $getopt_parser->new if not ref $getopt_parser; + } + else { + $getopt_parser = maybe::HAVE_MOOSEX_GETOPT_PARSER_DESCRIPTIVE + ? MooseX::Getopt::Parser::Descriptive->new + : MooseX::Getopt::Parser::Long->new; + } + if($class->meta->does_role('MooseX::ConfigFromFile')) { local @ARGV = @ARGV; @@ -36,10 +70,15 @@ sub new_with_options { } } + $class->throw_error("Single parameters to new_with_options() must be a HASH ref") + unless ref($constructor_params) eq 'HASH'; + my %processed = $class->_parse_argv( options => [ $class->_attrs_to_options( $config_from_file ) - ] + ], + params => $constructor_params, + getopt_parser => $getopt_parser, ); my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params}; @@ -47,17 +86,18 @@ sub new_with_options { $class->new( ARGV => $processed{argv_copy}, extra_argv => $processed{argv}, + getopt_parser => $getopt_parser, @params, # explicit params to ->new %$params, # params from CLI ); } sub _parse_argv { - my ( $class, %params ) = @_; + 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) ); + my ( $opt_spec, $name_to_init_arg ) = ( $params{getopt_parser}->_get_getopt_spec(%params) ); # Get a clean copy of the original @ARGV my $argv_copy = [ @ARGV ]; @@ -67,13 +107,7 @@ sub _parse_argv { 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 ); - } + return $params{getopt_parser}->getoptions($opt_spec); }; die join "", grep { defined } @err, $@ if @err or $@; @@ -95,51 +129,6 @@ sub _parse_argv { ); } -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}; - - my $identifier = $opt->{name}; - $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names - - $name_to_init_arg{$identifier} = $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}) : () ), - }, - ]; - - my $identifier = $opt->{name}; - $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names - - $name_to_init_arg{$identifier} = $opt->{init_arg}; - } - - return ( \@options, \%name_to_init_arg ); -} - sub _compute_getopt_attrs { my $class = shift; grep { @@ -178,9 +167,9 @@ sub _attrs_to_options { my $opt_string = join(q{|}, $flag, @aliases); 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) + my $type = $attr->type_constraint; + if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) { + $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type) } } @@ -189,7 +178,15 @@ sub _attrs_to_options { init_arg => $attr->init_arg, opt_string => $opt_string, required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name}, - ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ), + # NOTE: + # this "feature" was breaking because + # Getopt::Long::Descriptive would return + # the default value as if it was a command + # line flag, which would then override the + # one passed into a constructor. + # See 100_gld_default_bug.t for an example + # - SL + #( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ), ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ), } } @@ -242,10 +239,12 @@ 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 @@ -423,6 +422,8 @@ Stevan Little Estevan@iinteractive.comE Brandon L. Black, Eblblack@gmail.comE +Yuval Kogman, Enothingmuch@woobling.orgE + =head1 CONTRIBUTORS Ryan D Johnson, Eryan@innerfence.comE