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';
+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 %processed = $class->_parse_argv(
- options => [
- $class->_attrs_to_options( @params )
- ]
- );
+ my $config_from_file;
+
+ my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
- my $params = $processed{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;
+
my $configfile;
+ my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] );
+ $opt_parser->getoptions( "configfile=s" => \$configfile );
- if(defined $params->{configfile}) {
- $configfile = $params->{configfile}
- }
- else {
- my $cfmeta = $class->meta->get_attribute('configfile');
+ if(!defined $configfile) {
+ my $cfmeta = $class->meta->find_attribute_by_name('configfile');
$configfile = $cfmeta->default if $cfmeta->has_default;
}
if(defined $configfile) {
- %$params = (
- %{$class->get_config_from_file($configfile)},
- %$params,
- );
+ $config_from_file = $class->get_config_from_file($configfile);
}
}
+ $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 $@;
my $argv_mangled = [ @ARGV ];
my %constructor_args = (
- map {
- $name_to_init_arg->{$_} => $parsed_options->{$_}
- } keys %$parsed_options,
+ map {
+ $name_to_init_arg->{$_} => $parsed_options->{$_}
+ } keys %$parsed_options,
);
return (
);
}
-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 {
sub _attrs_to_options {
my $class = shift;
+ my $config_from_file = shift || {};
my @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)
+ my $type = $attr->type_constraint;
+ if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
+ $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
}
}
name => $flag,
init_arg => $attr->init_arg,
opt_string => $opt_string,
- 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({}) ) : () ),
+ 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
+ # 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 ) : () ),
}
}
=head1 SYNOPSIS
- ## In your class
+ ## In your class
package My::App;
use Moose;
-
+
with 'MooseX::Getopt';
-
+
has 'out' => (is => 'rw', isa => 'Str', required => 1);
has 'in' => (is => 'rw', isa => 'Str', required => 1);
-
+
# ... rest of the class here
-
+
## in your script
#!/usr/bin/perl
-
+
use My::App;
-
+
my $app = My::App->new_with_options();
# ... rest of the script here
-
+
## on the command line
% perl my_app_script.pl -in file.input -out file.dump
=head1 DESCRIPTION
-This is a role which provides an alternate constructor for creating
-objects using parameters passed in from the command line.
+This is a role which provides an alternate constructor for creating
+objects using parameters passed in from the command line.
-This module attempts to DWIM as much as possible with the command line
-params by introspecting your class's attributes. It will use the name
-of your attribute as the command line option, and if there is a type
+This module attempts to DWIM as much as possible with the command line
+params by introspecting your class's attributes. It will use the name
+of your attribute as the command line option, and if there is a type
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
# for read/write attributes
has '_foo' => (accessor => 'foo', ...);
-
+
# or for read-only attributes
- has '_bar' => (reader => 'bar', ...);
+ has '_bar' => (reader => 'bar', ...);
-This will mean that Getopt will not handle a --foo param, but your
-code can still call the C<foo> method.
+This will mean that Getopt will not handle a --foo param, but your
+code can still call the C<foo> method.
If your class also uses a configfile-loading role based on
L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
=item I<Bool>
-A I<Bool> type constraint is set up as a boolean option with
+A I<Bool> type constraint is set up as a boolean option with
Getopt::Long. So that this attribute description:
has 'verbose' => (is => 'rw', isa => 'Bool');
-would translate into C<verbose!> as a Getopt::Long option descriptor,
+would translate into C<verbose!> as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --verbose
- % my_script.pl --noverbose
-
+ % my_script.pl --noverbose
+
=item I<Int>, I<Float>, I<Str>
-These type constraints are set up as properly typed options with
+These type constraints are set up as properly typed options with
Getopt::Long, using the C<=i>, C<=f> and C<=s> modifiers as appropriate.
=item I<ArrayRef>
in Getopt::Long. So that this attribute description:
has 'include' => (
- is => 'rw',
- isa => 'ArrayRef',
+ is => 'rw',
+ isa => 'ArrayRef',
default => sub { [] }
);
-would translate into C<includes=s@> as a Getopt::Long option descriptor,
+would translate into C<includes=s@> as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --include /usr/lib --include /usr/local/lib
in Getopt::Long. So that this attribute description:
has 'define' => (
- is => 'rw',
- isa => 'HashRef',
+ is => 'rw',
+ isa => 'HashRef',
default => sub { {} }
);
-would translate into C<define=s%> as a Getopt::Long option descriptor,
+would translate into C<define=s%> as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --define os=linux --define vendor=debian
=head2 Custom Type Constraints
-It is possible to create custom type constraint to option spec
+It is possible to create custom type constraint to option spec
mappings if you need them. The process is fairly simple (but a
-little verbose maybe). First you create a custom subtype, like
+little verbose maybe). First you create a custom subtype, like
so:
subtype 'ArrayOfInts'
'ArrayOfInts' => '=i@'
);
-Now any attribute declarations using this type constraint will
+Now any attribute declarations using this type constraint will
get the custom option spec. So that, this:
has 'nums' => (
% my_script.pl --nums 5 --nums 88 --nums 199
-This example is fairly trivial, but more complex validations are
+This example is fairly trivial, but more complex validations are
easily possible with a little creativity. The trick is balancing
the type constraint validations with the Getopt::Long validations.
=item B<new_with_options (%params)>
-This method will take a set of default C<%params> and then collect
+This method will take a set of default C<%params> and then collect
params from the command line (possibly overriding those in C<%params>)
and then return a newly constructed object.
=head1 BUGS
-All complex software has bugs lurking in it, and this module is no
+All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
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>
+
=head1 COPYRIGHT AND LICENSE
Copyright 2007-2008 by Infinity Interactive, Inc.