ReferenceUsedNamesOnlySniff: Fixed missing reports

Author: kukulich

SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php

@@ -197,20 +197,21 @@ public function process(File $phpcsFile, $openTagPointer): void
 
 		$references = $this->getReferences($phpcsFile, $openTagPointer);
 
-		$definedClassesIndex = array_flip(array_map(static function (string $className): string {
-			return strtolower($className);
-		}, ClassHelper::getAllNames($phpcsFile)));
+		$definedClassesIndex = [];
+		foreach (ClassHelper::getAllNames($phpcsFile) as $definedClassPointer => $definedClassName) {
+			$definedClassesIndex[strtolower($definedClassName)] = NamespaceHelper::resolveClassName($phpcsFile, $definedClassName, $definedClassPointer);
+		}
 		$definedFunctionsIndex = array_flip(array_map(static function (string $functionName): string {
 			return strtolower($functionName);
 		}, FunctionHelper::getAllFunctionNames($phpcsFile)));
 		$definedConstantsIndex = array_flip(ConstantHelper::getAllNames($phpcsFile));
 
+		$classReferencesIndex = [];
 		if ($this->allowFullyQualifiedNameForCollidingClasses) {
 			$classReferences = array_filter($references, static function (stdClass $reference): bool {
 				return $reference->source === self::SOURCE_CODE && $reference->isClass;
 			});
 
-			$classReferencesIndex = [];
 			foreach ($classReferences as $classReference) {
 				$classReferencesIndex[strtolower($classReference->name)] = NamespaceHelper::resolveName($phpcsFile, $classReference->name, $classReference->type, $classReference->startPointer);
 			}
@@ -242,7 +243,10 @@ public function process(File $phpcsFile, $openTagPointer): void
 			if ($isFullyQualified) {
 				if ($reference->isClass && $this->allowFullyQualifiedNameForCollidingClasses) {
 					$lowerCasedUnqualifiedClassName = strtolower($unqualifiedName);
-					if (array_key_exists($lowerCasedUnqualifiedClassName, $definedClassesIndex)) {
+					if (
+						array_key_exists($lowerCasedUnqualifiedClassName, $definedClassesIndex)
+						&& $canonicalName !== NamespaceHelper::normalizeToCanonicalName($definedClassesIndex[$lowerCasedUnqualifiedClassName])
+					) {
 						continue;
 					}
 
@@ -357,7 +361,11 @@ public function process(File $phpcsFile, $openTagPointer): void
 
 							if (!(
 								$useStatement->getCanonicalNameAsReferencedInFile() === $canonicalNameToReference
-								|| ($reference->isClass && array_key_exists($canonicalNameToReference, $definedClassesIndex))
+								|| (
+									$reference->isClass
+									&& array_key_exists($canonicalNameToReference, $definedClassesIndex)
+									&& $canonicalName !== NamespaceHelper::normalizeToCanonicalName($definedClassesIndex[$canonicalNameToReference])
+								)
 								|| ($reference->isFunction && array_key_exists($canonicalNameToReference, $definedFunctionsIndex))
 								|| ($reference->isConstant && array_key_exists($canonicalNameToReference, $definedConstantsIndex))
 							)) {
@@ -383,14 +391,19 @@ public function process(File $phpcsFile, $openTagPointer): void
 						}
 
 						if ($fix) {
-							$alreadyUsed = false;
+							$addUse = true;
+
+							if ($reference->isClass && array_key_exists($canonicalNameToReference, $definedClassesIndex)) {
+								$addUse = false;
+							}
+
 							foreach ($useStatements as $useStatement) {
 								if ($useStatement->getType() !== $reference->type || $useStatement->getFullyQualifiedTypeName() !== $canonicalName) {
 									continue;
 								}
 
 								$nameToReference = $useStatement->getNameAsReferencedInFile();
-								$alreadyUsed = true;
+								$addUse = false;
 								break;
 							}
 
@@ -420,7 +433,7 @@ public function process(File $phpcsFile, $openTagPointer): void
 								$phpcsFile->fixer->replaceToken($i, '');
 							}
 
-							if (!$alreadyUsed) {
+							if ($addUse) {
 								$useStatementPlacePointer = $this->getUseStatementPlacePointer($phpcsFile, $openTagPointer, $useStatements);
 
 								$useTypeName = UseStatement::getTypeName($reference->type);

tests/Sniffs/Namespaces/ReferenceUsedNamesOnlySniffTest.php

@@ -882,7 +882,7 @@ public function testSearchingInAnnotations(): void
 			]
 		);
 
-		self::assertSame(30, $report->getErrorCount());
+		self::assertSame(31, $report->getErrorCount());
 
 		self::assertSniffError($report, 8, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME, 'Class \Foo\DateTime should not be referenced via a fully qualified name, but via a use statement.');
 		self::assertSniffError($report, 9, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME, 'Class \Foo\DateTime should not be referenced via a fully qualified name, but via a use statement.');
@@ -919,6 +919,8 @@ public function testSearchingInAnnotations(): void
 		self::assertSniffError($report, 121, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME, 'Class \Foo\DateTime should not be referenced via a fully qualified name, but via a use statement.');
 		self::assertSniffError($report, 121, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME, 'Class \Foo\ArrayObject should not be referenced via a fully qualified name, but via a use statement.');
 
+		self::assertSniffError($report, 131, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME, 'Class \Foo\Test\Bla\Whatever should not be referenced via a fully qualified name, but via a use statement.');
+
 		self::assertAllFixedInFile($report);
 	}
 

tests/Sniffs/Namespaces/data/shouldBeInUseStatementSearchingInAnnotations.fixed.php

@@ -128,3 +128,11 @@ class ConstantExpression
 {
 
 }
+
+class Whatever
+{
+
+	/** @var Whatever */
+	private $whatever;
+
+}

tests/Sniffs/Namespaces/data/shouldBeInUseStatementSearchingInAnnotations.php

@@ -124,3 +124,11 @@ class ConstantExpression
 {
 
 }
+
+class Whatever
+{
+
+	/** @var \Foo\Test\Bla\Whatever */
+	private $whatever;
+
+}