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