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;
}
}
+ $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};
$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 ];
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 $@;
);
}
-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 {
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)
}
}
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 ) : () ),
}
}
constraint defined, it will configure Getopt::Long to handle the option
accordingly.
-You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute>
-to get non-default commandline option names and aliases.
+You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait> or the
+attribute metaclass L<MooseX::Getopt::Meta::Attribute> to get non-default
+commandline option names and aliases.
-You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
+You can use the trait L<MooseX::Getopt::Meta::Attribute::Trait::NoGetopt>
+or the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetopt>
to have C<MooseX::Getopt> ignore your attribute in the commandline options.
By default, attributes which start with an underscore are not given
Brandon L. Black, E<lt>blblack@gmail.comE<gt>
+Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
+
=head1 CONTRIBUTORS
Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
projects / gitmo/MooseX-Getopt.git / blobdiff