package MooseX::Getopt::Basic;
-use Moose::Role;
+# ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality
-sub _getopt_spec {
- my ($class, %params) = @_;
- return $class->_traditional_spec(%params)
-}
+use Moose::Role;
-sub _get_options {
- my ($class, undef, $opt_spec) = @_;
- my %options;
- Getopt::Long::GetOptions(\%options, @$opt_spec);
- return ( \%options, undef );
+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 2.37 ();
+
+has ARGV => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
+has extra_argv => (is => 'rw', isa => 'ArrayRef', traits => ['NoGetopt']);
+
+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( no_auto_help pass_through no_auto_version ) ] );
+ $opt_parser->getoptions( "configfile=s" => \$configfile );
+
+ 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) {
+ # 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;
+ 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 = 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);
+ }
+ }
+
+ 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} 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
+ );
}
-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';
-
- 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 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
+sub new_with_options {
+ my ($class, @params) = @_;
-=item I<Bool>
+ my $pa = $class->process_argv(@params);
-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,
-which would enable the following command line options:
-
- % 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
+ $class->new(
+ 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
+ );
+}
-=back
+sub _getopt_spec { shift->_traditional_spec(@_); }
-=head2 Custom Type Constraints
+sub _parse_argv {
+ my ( $class, %params ) = @_;
-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:
+ local @ARGV = @{ $params{params}{argv} || \@ARGV };
- subtype 'ArrayOfInts'
- => as 'ArrayRef'
- => where { scalar (grep { looks_like_number($_) } @$_) };
+ my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params);
-Then you register the mapping, like so:
+ # Get a clean copy of the original @ARGV
+ my $argv_copy = [ @ARGV ];
- MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- 'ArrayOfInts' => '=i@'
- );
+ my @warnings;
+ my ( $parsed_options, $usage ) = try {
+ local $SIG{__WARN__} = sub { push @warnings, @_ };
-Now any attribute declarations using this type constraint will
-get the custom option spec. So that, this:
+ return $class->_getopt_get_options(\%params, $opt_spec);
+ }
+ catch {
+ $class->_getopt_spec_exception(\@warnings, $_);
+ };
- has 'nums' => (
- is => 'ro',
- isa => 'ArrayOfInts',
- default => sub { [0] }
- );
+ $class->_getopt_spec_warnings(@warnings) if @warnings;
-Will translate to the following on the command line:
+ # Get a copy of the Getopt::Long-mangled @ARGV
+ my $argv_mangled = [ @ARGV ];
- % my_script.pl --nums 5 --nums 88 --nums 199
+ my %constructor_args = (
+ map {
+ $name_to_init_arg->{$_} => $parsed_options->{$_}
+ } keys %$parsed_options,
+ );
-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.
+ return (
+ params => \%constructor_args,
+ argv_copy => $argv_copy,
+ argv => $argv_mangled,
+ ( defined($usage) ? ( usage => $usage ) : () ),
+ );
+}
-Better examples are certainly welcome :)
+sub _getopt_get_options {
+ my ($class, $params, $opt_spec) = @_;
+ my %options;
+ Getopt::Long::GetOptions(\%options, @$opt_spec);
+ return ( \%options, undef );
+}
-=head2 Inferred Type Constraints
+sub _getopt_spec_warnings { }
-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.
+sub _getopt_spec_exception {
+ my ($self, $warnings, $exception) = @_;
+ die @$warnings, $exception;
+}
-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@>).
+# 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(@_) }
-=head1 METHODS
+sub _usage_format {
+ return "usage: %c %o";
+}
-=over 4
+sub _traditional_spec {
+ my ( $class, %params ) = @_;
-=item B<new_with_options (%params)>
+ my ( @options, %name_to_init_arg, %options );
-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.
+ foreach my $opt ( @{ $params{options} } ) {
+ push @options, $opt->{opt_string};
-The special parameter C<argv>, if specified should point to an array
-reference with an array to use instead of C<@ARGV>.
+ my $identifier = $opt->{name};
+ $identifier =~ s/\W/_/g; # Getopt::Long does this to all option names
-The paramater C<disable_gld>, if specified and a true value will disable
-the use of L<Getopt::Long::Descriptive> .
+ $name_to_init_arg{$identifier} = $opt->{init_arg};
+ }
-If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
-C<new_with_options> will throw an exception.
+ return ( \@options, \%name_to_init_arg );
+}
-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.
+sub _compute_getopt_attrs {
+ my $class = shift;
+ sort { $a->insertion_order <=> $b->insertion_order }
+ grep {
+ $_->does("MooseX::Getopt::Meta::Attribute::Trait")
+ or
+ $_->name !~ /^_/
+ } grep {
+ !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
+ } $class->meta->get_all_attributes
+}
- --?
- --help
- --usage
+sub _get_cmd_flags_for_attr {
+ my ( $class, $attr ) = @_;
-If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
-C<new>.
+ my $flag = $attr->name;
-=item B<ARGV>
+ my @aliases;
-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>.
+ 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;
+ }
-=item B<extra_argv>
+ return ( $flag, @aliases );
+}
-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.
+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->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)
+ }
+ }
+
+ 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;
+}
-=item B<meta>
+no Moose::Role;
+1;
-This returns the role meta object.
+=head1 SYNOPSIS
-=back
+ ## In your class
+ package My::App;
+ use Moose;
-=head1 BUGS
+ with 'MooseX::Getopt::Basic';
-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.
+ has 'out' => (is => 'rw', isa => 'Str', required => 1);
+ has 'in' => (is => 'rw', isa => 'Str', required => 1);
-=head1 AUTHOR
+ # ... rest of the class here
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
+ ## in your script
+ #!/usr/bin/perl
-Brandon L. Black, E<lt>blblack@gmail.comE<gt>
+ use My::App;
-Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
+ my $app = My::App->new_with_options();
+ # ... rest of the script here
-=head1 CONTRIBUTORS
+ ## on the command line
+ % perl my_app_script.pl --in file.input --out file.dump
-Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
+=head1 DESCRIPTION
-Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+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 COPYRIGHT AND LICENSE
+=method new_with_options
-Copyright 2007-2008 by Infinity Interactive, Inc.
+See L<MooseX::Getopt/new_with_options>.
-L<http://www.iinteractive.com>
+=method process_argv
-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