[PHPMD] Add phpmd rule with ignoring of unused required parameters in the plugins

Signed-off-by: Denis Kopylov <[email protected]>

Author: Den4ik

app/code/Magento/Catalog/Plugin/CategoryAuthorization.php

@@ -12,11 +12,12 @@
 use Magento\Catalog\Api\CategoryRepositoryInterface;
 use Magento\Catalog\Model\Category\Authorization;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Interception\PluginInterface;
 
 /**
  * Perform additional authorization for category operations.
  */
-class CategoryAuthorization
+class CategoryAuthorization implements PluginInterface
 {
     /**
      * @var Authorization
@@ -38,7 +39,6 @@ public function __construct(Authorization $authorization)
      * @param CategoryInterface $category
      * @throws LocalizedException
      * @return array
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function beforeSave(CategoryRepositoryInterface $subject, CategoryInterface $category): array
     {

app/code/Magento/Catalog/Plugin/ProductAuthorization.php

@@ -12,11 +12,12 @@
 use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Catalog\Model\Product\Authorization;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Interception\PluginInterface;
 
 /**
  * Perform additional authorization for product operations.
  */
-class ProductAuthorization
+class ProductAuthorization implements PluginInterface
 {
     /**
      * @var Authorization
@@ -39,7 +40,6 @@ public function __construct(Authorization $authorization)
      * @param bool $saveOptions
      * @throws LocalizedException
      * @return array
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function beforeSave(
         ProductRepositoryInterface $subject,

app/code/Magento/Catalog/Plugin/RemoveImagesFromGalleryAfterRemovingProduct.php

@@ -12,11 +12,12 @@
 use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Catalog\Model\Product\Gallery\ReadHandler;
 use Magento\Catalog\Model\ResourceModel\Product\Gallery;
+use Magento\Framework\Interception\PluginInterface;
 
 /**
  * Responsible for deleting images from media gallery after deleting product
  */
-class RemoveImagesFromGalleryAfterRemovingProduct
+class RemoveImagesFromGalleryAfterRemovingProduct implements PluginInterface
 {
     /**
      * @var Gallery
@@ -45,7 +46,6 @@ public function __construct(Gallery $galleryResource, ReadHandler $mediaGalleryR
      * @param callable $proceed
      * @param ProductInterface $product
      * @return bool
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function aroundDelete(
         ProductRepositoryInterface $subject,

dev/tests/static/framework/Magento/CodeMessDetector/Rule/UnusedCode/UnusedFormalParameter.php

@@ -0,0 +1,106 @@
+<?php
+declare(strict_types=1);
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CodeMessDetector\Rule\UnusedCode;
+
+use Magento\Framework\Interception\PluginInterface;
+use PDepend\Source\AST\ASTParameter;
+use PHPMD\AbstractNode;
+use PHPMD\Node\ClassNode;
+use PHPMD\Node\MethodNode;
+use PHPMD\Rule\UnusedFormalParameter as PhpmdUnusedFormalParameter;
+
+class UnusedFormalParameter extends PhpmdUnusedFormalParameter
+{
+    /**
+     * This method collects all local variables in the body of the currently
+     * analyzed method or function and removes those parameters that are
+     * referenced by one of the collected variables.
+     *
+     * @param AbstractNode $node
+     * @return void
+     */
+    protected function removeUsedParameters(AbstractNode $node)
+    {
+        parent::removeUsedParameters($node);
+        $this->removeVariablesUsedInPlugins($node);
+    }
+
+    /**
+     * Remove required method variables used in plugins from given node
+     *
+     * @param AbstractNode $node
+     */
+    private function removeVariablesUsedInPlugins(AbstractNode $node)
+    {
+        if ($node instanceof MethodNode) {
+            /** @var ClassNode $classNode */
+            $classNode = $node->getParentType();
+            $implementInterfaces = class_implements($classNode->getFullQualifiedName());
+            if (array_key_exists(PluginInterface::class, $implementInterfaces)) {
+                /**
+                 * Around and After plugins has 2 required params $subject and $proceed or $result
+                 * that should be ignored
+                 */
+                foreach (['around', 'after'] as $pluginMethodPrefix) {
+                    if ($this->isFunctionNameStartingWith($node, $pluginMethodPrefix)) {
+                        $this->removeVariablesByCount($node, 2);
+
+                        break;
+                    }
+                }
+
+                /**
+                 * Before plugins has 1 required params $subject
+                 * that should be ignored
+                 */
+                if ($this->isFunctionNameStartingWith($node, 'before')) {
+                    $this->removeVariablesByCount($node, 1);
+                }
+            }
+        }
+    }
+
+    /**
+     * Check if the first part of function fully qualified name is equal to $name
+     *
+     * @param MethodNode $node
+     * @param string $name
+     * @return boolean
+     */
+    private function isFunctionNameStartingWith(MethodNode $node, string $name): bool
+    {
+        return (0 === strpos($node->getImage(), $name));
+    }
+
+    /**
+     * Get first $numberOfParams parameters of method
+     *
+     * @param MethodNode $node
+     * @param int $numberOfParams
+     * @return array
+     */
+    private function getMethodParametersByLength(MethodNode $node, int $numberOfParams): array
+    {
+        return array_slice($node->getNode()->getParameters(), 0, $numberOfParams);
+    }
+
+    /**
+     * Remove first $countOfRemovingVariables from given node
+     *
+     * @param MethodNode $node
+     * @param int $countOfRemovingVariables
+     */
+    private function removeVariablesByCount(MethodNode $node, int $countOfRemovingVariables)
+    {
+        $methodParameters = $this->getMethodParametersByLength($node, $countOfRemovingVariables);
+        /** @var ASTParameter $methodParameter */
+        foreach ($methodParameters as $methodParameter) {
+            unset($this->nodes[$methodParameter->getName()]);
+        }
+    }
+}

dev/tests/static/framework/Magento/CodeMessDetector/resources/rulesets/unusedcode.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+
+<ruleset name="Unused Code Rules"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+
+    <rule name="UnusedFormalParameter"
+          message="Avoid unused parameters such as '{0}'."
+          class="Magento\CodeMessDetector\Rule\UnusedCode\UnusedFormalParameter">
+        <description><![CDATA[Avoid passing parameters to methods or constructors and then not using those parameters except on plugins]]></description>
+        <example>
+<![CDATA[
+class Foo
+{
+    private function bar($howdy)
+    {
+        // $howdy is not used
+    }
+}
+]]>
+        </example>
+    </rule>
+
+</ruleset>

dev/tests/static/testsuite/Magento/Test/Php/_files/phpmd/ruleset.xml

@@ -26,7 +26,9 @@
     </rule>
 
     <!-- Unused code rules -->
-    <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/unusedcode.xml">
+        <exclude name="UnusedFormalParameter"/>
+    </rule>
 
     <!-- Code design rules -->
     <rule ref="rulesets/design.xml/NumberOfChildren" />
@@ -45,5 +47,6 @@
     <!-- Magento Specific Rules -->
     <rule ref="Magento/CodeMessDetector/resources/rulesets/design.xml/AllPurposeAction" />
     <rule ref="Magento/CodeMessDetector/resources/rulesets/design.xml/CookieAndSessionMisuse" />
+    <rule ref="Magento/CodeMessDetector/resources/rulesets/unusedcode.xml/UnusedFormalParameter" />
 
 </ruleset>

lib/internal/Magento/Framework/Interception/PluginInterface.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Interception;
+
+/**
+ * Interface for any plugin classes
+ */
+interface PluginInterface
+{
+
+}