package MooseX::Getopt;
-use Moose::Role;
+# ABSTRACT: A Moose role for processing command line options
-use constant _HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
+use Moose::Role 0.56;
-our $VERSION = '0.25';
-our $AUTHORITY = 'cpan:STEVAN';
+with 'MooseX::Getopt::GLD';
-with _HAVE_GLD ? 'MooseX::Getopt::GLD' : 'MooseX::Getopt::Basic';
+no Moose::Role;
-no Moose::Role; 1;
-
-__END__
-
-=pod
-
-=head1 NAME
-
-MooseX::Getopt - A Moose role for processing command line options
+1;
=head1 SYNOPSIS
given for the configfile attribute) for you.
Options specified in multiple places follow the following
-precendence order: commandline overrides configfile, which
+precedence order: commandline overrides configfile, which
overrides explicit new_with_options parameters.
=head2 Supported Type Constraints
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>)
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.
+ -?
--?
+ -h
--help
--usage
If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
-C<new>.
+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 I<options>
+(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<extra_argv> (for example to pass along to another class's C<new_with_options>), you can either enable the
+C<pass_through> option of L<Getopt::Long> for your class: C<< use Getopt::Long
+qw(:config pass_through); >> or specify a value for for L<MooseX::Getopt::GLD>'s C<getopt_conf> parameter.
-This returns the role meta object.
-
-=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<print_usage_text>
-Brandon L. Black, E<lt>blblack@gmail.comE<gt>
+This method is called internally when the C<help_flag> state is true.
+It prints the text from the C<usage> object (see above) to stdout and then the
+program terminates normally. You can apply a method modification (see
+L<Moose::Manual::MethodModifiers>) if different behaviour is desired, for
+example to include additional text.
-Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
+=method B<meta>
-=head1 CONTRIBUTORS
+This returns the role meta object.
-Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
+=method B<process_argv (%params)>
-Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+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>.
-Tomas Doran, (t0m) C<< <bobtfish@bobtfish.net> >>
+=head2 More Customization Options
-=head1 COPYRIGHT AND LICENSE
+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.
-Copyright 2007-2008 by Infinity Interactive, Inc.
+=cut
-L<http://www.iinteractive.com>
+=head1 SEE ALSO
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+L<MooseX::Getopt::Usage>, an extension to generate man pages, with colour
-=cut
projects / gitmo/MooseX-Getopt.git / blobdiff