-
package MooseX::Getopt::Meta::Attribute;
-use Moose;
+# ABSTRACT: Optional meta attribute for custom option names
-our $VERSION = '0.01';
-our $AUTHORITY = 'cpan:STEVAN';
+use Moose;
+use Moose::Util::TypeConstraints;
extends 'Moose::Meta::Attribute'; # << Moose extending Moose :)
+ with 'MooseX::Getopt::Meta::Attribute::Trait';
-has 'cmd_flag' => (
- is => 'rw',
- isa => 'Str',
- predicate => 'has_cmd_flag',
-);
-
-has 'cmd_aliases' => (
- is => 'rw',
- isa => 'ArrayRef',
- predicate => 'has_cmd_aliases',
-);
-
-no Moose; 1;
-
-__END__
-
+no Moose;
-=pod
+# register this as a metaclass alias ...
+package # stop confusing PAUSE
+ Moose::Meta::Attribute::Custom::Getopt;
+sub register_implementation { 'MooseX::Getopt::Meta::Attribute' }
-=head1 NAME
-
-MooseX::Getopt::Meta::Attribute - Optional meta attribute for custom option names
+1;
=head1 SYNOPSIS
package App;
use Moose;
-
+
with 'MooseX::Getopt';
-
+
has 'data' => (
- metaclass => 'MooseX::Getopt::Meta::Attribute',
+ metaclass => 'Getopt',
is => 'ro',
isa => 'Str',
default => 'file.dat',
- # tells MooseX::Getopt to use --somedata as the
- # command line flag instead of the normal
+
+ # 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 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
+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
+=head2 Use 'traits' instead of 'metaclass'
-These methods are of little use to most users, they are used interally
-within L<MooseX::Getopt>.
+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.
-=over 4
+Therefore, you should first try to do this:
-=item B<cmd_flag>
+ has 'foo' => (traits => ['Getopt'], cmd_flag => 'f');
-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>
+=head2 Custom Metaclass alias
-=item B<meta>
+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:
-=back
+ has 'foo' => (metaclass => 'Getopt', cmd_flag => 'f');
-=head1 BUGS
+=method B<cmd_flag>
-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.
-
-=head1 AUTHOR
-
-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