X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FClassAttribute.pm;h=4666903d26935db56a7e2427d5a8670f103e0306;hb=cd8784bb787360b59a0df1d8513633ce2bd593f4;hp=3b899c38da1ec1efaf5ac47221349d0086d6522b;hpb=0f24a39d98269d89db1b902d5c763124ce5fc797;p=gitmo%2FMooseX-ClassAttribute.git diff --git a/lib/MooseX/ClassAttribute.pm b/lib/MooseX/ClassAttribute.pm index 3b899c3..4666903 100644 --- a/lib/MooseX/ClassAttribute.pm +++ b/lib/MooseX/ClassAttribute.pm @@ -1,75 +1,156 @@ 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 instead of C. -Perhaps a little code snippet. +You can use any feature of Moose's attribute declarations, including +overriding a parent's attributes, delegation (C), 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. This +works exactly like Moose's C, but it declares class attributes. -=head1 METHODS +One little nit is that if you include C in your class, you won't +remove the C function. To do that you must include C as well. Or you can just use L +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 for details. This role +provides introspection methods for class attributes. -Dave Rolsky, C<< >> +Class attributes themselves do the +L 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, -or through the web interface at L. 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 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 + +=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, or through the web interface +at L. I will be notified, and then you'll +automatically be notified of progress on your bug as I make changes. =cut