lib/MooseX/ClassAttribute.pm

   1 package MooseX::ClassAttribute;
   2
   3 use strict;
   4 use warnings;
   5
   6 our $VERSION = '0.10';
   7 our $AUTHORITY = 'cpan:DROLSKY';
   8
   9 use Moose 0.89 ();
  10 use Moose::Exporter;
  11 use MooseX::ClassAttribute::Role::Meta::Class;
  12
  13 Moose::Exporter->setup_import_methods
  14     ( with_meta => [ 'class_has' ] );
  15
  16
  17 sub init_meta
  18 {
  19     shift;
  20     my %p = @_;
  21
  22     Moose->init_meta(%p);
  23
  24     return
  25         Moose::Util::MetaRole::apply_metaclass_roles
  26             ( for_class       => $p{for_class},
  27               metaclass_roles => [ 'MooseX::ClassAttribute::Role::Meta::Class' ],
  28             );
  29 }
  30
  31 sub class_has
  32 {
  33     my $meta    = shift;
  34     my $name    = shift;
  35     my %options = @_;
  36
  37     my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
  38
  39     $meta->add_class_attribute( $_, %options )
  40         for @{ $attrs };
  41 }
  42
  43 1;
  44
  45 __END__
  46
  47 =pod
  48
  49 =head1 NAME
  50
  51 MooseX::ClassAttribute - Declare class attributes Moose-style
  52
  53 =head1 SYNOPSIS
  54
  55     package My::Class;
  56
  57     use Moose;
  58     use MooseX::ClassAttribute;
  59
  60     class_has 'Cache' =>
  61         ( is      => 'rw',
  62           isa     => 'HashRef',
  63           default => sub { {} },
  64         );
  65
  66     __PACKAGE__->meta()->make_immutable();
  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
  79 way as object attributes, using C<class_has()> instead of C<has()>.
  80
  81 You can use any feature of Moose's attribute declarations, including
  82 overriding a parent's attributes, delegation (C<handles>), and
  83 attribute metaclasses, and it should just work. The one exception is
  84 the "required" flag, which is not allowed for class attributes.
  85
  86 The accessor methods for class attribute may be called on the class
  87 directly, or on objects of that class. Passing a class attribute to
  88 the constructor will not set it.
  89
  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
  95 One little nit is that if you include C<no Moose> in your class, you
  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
 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.
 107
 108 There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor>
 109 which provides part of the inlining implementation for class
 110 attributes.
 111
 112 =head2 Cooperation with Metaclasses and Traits
 113
 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>.
 117
 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
 139 =head1 AUTHOR
 140
 141 Dave Rolsky, C<< <autarch@urth.org> >>
 142
 143 =head1 BUGS
 144
 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.
 149
 150 =head1 COPYRIGHT & LICENSE
 151
 152 Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
 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