Merge pull request #20 from sirbrillig/fix/defined-class-used-as-namespace

Differentiate between namespace and class

Author: sirbrillig

ImportDetection/Sniffs/Imports/RequireImportsSniff.php

@@ -152,14 +152,22 @@ private function getIgnoredSymbolPattern() {
 
 	private function isSymbolDefined(File $phpcsFile, Symbol $symbol): bool {
 		$namespace = $symbol->getTopLevelNamespace();
-		// If the symbol's namespace is imported or defined, ignore it
+		// If the symbol's namespace is imported, ignore it
 		if ($namespace) {
-			return $this->isNamespaceImportedOrDefined($phpcsFile, $namespace);
+			return $this->isNamespaceImported($phpcsFile, $namespace);
 		}
 		// If the symbol has no namespace and is itself is imported or defined, ignore it
 		return $this->isNamespaceImportedOrDefined($phpcsFile, $symbol->getName());
 	}
 
+	private function isNamespaceImported(File $phpcsFile, string $namespace): bool {
+		return (
+			$this->isClassImported($phpcsFile, $namespace)
+			|| $this->isFunctionImported($phpcsFile, $namespace)
+			|| $this->isConstImported($phpcsFile, $namespace)
+		);
+	}
+
 	private function isNamespaceImportedOrDefined(File $phpcsFile, string $namespace): bool {
 		return (
 			$this->isClassImported($phpcsFile, $namespace)
@@ -281,8 +289,9 @@ private function markSymbolUsed(File $phpcsFile, Symbol $symbol) {
 
 	private function getRecordedImportedSymbolMatchingSymbol(File $phpcsFile, Symbol $symbol) {
 		foreach ($this->symbolRecordsByFile[$phpcsFile->path]->importedSymbolRecords as $record) {
-			$this->debug("comparing symbol {$symbol->getTopLevelNamespace()} to alias {$record->getAlias()}");
-			if ($record->getAlias() === $symbol->getTopLevelNamespace()) {
+			$namespaceOrAlias = $symbol->getTopLevelNamespace() ?? $symbol->getAlias();
+			$this->debug("comparing symbol {$namespaceOrAlias} to alias {$record->getAlias()}");
+			if ($record->getAlias() === $namespaceOrAlias) {
 				return $record;
 			}
 		}

ImportDetection/Symbol.php

@@ -50,6 +50,9 @@ public function isNamespaced(): bool {
 	 * @return string|null
 	 */
 	public function getTopLevelNamespace() {
+		if (! $this->isNamespaced()) {
+			return null;
+		}
 		return $this->tokens[0]['content'] ?? null;
 	}
 

tests/Sniffs/Imports/ClassUsedAsNamespaceFixture.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Movies;
+
+class Totoro {
+  public function playMovie() {
+    Totoro\startMoviePlayer(); // this should be a warning that `Totoro` is not imported
+  }
+}

tests/Sniffs/Imports/RequireImportsSniffTest.php

@@ -298,4 +298,17 @@ public function testRequireImportsDoesNotBleedToMultipleFiles() {
 		];
 		$this->assertEquals($expectedLines, $linesByFile);
 	}
+
+	public function testRequireImportsFindsUnimportedNamespaceIdenticalToClass() {
+		$fixtureFile = __DIR__ . '/ClassUsedAsNamespaceFixture.php';
+		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
+		$helper = new SniffTestHelper();
+		$phpcsFile = $helper->prepareLocalFileForSniffs($sniffFile, $fixtureFile);
+		$phpcsFile->process();
+		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
+		$expectedLines = [
+			7,
+		];
+		$this->assertEquals($expectedLines, $lines);
+	}
 }