1 package MooseX::ClassAttribute;
7 our $AUTHORITY = 'cpan:DROLSKY';
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;
17 Moose::Exporter->setup_import_methods( with_meta => ['class_has'] );
23 return Moose::Util::MetaRole::apply_metaclass_roles(
26 class => ['MooseX::ClassAttribute::Trait::Class'],
29 role => ['MooseX::ClassAttribute::Trait::Role'],
30 application_to_class =>
31 ['MooseX::ClassAttribute::Trait::Application::ToClass'],
32 application_to_role =>
33 ['MooseX::ClassAttribute::Trait::Application::ToRole'],
34 application_to_instance => [
35 'MooseX::ClassAttribute::Trait::Application::ToInstance'
46 my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
48 $meta->add_class_attribute( $_, %options ) for @{$attrs};
59 MooseX::ClassAttribute - Declare class attributes Moose-style
66 use MooseX::ClassAttribute;
71 default => sub { {} },
74 __PACKAGE__->meta()->make_immutable();
77 no MooseX::ClassAttribute;
81 My::Class->Cache()->{thing} = ...;
85 This module allows you to declare class attributes in exactly the same
86 way as object attributes, using C<class_has()> instead of C<has()>.
88 You can use any feature of Moose's attribute declarations, including
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.
93 The accessor methods for class attribute may be called on the class
94 directly, or on objects of that class. Passing a class attribute to
95 the constructor will not set that attribute.
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.
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>
107 =head2 Implementation and Immutability
109 This module will add a role to your class's metaclass, See
110 L<MooseX::ClassAttribute::Trait::Class> for details. This role
111 provides introspection methods for class attributes.
113 Class attributes themselves do the
114 L<MooseX::ClassAttribute::Trait::Attribute> role.
116 There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor>
117 which provides part of the inlining implementation for class
120 =head2 Cooperation with Metaclasses and Traits
122 This module should work with most attribute metaclasses and traits,
123 but it's possible that conflicts could occur. This module has been
124 tested to work with Moose's native traits.
126 =head2 Class Attributes in Roles
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
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
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
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
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>
156 Dave Rolsky, C<< <autarch@urth.org> >>
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.
165 =head1 COPYRIGHT & LICENSE
167 Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
169 This program is free software; you can redistribute it and/or modify
170 it under the same terms as Perl itself.