package MooseX::ClassAttribute;
-use warnings;
use strict;
+use warnings;
-our $VERSION = '0.01';
+our $VERSION = '0.05';
our $AUTHORITY = 'cpan:DROLSKY';
-use Moose;
-use MooseX::ClassAttribute::Meta::Method::Accessor;
+use Moose ();
+use Moose::Exporter;
+use MooseX::ClassAttribute::Role::Meta::Class;
+use MooseX::ClassAttribute::Role::Meta::Attribute;
-extends 'Moose::Meta::Attribute';
+Moose::Exporter->setup_import_methods
+ ( with_caller => [ 'class_has' ] );
-sub accessor_metaclass { 'MooseX::ClassAttribute::Meta::Method::Accessor' }
-
-# This is called when an object is constructed.
-sub initialize_instance_slot
+sub init_meta
{
- my ( $self, $meta_instance, $instance, $params ) = @_;
-
- return unless $self->has_init_arg();
+ shift;
+ my %p = @_;
- my $init_arg = $self->init_arg();
+ Moose->init_meta(%p);
- confess "Cannot set a class attribute via the constructor ($init_arg)"
- if exists $params->{$init_arg};
-
- return;
+ return
+ Moose::Util::MetaRole::apply_metaclass_roles
+ ( for_class => $p{for_class},
+ metaclass_roles => [ 'MooseX::ClassAttribute::Role::Meta::Class' ],
+ );
}
+sub class_has
+{
+ my $caller = shift;
+ my $name = shift;
+ my %options = @_;
-# This is the bit of magic that lets you specify the metaclass as
-# 'ClassAttribute' rather than the full name when creating an
-# attribute.
-package Moose::Meta::Attribute::Custom::ClassAttribute;
-
-sub register_implementation { 'MooseX::ClassAttribute' }
+ my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
+ Class::MOP::Class
+ ->initialize($caller)
+ ->add_class_attribute( $_, %options )
+ for @{ $attrs };
+}
1;
=head1 NAME
-MooseX::ClassAttribute - The fantastic new MooseX::ClassAttribute!
+MooseX::ClassAttribute - Declare class attributes Moose-style
=head1 SYNOPSIS
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
+ package My::Class;
+ use Moose;
use MooseX::ClassAttribute;
- my $foo = MooseX::ClassAttribute->new();
+ class_has 'Cache' =>
+ ( is => 'rw',
+ isa => 'HashRef',
+ default => sub { {} },
+ );
+
+ __PACKAGE__->meta()->make_immutable();
+ MooseX::ClassAttribute::container_class()->meta()->make_immutable();
+
+ no Moose;
+ no MooseX::ClassAttribute;
+
+ # then later ...
+
+ My::Class->Cache()->{thing} = ...;
+
+
+=head1 DESCRIPTION
+
+This module allows you to declare class attributes in exactly the same
+way as you declare object attributes, except using C<class_has()>
+instead of C<has()>. It is also possible to make these attributes
+immutable (and faster) just as you can with normal Moose attributes.
+
+You can use any feature of Moose's attribute declarations, including
+overriding a parent's attributes, delegation (C<handles>), and
+attribute metaclasses, and it should just work.
+
+The accessors methods for class attribute may be called on the class
+directly, or on objects of that class. Passing a class attribute to
+the constructor will not set it.
+
+=head1 FUNCTIONS
+
+This class exports one function when you use it, C<class_has()>. This
+works exactly like Moose's C<has()>, but it declares class attributes.
+
+One little nit is that if you include C<no Moose> in your class, you
+won't remove the C<class_has()> function. To do that you must include
+C<no MooseX::ClassAttribute> as well.
+
+If you want to use this module to create class attributes in I<other>
+classes, you can call the C<process_class_attribute()> function like
+this:
+
+ MooseX::ClassAttribute::process_class_attribute( $package, ... );
+
+The first argument is the package which will have the class attribute,
+and the remaining arguments are the same as those passed to
+C<class_has()>.
+
+=head2 Implementation and Immutability
+
+Underneath the hood, this class creates one new class for each class
+which has class attributes and sets up delegating methods in the class
+for which you're creating class attributes. You don't need to worry
+about this too much, except when it comes to making a class immutable.
- ...
+Since the class attributes are not really stored in your class, you
+need to make the container class immutable as well as your own ...
-=head1 METHODS
+ __PACKAGE__->meta()->make_immutable();
+ MooseX::ClassAttribute::container_class()->meta()->make_immutable();
-This class provides the following methods
+I<This may change in the future!>
=head1 AUTHOR
=head1 BUGS
-Please report any bugs or feature requests to C<bug-moosex-classattribute@rt.cpan.org>,
-or through the web interface at L<http://rt.cpan.org>. I will be
-notified, and then you'll automatically be notified of progress on
-your bug as I make changes.
+Please report any bugs or feature requests to
+C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface
+at L<http://rt.cpan.org>. I will be notified, and then you'll
+automatically be notified of progress on your bug as I make changes.
=head1 COPYRIGHT & LICENSE