X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=fc48b571b4412c7294bd4af52539088deb4b1781;hp=b9a5a1d17955751379a9d4f1abe0b38afe08b24a;hb=986fb4690bc00c860b1f728b986e39b412100854;hpb=2482085fd5e5adf1d2aa6a37a7099c5fcd139f01 diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index b9a5a1d..fc48b57 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -1,143 +1,80 @@ - package MooseX::Getopt; -use Moose::Role; - -use Getopt::Long (); - -use MooseX::Getopt::OptionTypeMap; -use MooseX::Getopt::Meta::Attribute; - -our $VERSION = '0.05'; -our $AUTHORITY = 'cpan:STEVAN'; - -has ARGV => (is => 'rw', isa => 'ArrayRef'); -has extra_argv => (is => 'rw', isa => 'ArrayRef'); - -sub new_with_options { - my ($class, %params) = @_; - - my (@options, %name_to_init_arg); - foreach my $attr ($class->meta->compute_all_applicable_attributes) { - my $name = $attr->name; - - my $aliases; - - 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; - } - else { - next if $name =~ /^_/; - } - - $name_to_init_arg{$name} = $attr->init_arg; - - 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); - } - } - - push @options => $opt_string; - } - - my %options; - - # Get a clean copy of the original @ARGV - my $argv_copy = [ @ARGV ]; - - { - local $SIG{__WARN__} = sub { die $_[0] }; - Getopt::Long::GetOptions(\%options, @options); - } - - # Get a copy of the Getopt::Long-mangled @ARGV - my $argv_mangled = [ @ARGV ]; - - # Restore the original @ARGV; - @ARGV = @$argv_copy; - - #use Data::Dumper; - #warn Dumper \@options; - #warn Dumper \%name_to_init_arg; - #warn Dumper \%options; - - $class->new( - ARGV => $argv_copy, - extra_argv => $argv_mangled, - %params, - map { - $name_to_init_arg{$_} => $options{$_} - } keys %options, - ); -} - -no Moose::Role; 1; - -__END__ - -=pod - -=head1 NAME - -MooseX::Getopt - A Moose role for processing command line options +# ABSTRACT: A Moose role for processing command line options + +use Moose::Role 0.56; + +with 'MooseX::Getopt::GLD'; + +no Moose::Role; + +1; =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 -to get non-default commandline option names and aliases. +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: +to L. If you don't want your accessors +to have the leading underscore in their name, you can do this: # 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 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. -This will mean that Getopt will not handle a --foo param, but your -code can still call the C method. +Options specified in multiple places follow the following +precedence order: commandline overrides configfile, which +overrides explicit new_with_options parameters. =head2 Supported Type Constraints @@ -145,20 +82,20 @@ code can still call the C method. =item I -A I type constraint is set up as a boolean option with +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, +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 - + % my_script.pl --noverbose + =item I, I, I -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 @@ -167,12 +104,12 @@ 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', + is => 'rw', + isa => 'ArrayRef', default => sub { [] } ); -would translate into C as a Getopt::Long option descriptor, +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 @@ -183,12 +120,12 @@ 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', + is => 'rw', + isa => 'HashRef', default => sub { {} } ); -would translate into C as a Getopt::Long option descriptor, +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 @@ -197,9 +134,9 @@ which would enable the following command line options: =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' @@ -212,7 +149,7 @@ Then you register the mapping, like so: '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' => ( @@ -225,7 +162,7 @@ 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 +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. @@ -245,55 +182,89 @@ 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 +=method B -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. +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. -=item B +If L is installed and any of the following +command line params are passed, the program will exit with usage +information (and the option's state will be stored in the help_flag +attribute). You can add descriptions for each option by including a +B option for each attribute to document. + + -? + --? + -h + --help + --usage + +If you have L the C param is also passed to +C as the usage option. + +=method 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 +=method 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 +B: By default, L will reject unrecognized I +(that is, options that do not correspond with attributes using the Getopt +trait). To disable this, and allow options to also be saved in C (for example to pass along to another class's C), you can either enable the +C option of L for your class: C<< use Getopt::Long +qw(:config pass_through); >> or specify a value for for L's C parameter. -This returns the role meta object. +=method B -=back +This accessor contains the L object (if +L is used). -=head1 BUGS +=method B -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. +This accessor contains the boolean state of the --help, --usage and --? +options (true if any of these options were passed on the command line). -=head1 AUTHOR +=method B -Stevan Little Estevan@iinteractive.comE +This method is called internally when the C state is true. +It prints the text from the C object (see above) to stdout and then the +program terminates normally. You can apply a method modification (see +L) if different behaviour is desired, for +example to include additional text. -Brandon L. Black, Eblblack@gmail.comE +=method B + +This returns the role meta object. -=head1 COPYRIGHT AND LICENSE +=method B -Copyright 2007 by Infinity Interactive, Inc. +This does most of the work of C, analyzing the parameters +and argv, except for actually calling the constructor. It returns a +L object. C uses this +method internally, so modifying this method via subclasses/roles will affect +C. -L +=head2 More Customization Options -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L for many other customizations you +can make to how options are parsed. Simply C in your class to set these. =cut + +=head1 SEE ALSO + +L, an extension to generate man pages, with colour +