Improved unused uses detection

Author: kukulich

SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php

@@ -64,20 +64,22 @@ public function process(\PHP_CodeSniffer_File $phpcsFile, $openTagPointer)
 			$tokens = $phpcsFile->getTokens();
 			$searchAnnotationsPointer = $openTagPointer + 1;
 			while (true) {
-				$phpDocTokenPointer = $phpcsFile->findNext([T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING], $searchAnnotationsPointer);
-				if ($phpDocTokenPointer === false) {
+				$docCommentPointer = $phpcsFile->findNext([T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING], $searchAnnotationsPointer);
+				if ($docCommentPointer === false) {
 					break;
 				}
 
 				foreach ($unusedNames as $i => $useStatement) {
-					if ($tokens[$phpDocTokenPointer]['code'] === T_DOC_COMMENT_TAG && preg_match('~^@' . preg_quote($useStatement->getNameAsReferencedInFile(), '~') . '(?:[^a-z\\d]|$)~i', $tokens[$phpDocTokenPointer]['content'])) {
-						unset($unusedNames[$i]);
-					} elseif ($tokens[$phpDocTokenPointer]['code'] === T_DOC_COMMENT_STRING && preg_match('~(?:^|[^a-z\\d\\\\])' . preg_quote($useStatement->getNameAsReferencedInFile(), '~') . '(?:[^a-z\\d\\\\]|$)~i', $tokens[$phpDocTokenPointer]['content'])) {
+					$nameAsReferencedInFile = $useStatement->getNameAsReferencedInFile();
+					if (
+						preg_match('~^@' . preg_quote($nameAsReferencedInFile, '~') . '(?=[^a-z\\d]|$)~i', $tokens[$docCommentPointer]['content'])
+						|| preg_match('~(?<=^|[^a-z\\d\\\\])' . preg_quote($nameAsReferencedInFile, '~') . '(?=[^a-z\\d\\\\]|$)~i', $tokens[$docCommentPointer]['content'])
+					) {
 						unset($unusedNames[$i]);
 					}
 				}
 
-				$searchAnnotationsPointer = $phpDocTokenPointer + 1;
+				$searchAnnotationsPointer = $docCommentPointer + 1;
 			}
 		}
 

tests/Sniffs/Namespaces/UnusedUsesSniffTest.php

@@ -94,7 +94,7 @@ public function testUsedUseInAnnotationWithDisabledSearchAnnotations()
 			'searchAnnotations' => false,
 		]);
 
-		$this->assertSame(4, $report->getErrorCount());
+		$this->assertSame(5, $report->getErrorCount());
 
 		$this->assertSniffError(
 			$report,
@@ -110,13 +110,13 @@ public function testUsedUseInAnnotationWithDisabledSearchAnnotations()
 		);
 		$this->assertSniffError(
 			$report,
-			7,
+			8,
 			UnusedUsesSniff::CODE_UNUSED_USE,
 			'Type X is not used in this file.'
 		);
 		$this->assertSniffError(
 			$report,
-			8,
+			9,
 			UnusedUsesSniff::CODE_UNUSED_USE,
 			'Type XX is not used in this file.'
 		);
@@ -132,7 +132,7 @@ public function testUsedUseInAnnotationWithEnabledSearchAnnotations()
 
 		$this->assertSniffError(
 			$report,
-			8,
+			9,
 			UnusedUsesSniff::CODE_UNUSED_USE,
 			'Type XX is not used in this file.'
 		);

tests/Sniffs/Namespaces/data/unusedUsesInAnnotation.php

@@ -4,6 +4,7 @@
 
 use Assert;
 use Doctrine\ORM\Mapping as ORM;
+use Foo\Bar;
 use X;
 use XX;
 
@@ -18,9 +19,15 @@ class Boo
 	 */
 	public $id;
 
+	/**
+	 * @ORM\OneToMany(targetEntity=Bar::class, mappedBy="boo")
+	 * @var \Foo\Bar[]
+	 */
+	private $bars;
+
 	/**
 	 * @Assert
-	 * @Assert\NotBlank(groups={X::SOME_CONSTANT}
+	 * @Assert\NotBlank(groups={X::SOME_CONSTANT})
 	 */
 	public function foo()
 	{