package MooseX::Getopt::Basic;
+# ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality
+
use Moose::Role;
use MooseX::Getopt::OptionTypeMap;
use MooseX::Getopt::Meta::Attribute;
use MooseX::Getopt::Meta::Attribute::NoGetopt;
+use MooseX::Getopt::ProcessedArgv;
+use Try::Tiny;
use Carp ();
-use Getopt::Long (); # GLD uses it anyway, doesn't hurt
-
-our $VERSION = '0.20';
-our $AUTHORITY = 'cpan:STEVAN';
-
-has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
-has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
-
-# _getopt_spec() and _getoptions() are overrided by MooseX::Getopt::GLD.
+use Getopt::Long 2.37 ();
-sub _getopt_spec {
- my ($class, %params) = @_;
- return $class->_traditional_spec(%params)
-}
+has ARGV => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
+has extra_argv => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
-sub _get_options {
- my ($class, undef, $opt_spec) = @_;
- my %options;
- Getopt::Long::GetOptions(\%options, @$opt_spec);
- return ( \%options, undef );
-}
-
-sub new_with_options {
+sub process_argv {
my ($class, @params) = @_;
+ my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
+
my $config_from_file;
if($class->meta->does_role('MooseX::ConfigFromFile')) {
local @ARGV = @ARGV;
+ # just get the configfile arg now out of @ARGV; the rest of the args
+ # will be fetched later
my $configfile;
- my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] );
+ my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through no_auto_version ) ] );
$opt_parser->getoptions( "configfile=s" => \$configfile );
- if(!defined $configfile) {
- my $cfmeta = $class->meta->find_attribute_by_name('configfile');
- $configfile = $cfmeta->default if $cfmeta->has_default;
+ my $cfmeta = $class->meta->find_attribute_by_name('configfile');
+ my $init_arg = $cfmeta->init_arg;
+
+ # was it passed to the constructor?
+ if (!defined $configfile)
+ {
+ $configfile = $constructor_params->{$init_arg} if defined $init_arg;
}
- if(defined $configfile) {
+ if(!defined $configfile) {
+ # this is a classic legacy usecase documented in
+ # MooseX::ConfigFromFile that we should continue to support
+ $configfile = try { $class->configfile };
+
+ $configfile = $cfmeta->default
+ if not defined $configfile and $cfmeta->has_default;
+
+ # note that this will die horribly if the default sub depends on
+ # other attributes
+ $configfile = $configfile->($class) if ref $configfile eq 'CODE';
+ if (defined $configfile) {
+ $config_from_file = try {
+ $class->get_config_from_file($configfile);
+ }
+ catch {
+ die $_ unless /Specified configfile '\Q$configfile\E' does not exist/;
+ };
+ }
+
+ $constructor_params->{$init_arg} = $configfile
+ if defined $configfile and defined $init_arg;
+ }
+ 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 $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();
+ if ( $processed{usage} and $params->{help_flag} ) {
+ $class->print_usage_text($processed{usage});
}
+ return MooseX::Getopt::ProcessedArgv->new(
+ argv_copy => $processed{argv_copy},
+ extra_argv => $processed{argv},
+ usage => $processed{usage},
+ constructor_params => $constructor_params, # explicit params to ->new
+ cli_params => $params, # params from CLI
+ );
+}
+
+sub new_with_options {
+ my ($class, @params) = @_;
+
+ my $pa = $class->process_argv(@params);
+
$class->new(
- ARGV => $processed{argv_copy},
- extra_argv => $processed{argv},
- %$constructor_params, # explicit params to ->new
- %$params, # params from CLI
+ ARGV => $pa->argv_copy,
+ extra_argv => $pa->extra_argv,
+ ( $pa->usage ? ( usage => $pa->usage ) : () ),
+ %{ $pa->constructor_params }, # explicit params to ->new
+ %{ $pa->cli_params }, # params from CLI
);
}
+sub _getopt_spec { shift->_traditional_spec(@_); }
+
sub _parse_argv {
my ( $class, %params ) = @_;
# Get a clean copy of the original @ARGV
my $argv_copy = [ @ARGV ];
- my @err;
-
- my ( $parsed_options, $usage ) = eval {
- local $SIG{__WARN__} = sub { push @err, @_ };
+ my @warnings;
+ my ( $parsed_options, $usage ) = try {
+ local $SIG{__WARN__} = sub { push @warnings, @_ };
- return $class->_get_options(\%params, $opt_spec);
+ return $class->_getopt_get_options(\%params, $opt_spec);
+ }
+ catch {
+ $class->_getopt_spec_exception(\@warnings, $_);
};
- die join "", grep { defined } @err, $@ if @err or $@;
+ $class->_getopt_spec_warnings(@warnings) if @warnings;
# Get a copy of the Getopt::Long-mangled @ARGV
my $argv_mangled = [ @ARGV ];
);
}
+sub _getopt_get_options {
+ my ($class, $params, $opt_spec) = @_;
+ my %options;
+ Getopt::Long::GetOptions(\%options, @$opt_spec);
+ return ( \%options, undef );
+}
+
+sub _getopt_spec_warnings { }
+
+sub _getopt_spec_exception {
+ my ($self, $warnings, $exception) = @_;
+ die @$warnings, $exception;
+}
+
+# maintained for backwards compatibility only
+sub _getopt_full_usage
+{
+ my ($self, $usage) = @_;
+ print $usage->text;
+ exit 0;
+}
+#(this is already documented in MooseX::Getopt. But FIXME later, via RT#82195)
+=for Pod::Coverage
+ print_usage_text
+=cut
+sub print_usage_text { shift->_getopt_full_usage(@_) }
+
sub _usage_format {
return "usage: %c %o";
}
sub _compute_getopt_attrs {
my $class = shift;
+ sort { $a->insertion_order <=> $b->insertion_order }
grep {
$_->does("MooseX::Getopt::Meta::Attribute::Trait")
or
opt_string => $opt_string,
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
+ # 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
return @options;
}
-no Moose::Role; 1;
-
+no Moose::Role;
1;
-=pod
-
-=head1 NAME
-
-MooseX::Getopt::Basic - role to implement the basic functionality of
-L<MooseX::Getopt> without GLD.
-
=head1 SYNOPSIS
## In your class
package My::App;
use Moose;
- with 'MooseX::Getopt';
+ with 'MooseX::Getopt::Basic';
has 'out' => (is => 'rw', isa => 'Str', required => 1);
has 'in' => (is => 'rw', isa => 'Str', required => 1);
# ... rest of the script here
## on the command line
- % perl my_app_script.pl -in file.input -out file.dump
+ % 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 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 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 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:
-
- # for read/write attributes
- has '_foo' => (accessor => 'foo', ...);
-
- # or for read-only attributes
- 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.
-
-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 (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
-
-=over 4
-
-=item I<Bool>
+This is like L<MooseX::Getopt> and can be used instead except that it
+doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short).
-A I<Bool> type constraint is set up as a boolean option with
-Getopt::Long. So that this attribute description:
+=method new_with_options
- has 'verbose' => (is => 'rw', isa => 'Bool');
+See L<MooseX::Getopt/new_with_options>.
-would translate into C<verbose!> as a Getopt::Long option descriptor,
-which would enable the following command line options:
+=method process_argv
- % my_script.pl --verbose
- % my_script.pl --noverbose
-
-=item I<Int>, I<Float>, I<Str>
-
-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>
-
-An I<ArrayRef> type constraint is set up as a multiple value option
-in Getopt::Long. So that this attribute description:
-
- has 'include' => (
- is => 'rw',
- isa => 'ArrayRef',
- default => sub { [] }
- );
-
-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
-
-=item I<HashRef>
-
-A I<HashRef> type constraint is set up as a hash value option
-in Getopt::Long. So that this attribute description:
-
- has 'define' => (
- is => 'rw',
- isa => 'HashRef',
- default => sub { {} }
- );
-
-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
-
-=back
-
-=head2 Custom Type Constraints
-
-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
-so:
-
- subtype 'ArrayOfInts'
- => as 'ArrayRef'
- => where { scalar (grep { looks_like_number($_) } @$_) };
-
-Then you register the mapping, like so:
-
- MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- 'ArrayOfInts' => '=i@'
- );
-
-Now any attribute declarations using this type constraint will
-get the custom option spec. So that, this:
-
- has 'nums' => (
- is => 'ro',
- isa => 'ArrayOfInts',
- default => sub { [0] }
- );
-
-Will translate to the following on the command line:
-
- % my_script.pl --nums 5 --nums 88 --nums 199
-
-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.
-
-Better examples are certainly welcome :)
-
-=head2 Inferred Type Constraints
-
-If you define a custom subtype which is a subtype of one of the
-standard L</Supported Type Constraints> above, and do not explicitly
-provide custom support as in L</Custom Type Constraints> above,
-MooseX::Getopt will treat it like the parent type for Getopt
-purposes.
-
-For example, if you had the same custom C<ArrayOfInts> subtype
-from the examples above, but did not add a new custom option
-type for it to the C<OptionTypeMap>, it would be treated just
-like a normal C<ArrayRef> type for Getopt purposes (that is,
-C<=s@>).
-
-=head1 METHODS
-
-=over 4
-
-=item B<new_with_options (%params)>
-
-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.
-
-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 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> 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
-as it originally existed at the time of C<new_with_options>.
-
-=item B<extra_argv>
-
-This accessor contains an arrayref of leftover C<@ARGV> elements that
-L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
-un-mangled.
-
-=item B<meta>
-
-This returns the role meta object.
-
-=back
-
-=head1 BUGS
-
-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.
-
-=head1 AUTHOR
-
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
-
-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.
-
-L<http://www.iinteractive.com>
-
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+See L<MooseX::Getopt/process_argv>.
=cut
-
projects / gitmo/MooseX-Getopt.git / blobdiff