move most of new_with_options logic into separate publically accessible process_argv...
[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt / Basic.pm
index 5000746..906ba39 100644 (file)
@@ -1,57 +1,52 @@
 package MooseX::Getopt::Basic;
+# ABSTRACT: MooseX::Getopt::Basic - role to implement the Getopt::Long functionality
+
 use Moose::Role;
 
 use MooseX::Getopt::OptionTypeMap;
 use MooseX::Getopt::Meta::Attribute;
 use MooseX::Getopt::Meta::Attribute::NoGetopt;
+use MooseX::Getopt::ProcessedArgv;
 use Carp ();
 
-use Getopt::Long (); # GLD uses it anyway, doesn't hurt
-
-our $VERSION   = '0.20';
-our $AUTHORITY = 'cpan:STEVAN';
+use Getopt::Long 2.37 ();
 
 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 {
+sub process_argv {
     my ($class, @params) = @_;
 
     my $config_from_file;
     if($class->meta->does_role('MooseX::ConfigFromFile')) {
         local @ARGV = @ARGV;
 
+        # just get the configfile arg now; the rest of the args will be
+        # fetched later
         my $configfile;
-        my $opt_parser = Getopt::Long::Parser->new( config => [ qw( pass_through ) ] );
+        my $opt_parser = Getopt::Long::Parser->new( config => [ qw( no_auto_help pass_through ) ] );
         $opt_parser->getoptions( "configfile=s" => \$configfile );
 
         if(!defined $configfile) {
             my $cfmeta = $class->meta->find_attribute_by_name('configfile');
             $configfile = $cfmeta->default if $cfmeta->has_default;
-        }
-
-        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 (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/;
+                }
             }
         }
+        else {
+            $config_from_file = $class->get_config_from_file($configfile);
+        }
     }
 
     my $constructor_params = ( @params == 1 ? $params[0] : {@params} );
@@ -69,24 +64,37 @@ 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}) )
+    if ( $processed{usage} and $params->{help_flag} )
     {
-        $class->_exit_with_usage($processed{usage});
+        $class->_getopt_full_usage($processed{usage});
     }
 
-    $class->new(
-        ARGV       => $processed{argv_copy},
-        extra_argv => $processed{argv},
-        %$constructor_params, # explicit params to ->new
-        %$params, # params from CLI
-    );
+    return MooseX::Getopt::ProcessedArgv->new
+        (
+         argv_copy          => $processed{argv_copy},
+         extra_argv         => $processed{argv},
+         usage              => $processed{usage},
+         constructor_params => $constructor_params, # explicit params to ->new
+         cli_params         => $params, # params from CLI
+        );
 }
 
-sub _exit_with_usage {
-    my ($self, $usage) = @_;
-    $usage->die();
+sub new_with_options {
+    my ($class, @params) = @_;
+
+    my $pa = $class->process_argv(@params);    
+
+    $class->new(
+        ARGV       => $pa->argv_copy,
+        extra_argv => $pa->extra_argv,
+        ( $pa->usage ? ( usage => $pa->usage ) : () ),
+        %{ $pa->constructor_params }, # explicit params to ->new
+        %{ $pa->cli_params }, # params from CLI
+        );
 }
 
+sub _getopt_spec { shift->_traditional_spec(@_); }
+
 sub _parse_argv {
     my ( $class, %params ) = @_;
 
@@ -97,15 +105,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 ];
@@ -124,6 +132,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";
 }
@@ -147,6 +174,7 @@ sub _traditional_spec {
 
 sub _compute_getopt_attrs {
     my $class = shift;
+    sort { $a->insertion_order <=> $b->insertion_order }
     grep {
         $_->does("MooseX::Getopt::Meta::Attribute::Trait")
             or
@@ -198,9 +226,9 @@ sub _attrs_to_options {
             opt_string => $opt_string,
             required   => $attr->is_required && !$attr->has_default && !$attr->has_builder && !exists $config_from_file->{$attr->name},
             # NOTE:
-            # this "feature" was breaking because 
-            # Getopt::Long::Descriptive would return 
-            # the default value as if it was a command 
+            # this "feature" was breaking because
+            # Getopt::Long::Descriptive would return
+            # the default value as if it was a command
             # line flag, which would then override the
             # one passed into a constructor.
             # See 100_gld_default_bug.t for an example
@@ -213,17 +241,9 @@ sub _attrs_to_options {
     return @options;
 }
 
-no Moose::Role; 1;
-
+no Moose::Role;
 1;
 
-=pod
-
-=head1 NAME
-
-MooseX::Getopt::Basic - role to implement the basic functionality of
-L<MooseX::Getopt> without GLD.
-
 =head1 SYNOPSIS
 
   ## In your class
@@ -253,50 +273,8 @@ L<MooseX::Getopt> without GLD.
 This is like L<MooseX::Getopt> and can be used instead except that it
 doesn't make use of L<Getopt::Long::Descriptive> (or "GLD" for short).
 
-=head1 METHODS
-
-=over 4
-
-=item B<new_with_options>
-
-See L<MooseX::Getopt> .
-
-=item B<meta>
-
-This returns the role meta object.
+=method new_with_options
 
-=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 E<lt>stevan@iinteractive.comE<gt>
-
-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>
-
-Drew Taylor, E<lt>drew@drewtaylor.comE<gt>
-
-Shlomi Fish E<lt>shlomif@cpan.orgE<gt>
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2007-2008 by Infinity Interactive, Inc.
-
-L<http://www.iinteractive.com>
-
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+See L<MooseX::Getopt/new_with_options>.
 
 =cut
-