lib/Moose/Policy/FollowPBP.pm - POD spelling/wording
[gitmo/Moose-Policy.git] / lib / Moose / Policy / FollowPBP.pm
1
2 package Moose::Policy::FollowPBP;
3
4 use constant attribute_metaclass => 'Moose::Policy::FollowPBP::Attribute';
5
6 package Moose::Policy::FollowPBP::Attribute;
7 use Moose;
8
9 extends 'Moose::Meta::Attribute';
10
11 before '_process_options' => sub {
12     my ($class, $name, $options) = @_;
13     # NOTE:
14     # If is has been specified, and 
15     # we don't have a reader or writer
16     # Of couse this is an odd case, but
17     # we better test for it anyway.
18     if (exists $options->{is} && !(exists $options->{reader} || exists $options->{writer})) {
19         if ($options->{is} eq 'ro') {
20             $options->{reader} = 'get_' . $name;
21         }
22         elsif ($options->{is} eq 'rw') {
23             $options->{reader} = 'get_' . $name;
24             $options->{writer} = 'set_' . $name;
25         }
26         delete $options->{is};
27     }
28 };
29
30 1;
31
32 __END__
33
34 =pod
35
36 =head1 NAME 
37
38 Moose::Policy::FollowPBP - Follow the recomendations in Perl Best Practices
39
40 =head1 SYNOPSIS
41
42   package Foo;
43   
44   use Moose::Policy 'Moose::Policy::FollowPBP';
45   use Moose;
46   
47   has 'bar' => (is => 'rw', default => 'Foo::bar');
48   has 'baz' => (is => 'ro', default => 'Foo::baz');
49   
50   # Foo now has (get, set)_bar methods as well as get_baz
51
52 =head1 DESCRIPTION
53
54 This meta-policy changes Moose's default accossor-naming behavior to
55 follow the recommendations found in Damian Conway's book I<Perl Best
56 Practices>.
57
58 =head1 BUGS
59
60 All complex software has bugs lurking in it, and this module is no
61 exception. If you find a bug please either email me, or add the bug
62 to cpan-RT.
63
64 =head1 AUTHOR
65
66 Stevan Little E<lt>stevan@iinteractive.comE<gt>
67
68 =head1 COPYRIGHT AND LICENSE
69
70 Copyright 2006 by Infinity Interactive, Inc.
71
72 L<http://www.iinteractive.com>
73
74 This library is free software; you can redistribute it and/or modify
75 it under the same terms as Perl itself.
76
77 =cut