From: ewilhelm <ewilhelm@3efe9002-19ed-0310-8735-a98156148065>
Date: Sat, 5 Aug 2006 23:04:09 +0000 (+0000)
Subject: lib/Moose/Policy.pm - add documentation
X-Git-Tag: 0_01~7
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=8e7059d61ce3df788e3831108c1045d606020d25;p=gitmo%2FMoose-Policy.git

lib/Moose/Policy.pm - add documentation
                      tell thePolicy who is calling so it can respond differently
---

diff --git a/lib/Moose/Policy.pm b/lib/Moose/Policy.pm
index 4cb790e..799a513 100644
--- a/lib/Moose/Policy.pm
+++ b/lib/Moose/Policy.pm
@@ -1,6 +1,7 @@
-
 package Moose::Policy;
 
+# vim:ts=4:sw=4:et:sta
+
 use strict;
 use warnings;
 
@@ -10,43 +11,136 @@ use Moose        ();
 use Carp         'confess';
 use Scalar::Util 'blessed';
 
+=head1 NAME
+
+Moose::Policy - moose-mounted police
+
+=head1 SYNOPSIS
+
+This class allows you to specify your project-wide or company-wide Moose
+meta policy in one location.
+
+  package Foo;
+
+  use Moose::Policy 'My::MooseBestPractice';
+  use Moose;
+
+  has 'bar' => (is => 'rw', default => 'Foo::bar');
+  has 'baz' => (is => 'ro', default => 'Foo::baz');
+
+=head1 USAGE
+
+  use Moose::Policy 'My::Policy';
+  use Moose;
+  ...
+  no Moose;
+
+=over
+
+=item YOU MUST
+
+  use Moose::Policy 'My::Policy';
+
+=item BEFORE
+
+  use Moose;
+
+=back
+
+=head2 The Policy
+
+The argument to C<import()> is a package name.  This package is
+require()'d and queried for the following constants:
+
+=over
+
+=item metaclass 
+
+Defaults to C<'Moose::Meta::Class'>.
+
+=item attribute_metaclass
+
+=item instance_metaclass
+
+=item method_metaclass
+
+=back
+
+These values are then used to setup your $package->meta object.
+
+Your policy package could be simply a list of constants.
+
+  package My::Policy;
+  use constant attribute_metaclass => 'My::Moose::Meta::Attribute';
+
+But the methods are told what package is using the policy, so they could
+concievably give different answers.
+
+  package My::FancyPolicy;
+
+  sub attribute_metaclass {
+    my $self = shift;
+    my ($user_package) = @_;
+    return('Our::Attributes::Stricter')
+      if $user_package =~ m/^Private::Banking::Money/;
+    return('Our::Attributes');
+  }
+
+=head1 AUTHOR
+
+Stevan Little E<lt>stevan@iinteractive.comE<gt>
+
+In response to a feature request by Eric Wilhelm and suggestions by Matt
+Trout.
+
+Documentation and some code are Eric's fault.
+
+=head1 COPYRIGHT AND LICENSE
+
+...
+
+=head1 SEE ALSO
+
+L<Moose>, L<Moose::Meta::Class>
+
+=cut
+
 sub import {
     shift;
-    
+
     my $policy = shift || return;
-    
+
     unless (Moose::_is_class_already_loaded($policy)) {
-        ($policy->require)
-            || confess "Could not load policy module '$policy' because : " . $UNIVERSAL::require::ERROR;
+        ($policy->require) or confess "Could not load policy module " .
+            "'$policy' because : $UNIVERSAL::require::ERROR";
     }
-        
+
+    my $package = caller();
+    $package->can('meta') and
+        croak("'$package' already has a meta() method");
+
     my $metaclass = 'Moose::Meta::Class';
-    $metaclass = $policy->metaclass if $policy->can('metaclass');
-    
+    $metaclass = $policy->metaclass($package)
+        if $policy->can('metaclass');
+
     my %options;
-    
+
     # build options out of policy's constants
-    $policy->can($_) and $options{":$_"} = $policy->$_()
+    $policy->can($_) and $options{":$_"} = $policy->$_($package)
         for (qw(
             attribute_metaclass
             instance_metaclass
             method_metaclass
             ));
-    
-    my $package = caller();
-    $package->can('meta') and
-        croak("'$package' already has a meta() method");
-    
+
     # create a meta object so we can install &meta
     my $meta = $metaclass->initialize($package => %options);
     $meta->add_method('meta' => sub {
-        # we must re-initialize so that it 
-        # works as expected in subclasses, 
-        # since metaclass instances are 
-        # singletons, this is not really a 
-        # big deal anyway.
+        # we must re-initialize so that it works as expected in
+        # subclasses, since metaclass instances are singletons, this is
+        # not really a big deal anyway.
         $metaclass->initialize((blessed($_[0]) || $_[0]) => %options)
-    });    
+    });
 }
 
 1;