package MooseX::ClassAttribute;
-use warnings;
use strict;
+use warnings;
-our $VERSION = '0.01';
-our $AUTHORITY = 'cpan:DROLSKY';
+# This module doesn't really need these pragmas - this is just for the benefit
+# of prereq scanning.
+require namespace::clean 0.20;
+require namespace::autoclean 0.11;
+
+use Moose 2.00 ();
+use Moose::Exporter;
+use Moose::Util;
+use MooseX::ClassAttribute::Trait::Class;
+use MooseX::ClassAttribute::Trait::Role;
+use MooseX::ClassAttribute::Trait::Application::ToClass;
+use MooseX::ClassAttribute::Trait::Application::ToRole;
+
+Moose::Exporter->setup_import_methods(
+ with_meta => ['class_has'],
+ class_metaroles => {
+ class => ['MooseX::ClassAttribute::Trait::Class'],
+ },
+ role_metaroles => {
+ role => ['MooseX::ClassAttribute::Trait::Role'],
+ application_to_class =>
+ ['MooseX::ClassAttribute::Trait::Application::ToClass'],
+ application_to_role =>
+ ['MooseX::ClassAttribute::Trait::Application::ToRole'],
+ },
+);
+
+sub class_has {
+ my $meta = shift;
+ my $name = shift;
+
+ my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
+
+ my %options = ( definition_context => _caller_info(), @_ );
+
+ $meta->add_class_attribute( $_, %options ) for @{$attrs};
+}
-use Moose;
-use MooseX::ClassAttribute::Meta::Method::Accessor;
+# Copied from Moose::Util in 2.06
+sub _caller_info {
+ my $level = @_ ? ( $_[0] + 1 ) : 2;
+ my %info;
+ @info{qw(package file line)} = caller($level);
+ return \%info;
+}
-extends 'Moose::Meta::Attribute';
+1;
-sub accessor_metaclass { 'MooseX::ClassAttribute::Meta::Method::Accessor' }
+# ABSTRACT: Declare class attributes Moose-style
-# This is called when an object is constructed.
-sub initialize_instance_slot
-{
- return;
-}
+__END__
+=pod
-# 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;
+=head1 SYNOPSIS
-sub register_implementation { 'MooseX::ClassAttribute' }
+ package My::Class;
+ use Moose;
+ use MooseX::ClassAttribute;
-1;
+ class_has 'Cache' =>
+ ( is => 'rw',
+ isa => 'HashRef',
+ default => sub { {} },
+ );
-__END__
+ __PACKAGE__->meta()->make_immutable();
-=pod
+ no Moose;
+ no MooseX::ClassAttribute;
-=head1 NAME
+ # then later ...
-MooseX::ClassAttribute - The fantastic new MooseX::ClassAttribute!
+ My::Class->Cache()->{thing} = ...;
-=head1 SYNOPSIS
+=head1 DESCRIPTION
-Quick summary of what the module does.
+This module allows you to declare class attributes in exactly the same
+way as object attributes, using C<class_has()> instead of C<has()>.
-Perhaps a little code snippet.
+You can use any feature of Moose's attribute declarations, including
+overriding a parent's attributes, delegation (C<handles>), attribute traits,
+etc. All features should just work. The one exception is the "required" flag,
+which is not allowed for class attributes.
- use MooseX::ClassAttribute;
+The accessor 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 that attribute.
- my $foo = MooseX::ClassAttribute->new();
+=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.
-=head1 METHODS
+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. Or you can just use L<namespace::autoclean>
+instead.
-This class provides the following methods
+=head2 Implementation and Immutability
-=head1 AUTHOR
+This module will add a role to your class's metaclass, See
+L<MooseX::ClassAttribute::Trait::Class> for details. This role
+provides introspection methods for class attributes.
-Dave Rolsky, C<< <autarch@urth.org> >>
+Class attributes themselves do the
+L<MooseX::ClassAttribute::Trait::Attribute> role.
-=head1 BUGS
+=head2 Cooperation with Metaclasses and Traits
+
+This module should work with most attribute metaclasses and traits,
+but it's possible that conflicts could occur. This module has been
+tested to work with Moose's native traits.
+
+=head2 Class Attributes in Roles
-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.
+You can add a class attribute to a role. When that role is applied to a class,
+the class will have the relevant class attributes added. Note that attribute
+defaults will be calculated when the class attribute is composed into the
+class.
-=head1 COPYRIGHT & LICENSE
+=head1 DONATIONS
-Copyright 2007 Dave Rolsky, All Rights Reserved.
+If you'd like to thank me for the work I've done on this module,
+please consider making a "donation" to me via PayPal. I spend a lot of
+free time creating free software, and would appreciate any support
+you'd care to offer.
+
+Please note that B<I am not suggesting that you must do this> in order
+for me to continue working on this particular software. I will
+continue to do so, inasmuch as I have in the past, for as long as it
+interests me.
+
+Similarly, a donation made in this way will probably not make me work
+on this software much more, unless I get so many donations that I can
+consider working on free software full time, which seems unlikely at
+best.
+
+To donate, log into PayPal and send money to autarch@urth.org or use
+the button on this page:
+L<http://www.urth.org/~autarch/fs-donation.html>
+
+=head1 BUGS
-This program is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+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.
=cut
projects / gitmo/MooseX-ClassAttribute.git / blobdiff