Merge pull request #53 from palbertini/master

Added getStringProperty and rule-setting to change TooManyMethods ignore Regexp
phpmd · Sep 7, 2012 · bc795b6 · bc795b6 · palbertini · Sep 8, 2012
2 parents 22b523c + f0a6ee2
commit bc795b6
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 5 deletions.
diff --git a/src/main/php/PHP/PMD/AbstractRule.php b/src/main/php/PHP/PMD/AbstractRule.php
@@ -410,6 +410,23 @@ public function getStringProperty($name)
 
     }
 
+    /**
+     * Returns the value of a configured property as a string or throws an
+     * exception when no property with <b>$name</b> exists.
+     *
+     * @param string $name The property identifier.
+     *
+     * @return string
+     * @throws OutOfBoundsException When no property for <b>$name</b> exists.
+     */
+    public function getStringProperty($name)
+    {
+        if (isset($this->_properties[$name])) {
+            return (string) $this->_properties[$name];
+        }
+        throw new OutOfBoundsException('Property $' . $name . ' does not exist.');
+    }
+
     /**
      * This method adds a violation to all reports for this violation type and
      * for the given <b>$node</b> instance.

diff --git a/src/main/php/PHP/PMD/Rule/Design/TooManyMethods.php b/src/main/php/PHP/PMD/Rule/Design/TooManyMethods.php
@@ -65,12 +65,19 @@ class PHP_PMD_Rule_Design_TooManyMethods
        extends PHP_PMD_AbstractRule
     implements PHP_PMD_Rule_IClassAware
 {
+    /**
+     * the default regex pattern for ignore method names. override with "ignorepattern" rule setting.
+     *
+     * @var string
+     */
+    const DEFAULT_IGNORE_REGEXP = '(^(set|get))i';
+
     /**
      * Regular expression that filter all methods that are ignored by this rule.
      *
      * @var string
      */
-    private $_ignoreRegexp = '(^(set|get))i';
+    private $_ignoreRegexp;
 
     /**
      * This method checks the number of methods with in a given class and checks
@@ -82,6 +89,12 @@ class PHP_PMD_Rule_Design_TooManyMethods
      */
     public function apply(PHP_PMD_AbstractNode $node)
     {
+        try {
+            $this->_ignoreRegexp = $this->getStringProperty('ignorepattern');
+        } catch (OutOfBoundsException $e) {
+            $this->_ignoreRegexp = self::DEFAULT_IGNORE_REGEXP;
+        }
+
         $threshold = $this->getIntProperty('maxmethods');
         if ($node->getMetric('nom') <= $threshold) {
             return;
@@ -91,11 +104,11 @@ public function apply(PHP_PMD_AbstractNode $node)
             return;
         }
         $this->addViolation(
-            $node, 
+            $node,
             array(
-                $node->getType(), 
-                $node->getName(), 
-                $nom, 
+                $node->getType(),
+                $node->getName(),
+                $nom,
                 $threshold
             )
         );

diff --git a/src/test/php/PHP/PMD/Rule/Design/TooManyMethodsTest.php b/src/test/php/PHP/PMD/Rule/Design/TooManyMethodsTest.php
@@ -135,6 +135,20 @@ public function testRuleIgnoresSetterMethodsInTest()
         $rule->apply($this->_createClassMock(2, array('invoke', 'setClass')));
     }
 
+   /**
+     * testRuleIgnoresCustomMethodsWhenRegexPropertyIsGiven
+     *
+     * @return void
+     */
+    public function testRuleIgnoresCustomMethodsWhenRegexPropertyIsGiven()
+    {
+        $rule = new PHP_PMD_Rule_Design_TooManyMethods();
+        $rule->setReport($this->getReportMock(0));
+        $rule->addProperty('maxmethods', '1');
+        $rule->addProperty('ignorepattern', '(^(set|get|inject))i');
+        $rule->apply($this->_createClassMock(2, array('invoke', 'injectClass')));
+    }
+
     /**
      * testRuleIgnoresGetterAndSetterMethodsInTest
      *