From: Shlomi Fish Date: Thu, 13 Aug 2009 21:14:35 +0000 (+0300) Subject: Splitted into Getopt::Basic and Getopt::GLD. X-Git-Tag: 0.22~10 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=commitdiff_plain;h=ef47fe440114bcfc790464f79e476ef7defb0a67 Splitted into Getopt::Basic and Getopt::GLD. Getopt::Basic does not work yet. --- diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 5807378..01904f3 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -14,6 +14,11 @@ use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive }; our $VERSION = '0.20'; our $AUTHORITY = 'cpan:STEVAN'; +my @roles = ('MooseX::Getopt::Basic'); +if (HAVE_GLD) { push @roles, 'MooseX::Getopt::GLD' } + +with @roles; + has ARGV => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); has extra_argv => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt"); @@ -71,9 +76,7 @@ sub _parse_argv { local @ARGV = @{ $params{params}{argv} || \@ARGV }; - my $use_gld = (HAVE_GLD && !$params{params}{disable_gld}); - - my ( $opt_spec, $name_to_init_arg ) = ( $use_gld ? $class->_gld_spec(%params) : $class->_traditional_spec(%params) ); + my ( $opt_spec, $name_to_init_arg ) = $class->_getopt_spec(%params); # Get a clean copy of the original @ARGV my $argv_copy = [ @ARGV ]; @@ -83,13 +86,7 @@ sub _parse_argv { my ( $parsed_options, $usage ) = eval { local $SIG{__WARN__} = sub { push @err, @_ }; - if ( $use_gld ) { - return Getopt::Long::Descriptive::describe_options($class->_usage_format(%params), @$opt_spec); - } else { - my %options; - Getopt::Long::GetOptions(\%options, @$opt_spec); - return ( \%options, undef ); - } + return $class->_get_options(\%params, $opt_spec); }; die join "", grep { defined } @err, $@ if @err or $@; @@ -461,6 +458,10 @@ un-mangled. This returns the role meta object. +=item B + +A constant for internal use. + =back =head1 BUGS diff --git a/lib/MooseX/Getopt/Basic.pm b/lib/MooseX/Getopt/Basic.pm new file mode 100644 index 0000000..33d90ef --- /dev/null +++ b/lib/MooseX/Getopt/Basic.pm @@ -0,0 +1,276 @@ +package MooseX::Getopt::Basic; +use Moose::Role; + +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 ); +} + +1; + +=pod + +=head1 NAME + +MooseX::Getopt::Basic - role to implement the basic functionality of +L 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 or the +attribute metaclass L to get non-default +commandline option names and aliases. + +You can use the trait L +or the attribute metaclass L +to have C 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. 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 method. + +If your class also uses a configfile-loading role based on +L, such as L, +L's C 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 + +A I 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 as a Getopt::Long option descriptor, +which would enable the following command line options: + + % my_script.pl --verbose + % my_script.pl --noverbose + +=item I, I, I + +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 + +An I 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 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 + +A I 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 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 above, and do not explicitly +provide custom support as in L above, +MooseX::Getopt will treat it like the parent type for Getopt +purposes. + +For example, if you had the same custom C subtype +from the examples above, but did not add a new custom option +type for it to the C, it would be treated just +like a normal C type for Getopt purposes (that is, +C<=s@>). + +=head1 METHODS + +=over 4 + +=item B + +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, if specified should point to an array +reference with an array to use instead of C<@ARGV>. + +The paramater C, if specified and a true value will disable +the use of L . + +If L fails (due to invalid arguments), +C will throw an exception. + +If L 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 option for each attribute to document. + + --? + --help + --usage + +If you have L a the C param is also passed to +C. + +=item B + +This accessor contains a reference to a copy of the C<@ARGV> array +as it originally existed at the time of C. + +=item B + +This accessor contains an arrayref of leftover C<@ARGV> elements that +L did not parse. Note that the real C<@ARGV> is left +un-mangled. + +=item B + +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 Estevan@iinteractive.comE + +Brandon L. Black, Eblblack@gmail.comE + +Yuval Kogman, Enothingmuch@woobling.orgE + +=head1 CONTRIBUTORS + +Ryan D Johnson, Eryan@innerfence.comE + +Drew Taylor, Edrew@drewtaylor.comE + +=head1 COPYRIGHT AND LICENSE + +Copyright 2007-2008 by Infinity Interactive, Inc. + +L + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut + diff --git a/lib/MooseX/Getopt/GLD.pm b/lib/MooseX/Getopt/GLD.pm new file mode 100644 index 0000000..87b7ad9 --- /dev/null +++ b/lib/MooseX/Getopt/GLD.pm @@ -0,0 +1,74 @@ +package MooseX::Getopt::GLD; + +use Moose::Role; + +around '_getopt_spec' => sub { + my $orig = shift; + my $self = shift; + + return $self->_gld_spec(@_); + # Ignore $orig, code for _gld_spec here +}; + +around '_get_options' => sub { + my $orig = shift; + my $class = shift; + + my ($params, $opt_spec) = @_; + return Getopt::Long::Descriptive::describe_options( + $class->_usage_format(%$params), @$opt_spec + ); +}; + +1; + +__END__ + +=pod + +=head1 NAME + +MooseX::Getopt::GLD - role to implement specific functionality for +L + +=head1 SYNOPSIS + +For internal use. + +=head1 DESCRIPTION + +This is a role for C. + +=head1 METHODS + +=over 4 + +=item meta + +=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 + +Dagfinn Ilmari MannsEker Eilmari@ilmari.orgE + +Stevan Little Estevan@iinteractive.comE + +Yuval Kogman C<< >> + +=head1 COPYRIGHT AND LICENSE + +Copyright 2007-2008 by Infinity Interactive, Inc. + +L + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut +=head1