X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=d463fd423e6ebdf8d23a55d2e539bf2485c9cf20;hb=topic%2Fcreate_via_new;hp=1c4a2358a2f07c04743c3fb700597e64598caffd;hpb=cd9a4a412a0d9729637128b07db4a277ed4259b6;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 1c4a235..d463fd4 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -6,10 +6,12 @@ use MooseX::Getopt::OptionTypeMap; use MooseX::Getopt::Meta::Attribute; use MooseX::Getopt::Meta::Attribute::NoGetopt; +use Carp (); + use Getopt::Long (); # GLD uses it anyway, doesn't hurt use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; -our $VERSION = '0.13'; +our $VERSION = '0.20'; our $AUTHORITY = 'cpan:STEVAN'; has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); @@ -36,22 +38,86 @@ sub new_with_options { } } + 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'; + my %processed = $class->_parse_argv( options => [ $class->_attrs_to_options( $config_from_file ) - ] + ], + params => $constructor_params, ); 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}) ) + { + $processed{usage}->die(); + } + $class->new( ARGV => $processed{argv_copy}, extra_argv => $processed{argv}, - @params, # explicit params to ->new + %$constructor_params, # explicit params to ->new %$params, # params from CLI ); } +sub BUILDARGS { + + my ($class, @params) = @_; + + my $config_from_file; + if($class->meta->does_role('MooseX::ConfigFromFile')) { + local @ARGV = @ARGV; + + my $configfile; + my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] ); + $opt_parser->getoptions( "configfile=s" => \$configfile ); + + if(!defined $configfile) { + my $cfmeta = $class->meta->find_attribute_by_name('configfile'); + $configfile = $cfmeta->default if $cfmeta->has_default; + } + + if(defined $configfile) { + $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'; + + my %processed = $class->_parse_argv( + options => [ + $class->_attrs_to_options( $config_from_file ) + ], + params => $constructor_params, + ); + + 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}) ) + { + $processed{usage}->die(); + } + + # BUILDALL needs to return a hash ref of args used to build + return { + ARGV => $processed{argv_copy}, + extra_argv => $processed{argv}, + %$constructor_params, # explicit params to ->new + %$params, # params from CLI + } +} + + sub _parse_argv { my ( $class, %params ) = @_; @@ -121,13 +187,21 @@ sub _gld_spec { my ( @options, %name_to_init_arg ); + my $constructor_params = $params{params}; + 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}) : () ), + ( ( $opt->{required} && !exists($constructor_params->{$opt->{init_arg}}) ) ? (required => $opt->{required}) : () ), + # NOTE: + # remove this 'feature' because it didn't work + # all the time, and so is better to not bother + # since Moose will handle the defaults just + # fine anyway. + # - SL + #( exists $opt->{default} ? (default => $opt->{default}) : () ), }, ]; @@ -148,7 +222,7 @@ sub _compute_getopt_attrs { $_->name !~ /^_/ } grep { !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt') - } $class->meta->compute_all_applicable_attributes + } $class->meta->get_all_attributes } sub _get_cmd_flags_for_attr { @@ -177,10 +251,13 @@ 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) + if ($attr->name eq 'configfile') { + $opt_string .= '=s'; + } + elsif ($attr->has_type_constraint) { + my $type = $attr->type_constraint; + if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) { + $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type) } } @@ -189,7 +266,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 ) : () ), } } @@ -393,6 +478,15 @@ and then return a newly constructed object. If L fails (due to invalid arguments), C will throw an exception. +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 a the C param is also passed to C. @@ -425,10 +519,14 @@ 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 + =head1 COPYRIGHT AND LICENSE Copyright 2007-2008 by Infinity Interactive, Inc.