package MooseX::Getopt;
+
+our $VERSION = '0.150001';
+our $AUTHORITY = 'cpan:STEVAN';
+
use Moose::Role;
-use Getopt::Long::Descriptive ();
+use Moose::Util::TypeConstraints;
use MooseX::Getopt::OptionTypeMap;
+
+use MooseX::Getopt::Session;
+
use MooseX::Getopt::Meta::Attribute;
use MooseX::Getopt::Meta::Attribute::NoGetopt;
-our $VERSION = '0.08';
-our $AUTHORITY = 'cpan:STEVAN';
-has ARGV => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
-has extra_argv => (is => 'rw', isa => 'ArrayRef', documentation => "hidden");
+use Getopt::Long ();
-sub new_with_options {
- my ($class, @params) = @_;
- my %processed = $class->_parse_argv(
- options => [
- $class->_attrs_to_options( @params )
- ]
- );
+use constant _default_getopt_session => 'MooseX::Getopt::Session';
- my $params = $processed{params};
- if($class->meta->does_role('MooseX::ConfigFromFile')
- && defined $params->{configfile}) {
- %$params = (
- %{$class->get_config_from_file($params->{configfile})},
- %$params,
- );
- }
+has getopt => (
+ is => 'rw',
+ isa => 'MooseX::Getopt::Session',
+ metaclass => 'NoGetopt',
+ handles => [ 'ARGV', 'extra_argv' ],
+);
- $class->new(
- ARGV => $processed{argv_copy},
- extra_argv => $processed{argv},
- @params, # explicit params to ->new
- %$params, # params from CLI
- );
-}
-sub _parse_argv {
- my ( $class, %params ) = @_;
+sub new_with_options {
+ my $class = shift;
- local @ARGV = @{ $params{argv} || \@ARGV };
+ return $class->new( $class->get_options_from_argv(@_) );
+};
- my ( $opt_spec, $name_to_init_arg ) = $class->_gld_spec(%params);
- # Get a clean copy of the original @ARGV
- my $argv_copy = [ @ARGV ];
+sub get_options_from_argv {
+ my $class = shift;
- my @err;
+ Moose->throw_error(
+ "Single parameters to get_options_from_argv() must be a HASH ref"
+ ) if ref $_[0] and ref $_ ne 'HASH';
- my ( $parsed_options, $usage ) = eval {
- local $SIG{__WARN__} = sub { push @err, @_ };
- Getopt::Long::Descriptive::describe_options("usage: %c %o", @$opt_spec)
+ my $options = {
+ %{ $class->get_options_from_configfile },
+ @_ == 1 ? %{ $_[0] } : @_
};
- die join "", grep { defined } @err, $@ if @err or $@;
+ my $getopt = defined $options->{getopt}
+ ? $options->{getopt}
+ : $class->_default_getopt_session->new(
+ classes_filter => sub { $_ eq $class },
+ options => $options,
+ );
- # Get a copy of the Getopt::Long-mangled @ARGV
- my $argv_mangled = [ @ARGV ];
+ # Call Getopt parser only once.
+ $getopt->build_options if not $getopt->has_status;
- my %constructor_args = (
- map {
- $name_to_init_arg->{$_} => $parsed_options->{$_}
- } keys %$parsed_options,
- );
+ my $new_options = {
+ %$options, # explicit options to ->new
+ %{ $getopt->options }, # options from CLI
+ getopt => $getopt,
+ };
- return (
- params => \%constructor_args,
- argv_copy => $argv_copy,
- argv => $argv_mangled,
- usage => $usage
- );
-}
+ return $new_options;
+};
-sub _gld_spec {
- my ( $class, %params ) = @_;
- my ( @options, %name_to_init_arg );
+sub get_options_from_configfile {
+ my $class = shift;
- 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 $options = {};
- $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
- }
+ if ( $class->meta->does_role('MooseX::ConfigFromFile') ) {
+ local @ARGV = @ARGV;
- return ( \@options, \%name_to_init_arg );
-}
+ my $configfile;
+ my $opt_parser = Getopt::Long::Parser->new( config => ['pass_through'] );
+ $opt_parser->getoptions( "configfile=s" => \$configfile );
-sub _compute_getopt_attrs {
- my $class = shift;
- grep {
- $_->isa("MooseX::Getopt::Meta::Attribute")
- or
- $_->name !~ /^_/
- &&
- !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt')
- } $class->meta->compute_all_applicable_attributes
-}
-
-sub _attrs_to_options {
- my $class = shift;
+ if ( not defined $configfile ) {
+ my $cfmeta = $class->meta->find_attribute_by_name('configfile');
+ $configfile = $cfmeta->default if $cfmeta->has_default;
+ };
- my @options;
-
- foreach my $attr ($class->_compute_getopt_attrs) {
- my $name = $attr->name;
-
- my $aliases;
+ if ( defined $configfile ) {
+ $options = $class->get_config_from_file($configfile);
+ };
+ };
- if ($attr->isa('MooseX::Getopt::Meta::Attribute')) {
- $name = $attr->cmd_flag if $attr->has_cmd_flag;
- $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases;
- }
+ return $options;
+};
- my $opt_string = $aliases
- ? join(q{|}, $name, @$aliases)
- : $name;
- 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)
- }
- }
+sub _compute_getopt_attrs {
+ my $class = shift;
- push @options, {
- name => $name,
- init_arg => $attr->init_arg,
- opt_string => $opt_string,
- required => $attr->is_required,
- ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
- ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
- }
- }
+ return grep {
+ $_->does('MooseX::Getopt::Meta::Attribute::Trait')
+ or $_->name !~ /^_/
+ } grep {
+ !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
+ } $class->meta->compute_all_applicable_attributes;
+};
- return @options;
-}
no Moose::Role; 1;
+
__END__
=pod
=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>,
L<MooseX::Getopt>'s C<new_with_options> will load the configfile
-specified by the C<--configfile> option for you.
+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
=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<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
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.
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
=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.
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
+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
+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>
+
+Piotr Roszatycki, E<lt>dexter@cpan.orgE<gt>
+
+=head1 CONTRIBUTORS
+
+Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
+
=head1 COPYRIGHT AND LICENSE
-Copyright 2007 by Infinity Interactive, Inc.
+Copyright 2007-2008 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/MooseX-Getopt.git / blobdiff