X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=cd0cd8bd5660e0462e2a0cd8fe6f0302d779748a;hb=449f00873d6a740b73bcb55c8d3afbbc1640036e;hp=8f5a46a8470f282c3590cb925afa28055e97e1e6;hpb=9f7acb143b1238a6209b035fdc51df6c0683c324;p=gitmo%2FMooseX-Getopt.git

diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm
index 8f5a46a..cd0cd8b 100644
--- a/lib/MooseX/Getopt.pm
+++ b/lib/MooseX/Getopt.pm
@@ -1,26 +1,13 @@
-
 package MooseX::Getopt;
-use Moose::Role;
-
-our $VERSION   = '0.20';
-our $AUTHORITY = 'cpan:STEVAN';
-
-use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
-
-my @roles = ('MooseX::Getopt::Basic');
-if (HAVE_GLD()) { push @roles, 'MooseX::Getopt::GLD' }
-
-with @roles;
+# ABSTRACT: A Moose role for processing command line options
 
-no Moose::Role; 1;
+use Moose::Role 0.56;
 
-__END__
+with 'MooseX::Getopt::GLD';
 
-=pod
+no Moose::Role;
 
-=head1 NAME
-
-MooseX::Getopt - A Moose role for processing command line options
+1;
 
 =head1 SYNOPSIS
 
@@ -67,8 +54,8 @@ 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:
+to L<MooseX::Getopt::Meta::Attribute>. 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', ...);
@@ -195,85 +182,76 @@ 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@>).
 
-=head1 METHODS
-
-=over 4
-
-=item B<new_with_options (%params)>
+=method B<new_with_options (%params)>
 
 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<argv>, if specified should point to an array  
+The special parameter C<argv>, if specified should point to an array
 reference with an array to use instead of C<@ARGV>.
 
-The paramater C<disable_gld>, if specified and a true value will disable
-the use of L<Getopt::Long::Descriptive> .
-
 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
 C<new_with_options> will throw an exception.
 
 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
+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<documentation> option for each attribute to document.
 
   --?
   --help
   --usage
 
-If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
-C<new>.
+If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
+C<new> as the usage option.
 
-=item B<ARGV>
+=method 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>.
 
-=item B<extra_argv>
+=method B<extra_argv>
 
 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.
 
-=item B<meta>
+B<Important>: By default, L<Getopt::Long> will reject unrecognized arguments
+(that is, arguments that do not correspond with attributes using the Getopt
+trait). To disable this, and allow the population of C<extra_argv>, enable the
+C<pass_through> option of L<Getopt::Long> for your class:  C<use Getopt::Long
+qw(:config pass_through);>
 
-This returns the role meta object.
-
-=item B<HAVE_GLD>
-
-A constant for internal use.
-
-=back
+=method B<usage>
 
-=head1 BUGS
+This accessor contains the L<Getopt::Long::Descriptive::Usage> object (if
+L<Getopt::Long::Descriptive> is used).
 
-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.
+=method B<help_flag>
 
-=head1 AUTHOR
+This accessor contains the boolean state of the --help, --usage and --?
+options (true if any of these options were passed on the command line).
 
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
+=method B<meta>
 
-Brandon L. Black, E<lt>blblack@gmail.comE<gt>
-
-Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
-
-=head1 CONTRIBUTORS
-
-Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
+This returns the role meta object.
 
-Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+=method B<process_argv (%params)>
 
-=head1 COPYRIGHT AND LICENSE
+This does most of the work of C<new_with_options>, analyzing the parameters
+and argv, except for actually calling the constructor. It returns a
+L<MooseX::Getopt::ProcessedArgv> object. C<new_with_options> uses this
+method internally, so modifying this method via subclasses/roles will affect
+C<new_with_options>.
 
-Copyright 2007-2008 by Infinity Interactive, Inc.
+=head2 More Customization Options
 
-L<http://www.iinteractive.com>
+See L<Getopt::Long#Configuring_Getopt::Long> for many other customizations you
+can make to how options are parsed. Simply C<use Getopt::Long qw(:config
+other_options...)> in your class to set these.
 
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+=back
 
 =cut