Splitted into Getopt::Basic and Getopt::GLD.

[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt.pm

diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm
index b96edfb..01904f3 100644 (file)
--- a/lib/MooseX/Getopt.pm
+++ b/lib/MooseX/Getopt.pm
@@ -11,9 +11,14 @@ use Carp ();
 use Getopt::Long (); # GLD uses it anyway, doesn't hurt
 use constant HAVE_GLD => not not eval { require Getopt::Long::Descriptive };
 
-our $VERSION   = '0.14';
+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");
 
@@ -52,10 +57,16 @@ sub new_with_options {
 
     my $params = $config_from_file ? { %$config_from_file, %{$processed{params}} } : $processed{params};
 
+    # did the user request usage information?
+    if ( $processed{usage} && ($params->{'?'} or $params->{help} or $params->{usage}) )
+    {
+        $processed{usage}->die();
+    }
+
     $class->new(
         ARGV       => $processed{argv_copy},
         extra_argv => $processed{argv},
-        @params, # explicit params to ->new
+        %$constructor_params, # explicit params to ->new
         %$params, # params from CLI
     );
 }
@@ -63,9 +74,9 @@ sub new_with_options {
 sub _parse_argv {
     my ( $class, %params ) = @_;
 
-    local @ARGV = @{ $params{argv} || \@ARGV };
+    local @ARGV = @{ $params{params}{argv} || \@ARGV };
 
-    my ( $opt_spec, $name_to_init_arg ) = ( HAVE_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 ];
@@ -75,13 +86,7 @@ sub _parse_argv {
     my ( $parsed_options, $usage ) = eval {
         local $SIG{__WARN__} = sub { push @err, @_ };
 
-        if ( HAVE_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 $@;
@@ -164,7 +169,7 @@ sub _compute_getopt_attrs {
         $_->name !~ /^_/
     } grep {
         !$_->does('MooseX::Getopt::Meta::Attribute::Trait::NoGetopt')
-    } $class->meta->compute_all_applicable_attributes
+    } $class->meta->get_all_attributes
 }
 
 sub _get_cmd_flags_for_attr {
@@ -193,7 +198,10 @@ sub _attrs_to_options {
 
         my $opt_string = join(q{|}, $flag, @aliases);
 
-        if ($attr->has_type_constraint) {
+        if ($attr->name eq 'configfile') {
+            $opt_string .= '=s';
+        }
+        elsif ($attr->has_type_constraint) {
             my $type = $attr->type_constraint;
             if (MooseX::Getopt::OptionTypeMap->has_option_type($type)) {
                 $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type)
@@ -414,9 +422,24 @@ 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  
+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
+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>.
 
@@ -435,6 +458,10 @@ un-mangled.
 
 This returns the role meta object.
 
+=item B<HAVE_GLD>
+
+A constant for internal use.
+
 =back
 
 =head1 BUGS
@@ -455,6 +482,8 @@ Yuval Kogman, E<lt>nothingmuch@woobling.orgE<gt>
 
 Ryan D Johnson, E<lt>ryan@innerfence.comE<gt>
 
+Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
+
 =head1 COPYRIGHT AND LICENSE
 
 Copyright 2007-2008 by Infinity Interactive, Inc.