AC-662: Create phpcs static check for AutogeneratedClassNotInConstructorTest

Author: jcuerdo

Magento2/Sniffs/PHP/AutogeneratedClassNotInConstructorSniff.php

@@ -41,7 +41,7 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         if ($phpcsFile->getTokens()[$stackPtr]['type'] === 'T_USE') {
-            $this->registerUses($phpcsFile, $stackPtr);
+            $this->registerUse($phpcsFile, $stackPtr);
         }
         if ($phpcsFile->getTokens()[$stackPtr]['type'] === 'T_FUNCTION') {
             $this->registerConstructorParameters($phpcsFile, $stackPtr);
@@ -59,29 +59,9 @@ public function process(File $phpcsFile, $stackPtr)
                 return;
             }
 
-            $variableInParameters = false;
-            if ($variable = $phpcsFile->findNext(T_VARIABLE, $equalsPtr, $statementEnd)) {
-                $variableName = $phpcsFile->getTokens()[$variable]['content'];
-                if ($variableName === '$this') {
-                    $variableName = $this->getNext($phpcsFile, $variable, $statementEnd, T_STRING)['content'];
-                }
-                foreach ($this->constructorParameters as $parameter) {
-                    $parameterName = $parameter['name'];
-                    if ($this->variableName($parameterName) === $this->variableName($variableName)) {
-                        $variableInParameters = true;
-                    }
-                }
-            }
-
-            if (!$variableInParameters) {
+            if (!$this->isVariableInConstructorParameters($phpcsFile, $equalsPtr, $statementEnd)) {
                 $next = $stackPtr;
-                while ($next = $phpcsFile->findNext(T_DOUBLE_COLON, $next + 1, $statementEnd)) {
-                    if ($this->getNext($phpcsFile, $next, $statementEnd, T_STRING)['content'] === 'class') {
-                        $className = $this->getPrevious($phpcsFile, $next, T_STRING)['content'];
-                    }
-                }
-
-                $className = $this->getClassNamespace($className);
+                $className = $this->obtainClassToGetOrCreate($phpcsFile, $next, $statementEnd);
 
                 $phpcsFile->addWarning(
                     sprintf("Class %s needs to be requested in constructor, " .
@@ -118,9 +98,9 @@ private function isObjectManagerGetInstance(File $phpcsFile, int $stackPtr): boo
      */
     private function getClassNamespace(string $className): string
     {
-        foreach ($this->uses as $use) {
-            if (end($use) === $className) {
-                $className = implode('/', $use);
+        foreach ($this->uses as $key => $use) {
+            if ($key === $className) {
+                return $use;
             }
         }
         return $className;
@@ -132,15 +112,21 @@ private function getClassNamespace(string $className): string
      * @param File $phpcsFile
      * @param int $stackPtr
      */
-    private function registerUses(File $phpcsFile, int $stackPtr): void
+    private function registerUse(File $phpcsFile, int $stackPtr): void
     {
         $useEnd = $phpcsFile->findEndOfStatement($stackPtr);
         $use = [];
         $usePosition = $stackPtr;
         while ($usePosition = $phpcsFile->findNext(T_STRING, $usePosition + 1, $useEnd)) {
             $use[] = $phpcsFile->getTokens()[$usePosition]['content'];
         }
-        $this->uses [] = $use;
+
+        $key = end($use);
+        if ($phpcsFile->findNext(T_AS, $stackPtr, $useEnd)) {
+            $this->uses[$key] = implode("\\", array_slice($use, 0, count($use) - 1));
+        } else {
+            $this->uses[$key] = implode("\\", $use);
+        }
     }
 
     /**
@@ -194,4 +180,44 @@ protected function variableName(string $parameterName): string
     {
         return str_replace('$', '', $parameterName);
     }
+
+    /**
+     * @param File $phpcsFile
+     * @param int $equalsPtr
+     * @param int $statementEnd
+     * @return bool
+     */
+    private function isVariableInConstructorParameters(File $phpcsFile, int $equalsPtr, int $statementEnd): bool
+    {
+        if ($variable = $phpcsFile->findNext(T_VARIABLE, $equalsPtr, $statementEnd)) {
+            $variableName = $phpcsFile->getTokens()[$variable]['content'];
+            if ($variableName === '$this') {
+                $variableName = $this->getNext($phpcsFile, $variable, $statementEnd, T_STRING)['content'];
+            }
+            foreach ($this->constructorParameters as $parameter) {
+                $parameterName = $parameter['name'];
+                if ($this->variableName($parameterName) === $this->variableName($variableName)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param $next
+     * @param int $statementEnd
+     * @return string
+     */
+    private function obtainClassToGetOrCreate(File $phpcsFile, $next, int $statementEnd): string
+    {
+        while ($next = $phpcsFile->findNext(T_DOUBLE_COLON, $next + 1, $statementEnd)) {
+            if ($this->getNext($phpcsFile, $next, $statementEnd, T_STRING)['content'] === 'class') {
+                $className = $this->getPrevious($phpcsFile, $next, T_STRING)['content'];
+            }
+        }
+
+        return $this->getClassNamespace($className);
+    }
 }

Magento2/Tests/PHP/AutogeneratedClassNotInConstructorUnitTest.1.php.inc

@@ -7,7 +7,7 @@ declare(strict_types = 1);
 
 namespace Magento2\Tests\PHP;
 
-use Magento2\Model;
+use Magento2\OneModel as Model;
 
 class Good
 {

Magento2/ruleset.xml

@@ -151,6 +151,7 @@
         <type>warning</type>
     </rule>
     <rule ref="Magento2.Html.HtmlBinding">
+        <include-pattern>*\/.phtml$</include-pattern>
         <severity>9</severity>
         <type>warning</type>
     </rule>
@@ -247,7 +248,7 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
-    <rule ref="Magento2.Legacy.WidgetXML.FoundObsoleteNode">
+    <rule ref="Magento2.Legacy.WidgetXML">
         <include-pattern>*\/widget.xml$</include-pattern>
         <severity>8</severity>
         <type>warning</type>