Bump versions

[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..4445e14 100644 (file)
--- a/lib/MooseX/Getopt/Meta/Attribute.pm
+++ b/lib/MooseX/Getopt/Meta/Attribute.pm
@@ -1,38 +1,96 @@
 
 package MooseX::Getopt::Meta::Attribute;
 use Moose;
+use Moose::Util::TypeConstraints;
 
-extends 'Moose::Meta::Attribute';
+our $VERSION   = '0.25';
+our $AUTHORITY = 'cpan:STEVAN';
 
-has 'cmd_flag' => (
-    is        => 'rw',
-    isa       => 'Str',
-    predicate => 'has_cmd_flag',
-);
+extends 'Moose::Meta::Attribute'; # << Moose extending Moose :)
+   with 'MooseX::Getopt::Meta::Attribute::Trait';
+
+no Moose;
+
+# register this as a metaclass alias ...
+package # stop confusing PAUSE 
+    Moose::Meta::Attribute::Custom::Getopt;
+sub register_implementation { 'MooseX::Getopt::Meta::Attribute' }
 
 1;
 
 __END__
 
-
 =pod
 
 =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 /],
+
+      # Or, you can use a plain scalar for a single alias:
+      cmd_aliases => 'm',
+  );
+
 =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.
+
+=head2 Custom Metaclass alias
+
+This now takes advantage of the Moose 0.19 feature to support 
+custom attribute metaclass aliases. This means you can also
+use this as the B<Getopt> alias, like so:
+
+  has 'foo' => (metaclass => 'Getopt', cmd_flag => 'f');
+
 =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
@@ -47,13 +105,15 @@ to cpan-RT.
 
 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
+Brandon L. Black, E<lt>blblack@gmail.comE<gt>
+
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007 by Infinity Interactive, Inc.
+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.
 
-=cut
\ No newline at end of file
+=cut