X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=a8ce4a3cec4f9e6b5b82a81f522383fbfc55e156;hb=62c4891a67e6c7f3a79eb48adec1bf3eca3ff4d1;hp=3dfd63245c9c4617141655181fb3c58de4baa87a;hpb=384fb15d47f2d28e63951b5f5e6be6df28bb87c8;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 3dfd632..a8ce4a3 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -2,17 +2,18 @@ package MooseX::Getopt; use Moose::Role; -use Getopt::Long (); - use MooseX::Getopt::OptionTypeMap; use MooseX::Getopt::Meta::Attribute; use MooseX::Getopt::Meta::Attribute::NoGetopt; -our $VERSION = '0.08'; +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'; our $AUTHORITY = 'cpan:STEVAN'; -has ARGV => (is => 'rw', isa => 'ArrayRef'); -has extra_argv => (is => 'rw', isa => 'ArrayRef'); +has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); +has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); sub new_with_options { my ($class, @params) = @_; @@ -25,12 +26,23 @@ sub new_with_options { my $params = $processed{params}; - if($class->meta->does_role('MooseX::ConfigFromFile') - && defined $params->{configfile}) { - %$params = ( - %{$class->get_config_from_file($params->{configfile})}, - %$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( @@ -46,77 +58,138 @@ sub _parse_argv { local @ARGV = @{ $params{argv} || \@ARGV }; - 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}; - } + 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 ]; - { - local $SIG{__WARN__} = sub { die $_[0] }; - Getopt::Long::GetOptions(\%options, @options); - } + 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, - params => { - map { - $name_to_init_arg{$_} => $options{$_} - } keys %options, - } + ( 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}; + + 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 { - $_->isa("MooseX::Getopt::Meta::Attribute") + $_->does("MooseX::Getopt::Meta::Attribute::Trait") or $_->name !~ /^_/ - && - !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt') + } grep { + !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt') } $class->meta->compute_all_applicable_attributes } +sub _get_cmd_flags_for_attr { + my ( $class, $attr ) = @_; + + my $flag = $attr->name; + + my @aliases; + + if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) { + $flag = $attr->cmd_flag if $attr->has_cmd_flag; + @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases; + } + + return ( $flag, @aliases ); +} + sub _attrs_to_options { my $class = shift; my @options; foreach my $attr ($class->_compute_getopt_attrs) { - my $name = $attr->name; - - my $aliases; - - 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; - } + my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr); - my $opt_string = $aliases - ? join(q{|}, $name, @$aliases) - : $name; + 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 (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) { + $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name) } } push @options, { - name => $name, + name => $flag, init_arg => $attr->init_arg, opt_string => $opt_string, - required => $attr->is_required, + required => $attr->is_required && !$attr->has_default && !$attr->has_builder, + ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ), ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ), } } @@ -192,7 +265,12 @@ 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 @@ -313,6 +391,9 @@ and then return a newly constructed object. 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. + =item B This accessor contains a reference to a copy of the C<@ARGV> array @@ -344,7 +425,7 @@ Brandon L. Black, Eblblack@gmail.comE =head1 COPYRIGHT AND LICENSE -Copyright 2007 by Infinity Interactive, Inc. +Copyright 2007-2008 by Infinity Interactive, Inc. L