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 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)
-}
-
-sub _get_options {
- my ($class, undef, $opt_spec) = @_;
- my %options;
- Getopt::Long::GetOptions(\%options, @$opt_spec);
- return ( \%options, undef );
-}
+has ARGV => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
+has extra_argv => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
-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 );
+ my $cfmeta = $class->meta->find_attribute_by_name('configfile');
+
+ # was it passed to the constructor?
+ if (!defined $configfile)
+ {
+ my $key = $cfmeta->init_arg;
+ $configfile = $constructor_params->{$key} if $key;
+ }
+
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 $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 @warnings;
my ( $parsed_options, $usage ) = eval {
- local $SIG{__WARN__} = sub { push @err, @_ };
+ local $SIG{__WARN__} = sub { push @warnings, @_ };
- return $class->_get_options(\%params, $opt_spec);
+ return $class->_getopt_get_options(\%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_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;
+}
+
+#(this is already documented in MooseX::Getopt. But FIXME later, via RT#82195)
+=for Pod::Coverage
+ print_usage_text
+=cut
+sub print_usage_text {
+ my ($self, $usage) = @_;
+ print $usage->text;
+ exit 0;
+}
+# maintained for backwards compatibility only
+sub _getopt_full_usage { shift->print_usage_text(@_) }
+
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
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).
-=head1 METHODS
-
-=over 4
-
-=item B<new_with_options>
-
-See L<MooseX::Getopt> .
+=method new_with_options
-=item B<meta>
+See L<MooseX::Getopt/new_with_options>.
-This returns the role meta object.
+=method process_argv
-=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>
-
-Shlomi Fish E<lt>shlomif@cpan.orgE<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