« blib/lib/Perl/Critic/Policy/Moose/RequireCleanNamespace.pm
↑ Summary
blib/lib/Perl/Critic/Policy/Moose/ProhibitNewMethod.pm »
| 1 | # $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/distributions/Perl-Critic-Moose/lib/Perl/Critic/Moose.pm $ | ||
| 2 | # $Date: 2009-05-15 19:35:37 -0500 (Fri, 15 May 2009) $ | ||
| 3 | # $Author: clonezone $ | ||
| 4 | # $Revision: 3336 $ | ||
| 5 | |||
| 6 | package Perl::Critic::Moose; | ||
| 7 | |||
| 8 | use 5.008; # Moose's minimum version. | ||
| 9 | |||
| 10 | use strict; | ||
| 11 | use warnings; | ||
| 12 | |||
| 13 | our $VERSION = '0.999_002'; | ||
| 14 | |||
| 15 | 1; # Magic true value required at end of module | ||
| 16 | |||
| 17 | __END__ | ||
| 18 | |||
| 19 | =for stopwords | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Perl::Critic::Moose - Policies for Perl::Critic concerned with using Moose, the "post-modern" object system for Perl. | ||
| 24 | |||
| 25 | |||
| 26 | =head1 AFFILIATION | ||
| 27 | |||
| 28 | This module has no functionality, but instead contains documentation for this | ||
| 29 | distribution and acts as a means of pulling other modules into a bundle. All | ||
| 30 | of the Policy modules contained herein will have an "AFFILIATION" section | ||
| 31 | announcing their participation in this grouping. | ||
| 32 | |||
| 33 | |||
| 34 | =head1 VERSION | ||
| 35 | |||
| 36 | This document describes Perl::Critic::Moose version 0.999_002. | ||
| 37 | |||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | Some L<Perl::Critic> policies that will help you keep your code in good shape | ||
| 42 | with regards to L<Moose>. | ||
| 43 | |||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | The included policies are: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item L<Perl::Critic::Policy::Moose::ProhibitMultipleWiths> | ||
| 52 | |||
| 53 | Compose your roles to enjoy safe composition. [Severity: 4] | ||
| 54 | |||
| 55 | |||
| 56 | =item L<Perl::Critic::Policy::Moose::ProhibitNewMethod> | ||
| 57 | |||
| 58 | Don't override the built-in constructors. [Severity: 4] | ||
| 59 | |||
| 60 | |||
| 61 | =item L<Perl::Critic::Policy::Moose::RequireCleanNamespace> | ||
| 62 | |||
| 63 | Require removing implementation details from you packages. [Severity: 3] | ||
| 64 | |||
| 65 | |||
| 66 | =item L<Perl::Critic::Policy::Moose::RequireMakeImmutable> | ||
| 67 | |||
| 68 | Increase performance by freezing your class structures with | ||
| 69 | C<< __PACKAGE__->meta()->make_immutable() >>. [Severity: 3] | ||
| 70 | |||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | |||
| 75 | =head1 INTERFACE | ||
| 76 | |||
| 77 | None. This is nothing but documentation. | ||
| 78 | |||
| 79 | |||
| 80 | =head1 DIAGNOSTICS | ||
| 81 | |||
| 82 | None. This is nothing but documentation. | ||
| 83 | |||
| 84 | |||
| 85 | =head1 CONFIGURATION AND ENVIRONMENT | ||
| 86 | |||
| 87 | All policies included are in the "moose" theme. See the | ||
| 88 | L<Perl::Critic> documentation for how to make use of this. | ||
| 89 | |||
| 90 | |||
| 91 | =head1 DEPENDENCIES | ||
| 92 | |||
| 93 | L<Perl::Critic> | ||
| 94 | |||
| 95 | |||
| 96 | =head1 INCOMPATIBILITIES | ||
| 97 | |||
| 98 | None reported. | ||
| 99 | |||
| 100 | |||
| 101 | =head1 BUGS AND LIMITATIONS | ||
| 102 | |||
| 103 | No bugs have been reported. | ||
| 104 | |||
| 105 | Please report any bugs or feature requests to | ||
| 106 | C<bug-perl-critic-moose@rt.cpan.org>, or through the web interface at | ||
| 107 | L<http://rt.cpan.org>. | ||
| 108 | |||
| 109 | |||
| 110 | =head1 AUTHOR | ||
| 111 | |||
| 112 | Elliot Shank C<< <perl@galumph.com> >> | ||
| 113 | |||
| 114 | |||
| 115 | =head1 COPYRIGHT | ||
| 116 | |||
| 117 | Copyright (c)2008-2009, Elliot Shank C<< <perl@galumph.com> >>. Some rights | ||
| 118 | reserved. | ||
| 119 | |||
| 120 | This module is free software; you can redistribute it and/or modify it under | ||
| 121 | the same terms as Perl itself. See L<perlartistic>. | ||
| 122 | |||
| 123 | |||
| 124 | =head1 DISCLAIMER OF WARRANTY | ||
| 125 | |||
| 126 | BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE | ||
| 127 | SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE | ||
| 128 | STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE | ||
| 129 | SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, | ||
| 130 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | ||
| 131 | FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND | ||
| 132 | PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, | ||
| 133 | YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. | ||
| 134 | |||
| 135 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY | ||
| 136 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE | ||
| 137 | SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, | ||
| 138 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING | ||
| 139 | OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO | ||
| 140 | LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR | ||
| 141 | THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER | ||
| 142 | SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | ||
| 143 | POSSIBILITY OF SUCH DAMAGES. | ||
| 144 | |||
| 145 | |||
| 146 | =cut | ||
| 147 | |||
| 148 | # Local Variables: | ||
| 149 | # mode: cperl | ||
| 150 | # cperl-indent-level: 4 | ||
| 151 | # fill-column: 78 | ||
| 152 | # indent-tabs-mode: nil | ||
| 153 | # c-indentation-style: bsd | ||
| 154 | # End: | ||
| 155 | # setup vim: set filetype=perl tabstop=4 softtabstop=4 expandtab : | ||
| 156 | # setup vim: set shiftwidth=4 shiftround textwidth=78 nowrap autoindent : | ||
| 157 | # setup vim: set foldmethod=indent foldlevel=0 : |