Merge pull request #189 from milindsingh/deprecated-methods

Added sniff for deprecated model methods. #187

Author: lenaorobei

Magento2/Sniffs/Methods/DeprecatedModelMethodSniff.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\Methods;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects possible use of deprecated model methods.
+ */
+class DeprecatedModelMethodSniff implements Sniff
+{
+    const RESOURCE_METHOD = "getResource";
+
+    /**
+     * String representation of warning.
+     *
+     * @var string
+     */
+    protected $warningMessage = "The use of the deprecated method 'getResource()' to '%s' the data detected.";
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    protected $warningCode = 'FoundDeprecatedModelMethod';
+
+    /**
+     * List of deprecated method.
+     *
+     * @var array
+     */
+    protected $methods = [
+        'save',
+        'load',
+        'delete'
+    ];
+
+    protected $severity = 0;
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [
+            T_OBJECT_OPERATOR
+        ];
+    }
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $endOfStatement = $phpcsFile->findEndOfStatement($stackPtr);
+        $resourcePosition = $phpcsFile->findNext(
+            T_STRING,
+            $stackPtr + 1,
+            $endOfStatement,
+            false,
+            self::RESOURCE_METHOD
+        );
+        if ($resourcePosition !== false) {
+            $methodPosition = $phpcsFile->findNext([T_STRING, T_VARIABLE], $resourcePosition + 1, $endOfStatement);
+            if ($methodPosition !== false && in_array($tokens[$methodPosition]['content'], $this->methods, true)) {
+                $phpcsFile->addWarning(
+                    sprintf($this->warningMessage, $tokens[$methodPosition]['content']),
+                    $stackPtr,
+                    $this->warningCode
+                );
+            }
+        }
+    }
+}

Magento2/Tests/Methods/DeprecatedModelMethodUnitTest.inc

@@ -0,0 +1,13 @@
+<?php
+
+$model->getResource()->save($model);
+
+$model->getResource()->load($model, $id);
+
+$model->getResource()->delete($model);
+
+$model->getResource()->myCustomMethod();
+
+$model->myCustomMethod();
+
+$model->anotherMethodWithResource()->save($model);

Magento2/Tests/Methods/DeprecatedModelMethodUnitTest.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Methods;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class DeprecatedModelMethodUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList()
+    {
+        return [
+            3 => 1,
+            5 => 1,
+            7 => 1,
+        ];
+    }
+}

Magento2/ruleset.xml

@@ -215,6 +215,10 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento2.Methods.DeprecatedModelMethod">
+        <severity>8</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 7 warnings: General code issues. -->
     <rule ref="Generic.Arrays.DisallowLongArraySyntax">