#26: Add Sniff for Gettersnot change state

Author: Lars Roettig

Magento/Sniffs/Functions/GetterStateSniff.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Sniffs\Functions;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
+
+/**
+ * Detects getter that change the state of an object.
+ */
+class GetterStateSniff implements Sniff
+{
+
+    /**
+     * String representation of warning.
+     *
+     * @var string
+     */
+    protected $warningMessage = 'Getters SHOULD NOT change the state of an object.';
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    protected $warningCode = 'GetterState';
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_FUNCTION];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+
+        if ($methodName === null || strpos($methodName, 'get') === false) {
+            // Ignore closures and no getters
+            return;
+        }
+
+        $tokens = $phpcsFile->getTokens();
+        $open = $tokens[$stackPtr]['scope_opener'];
+        $close = $tokens[$stackPtr]['scope_closer'];
+
+        $isObjectScope = false;
+        $isObjectScopeToken = [T_SELF => T_SELF, T_PARENT => T_PARENT, T_STATIC => T_STATIC];
+
+        for ($i = ($open + 1); $i < $close; $i++) {
+            $token = $tokens[$i];
+
+            if (T_SEMICOLON === $token['code']) {
+                // Detect line end scope change to function scope.
+                $isObjectScope = false;
+            }
+
+            if (array_key_exists($token['code'], $isObjectScopeToken)) {
+                $isObjectScope = true;
+            }
+
+            if ($token['content'] === '$this') {
+                $isObjectScope = true;
+            }
+
+            if ($isObjectScope === true && array_key_exists($token['code'], Tokens::$assignmentTokens)) {
+                $phpcsFile->addWarning($this->warningMessage, $i, $this->warningCode);
+            }
+        }
+    }
+}

Magento/Tests/Functions/GetterStateUnitTest.inc

@@ -0,0 +1,56 @@
+<?php
+
+namespace Foo\Bar;
+
+
+abstract class Bar{
+
+    public static $foobar  = 100;
+}
+
+class Foo extends Bar
+{
+    /**
+     * @var int
+     */
+    private static $staticProperty;
+
+    /**
+     * @var int
+     */
+    private $property;
+
+    /**
+     * @return int
+     */
+    public function getStaticProperty()
+    {
+        self::$staticProperty = 12;
+        static::$staticProperty -= 12;
+        self::$staticProperty .= 12;
+        return self::$staticProperty;
+    }
+
+    /**
+     * @return int
+     */
+    public function getProperty()
+    {
+        $this->property = 1223;
+        return $this->property;
+    }
+
+    /**
+     * @return int
+     */
+    public function normalMethod()
+    {
+        $localVariable = 12;
+        return $localVariable;
+    }
+}
+
+$d = function ($test) {
+    $test = 123;
+};
+

Magento/Tests/Functions/GetterStateUnitTest.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Tests\Functions;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Class GetterStateUnitTest
+ */
+class GetterStateUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    protected function getErrorList()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function getWarningList()
+    {
+        return [
+            28 => 1,
+            29 => 1,
+            30 => 1,
+            39 => 1,
+        ];
+    }
+}

phpunit.xml.dist

@@ -8,4 +8,9 @@
     <php>
         <env name="PHPCS_IGNORE_TESTS" value="Generic,MySource,PEAR,PSR1,PSR2,Squiz,Zend"/>
     </php>
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">Magento/Sniffs</directory>
+        </whitelist>
+    </filter>
 </phpunit>