X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt%2FBasic.pm;h=316b15cb1adb5641c64214601758ad4a72365546;hb=4f214b88269f6b81131825e5f3571d35b2609ee3;hp=5473d04abad4114f82bfef6e4c42115a55e8e0f5;hpb=a20996695460dc338556f0435299555074c76c34;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt/Basic.pm b/lib/MooseX/Getopt/Basic.pm index 5473d04..316b15c 100644 --- a/lib/MooseX/Getopt/Basic.pm +++ b/lib/MooseX/Getopt/Basic.pm @@ -1,3 +1,4 @@ + package MooseX::Getopt::Basic; use Moose::Role; @@ -6,28 +7,11 @@ use MooseX::Getopt::Meta::Attribute; use MooseX::Getopt::Meta::Attribute::NoGetopt; use Carp (); -use Getopt::Long (); # GLD uses it anyway, doesn't hurt - -our $VERSION = '0.20'; -our $AUTHORITY = 'cpan:STEVAN'; +use Getopt::Long (); 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. - -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 ); -} - sub new_with_options { my ($class, @params) = @_; @@ -42,15 +26,27 @@ sub new_with_options { 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'; @@ -66,7 +62,7 @@ sub new_with_options { # did the user request usage information? if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) ) { - $processed{usage}->die(); + $class->_getopt_full_usage($processed{usage}); } $class->new( @@ -77,6 +73,8 @@ sub new_with_options { ); } +sub _getopt_spec { shift->_traditional_spec(@_); } + sub _parse_argv { my ( $class, %params ) = @_; @@ -87,15 +85,15 @@ sub _parse_argv { # 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 ]; @@ -114,6 +112,25 @@ sub _parse_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; +} + +sub _getopt_full_usage { + my ($self, $usage) = @_; + $usage->die; +} + sub _usage_format { return "usage: %c %o"; } @@ -205,14 +222,13 @@ sub _attrs_to_options { no Moose::Role; 1; -1; +__END__ =pod =head1 NAME -MooseX::Getopt::Basic - role to implement the basic functionality of -L without GLD. +MooseX::Getopt::Basic - role to implement the Getopt::Long functionality =head1 SYNOPSIS @@ -220,7 +236,7 @@ L without GLD. package My::App; use Moose; - with 'MooseX::Getopt'; + with 'MooseX::Getopt::Basic'; has 'out' => (is => 'rw', isa => 'Str', required => 1); has 'in' => (is => 'rw', isa => 'Str', required => 1); @@ -236,221 +252,18 @@ L without GLD. # ... rest of the script here ## on the command line - % perl my_app_script.pl -in file.input -out file.dump + % 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@>). +This is like L and can be used instead except that it +doesn't make use of L (or "GLD" for short). =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>. - -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 +=head2 new_with_options -Drew Taylor, Edrew@drewtaylor.comE +See L. =head1 COPYRIGHT AND LICENSE