Make some methods private

[gitmo/Perl-Critic-Dynamic-Moose.git] / lib / Perl / Critic / Policy / DynamicMoose.pm

diff --git a/lib/Perl/Critic/Policy/DynamicMoose.pm b/lib/Perl/Critic/Policy/DynamicMoose.pm
index 068eea3..888ff73 100644 (file)
--- a/lib/Perl/Critic/Policy/DynamicMoose.pm
+++ b/lib/Perl/Critic/Policy/DynamicMoose.pm
@@ -11,6 +11,7 @@ has document => (
 
 sub applies_to { 'PPI::Document' }
 sub applies_to_metaclass { 'Class::MOP::Class', inner() }
+sub default_themes { qw(moose dynamic), inner() }
 
 around violation => sub {
     my $orig    = shift;
@@ -39,9 +40,9 @@ sub violates_dynamic {
 
     $self->document($doc);
 
-    my $old_packages = $self->find_packages;
-    $self->compile_document;
-    my @new_packages = $self->new_packages($old_packages);
+    my $old_packages = $self->_find_packages;
+    $self->_compile_document;
+    my @new_packages = $self->_new_packages($old_packages);
 
     my @violations;
     for my $package (@new_packages) {
@@ -57,7 +58,7 @@ sub violates_dynamic {
     return @violations;
 }
 
-sub compile_document {
+sub _compile_document {
     my $self = shift;
     my $doc = $self->document;
 
@@ -68,12 +69,12 @@ sub compile_document {
     die "Unable to execute " . $doc->filename . ": $@" if $@;
 }
 
-sub find_packages {
+sub _find_packages {
     my $self = shift;
     return [ Class::MOP::get_all_metaclass_names ];
 }
 
-sub new_packages {
+sub _new_packages {
     my $self = shift;
     my $old  = shift;
     my @new;
@@ -81,7 +82,7 @@ sub new_packages {
 
     $seen{$_} = 1 for @$old;
 
-    for (@{ $self->find_packages }) {
+    for (@{ $self->_find_packages }) {
         push @new, $_ if !$seen{$_}++;
     }
 
@@ -92,3 +93,41 @@ no Moose;
 
 1;
 
+__END__
+
+=head1 NAME
+
+Perl::Critic::Policy::DynamicMoose
+
+=head1 DESCRIPTION
+
+The included policies are:
+
+=over 4
+
+=item L<Perl::Critic::Policy::DynamicMoose::ProhibitPublicBuilders>
+
+Prohibit public builder methods for attributes. [Severity: 3]
+
+=back
+
+=head1 WARNING
+
+B<VERY IMPORTANT:> Most L<Perl::Critic> Policies (including all the ones that
+ship with Perl::Critic> use pure static analysis -- they never compile nor
+execute any of the code that they analyze.  However, this policy is very
+different.  It actually attempts to compile your code and then compares the
+subroutines mentioned in your code to those found in the symbol table.
+Therefore you should B<not> use this Policy on any code that you do not trust,
+or may have undesirable side-effects at compile-time (such as connecting to the
+network or mutating files).
+
+For this Policy to work, all the modules included in your code must be
+installed locally, and must compile without error.
+
+=head1 AUTHOR
+
+Shawn M Moore, C<sartak@bestpractical.com>
+
+=cut
+