Merge pull request #10 from jrbasso/fix-unusedlocalvar-compact

Fix UnusedLocalVariable to recognize compact function.

src/main/php/PHP/PMD/Rule/UnusedLocalVariable.php

@@ -140,6 +140,13 @@ private function collectVariables(PHP_PMD_Node_AbstractCallable $node)
         foreach ($node->findChildrenOfType('VariableDeclarator') as $variable) {
             $this->collectVariable($variable);
         }
+        foreach ($node->findChildrenOfType('FunctionPostfix') as $func) {
+            if ($func->getImage() === 'compact') {
+                foreach ($func->findChildrenOfType('Literal') as $literal) {
+                    $this->_collectLiteral($literal);
+                }
+            }
+        }
     }
 
     /**
@@ -157,6 +164,22 @@ private function collectVariable(PHP_PMD_Node_ASTNode $node)
         $this->images[$node->getImage()][] = $node;
     }
 
+    /**
+     * Stores the given literal node in an internal list of found variables.
+     *
+     * @param PHP_PMD_Node_ASTNode $node The context variable node.
+     *
+     * @return void
+     */
+    private function _collectLiteral(PHP_PMD_Node_ASTNode $node)
+    {
+        $variable = '$' . trim($node->getImage(), '\'');
+        if (!isset($this->_images[$variable])) {
+            $this->_images[$variable] = array();
+        }
+        $this->_images[$variable][] = $node;
+    }
+
     /**
      * Template method that performs the real node image check.
      *

src/test/php/PHP/PMD/Rule/UnusedLocalVariableTest.php

@@ -487,4 +487,25 @@ public function testRuleDoesNotApplyToCatchStatement()
         $rule->setReport($this->getReportMock(0));
         $rule->apply($this->getMethod());
     }
+
+    /**
+     * testRuleDoesNotApplyToCatchStatement
+     *
+     * <code>
+     * class Foo {
+     *     public function bar() {
+     *         $key = 'ok';
+     *         return compact('key');
+     *     }
+     * }
+     * </code>
+     *
+     * @return void
+     */
+    public function testRuleDoesNotApplyToCompactFunction()
+    {
+        $rule = new PHP_PMD_Rule_UnusedLocalVariable();
+        $rule->setReport($this->getReportMock(0));
+        $rule->apply($this->getMethod());
+    }
 }

src/test/resources/files/Rule/UnusedLocalVariable/testRuleDoesNotApplyToCompactFunction.php

@@ -0,0 +1,10 @@
+<?php
+class testRuleDoesNotApplyToCompactFunction
+{
+    public function testRuleDoesNotApplyToCompactFunction()
+    {
+        $key = 'ok';
+        return compact('key');
+    }
+}
+?>