X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FPolicy.pm;h=14bdb668e85c6fb45a4db97aba0220237ac0a9b2;hb=cdaa4ee1af431df08155781b9d2f16d3fc872b06;hp=32ee1ee59da9da3cd6422ac2d4a3cabdcb370354;hpb=2756232eadcf7f35de9d19a273b16528d487e7e3;p=gitmo%2FMoose-Policy.git diff --git a/lib/Moose/Policy.pm b/lib/Moose/Policy.pm index 32ee1ee..14bdb66 100644 --- a/lib/Moose/Policy.pm +++ b/lib/Moose/Policy.pm @@ -1,29 +1,24 @@ package Moose::Policy; +use Moose 'confess', 'blessed'; -# vim:ts=4:sw=4:et:sta - -use strict; -use warnings; - -our $VERSION = '0.01'; - -use Moose (); -use Carp 'confess'; -use Scalar::Util 'blessed'; +our $VERSION = '0.04'; +our $AUTHORITY = 'cpan:STEVAN'; sub import { shift; my $policy = shift || return; - unless (Moose::_is_class_already_loaded($policy)) { - ($policy->require) or confess "Could not load policy module " . - "'$policy' because : $UNIVERSAL::require::ERROR"; + unless (Class::MOP::is_class_loaded($policy)) { + # otherwise require it ... + eval { Class::MOP::load_class($policy) }; + confess "Could not load policy module '$policy' because : $@" + if $@; } my $package = caller(); $package->can('meta') and - croak("'$package' already has a meta() method"); + croak("'$package' already has a meta() method, this is very problematic"); my $metaclass = 'Moose::Meta::Class'; $metaclass = $policy->metaclass($package) @@ -32,7 +27,7 @@ sub import { my %options; # build options out of policy's constants - $policy->can($_) and $options{":$_"} = $policy->$_($package) + $policy->can($_) and $options{"$_"} = $policy->$_($package) for (qw( attribute_metaclass instance_metaclass @@ -57,79 +52,120 @@ __END__ =head1 NAME -Moose::Policy - moose-mounted police +Moose::Policy - Moose-mounted police =head1 SYNOPSIS package Foo; - use Moose::Policy 'My::MooseBestPractice'; + use Moose::Policy 'Moose::Policy::FollowPBP'; use Moose; has 'bar' => (is => 'rw', default => 'Foo::bar'); has 'baz' => (is => 'ro', default => 'Foo::baz'); + # Foo now has (get, set)_bar methods as well as get_baz + =head1 DESCRIPTION -This class allows you to specify your project-wide or company-wide Moose -meta policy in one location. +This module allows you to specify your project-wide or even company-wide +Moose meta-policy. -=head1 CAVEAT +Most all of Moose's features can be customized through the use of custom +metaclasses, however fiddling with the metaclasses can be hairy. Moose::Policy +removes most of that hairiness and makes it possible to cleanly contain +a set of meta-level customizations in one easy to use module. -=over 4 +This is still an release of this module and it should not be considered to +be complete by any means. It is very basic implemenation at this point and +will likely get more feature-full over time, as people request features. +So if you have a suggestion/need/idea, please speak up. + +=head2 What is a meta-policy? + +A meta-policy is a set of custom Moose metaclasses which can be used to +implement a number of customizations and restrictions on a particular +Moose class. + +For instance, L enforces that all +specified Moose classes can only use single inheritance. It does this +by trapping the call to C on the metaclass and only allowing +you to assign a single superclass. + +The L policy changes the default behavior of +accessors to fit the recomendations found in Perl Best Practices. + +=head1 CAVEATS + +=head2 Always load Moose::Policy first. -=item YOU MUST +You B put the following line of code: use Moose::Policy 'My::Policy'; -=item BEFORE +before this line: use Moose; -=back +This is because Moose::Policy must be given the opportunity to set the +custom metaclass before Moose has set it's default metaclass. In fact, if +you try to set a Moose::Policy and there is a C method available, +not only will kittens die, but your program will too. + +=head2 Policies are class scoped + +You must repeat the policy for each class you want to use it. It is B +inherited. This may change in the future, probably it will be a Moose::Policy +itself to allow Moose policies to be inherited. -=head2 The Policy +=head1 THE POLICY -The argument to C is a package name. This package is -require()'d and queried for the following constants: +A Policy is set by passing C a package name. This +package is then queried for what metaclasses it should use. The possible +metaclass values are: =over -=item metaclass +=item B -Defaults to C<'Moose::Meta::Class'>. +This defaults to C. -=item attribute_metaclass +=item B -=item instance_metaclass +=item B -=item method_metaclass +=item B =back -These values are then used to setup your $package->meta object. +For examples of what a Policy actually looks like see the examples in +C and the test suite. More docs to come on this later (probably +a cookbook or something). + +=head1 METHODS + +=over 4 -Your policy package could be simply a list of constants. +=item B - package My::Policy; - use constant attribute_metaclass => 'My::Moose::Meta::Attribute'; +=back -But the methods are told what package is using the policy, so they could -concievably give different answers. +=head1 FUTURE PLANS - package My::FancyPolicy; +As I said above, this is the first release and it is by no means feature complete. +There are a number of thoughts on the future direction of this module. Here are +some random thoughts on that, in no particular order. - sub attribute_metaclass { - my $self = shift; - my ($user_package) = @_; - return('Our::Attributes::Stricter') - if $user_package =~ m/^Private::Banking::Money/; - return('Our::Attributes'); - } +=over 4 -=head1 SEE ALSO +=item Make set of policy roles -L, L +Roles are an excellent way to combine sets of behaviors together into one, and +custom metaclasses are actually better composed by roles then by inheritence. +The ideal situation is that this module will provide a set of roles which can be +used to compose your meta-policy with relative ease. + +=back =head1 BUGS @@ -141,11 +177,11 @@ to cpan-RT. Stevan Little Estevan@iinteractive.comE -Eric Wilhelm E...E +Eric Wilhelm =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006-2007 by Infinity Interactive, Inc. L