Login
Initial, dumb implementation of
authorElliot Shank <perl@galumph.com>
Mon, 19 May 2008 04:24:38 +0000 (04:24 +0000)
committerElliot Shank <perl@galumph.com>
Mon, 19 May 2008 04:24:38 +0000 (04:24 +0000)
Variables::ProhibitUnusedVariables.  And, whadayaknow, it
found problems in one of the examples.  Hurrah!

examples/generatestats
lib/Perl/Critic/Policy/Variables/ProhibitPunctuationVars.pm
lib/Perl/Critic/Policy/Variables/ProhibitUnusedVariables.pm [new file with mode: 0644]
t/Variables/ProhibitUnusedVariables.run [new file with mode: 0644]

index 97078d1..4c864de 100755 (executable)
@@ -63,13 +63,10 @@ sub summarize {
     my %total_policies;
     my %types;
     my %files;
-    my %results;
 
     foreach my $file ( @{$files} ) {
         my $relative_path;
         my $type;
-        my %severities;
-        my %policies;
 
         if ($file eq $path) {
             $relative_path = $file;
index e79d576..7e959ec 100644 (file)
@@ -100,7 +100,7 @@ punctuation variables.
 
 =head1 BUGS
 
-This doesn't find punctionation variables in strings.
+This doesn't find punctuation variables in strings.
 
 
 =head1 AUTHOR
diff --git a/lib/Perl/Critic/Policy/Variables/ProhibitUnusedVariables.pm b/lib/Perl/Critic/Policy/Variables/ProhibitUnusedVariables.pm
new file mode 100644 (file)
index 0000000..0b87e7b
--- /dev/null
@@ -0,0 +1,167 @@
+##############################################################################
+#      $URL$
+#     $Date$
+#   $Author$
+# $Revision$
+##############################################################################
+
+package Perl::Critic::Policy::Variables::ProhibitUnusedVariables;
+
+use strict;
+use warnings;
+
+use Readonly;
+
+use PPI::Token::Symbol;
+
+use Perl::Critic::Utils qw< :characters :severities >;
+use base 'Perl::Critic::Policy';
+
+our $VERSION = '1.083_004';
+
+#-----------------------------------------------------------------------------
+
+Readonly::Scalar my $EXPL =>
+    q<Unused variables clutter code and make it harder to read>;
+
+#-----------------------------------------------------------------------------
+
+sub supported_parameters { return ()                     }
+sub default_severity     { return $SEVERITY_LOW          }
+sub default_themes       { return qw< core maintenance > }
+sub applies_to           { return qw< PPI::Document >    }
+
+#-----------------------------------------------------------------------------
+
+# "my" "$x" ";"
+Readonly::Scalar my $TOKENS_IN_SIMPLE_DECLARATION   => 3;
+
+sub violates {
+    my ( $self, $elem, $document ) = @_;
+
+    my %symbol_usage = _get_symbol_usage($document);
+    return if not %symbol_usage;
+
+    my $declarations = $document->find('PPI::Statement::Variable');
+    return if not $declarations;
+
+    my @violations;
+    foreach my $declaration ( @{$declarations} ) {
+        next if 'my' ne $declaration->type();
+
+        my @children = $declaration->schildren();
+        next if @children > $TOKENS_IN_SIMPLE_DECLARATION;
+        next if
+                @children == $TOKENS_IN_SIMPLE_DECLARATION
+            and $children[2] ne $SCOLON;
+
+        my @variables = $declaration->variables();
+        next if not @variables;
+        next if @variables > 1;
+
+        my $symbol = $variables[0];
+        if (not ref $symbol) {
+            # It's actually a string.  But test in case this changes
+            # in the future.
+            $symbol = PPI::Token::Symbol->new($symbol);
+        }
+        my $count = $symbol_usage{ $symbol->symbol() };
+        next if not $count; # BUG!
+        next if $count > 1;
+
+        push
+            @violations,
+            $self->violation(
+                qq<"$symbol" is declared but not used.>,
+                $EXPL,
+                $declaration,
+            );
+    }
+
+    return @violations;
+}
+
+sub _get_symbol_usage {
+    my ($document) = @_;
+
+    my $symbols = $document->find('PPI::Token::Symbol');
+    return if not $symbols;
+
+    my %symbol_usage;
+    foreach my $symbol ( @{$symbols} ) {
+        $symbol_usage{ $symbol->symbol() }++;
+    }
+
+    return %symbol_usage;
+}
+
+#-----------------------------------------------------------------------------
+
+1;
+
+__END__
+
+#-----------------------------------------------------------------------------
+
+=pod
+
+=head1 NAME
+
+Perl::Critic::Policy::Variables::ProhibitUnusedVariables - Don't ask for storage you don't need.
+
+=head1 AFFILIATION
+
+This Policy is part of the core L<Perl::Critic> distribution.
+
+
+=head1 DESCRIPTION
+
+Unused variables clutter code and require the reader to do mental
+bookkeeping to figure out if the variable is actually used or not.
+
+At present, this Policy is very limited in order to ensure that there
+aren't any false positives.  Hopefully, this will become more
+sophisticated soon.
+
+Right now, this only looks for simply declared, uninitialized lexical
+variables.
+
+    my $x;          # not ok, assuming no other appearances.
+    my @y = ();     # ok, not handled yet.
+    our $z;         # ok, global.
+    local $w;       # ok, global.
+
+This module is very dumb: it does no scoping detection, i.e. if the
+same variable name is used in two different locations, even if they
+aren't the same variable, this Policy won't complain.
+
+Have to start somewhere.
+
+
+=head1 CONFIGURATION
+
+This Policy is not configurable except for the standard options.
+
+
+=head1 AUTHOR
+
+Elliot Shank C<< <perl@galumph.com> >>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2008 Elliot Shank.  All rights reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.  The full text of this license
+can be found in the LICENSE file included with this module.
+
+=cut
+
+# Local Variables:
+#   mode: cperl
+#   cperl-indent-level: 4
+#   fill-column: 78
+#   indent-tabs-mode: nil
+#   c-indentation-style: bsd
+# End:
+# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
diff --git a/t/Variables/ProhibitUnusedVariables.run b/t/Variables/ProhibitUnusedVariables.run
new file mode 100644 (file)
index 0000000..b247e22
--- /dev/null
@@ -0,0 +1,122 @@
+## name Simple unused, single, unassigned lexical.
+## failures 1
+## cut
+
+my $x;
+
+#-----------------------------------------------------------------------------
+
+## name Simple unused, multiple, unassigned lexicals.  Not going to handle this yet.
+## failures 0
+## cut
+
+my $x, @z, %y;
+
+#-----------------------------------------------------------------------------
+
+## name Simple unused assigned lexicals.  Not going to handle this yet.
+## failures 0
+## cut
+
+# Need to look out for RAII.
+my $y = foo();
+
+#-----------------------------------------------------------------------------
+
+## name Simple unused explicit global.
+## failures 0
+## cut
+
+our $x;
+
+#-----------------------------------------------------------------------------
+
+## name Simple unused implicit global.
+## failures 0
+## cut
+
+$x;
+
+#-----------------------------------------------------------------------------
+
+## name Simple unused localized.
+## failures 0
+## cut
+
+local $x;
+
+#-----------------------------------------------------------------------------
+
+## name Simple used lexical scalar.
+## failures 0
+## cut
+
+my $x = 1;
+
+print $x;
+
+#-----------------------------------------------------------------------------
+
+## name Simple used lexical array.
+## failures 0
+## cut
+
+my @x;
+
+$x[0] = 5;
+
+#-----------------------------------------------------------------------------
+
+## name Simple used lexical hash.
+## failures 0
+## cut
+
+my %foo;
+
+$foo{bar} = -24;
+
+#-----------------------------------------------------------------------------
+
+## name Shadowed variable.  No going to handle this yet.
+## failures 0
+## cut
+
+my $x = 2;
+
+{
+    my $x = 1;
+    blah();
+}
+
+#-----------------------------------------------------------------------------
+
+## name Separate lexicals.  No going to handle this yet.
+## failures 0
+## cut
+
+{
+    my $x = 2;
+}
+
+{
+    my $x = 1;
+    blah();
+}
+
+#-----------------------------------------------------------------------------
+
+##############################################################################
+#      $URL$
+#     $Date$
+#   $Author$
+# $Revision$
+##############################################################################
+
+# Local Variables:
+#   mode: cperl
+#   cperl-indent-level: 4
+#   fill-column: 78
+#   indent-tabs-mode: nil
+#   c-indentation-style: bsd
+# End:
+# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :