package MooseX::Getopt;
use Moose::Role;
-use Getopt::Long::Descriptive ();
-
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.11';
our $AUTHORITY = 'cpan:STEVAN';
-has ARGV => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
-has extra_argv => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
+has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
+has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
sub new_with_options {
my ($class, @params) = @_;
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(
local @ARGV = @{ $params{argv} || \@ARGV };
- my ( $opt_spec, $name_to_init_arg ) = $class->_gld_spec(%params);
+ 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 ];
my ( $parsed_options, $usage ) = eval {
local $SIG{__WARN__} = sub { push @err, @_ };
- Getopt::Long::Descriptive::describe_options("usage: %c %o", @$opt_spec)
+
+ 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 $@;
params => \%constructor_args,
argv_copy => $argv_copy,
argv => $argv_mangled,
- usage => $usage
+ ( 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 ) = @_;
},
];
- $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
+ 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 );
} $class->meta->compute_all_applicable_attributes
}
+sub _get_cmd_flags_for_attr {
+ my ( $class, $attr ) = @_;
+
+ my $flag = $attr->name;
+
+ my @aliases;
+
+ if ($attr->isa('MooseX::Getopt::Meta::Attribute')) {
+ $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;
+ my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
- 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 $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;
}
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 ) : () ),
}
If your class also uses a configfile-loading role based on
L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
L<MooseX::Getopt>'s C<new_with_options> 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
If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
C<new_with_options> will throw an exception.
+If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
+C<new>.
+
=item B<ARGV>
This accessor contains a reference to a copy of the C<@ARGV> array
projects / gitmo/MooseX-Getopt.git / blobdiff