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.12_01';
+our $VERSION = '0.24';
our $AUTHORITY = 'cpan:STEVAN';
has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
if(!defined $configfile) {
my $cfmeta = $class->meta->find_attribute_by_name('configfile');
$configfile = $cfmeta->default if $cfmeta->has_default;
+ if (ref $configfile eq 'CODE') {
+ # not sure theres a lot you can do with the class and may break some assumptions
+ # warn?
+ $configfile = &$configfile($class);
+ }
+ if (defined $configfile) {
+ $config_from_file = eval {
+ $class->get_config_from_file($configfile);
+ };
+ if ($@) {
+ die $@ unless $@ =~ /Specified configfile '\Q$configfile\E' does not exist/;
+ }
+ }
}
-
- if(defined $configfile) {
+ else {
$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();
+ }
+
$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 _parse_argv {
my ( $class, %params ) = @_;
- local @ARGV = @{ $params{argv} || \@ARGV };
+ local @ARGV = @{ $params{params}{argv} || \@ARGV };
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 @err;
-
+ my @warnings;
my ( $parsed_options, $usage ) = eval {
- local $SIG{__WARN__} = sub { push @err, @_ };
+ local $SIG{__WARN__} = sub { push @warnings, @_ };
if ( HAVE_GLD ) {
return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec);
}
};
- die join "", grep { defined } @err, $@ if @err or $@;
+ $class->_getopt_spec_warnings(@warnings) if @warnings;
+ $class->_getopt_spec_exception(\@warnings, $@) if $@;
# Get a copy of the Getopt::Long-mangled @ARGV
my $argv_mangled = [ @ARGV ];
);
}
+sub _getopt_spec_warnings { }
+
+sub _getopt_spec_exception {
+ my ($self, $warnings, $exception) = @_;
+ die @$warnings, $exception;
+}
+
sub _usage_format {
return "usage: %c %o";
}
foreach my $opt ( @{ $params{options} } ) {
push @options, $opt->{opt_string};
- my $identifier = $opt->{name};
+ my $identifier = lc($opt->{name});
$identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
$name_to_init_arg{$identifier} = $opt->{init_arg};
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}) : () ),
},
];
- my $identifier = $opt->{name};
+ my $identifier = lc($opt->{name});
$identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
$name_to_init_arg{$identifier} = $opt->{init_arg};
$_->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 {
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)
}
}
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
commandline argument support, unless the attribute's metaclass is set
-to L<MooseX::Getopt::Meta::Attribute>. If you don't want you accessors
-to have the leading underscore in thier name, you can do this:
+to L<MooseX::Getopt::Meta::Attribute>. If you don't want your accessors
+to have the leading underscore in their name, you can do this:
# for read/write attributes
has '_foo' => (accessor => 'foo', ...);
params from the command line (possibly overriding those in C<%params>)
and then return a newly constructed object.
+The special parameter C<argv>, if specified should point to an array
+reference with an array to use instead of C<@ARGV>.
+
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
+If L<Getopt::Long::Descriptive> 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<documentation> option for each attribute to document.
+
+ --?
+ --help
+ --usage
+
+If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
C<new>.
=item B<ARGV>
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>
+Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+
=head1 COPYRIGHT AND LICENSE
Copyright 2007-2008 by Infinity Interactive, Inc.
projects / gitmo/MooseX-Getopt.git / blobdiff