Commit | Line | Data |
4dee0fd3 |
1 | package MooseX::ClassAttribute; |
2 | |
4dee0fd3 |
3 | use strict; |
54a288bd |
4 | use warnings; |
4dee0fd3 |
5 | |
12a0d4db |
6 | our $VERSION = '0.13'; |
0f24a39d |
7 | our $AUTHORITY = 'cpan:DROLSKY'; |
8 | |
6cb25e09 |
9 | use Moose 0.98 (); |
bb70fe3a |
10 | use Moose::Exporter; |
63fcc508 |
11 | use MooseX::ClassAttribute::Trait::Class; |
12 | use MooseX::ClassAttribute::Trait::Role; |
13 | use MooseX::ClassAttribute::Trait::Application::ToClass; |
14 | use MooseX::ClassAttribute::Trait::Application::ToRole; |
0f24a39d |
15 | |
7ce5e557 |
16 | Moose::Exporter->setup_import_methods( |
17 | with_meta => ['class_has'], |
18 | class_metaroles => { |
19 | class => ['MooseX::ClassAttribute::Trait::Class'], |
20 | }, |
21 | role_metaroles => { |
22 | role => ['MooseX::ClassAttribute::Trait::Role'], |
23 | application_to_class => |
24 | ['MooseX::ClassAttribute::Trait::Application::ToClass'], |
25 | application_to_role => |
26 | ['MooseX::ClassAttribute::Trait::Application::ToRole'], |
27 | }, |
28 | ); |
8d655404 |
29 | |
9b2bd146 |
30 | sub class_has { |
59ee60b4 |
31 | my $meta = shift; |
bb70fe3a |
32 | my $name = shift; |
33 | my %options = @_; |
8d655404 |
34 | |
bb70fe3a |
35 | my $attrs = ref $name eq 'ARRAY' ? $name : [$name]; |
54a288bd |
36 | |
9b2bd146 |
37 | $meta->add_class_attribute( $_, %options ) for @{$attrs}; |
0f24a39d |
38 | } |
39 | |
4dee0fd3 |
40 | 1; |
41 | |
0d0bf8c3 |
42 | # ABSTRACT: Declare class attributes Moose-style |
43 | |
4dee0fd3 |
44 | __END__ |
45 | |
46 | =pod |
47 | |
4dee0fd3 |
48 | =head1 SYNOPSIS |
49 | |
54a288bd |
50 | package My::Class; |
4dee0fd3 |
51 | |
54a288bd |
52 | use Moose; |
4dee0fd3 |
53 | use MooseX::ClassAttribute; |
54 | |
54a288bd |
55 | class_has 'Cache' => |
56 | ( is => 'rw', |
57 | isa => 'HashRef', |
58 | default => sub { {} }, |
59 | ); |
60 | |
61 | __PACKAGE__->meta()->make_immutable(); |
54a288bd |
62 | |
63 | no Moose; |
64 | no MooseX::ClassAttribute; |
65 | |
66 | # then later ... |
67 | |
68 | My::Class->Cache()->{thing} = ...; |
69 | |
54a288bd |
70 | =head1 DESCRIPTION |
71 | |
72 | This module allows you to declare class attributes in exactly the same |
169f4cc7 |
73 | way as object attributes, using C<class_has()> instead of C<has()>. |
54a288bd |
74 | |
75 | You can use any feature of Moose's attribute declarations, including |
0388e669 |
76 | overriding a parent's attributes, delegation (C<handles>), attribute traits, |
77 | etc. All features should just work. The one exception is the "required" flag, |
78 | which is not allowed for class attributes. |
54a288bd |
79 | |
169f4cc7 |
80 | The accessor methods for class attribute may be called on the class |
7dc1418a |
81 | directly, or on objects of that class. Passing a class attribute to |
0388e669 |
82 | the constructor will not set that attribute. |
7dc1418a |
83 | |
54a288bd |
84 | =head1 FUNCTIONS |
85 | |
86 | This class exports one function when you use it, C<class_has()>. This |
87 | works exactly like Moose's C<has()>, but it declares class attributes. |
88 | |
6c69490f |
89 | One little nit is that if you include C<no Moose> in your class, you won't |
90 | remove the C<class_has()> function. To do that you must include C<no |
91 | MooseX::ClassAttribute> as well. Or you can just use L<namespace::autoclean> |
92 | instead. |
54a288bd |
93 | |
94 | =head2 Implementation and Immutability |
95 | |
169f4cc7 |
96 | This module will add a role to your class's metaclass, See |
63fcc508 |
97 | L<MooseX::ClassAttribute::Trait::Class> for details. This role |
169f4cc7 |
98 | provides introspection methods for class attributes. |
99 | |
100 | Class attributes themselves do the |
63fcc508 |
101 | L<MooseX::ClassAttribute::Trait::Attribute> role. |
4dee0fd3 |
102 | |
169f4cc7 |
103 | There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor> |
104 | which provides part of the inlining implementation for class |
105 | attributes. |
4dee0fd3 |
106 | |
169f4cc7 |
107 | =head2 Cooperation with Metaclasses and Traits |
4dee0fd3 |
108 | |
169f4cc7 |
109 | This module should work with most attribute metaclasses and traits, |
110 | but it's possible that conflicts could occur. This module has been |
0388e669 |
111 | tested to work with Moose's native traits. |
112 | |
113 | =head2 Class Attributes in Roles |
114 | |
115 | You can add a class attribute to a role. When that role is applied to a class, |
116 | the class will have the relevant class attributes added. Note that attribute |
117 | defaults will be calculated when the class attribute is composed into the |
118 | class. |
4dee0fd3 |
119 | |
7a4a3b1e |
120 | =head1 DONATIONS |
121 | |
122 | If you'd like to thank me for the work I've done on this module, |
123 | please consider making a "donation" to me via PayPal. I spend a lot of |
124 | free time creating free software, and would appreciate any support |
125 | you'd care to offer. |
126 | |
127 | Please note that B<I am not suggesting that you must do this> in order |
128 | for me to continue working on this particular software. I will |
129 | continue to do so, inasmuch as I have in the past, for as long as it |
130 | interests me. |
131 | |
132 | Similarly, a donation made in this way will probably not make me work |
133 | on this software much more, unless I get so many donations that I can |
134 | consider working on free software full time, which seems unlikely at |
135 | best. |
136 | |
137 | To donate, log into PayPal and send money to autarch@urth.org or use |
138 | the button on this page: |
139 | L<http://www.urth.org/~autarch/fs-donation.html> |
140 | |
4dee0fd3 |
141 | =head1 BUGS |
142 | |
54a288bd |
143 | Please report any bugs or feature requests to |
144 | C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface |
145 | at L<http://rt.cpan.org>. I will be notified, and then you'll |
146 | automatically be notified of progress on your bug as I make changes. |
4dee0fd3 |
147 | |
4dee0fd3 |
148 | =cut |