Commit | Line | Data |
5dac17c3 |
1 | |
23575d46 |
2 | package MooseX::Getopt::Meta::Attribute; |
5dac17c3 |
3 | use Moose; |
61c9baa9 |
4 | use Moose::Util::TypeConstraints; |
5dac17c3 |
5 | |
f969917f |
6 | our $VERSION = '0.04'; |
8034a232 |
7 | our $AUTHORITY = 'cpan:STEVAN'; |
8 | |
9 | extends 'Moose::Meta::Attribute'; # << Moose extending Moose :) |
5dac17c3 |
10 | |
11 | has 'cmd_flag' => ( |
12 | is => 'rw', |
13 | isa => 'Str', |
14 | predicate => 'has_cmd_flag', |
15 | ); |
16 | |
61c9baa9 |
17 | # This subtype is to support scalar -> arrayref coercion |
18 | # without polluting the built-in types |
f969917f |
19 | subtype '_MooseX_Getopt_CmdAliases' => as 'ArrayRef'; |
3d9a716d |
20 | |
61c9baa9 |
21 | coerce '_MooseX_Getopt_CmdAliases' |
3d9a716d |
22 | => from 'Str' |
61c9baa9 |
23 | => via { [$_] }; |
24 | |
de75868f |
25 | has 'cmd_aliases' => ( |
26 | is => 'rw', |
61c9baa9 |
27 | isa => '_MooseX_Getopt_CmdAliases', |
de75868f |
28 | predicate => 'has_cmd_aliases', |
61c9baa9 |
29 | coerce => 1, |
de75868f |
30 | ); |
31 | |
1a8b4ed1 |
32 | no Moose; |
5dac17c3 |
33 | |
1a8b4ed1 |
34 | # register this as a metaclass alias ... |
35 | package Moose::Meta::Attribute::Custom::Getopt; |
36 | sub register_implementation { 'MooseX::Getopt::Meta::Attribute' } |
37 | |
38 | 1; |
5dac17c3 |
39 | |
1a8b4ed1 |
40 | __END__ |
5dac17c3 |
41 | |
42 | =pod |
43 | |
44 | =head1 NAME |
45 | |
8034a232 |
46 | MooseX::Getopt::Meta::Attribute - Optional meta attribute for custom option names |
5dac17c3 |
47 | |
48 | =head1 SYNOPSIS |
49 | |
8034a232 |
50 | package App; |
51 | use Moose; |
52 | |
53 | with 'MooseX::Getopt'; |
54 | |
55 | has 'data' => ( |
1a8b4ed1 |
56 | metaclass => 'MooseX::Getopt::Meta::Attribute', |
8034a232 |
57 | is => 'ro', |
58 | isa => 'Str', |
59 | default => 'file.dat', |
61c9baa9 |
60 | |
de75868f |
61 | # tells MooseX::Getopt to use --somedata as the |
8034a232 |
62 | # command line flag instead of the normal |
63 | # autogenerated one (--data) |
de75868f |
64 | cmd_flag => 'somedata', |
61c9baa9 |
65 | |
de75868f |
66 | # tells MooseX::Getopt to also allow --moosedata, |
67 | # -m, and -d as aliases for this same option on |
68 | # the commandline. |
69 | cmd_aliases => [qw/ moosedata m d /], |
61c9baa9 |
70 | |
71 | # Or, you can use a plain scalar for a single alias: |
72 | cmd_aliases => 'm', |
8034a232 |
73 | ); |
74 | |
5dac17c3 |
75 | =head1 DESCRIPTION |
76 | |
8034a232 |
77 | This is a custom attribute metaclass which can be used to specify a |
78 | the specific command line flag to use instead of the default one |
79 | which L<MooseX::Getopt> will create for you. |
80 | |
81 | This is certainly not the prettiest way to go about this, but for |
82 | now it works for those who might need such a feature. |
83 | |
1a8b4ed1 |
84 | =head2 Custom Metaclass alias |
85 | |
86 | This now takes advantage of the Moose 0.19 feature to support |
87 | custom attribute metaclass aliases. This means you can also |
88 | use this as the B<Getopt> alias, like so: |
89 | |
90 | has 'foo' => (metaclass => 'Getopt', cmd_flag => 'f'); |
91 | |
5dac17c3 |
92 | =head1 METHODS |
93 | |
8034a232 |
94 | These methods are of little use to most users, they are used interally |
95 | within L<MooseX::Getopt>. |
96 | |
5dac17c3 |
97 | =over 4 |
98 | |
99 | =item B<cmd_flag> |
100 | |
de75868f |
101 | Changes the commandline flag to be this value, instead of the default, |
102 | which is the same as the attribute name. |
103 | |
104 | =item B<cmd_aliases> |
105 | |
106 | Adds more aliases for this commandline flag, useful for short options |
107 | and such. |
108 | |
5dac17c3 |
109 | =item B<has_cmd_flag> |
110 | |
de75868f |
111 | =item B<has_cmd_aliases> |
112 | |
5dac17c3 |
113 | =item B<meta> |
114 | |
115 | =back |
116 | |
117 | =head1 BUGS |
118 | |
119 | All complex software has bugs lurking in it, and this module is no |
120 | exception. If you find a bug please either email me, or add the bug |
121 | to cpan-RT. |
122 | |
123 | =head1 AUTHOR |
124 | |
125 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
126 | |
3d9a716d |
127 | Brandon L. Black, E<lt>blblack@gmail.comE<gt> |
128 | |
5dac17c3 |
129 | =head1 COPYRIGHT AND LICENSE |
130 | |
131 | Copyright 2007 by Infinity Interactive, Inc. |
132 | |
133 | L<http://www.iinteractive.com> |
134 | |
135 | This library is free software; you can redistribute it and/or modify |
136 | it under the same terms as Perl itself. |
137 | |
de75868f |
138 | =cut |