X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt%2FBasic.pm;h=691f67299726033ae720070018275d0e5ff254b0;hb=bde911ddcfdec86961080d6292ff414753671793;hp=721fd3fa2312102ccd1faa53e1be50046edd685d;hpb=33edcaa4819f23f5c92f2f4db8b0163866156d22;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt/Basic.pm b/lib/MooseX/Getopt/Basic.pm index 721fd3f..691f672 100644 --- a/lib/MooseX/Getopt/Basic.pm +++ b/lib/MooseX/Getopt/Basic.pm @@ -1,52 +1,73 @@ - package MooseX::Getopt::Basic; +# ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality + use Moose::Role; use MooseX::Getopt::OptionTypeMap; use MooseX::Getopt::Meta::Attribute; use MooseX::Getopt::Meta::Attribute::NoGetopt; +use MooseX::Getopt::ProcessedArgv; +use Try::Tiny; use Carp (); -use Getopt::Long (); +use Getopt::Long 2.37 (); -has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); -has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); +has ARGV => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']); +has extra_argv => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']); -sub new_with_options { +sub process_argv { my ($class, @params) = @_; + my $constructor_params = ( @params == 1 ? $params[0] : {@params} ); + my $config_from_file; if($class->meta->does_role('MooseX::ConfigFromFile')) { local @ARGV = @ARGV; + # just get the configfile arg now out of @ARGV; the rest of the args + # will be fetched later my $configfile; - my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] ); + my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through no_auto_version ) ] ); $opt_parser->getoptions( "configfile=s" => \$configfile ); + my $cfmeta = $class->meta->find_attribute_by_name('configfile'); + my $init_arg = $cfmeta->init_arg; + + # was it passed to the constructor? + if (!defined $configfile) + { + $configfile = $constructor_params->{$init_arg} if defined $init_arg; + } + if(!defined $configfile) { - my $cfmeta = $class->meta->find_attribute_by_name('configfile'); - $configfile = $cfmeta->default if $cfmeta->has_default; + # this is a classic legacy usecase documented in + # MooseX::ConfigFromFile that we should continue to support + $configfile = try { $class->configfile }; + + $configfile = $cfmeta->default + if not defined $configfile and $cfmeta->has_default; if (ref $configfile eq 'CODE') { # not sure theres a lot you can do with the class and may break some assumptions # warn? $configfile = &$configfile($class); } if (defined $configfile) { - $config_from_file = eval { + $config_from_file = try { $class->get_config_from_file($configfile); - }; - if ($@) { - die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/; } + catch { + die $_ unless /Specified configfile '\Q$configfile\E' does not exist/; + }; } + + $constructor_params->{$init_arg} = $configfile + if defined $configfile and defined $init_arg; } else { $config_from_file = $class->get_config_from_file($configfile); } } - my $constructor_params = ( @params == 1 ? $params[0] : {@params} ); - Carp::croak("Single parameters to new_with_options() must be a HASH ref") unless ref($constructor_params) eq 'HASH'; @@ -60,16 +81,30 @@ sub new_with_options { my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params}; # did the user request usage information? - if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) ) - { - $class->_getopt_full_usage($processed{usage}); + if ( $processed{usage} and $params->{help_flag} ) { + $class->print_usage_text($processed{usage}); } + return MooseX::Getopt::ProcessedArgv->new( + argv_copy => $processed{argv_copy}, + extra_argv => $processed{argv}, + usage => $processed{usage}, + constructor_params => $constructor_params, # explicit params to ->new + cli_params => $params, # params from CLI + ); +} + +sub new_with_options { + my ($class, @params) = @_; + + my $pa = $class->process_argv(@params); + $class->new( - ARGV => $processed{argv_copy}, - extra_argv => $processed{argv}, - %$constructor_params, # explicit params to ->new - %$params, # params from CLI + ARGV => $pa->argv_copy, + extra_argv => $pa->extra_argv, + ( $pa->usage ? ( usage => $pa->usage ) : () ), + %{ $pa->constructor_params }, # explicit params to ->new + %{ $pa->cli_params }, # params from CLI ); } @@ -86,14 +121,16 @@ sub _parse_argv { my $argv_copy = [ @ARGV ]; my @warnings; - my ( $parsed_options, $usage ) = eval { + my ( $parsed_options, $usage ) = try { local $SIG{__WARN__} = sub { push @warnings, @_ }; return $class->_getopt_get_options(\%params, $opt_spec); + } + catch { + $class->_getopt_spec_exception(\@warnings, $_); }; $class->_getopt_spec_warnings(@warnings) if @warnings; - $class->_getopt_spec_exception(\@warnings, $@) if $@; # Get a copy of the Getopt::Long-mangled @ARGV my $argv_mangled = [ @ARGV ]; @@ -126,10 +163,18 @@ sub _getopt_spec_exception { die @$warnings, $exception; } -sub _getopt_full_usage { +# maintained for backwards compatibility only +sub _getopt_full_usage +{ my ($self, $usage) = @_; - $usage->die; + print $usage->text; + exit 0; } +#(this is already documented in MooseX::Getopt. But FIXME later, via RT#82195) +=for Pod::Coverage + print_usage_text +=cut +sub print_usage_text { shift->_getopt_full_usage(@_) } sub _usage_format { return "usage: %c %o"; @@ -143,7 +188,7 @@ sub _traditional_spec { foreach my $opt ( @{ $params{options} } ) { push @options, $opt->{opt_string}; - my $identifier = lc($opt->{name}); + my $identifier = $opt->{name}; $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names $name_to_init_arg{$identifier} = $opt->{init_arg}; @@ -154,6 +199,7 @@ sub _traditional_spec { sub _compute_getopt_attrs { my $class = shift; + sort { $a->insertion_order <=> $b->insertion_order } grep { $_->does("MooseX::Getopt::Meta::Attribute::Trait") or @@ -205,9 +251,9 @@ sub _attrs_to_options { opt_string => $opt_string, required => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name}, # NOTE: - # this "feature" was breaking because - # Getopt::Long::Descriptive would return - # the default value as if it was a command + # 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 @@ -220,15 +266,8 @@ sub _attrs_to_options { return @options; } -no Moose::Role; 1; - -__END__ - -=pod - -=head1 NAME - -MooseX::Getopt::Basic - role to implement the Getopt::Long functionality +no Moose::Role; +1; =head1 SYNOPSIS @@ -259,20 +298,12 @@ MooseX::Getopt::Basic - role to implement the Getopt::Long functionality This is like L and can be used instead except that it doesn't make use of L (or "GLD" for short). -=head1 METHODS - -=head2 new_with_options +=method new_with_options See L. -=head1 COPYRIGHT AND LICENSE +=method process_argv -Copyright 2007-2008 by Infinity Interactive, Inc. - -L - -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L. =cut -