support scalar cmd_aliases, so that singular aliases are not so clunky to type
[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt / Meta / Attribute.pm
index ddf928f..55d1750 100644 (file)
@@ -1,6 +1,7 @@
 
 package MooseX::Getopt::Meta::Attribute;
 use Moose;
+use Moose::Util::TypeConstraints;
 
 our $VERSION   = '0.01';
 our $AUTHORITY = 'cpan:STEVAN';
@@ -13,6 +14,22 @@ has 'cmd_flag' => (
     predicate => 'has_cmd_flag',
 );
 
+# This subtype is to support scalar -> arrayref coercion
+#  without polluting the built-in types
+subtype '_MooseX_Getopt_CmdAliases'
+    => as 'ArrayRef'
+        => where { 1 };
+coerce '_MooseX_Getopt_CmdAliases'
+    => from 'Value'
+        => via { [$_] };
+
+has 'cmd_aliases' => (
+    is        => 'rw',
+    isa       => '_MooseX_Getopt_CmdAliases',
+    predicate => 'has_cmd_aliases',
+    coerce    => 1,
+);
+
 no Moose; 1;
 
 __END__
@@ -36,10 +53,19 @@ MooseX::Getopt::Meta::Attribute - Optional meta attribute for custom option name
       is        => 'ro',
       isa       => 'Str',
       default   => 'file.dat',
-      # tells MooseX::Getopt to use -f as the 
+
+      # tells MooseX::Getopt to use --somedata as the 
       # command line flag instead of the normal 
       # autogenerated one (--data)
-      cmd_flag  => 'f',
+      cmd_flag  => 'somedata',
+
+      # tells MooseX::Getopt to also allow --moosedata,
+      # -m, and -d as aliases for this same option on
+      # the commandline.
+      cmd_aliases => [qw/ moosedata m d /],
+
+      # Or, you can use a plain scalar for a single alias:
+      cmd_aliases => 'm',
   );
 
 =head1 DESCRIPTION
@@ -60,8 +86,18 @@ within L<MooseX::Getopt>.
 
 =item B<cmd_flag>
 
+Changes the commandline flag to be this value, instead of the default,
+which is the same as the attribute name.
+
+=item B<cmd_aliases>
+
+Adds more aliases for this commandline flag, useful for short options
+and such.
+
 =item B<has_cmd_flag>
 
+=item B<has_cmd_aliases>
+
 =item B<meta>
 
 =back
@@ -85,4 +121,4 @@ 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.
 
-=cut
\ No newline at end of file
+=cut