Getopt::Long::Descriptive

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

diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm
index c773e22..7011a55 100644 (file)
--- a/lib/MooseX/Getopt.pm
+++ b/lib/MooseX/Getopt.pm
@@ -2,27 +2,42 @@
 package MooseX::Getopt;
 use Moose::Role;
 
-use Getopt::Long ();
+use Getopt::Long::Descriptive ();
 
 use MooseX::Getopt::OptionTypeMap;
 use MooseX::Getopt::Meta::Attribute;
+use MooseX::Getopt::Meta::Attribute::NoGetopt;
 
-our $VERSION   = '0.05';
+our $VERSION   = '0.08';
 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 ($class, @params) = @_;
 
-    my %processed = $class->_parse_argv( options => [ $class->_attrs_to_options( %params ) ] );
+    my %processed = $class->_parse_argv( 
+        options => [ 
+            $class->_attrs_to_options( @params ) 
+        ] 
+    );
+
+    my $params = $processed{params};
+
+    if($class->meta->does_role('MooseX::ConfigFromFile')
+       && defined $params->{configfile}) {
+        %$params = (
+            %{$class->get_config_from_file($params->{configfile})},
+            %$params,
+        );
+    }
 
     $class->new(
         ARGV       => $processed{argv_copy},
         extra_argv => $processed{argv},
-        %params, # explicit params to ->new
-        %{ $processed{params} }, # params from CLI
+        @params, # explicit params to ->new
+        %$params, # params from CLI
     );
 }
 
@@ -31,20 +46,32 @@ sub _parse_argv {
 
     local @ARGV = @{ $params{argv} || \@ARGV };
 
-    my ( @options, %name_to_init_arg, %options );
+    my ( @options, %name_to_init_arg );
 
     foreach my $opt ( @{ $params{options} } ) {
-        push @options, $opt->{opt_string};
+        push @options, [
+            $opt->{opt_string},
+            $opt->{doc} || ' ',
+            {
+                ( $opt->{required} ? (required => $opt->{required}) : () ),
+                ( exists $opt->{default}  ? (default  => $opt->{default})  : () ),
+            },
+        ];
+
         $name_to_init_arg{ $opt->{name} } = $opt->{init_arg};
     }
 
     # Get a clean copy of the original @ARGV
     my $argv_copy = [ @ARGV ];
 
-    {
-        local $SIG{__WARN__} = sub { die $_[0] };
-        Getopt::Long::GetOptions(\%options, @options);
-    }
+    my @err;
+
+    my ( $parsed_options, $usage ) = eval {
+        local $SIG{__WARN__} = sub { push @err, @_ };
+        Getopt::Long::Descriptive::describe_options("usage: %c %o", @options)
+    };
+
+    die join "", grep { defined } @err, $@ if @err or $@;
 
     # Get a copy of the Getopt::Long-mangled @ARGV
     my $argv_mangled = [ @ARGV ];
@@ -54,18 +81,29 @@ sub _parse_argv {
         argv      => $argv_mangled,
         params    => {
             map { 
-                $name_to_init_arg{$_} => $options{$_} 
-            } keys %options,   
+                $name_to_init_arg{$_} => $parsed_options->{$_} 
+            } keys %$parsed_options,   
         }
     );
 }
 
+sub _compute_getopt_attrs {
+    my $class = shift;
+    grep {
+        $_->isa("MooseX::Getopt::Meta::Attribute")
+            or
+        $_->name !~ /^_/
+            &&
+        !$_->isa('MooseX::Getopt::Meta::Attribute::NoGetopt')
+    } $class->meta->compute_all_applicable_attributes
+}
+
 sub _attrs_to_options {
     my $class = shift;
 
     my @options;
 
-    foreach my $attr ($class->meta->compute_all_applicable_attributes) {
+    foreach my $attr ($class->_compute_getopt_attrs) {
         my $name = $attr->name;
 
         my $aliases;
@@ -74,9 +112,6 @@ sub _attrs_to_options {
             $name = $attr->cmd_flag if $attr->has_cmd_flag;
             $aliases = $attr->cmd_aliases if $attr->has_cmd_aliases;
         }
-        else {
-            next if $name =~ /^_/;
-        }
 
         my $opt_string = $aliases
             ? join(q{|}, $name, @$aliases)
@@ -84,8 +119,8 @@ sub _attrs_to_options {
 
         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);
+            if (MooseX::Getopt::OptionTypeMap->has_option_type($type_name)) {
+                $opt_string .= MooseX::Getopt::OptionTypeMap->get_option_type($type_name)
             }
         }
 
@@ -94,6 +129,7 @@ sub _attrs_to_options {
             init_arg   => $attr->init_arg,
             opt_string => $opt_string,
             required   => $attr->is_required,
+            ( ( $attr->has_default && ( $attr->is_default_a_coderef xor $attr->is_lazy ) ) ? ( default => $attr->default({}) ) : () ),
             ( $attr->has_documentation ? ( doc => $attr->documentation ) : () ),
         }
     }
@@ -149,6 +185,9 @@ accordingly.
 You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute>
 to get non-default commandline option names and aliases.
 
+You can use the attribute metaclass L<MooseX::Getopt::Meta::Attribute::NoGetOpt>
+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
@@ -163,6 +202,11 @@ to have the leading underscore in thier name, you can do this:
 This will mean that Getopt will not handle a --foo param, but your 
 code can still call the C<foo> method. 
 
+If your class also uses a configfile-loading role based on
+L<MooseX::ConfigFromFile>, such as L<MooseX::SimpleConfig>,
+L<MooseX::Getopt>'s C<new_with_options> will load the configfile
+specified by the C<--configfile> option for you.
+
 =head2 Supported Type Constraints
 
 =over 4