Merge pull request #571 from tariq86/fixes/dev-frag-ns-ignore

Add 'ignore-namespaces' option to DevelopmentCodeFragment
phpmd · Aug 13, 2019 · 9063b80 · 9063b80
2 parents e0a91fa + 6c26e1d
commit 9063b80
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 15 deletions.
diff --git a/src/main/php/PHPMD/Rule/Design/DevelopmentCodeFragment.php b/src/main/php/PHPMD/Rule/Design/DevelopmentCodeFragment.php
@@ -41,9 +41,15 @@ class DevelopmentCodeFragment extends AbstractRule implements MethodAware, Funct
      */
     public function apply(AbstractNode $node)
     {
+        $ignoreNS = $this->getBooleanProperty('ignore-namespaces');
+        $namespace = $node->getNamespaceName();
         foreach ($node->findChildrenOfType('FunctionPostfix') as $postfix) {
-            $image = strtolower($postfix->getImage());
-            if (false === in_array($image, $this->getSuspectImages())) {
+            $fragment = $postfix->getImage();
+            if ($ignoreNS) {
+                $fragment = str_replace("{$namespace}\\", "", $fragment);
+            }
+            $fragment = strtolower($fragment);
+            if (false === in_array($fragment, $this->getSuspectImages())) {
                 continue;
             }
 
@@ -52,7 +58,7 @@ public function apply(AbstractNode $node)
                 $image = sprintf('%s::%s', $node->getParentName(), $node->getImage());
             }
 
-            $this->addViolation($postfix, array($node->getType(), $image, $postfix->getImage()));
+            $this->addViolation($postfix, array($node->getType(), $image, $fragment));
         }
     }
 

diff --git a/src/main/resources/rulesets/design.xml b/src/main/resources/rulesets/design.xml
@@ -206,6 +206,7 @@ just forgotten.
         <priority>2</priority>
         <properties>
             <property name="unwanted-functions" value="var_dump,print_r,debug_zval_dump,debug_print_backtrace" description="Comma separated list of suspect function images." />
+            <property name="ignore-namespaces" value="false" description="Ignore namespaces when looking for dev. fragments" />
         </properties>
         <example>
             <![CDATA[

diff --git a/src/test/php/PHPMD/Rule/Design/DevelopmentCodeFragmentTest.php b/src/test/php/PHPMD/Rule/Design/DevelopmentCodeFragmentTest.php
@@ -36,8 +36,7 @@ class DevelopmentCodeFragmentTest extends AbstractTest
      */
     public function testRuleNotAppliesToMethodWithoutSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(0));
         $rule->apply($this->getMethod());
     }
@@ -49,8 +48,7 @@ public function testRuleNotAppliesToMethodWithoutSuspectFunctionCall()
      */
     public function testRuleAppliesToMethodWithSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(1));
         $rule->apply($this->getMethod());
     }
@@ -62,8 +60,7 @@ public function testRuleAppliesToMethodWithSuspectFunctionCall()
      */
     public function testRuleAppliesToMethodWithMultipleSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(3));
         $rule->apply($this->getMethod());
     }
@@ -75,8 +72,7 @@ public function testRuleAppliesToMethodWithMultipleSuspectFunctionCall()
      */
     public function testRuleNotAppliesToFunctionWithoutSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(0));
         $rule->apply($this->getFunction());
     }
@@ -88,8 +84,7 @@ public function testRuleNotAppliesToFunctionWithoutSuspectFunctionCall()
      */
     public function testRuleAppliesToFunctionWithSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(1));
         $rule->apply($this->getFunction());
     }
@@ -101,9 +96,44 @@ public function testRuleAppliesToFunctionWithSuspectFunctionCall()
      */
     public function testRuleAppliesToFunctionWithMultipleSuspectFunctionCall()
     {
-        $rule = new DevelopmentCodeFragment();
-        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule = $this->getRule();
         $rule->setReport($this->getReportMock(3));
         $rule->apply($this->getFunction());
     }
+
+    /**
+     * testRuleAppliesToMethodWithinNamespace
+     *
+     * @return void
+     */
+    public function testRuleAppliesToMethodWithinNamespace()
+    {
+        $rule = $this->getRule();
+        $rule->addProperty('ignore-namespaces', 'true');
+        $rule->setReport($this->getReportMock(1));
+        $rule->apply($this->getClass());
+    }
+
+    /**
+     * testRuleNotAppliesToMethodWithinNamespaceByDefault
+     *
+     * @return void
+     */
+    public function testRuleNotAppliesToMethodWithinNamespaceByDefault()
+    {
+        $rule = $this->getRule();
+        $rule->setReport($this->getReportMock(0));
+        $rule->apply($this->getClass());
+    }
+
+    /**
+     * Get a configured DevelopmentCodeFragment rule
+     * @return DevelopmentCodeFragment
+     */
+    private function getRule() {
+        $rule = new DevelopmentCodeFragment();
+        $rule->addProperty('unwanted-functions', 'var_dump,print_r,debug_zval_dump,debug_print_backtrace');
+        $rule->addProperty('ignore-namespaces', 'false');
+        return $rule;
+    }
 }
diff --git a/...rces/files/Rule/Design/DevelopmentCodeFragment/testRuleAppliesToMethodWithinNamespace.php b/...rces/files/Rule/Design/DevelopmentCodeFragment/testRuleAppliesToMethodWithinNamespace.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Test\Namespace;
+
+/**
+ * This file is part of PHP Mess Detector.
+ *
+ * Copyright (c) Manuel Pichler <[email protected]>.
+ * All rights reserved.
+ *
+ * Licensed under BSD License
+ * For full copyright and license information, please see the LICENSE file.
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @author Manuel Pichler <[email protected]>
+ * @copyright Manuel Pichler. All rights reserved.
+ * @license https://opensource.org/licenses/bsd-license.php BSD License
+ * @link http://phpmd.org/
+ */
+
+class testRuleAppliesToMethodWithinNamespace {
+    public function __construct($test = 'Test') {
+        var_dump($test);
+    }
+}
diff --git a/...ule/Design/DevelopmentCodeFragment/testRuleNotAppliesToMethodWithinNamespaceByDefault.php b/...ule/Design/DevelopmentCodeFragment/testRuleNotAppliesToMethodWithinNamespaceByDefault.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Test\Namespace;
+
+/**
+ * This file is part of PHP Mess Detector.
+ *
+ * Copyright (c) Manuel Pichler <[email protected]>.
+ * All rights reserved.
+ *
+ * Licensed under BSD License
+ * For full copyright and license information, please see the LICENSE file.
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @author Manuel Pichler <[email protected]>
+ * @copyright Manuel Pichler. All rights reserved.
+ * @license https://opensource.org/licenses/bsd-license.php BSD License
+ * @link http://phpmd.org/
+ */
+
+class testRuleNotAppliesToMethodWithinNamespaceByDefault {
+    public function __construct($test = 'Test') {
+        var_dump($test);
+    }
+}