Allow non-enum tokens called 'enum' (#293)

* Allow non-enum tokens called 'enum' * Fix spacing issue * Do not stop scanning if we are not an enum
sirbrillig · Mar 13, 2023 · d8a00fb · d8a00fb
1 parent 241ddec
commit d8a00fb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 17 deletions.
diff --git a/Tests/VariableAnalysisSniff/fixtures/EnumFixture.php b/Tests/VariableAnalysisSniff/fixtures/EnumFixture.php
@@ -37,3 +37,15 @@ public function foobar(): string {
     };
   }
 }
+
+final class Test
+{
+    public function __construct(private SomeClass $someClass)
+    {
+    }
+
+    public function createFor()
+    {
+        $this->someClass->enum('test');
+    }
+}
diff --git a/VariableAnalysis/Lib/Helpers.php b/VariableAnalysis/Lib/Helpers.php
@@ -1298,7 +1298,7 @@ public static function isTokenVariableVariable(File $phpcsFile, $stackPtr)
 	 * @param File $phpcsFile
 	 * @param int  $stackPtr
 	 *
-	 * @return EnumInfo
+	 * @return EnumInfo|null
 	 */
 	public static function makeEnumInfo(File $phpcsFile, $stackPtr)
 	{
@@ -1314,7 +1314,7 @@ public static function makeEnumInfo(File $phpcsFile, $stackPtr)
 
 			$blockStart = $phpcsFile->findNext([T_OPEN_CURLY_BRACKET], $stackPtr + 1);
 			if (! is_int($blockStart)) {
-				throw new \Exception("Cannot find enum start at position {$stackPtr}");
+				return null;
 			}
 			$blockEnd = $tokens[$blockStart]['bracket_closer'];
 		}

diff --git a/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php b/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php
@@ -278,8 +278,13 @@ public function process(File $phpcsFile, $stackPtr)
 
 		// Record enums so we can detect them even before phpcs was able to.
 		if ($token['content'] === 'enum') {
-			$this->recordEnum($phpcsFile, $stackPtr);
-			return;
+			$enumInfo = Helpers::makeEnumInfo($phpcsFile, $stackPtr);
+			// The token might not actually be an enum so let's avoid returning if
+			// it's not.
+			if ($enumInfo) {
+				$this->enums[$stackPtr] = $enumInfo;
+				return;
+			}
 		}
 
 		// If the current token is a call to `get_defined_vars()`, consider that a
@@ -303,19 +308,6 @@ public function process(File $phpcsFile, $stackPtr)
 		}
 	}
 
-	/**
-	 * Record the boundaries of an enum.
-	 *
-	 * @param File $phpcsFile
-	 * @param int  $stackPtr
-	 *
-	 * @return void
-	 */
-	private function recordEnum($phpcsFile, $stackPtr)
-	{
-		$this->enums[$stackPtr] = Helpers::makeEnumInfo($phpcsFile, $stackPtr);
-	}
-
 	/**
 	 * Record the boundaries of a for loop.
 	 *