Merge
[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt.pm
index d0a8fd7..8369321 100644 (file)
@@ -11,7 +11,7 @@ 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.16';
+our $VERSION   = '0.20';
 our $AUTHORITY = 'cpan:STEVAN';
 
 has ARGV       => (is => 'rw', isa => 'ArrayRef', metaclass => "NoGetopt");
@@ -52,10 +52,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
     );
 }
@@ -164,7 +170,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 +199,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)
@@ -276,8 +285,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', ...);
@@ -414,10 +423,22 @@ 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>.
+
 If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
 C<new_with_options> will throw an exception.
 
-If you have L<Getopt::Long::Descriptive> a the C<usage> param is also passed to
+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> the C<usage> param is also passed to
 C<new>.
 
 =item B<ARGV>
@@ -455,6 +476,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.