added cmd_alias to accomplish "verbose|debug|v|d" sort of stuff

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

diff --git a/lib/MooseX/Getopt/Meta/Attribute.pm b/lib/MooseX/Getopt/Meta/Attribute.pm
index 5f35fec..634bbbb 100644 (file)
--- a/lib/MooseX/Getopt/Meta/Attribute.pm
+++ b/lib/MooseX/Getopt/Meta/Attribute.pm
@@ -2,7 +2,10 @@
 package MooseX::Getopt::Meta::Attribute;
 use Moose;
 
-extends 'Moose::Meta::Attribute';
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
+extends 'Moose::Meta::Attribute'; # << Moose extending Moose :)
 
 has 'cmd_flag' => (
     is        => 'rw',
@@ -10,7 +13,13 @@ has 'cmd_flag' => (
     predicate => 'has_cmd_flag',
 );
 
-1;
+has 'cmd_aliases' => (
+    is        => 'rw',
+    isa       => 'ArrayRef',
+    predicate => 'has_cmd_aliases',
+);
+
+no Moose; 1;
 
 __END__
 
@@ -19,20 +28,60 @@ __END__
 
 =head1 NAME
 
-MooseX::Getopt::Meta::Attribute - 
+MooseX::Getopt::Meta::Attribute - Optional meta attribute for custom option names
 
 =head1 SYNOPSIS
 
+  package App;
+  use Moose;
+  
+  with 'MooseX::Getopt';
+  
+  has 'data' => (
+      metaclass => 'MooseX::Getopt::Meta::Attribute',        
+      is        => 'ro',
+      isa       => 'Str',
+      default   => 'file.dat',
+      # tells MooseX::Getopt to use --somedata as the 
+      # command line flag instead of the normal 
+      # autogenerated one (--data)
+      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 /],
+  );
+
 =head1 DESCRIPTION
 
+This is a custom attribute metaclass which can be used to specify a 
+the specific command line flag to use instead of the default one 
+which L<MooseX::Getopt> will create for you. 
+
+This is certainly not the prettiest way to go about this, but for 
+now it works for those who might need such a feature.
+
 =head1 METHODS
 
+These methods are of little use to most users, they are used interally 
+within L<MooseX::Getopt>.
+
 =over 4
 
 =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
@@ -56,4 +105,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