X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Getopt.git;a=blobdiff_plain;f=lib%2FMooseX%2FGetopt%2FMeta%2FAttribute.pm;h=fe53a14c4e793f3467d3676527b28848ff969070;hp=e668587a0925ae9a72a7907564a93236ab98ca47;hb=747717044102ba1feba0134bdbcb7aeb3d2d1adb;hpb=8b9e50c33133b5735d32f4b3d05eee82a919b382 diff --git a/lib/MooseX/Getopt/Meta/Attribute.pm b/lib/MooseX/Getopt/Meta/Attribute.pm index e668587..fe53a14 100644 --- a/lib/MooseX/Getopt/Meta/Attribute.pm +++ b/lib/MooseX/Getopt/Meta/Attribute.pm @@ -1,46 +1,36 @@ - package MooseX::Getopt::Meta::Attribute; +# ABSTRACT: Optional meta attribute for custom option names + use Moose; use Moose::Util::TypeConstraints; -our $VERSION = '0.26'; -our $AUTHORITY = 'cpan:STEVAN'; - 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 +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 - Optional meta attribute for custom option names - =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', @@ -55,65 +45,44 @@ MooseX::Getopt::Meta::Attribute - Optional meta attribute for custom option name =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 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 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. +=head2 Use 'traits' instead of 'metaclass' + +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. + +Therefore, you should first try to do this: + + has 'foo' => (traits => ['Getopt'], cmd_flag => 'f'); + =head2 Custom Metaclass alias -This now takes advantage of the Moose 0.19 feature to support +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 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. - -=over 4 - -=item B +=method B Changes the commandline flag to be this value, instead of the default, which is the same as the attribute name. -=item B +=method B Adds more aliases for this commandline flag, useful for short options and such. -=item B - -=item B - -=item B - -=back - -=head1 BUGS - -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 Estevan@iinteractive.comE - -Brandon L. Black, Eblblack@gmail.comE - -=head1 COPYRIGHT AND LICENSE - -Copyright 2007-2008 by Infinity Interactive, Inc. - -L +=method B -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +=method B =cut