spelling (RT#87780)

[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..fe53a14 100644 (file)
--- a/lib/MooseX/Getopt/Meta/Attribute.pm
+++ b/lib/MooseX/Getopt/Meta/Attribute.pm
@@ -1,59 +1,88 @@
-
 package MooseX::Getopt::Meta::Attribute;
+# ABSTRACT: Optional meta attribute for custom option names
+
 use Moose;
+use Moose::Util::TypeConstraints;
 
-extends 'Moose::Meta::Attribute';
+extends 'Moose::Meta::Attribute'; # << Moose extending Moose :)
+   with 'MooseX::Getopt::Meta::Attribute::Trait';
 
-has 'cmd_flag' => (
-    is        => 'rw',
-    isa       => 'Str',
-    predicate => 'has_cmd_flag',
-);
+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__
+=head1 SYNOPSIS
 
+  package App;
+  use Moose;
 
-=pod
+  with 'MooseX::Getopt';
 
-=head1 NAME
+  has 'data' => (
+      metaclass => 'Getopt',
+      is        => 'ro',
+      isa       => 'Str',
+      default   => 'file.dat',
 
-MooseX::Getopt::Meta::Attribute - 
+      # tells MooseX::Getopt to use --somedata as the
+      # command line flag instead of the normal
+      # autogenerated one (--data)
+      cmd_flag  => 'somedata',
 
-=head1 SYNOPSIS
+      # 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
 
-=head1 METHODS
+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.
 
-=over 4
+=head2 Use 'traits' instead of 'metaclass'
 
-=item B<cmd_flag>
+You should rarely need to explicitly set the attribute metaclass. It is much
+preferred to simply provide a trait (a role applied to the attribute
+metaclass), which allows other code to further modify the attribute by applying
+additional roles.
 
-=item B<has_cmd_flag>
+Therefore, you should first try to do this:
 
-=item B<meta>
+  has 'foo' => (traits => ['Getopt'], cmd_flag => 'f');
 
-=back
+=head2 Custom Metaclass alias
 
-=head1 BUGS
+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:
 
-All complex software has bugs lurking in it, and this module is no 
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+  has 'foo' => (metaclass => 'Getopt', cmd_flag => 'f');
 
-=head1 AUTHOR
+=method B<cmd_flag>
 
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
+Changes the commandline flag to be this value, instead of the default,
+which is the same as the attribute name.
 
-=head1 COPYRIGHT AND LICENSE
+=method B<cmd_aliases>
 
-Copyright 2007 by Infinity Interactive, Inc.
+Adds more aliases for this commandline flag, useful for short options
+and such.
 
-L<http://www.iinteractive.com>
+=method B<has_cmd_flag>
 
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+=method B<has_cmd_aliases>
 
-=cut
\ No newline at end of file
+=cut