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