package MooseX::Getopt;
+
+our $VERSION = '0.150001';
+our $AUTHORITY = 'cpan:STEVAN';
+
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::Session;
use MooseX::Getopt::Meta::Attribute;
use MooseX::Getopt::Meta::Attribute::NoGetopt;
-our $VERSION = '0.15';
-our $AUTHORITY = 'cpan:STEVAN';
+use Getopt::Long ();
-has ARGV => (
- is => 'rw',
- isa => 'ArrayRef',
- metaclass => 'NoGetopt',
-);
+use constant _default_getopt_session => 'MooseX::Getopt::Session';
-has extra_argv => (
- is => 'rw',
- isa => 'ArrayRef',
- metaclass => 'NoGetopt',
-);
-has getopt_parser => (
- is => 'rw',
- does => 'MooseX::Getopt::Parser',
+has getopt => (
+ is => 'rw',
+ isa => 'MooseX::Getopt::Session',
metaclass => 'NoGetopt',
+ handles => [ 'ARGV', 'extra_argv' ],
);
-sub new_with_options {
- my ($class, @params) = @_;
-
- my $config_from_file;
- my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
+sub new_with_options {
+ my $class = shift;
- 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;
- }
+ return $class->new( $class->get_options_from_argv(@_) );
+};
- 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 );
+sub get_options_from_argv {
+ my $class = shift;
- if(!defined $configfile) {
- my $cfmeta = $class->meta->find_attribute_by_name('configfile');
- $configfile = $cfmeta->default if $cfmeta->has_default;
- }
+ Moose->throw_error(
+ "Single parameters to get_options_from_argv() must be a HASH ref"
+ ) if ref $_[0] and ref $_ ne 'HASH';
- if(defined $configfile) {
- $config_from_file = $class->get_config_from_file($configfile);
- }
- }
+ my $options = {
+ %{ $class->get_options_from_configfile },
+ @_ == 1 ? %{ $_[0] } : @_
+ };
- $class->throw_error("Single parameters to new_with_options() must be a HASH ref")
- unless ref($constructor_params) eq 'HASH';
+ my $getopt = defined $options->{getopt}
+ ? $options->{getopt}
+ : $class->_default_getopt_session->new(
+ classes_filter => sub { $_ eq $class },
+ options => $options,
+ );
- my %processed = $class->_parse_argv(
- options => [
- $class->_attrs_to_options( $config_from_file )
- ],
- params => $constructor_params,
- getopt_parser => $getopt_parser,
- );
+ # Call Getopt parser only once.
+ $getopt->build_options if not $getopt->has_status;
- my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
+ my $new_options = {
+ %$options, # explicit options to ->new
+ %{ $getopt->options }, # options from CLI
+ getopt => $getopt,
+ };
- $class->new(
- ARGV => $processed{argv_copy},
- extra_argv => $processed{argv},
- getopt_parser => $getopt_parser,
- @params, # explicit params to ->new
- %$params, # params from CLI
- );
-}
+ return $new_options;
+};
-sub _parse_argv {
- my ($class, %params) = @_;
- local @ARGV = @{ $params{argv} || \@ARGV };
+sub get_options_from_configfile {
+ my $class = shift;
- my ( $opt_spec, $name_to_init_arg ) = ( $params{getopt_parser}->_get_getopt_spec(%params) );
+ my $options = {};
- # Get a clean copy of the original @ARGV
- my $argv_copy = [ @ARGV ];
+ if ( $class->meta->does_role('MooseX::ConfigFromFile') ) {
+ local @ARGV = @ARGV;
- my @err;
+ my $configfile;
+ my $opt_parser = Getopt::Long::Parser->new( config => ['pass_through'] );
+ $opt_parser->getoptions( "configfile=s" => \$configfile );
- my ( $parsed_options, $usage ) = eval {
- local $SIG{__WARN__} = sub { push @err, @_ };
+ if ( not defined $configfile ) {
+ my $cfmeta = $class->meta->find_attribute_by_name('configfile');
+ $configfile = $cfmeta->default if $cfmeta->has_default;
+ };
- return $params{getopt_parser}->getoptions($opt_spec);
+ if ( defined $configfile ) {
+ $options = $class->get_config_from_file($configfile);
+ };
};
- die join "", grep { defined } @err, $@ if @err or $@;
-
- # Get a copy of the Getopt::Long-mangled @ARGV
- my $argv_mangled = [ @ARGV ];
-
- my %constructor_args = (
- map {
- $name_to_init_arg->{$_} => $parsed_options->{$_}
- } keys %$parsed_options,
- );
+ return $options;
+};
- return (
- params => \%constructor_args,
- argv_copy => $argv_copy,
- argv => $argv_mangled,
- ( defined($usage) ? ( usage => $usage ) : () ),
- );
-}
sub _compute_getopt_attrs {
my $class = shift;
- grep {
- $_->does("MooseX::Getopt::Meta::Attribute::Trait")
- or
- $_->name !~ /^_/
+
+ return grep {
+ $_->does('MooseX::Getopt::Meta::Attribute::Trait')
+ or $_->name !~ /^_/
} grep {
!$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
- } $class->meta->compute_all_applicable_attributes
-}
-
-sub _get_cmd_flags_for_attr {
- my ( $class, $attr ) = @_;
-
- my $flag = $attr->name;
-
- my @aliases;
-
- if ($attr->does('MooseX::Getopt::Meta::Attribute::Trait')) {
- $flag = $attr->cmd_flag if $attr->has_cmd_flag;
- @aliases = @{ $attr->cmd_aliases } if $attr->has_cmd_aliases;
- }
+ } $class->meta->compute_all_applicable_attributes;
+};
- return ( $flag, @aliases );
-}
-
-sub _attrs_to_options {
- my $class = shift;
- my $config_from_file = shift || {};
-
- my @options;
-
- foreach my $attr ($class->_compute_getopt_attrs) {
- my ( $flag, @aliases ) = $class->_get_cmd_flags_for_attr($attr);
-
- my $opt_string = join(q{|}, $flag, @aliases);
-
- if ($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)
- }
- }
-
- push @options, {
- name => $flag,
- 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},
- # 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 ) : () ),
- }
- }
-
- return @options;
-}
no Moose::Role; 1;
+
__END__
=pod
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<Defined|Int>, I<Defined|Float>, I<Defined|Str>
+
+These type constaints 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
like a normal C<ArrayRef> type for Getopt purposes (that is,
C<=s@>).
+=head2 Session
+
+L<MooseX::Getopt> can handle more than one class which contain
+attributes filled from CLI. In this case, you need to use explicite
+L<MooseX::Getopt::Session> object and then the Getopt attributes will be
+searched in any class which does L<MooseX::Getopt>.
+
+ package My::App;
+ use Moose;
+ with 'MooseX::Getopt';
+ has 'send' => (is => 'rw', predicate => 'has_send');
+
+ package My::App::Send;
+ use Moose;
+ with 'MooseX::Getopt';
+ has 'to' => (is => 'rw', isa => 'Str', default => 'localhost');
+ sub send { my $self = shift; warn "Sending mail to ", $self->to; }
+
+ # ... rest of the class here
+
+ ## in your script
+ #!/usr/bin/perl
+
+ my $getopt = MooseX::Getopt::Session->new;
+
+ my $app = My::App->new_with_options( getopt => $getopt );
+ if ($app->has_send) {
+ # Use the same command line
+ my $sender = My::App::Send->new_with_options( getopt => $getopt );
+ $sender->send;
+ }
+ # ... rest of the script here
+
+ ## on the command line
+ % perl my_app_script.pl --send --to server.example.net
+
=head1 METHODS
=over 4
If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
C<new>.
+=item B<get_options_from_argv (%params)>
+
+This method returns the list of parameters collected from command line
+without creating the new object.
+
+=item B<get_options_from_configfile>
+
+This method returns the list of parameters collected with
+L<MooseX::ConfigFromFile> mechanism.
+
=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>.
+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>.
+
+The C<ARGV> is delegated from L<MooseX::Getopt::Session> object.
=item B<extra_argv>
L<Getopt::Long> did not parse. Note that the real C<@ARGV> is left
un-mangled.
+The C<extra_argv> is delegated from L<MooseX::Getopt::Session> object.
+
+=item B<getopt>
+
+This accessor contains a L<MooseX::Getopt::Session> object. This object can
+be shared between more than one class which does L<MooseX::Getopt>. The new
+object is created by default.
+
=item B<meta>
This returns the role meta object.
=back
+=head1 SEE ALSO
+
+=over 4
+
+=item L<MooseX::Getopt::Strict>
+
+=item L<MooseX::Getopt::Session>
+
+=item L<MooseX::Getopt::Parser>
+
+=back
+
=head1 BUGS
All complex software has bugs lurking in it, and this module is no
Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
+Piotr Roszatycki, E<lt>dexter@cpan.orgE<gt>
+
=head1 CONTRIBUTORS
Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
projects / gitmo/MooseX-Getopt.git / blobdiff