AC-662: Create phpcs static check for AutogeneratedClassNotInConstructorTest

Author: jcuerdo

Magento2/Sniffs/PHP/AutogeneratedClassNotInConstructorSniff.php

@@ -15,15 +15,7 @@
  */
 class AutogeneratedClassNotInConstructorSniff implements Sniff
 {
-    const ERROR_CODE = 'AUTOGENERATED_CLASS_NOT_IN_CONSTRUCTOR';
-    /**
-     * @var mixed
-     */
-    private $constructorScopeOpener;
-    /**
-     * @var mixed
-     */
-    private $constructorScopeCloser;
+    private const ERROR_CODE = 'AUTOGENERATED_CLASS_NOT_IN_CONSTRUCTOR';
 
     /**
      * @var array
@@ -55,9 +47,6 @@ public function process(File $phpcsFile, $stackPtr)
             $this->registerConstructorParameters($phpcsFile, $stackPtr);
         }
         if ($phpcsFile->getTokens()[$stackPtr]['type'] === 'T_DOUBLE_COLON') {
-            if (!$this->isInsideConstruct($stackPtr)) {
-                return;
-            }
             if (!$this->isObjectManagerGetInstance($phpcsFile, $stackPtr)) {
                 return;
             }
@@ -73,9 +62,12 @@ public function process(File $phpcsFile, $stackPtr)
             $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 ($parameterName === $variableName) {
+                    if ($this->variableName($parameterName) === $this->variableName($variableName)) {
                         $variableInParameters = true;
                     }
                 }
@@ -91,7 +83,7 @@ public function process(File $phpcsFile, $stackPtr)
 
                 $className = $this->getClassNamespace($className);
 
-                $phpcsFile->addError(
+                $phpcsFile->addWarning(
                     sprintf("Class %s needs to be requested in constructor, " .
                         "otherwise compiler will not be able to find and generate these classes", $className),
                     $stackPtr,
@@ -121,17 +113,6 @@ private function isObjectManagerGetInstance(File $phpcsFile, int $stackPtr): boo
         return false;
     }
 
-    /**
-     * Checks if the code is inside __construct
-     *
-     * @param int $stackPtr
-     * @return bool
-     */
-    private function isInsideConstruct(int $stackPtr): bool
-    {
-        return $stackPtr > $this->constructorScopeOpener && $stackPtr < $this->constructorScopeCloser;
-    }
-
     /**
      * Get the complete class namespace from the use's
      *
@@ -176,36 +157,42 @@ private function registerConstructorParameters(File $phpcsFile, int $stackPtr):
         $functionName = $phpcsFile->getDeclarationName($stackPtr);
         if ($functionName == '__construct') {
             $this->constructorParameters = $phpcsFile->getMethodParameters($stackPtr);
-            $this->constructorScopeOpener = $phpcsFile->getTokens()[$stackPtr]['scope_opener'];
-            $this->constructorScopeCloser = $phpcsFile->getTokens()[$stackPtr]['scope_closer'];
-
         }
     }
 
     /**
      * Get next token
      *
      * @param File $phpcsFile
-     * @param int $nextDoubleColumn
-     * @param int $statementEnd
+     * @param int $from
+     * @param int $to
      * @param int|string|array $types
      * @return mixed
      */
-    private function getNext(File $phpcsFile, int $nextDoubleColumn, int $statementEnd, $types)
+    private function getNext(File $phpcsFile, int $from, int $to, $types)
     {
-        return $phpcsFile->getTokens()[$phpcsFile->findNext($types, $nextDoubleColumn + 1, $statementEnd)];
+        return $phpcsFile->getTokens()[$phpcsFile->findNext($types, $from + 1, $to)];
     }
 
     /**
      * Get previous token
      *
      * @param File $phpcsFile
-     * @param int $nextDoubleColumn
+     * @param int $from
      * @param int|string|array $types
      * @return mixed
      */
-    private function getPrevious(File $phpcsFile, int $nextDoubleColumn, $types)
+    private function getPrevious(File $phpcsFile, int $from, $types)
+    {
+        return $phpcsFile->getTokens()[$phpcsFile->findPrevious($types, $from - 1)];
+    }
+
+    /**
+     * @param $parameterName
+     * @return array|string|string[]
+     */
+    protected function variableName($parameterName)
     {
-        return $phpcsFile->getTokens()[$phpcsFile->findPrevious($types, $nextDoubleColumn - 1)];
+        return str_replace('$', '', $parameterName);
     }
 }

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

@@ -21,9 +21,18 @@ class Good
     /**
      * @return Model
      */
-    public function otherMethodThatCallsGetInstance(): void
+    public function otherMethodThatCallsGetInstanceBad(): void
     {
         $model = ObjectManager::getInstance()->get(Model::class);
         $model->something();
     }
+
+    /**
+     * @return Model
+     */
+    public function otherMethodThatCallsGetInstanceGood(): void
+    {
+        $model = $this->model ?? ObjectManager::getInstance()->get(Model::class);
+        $model->something();
+    }
 }

Magento2/Tests/PHP/AutogeneratedClassNotInConstructorUnitTest.php

@@ -14,11 +14,16 @@ class AutogeneratedClassNotInConstructorUnitTest extends AbstractSniffUnitTest
     /**
      * @inheritdoc
      */
-    public function getErrorList($filename = '')
+    public function getWarningList($filename = '')
     {
+        if ($filename === 'AutogeneratedClassNotInConstructorUnitTest.1.php.inc') {
+            return [
+                26 => 1,
+            ];
+        }
         if ($filename === 'AutogeneratedClassNotInConstructorUnitTest.2.php.inc') {
             return [
-                14 => 1
+                14 => 1,
             ];
         }
         return [];
@@ -27,7 +32,7 @@ public function getErrorList($filename = '')
     /**
      * @inheritdoc
      */
-    public function getWarningList()
+    public function getErrorList()
     {
         return [];
     }