ReferenceUsedNamesOnlySniff: Improved fixer

Author: kukulich

SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php

@@ -4,13 +4,15 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use SlevomatCodingStandard\Helpers\Annotation\GenericAnnotation;
 use SlevomatCodingStandard\Helpers\AnnotationConstantExpressionHelper;
 use SlevomatCodingStandard\Helpers\AnnotationHelper;
 use SlevomatCodingStandard\Helpers\AnnotationTypeHelper;
 use SlevomatCodingStandard\Helpers\ClassHelper;
+use SlevomatCodingStandard\Helpers\CommentHelper;
 use SlevomatCodingStandard\Helpers\ConstantHelper;
 use SlevomatCodingStandard\Helpers\FunctionHelper;
 use SlevomatCodingStandard\Helpers\NamespaceHelper;
@@ -37,6 +39,7 @@
 use function function_exists;
 use function in_array;
 use function sprintf;
+use function strlen;
 use function strtolower;
 use function substr;
 use const T_COMMA;
@@ -572,14 +575,41 @@ private function getUseStatementPlacePointer(File $phpcsFile, int $openTagPointe
 			return $useStatementPlacePointer;
 		}
 
-		$pointerAfterOpenTagPointer = TokenHelper::findNextEffective($phpcsFile, $openTagPointer + 1);
-		if ($phpcsFile->getTokens()[$pointerAfterOpenTagPointer]['code'] === T_DECLARE) {
-			/** @var int $useStatementPlacePointer */
-			$useStatementPlacePointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $pointerAfterOpenTagPointer + 1);
-			return $useStatementPlacePointer;
+		$tokens = $phpcsFile->getTokens();
+
+		$useStatementPlacePointer = $openTagPointer;
+
+		$nonWhitespacePointerAfterOpenTag = TokenHelper::findNextExcluding($phpcsFile, T_WHITESPACE, $openTagPointer + 1);
+		if (in_array($tokens[$nonWhitespacePointerAfterOpenTag]['code'], Tokens::$commentTokens, true)) {
+			$commentEndPointer = CommentHelper::getCommentEndPointer($phpcsFile, $nonWhitespacePointerAfterOpenTag);
+
+			if (substr($tokens[$commentEndPointer]['content'], -strlen($phpcsFile->eolChar)) === $phpcsFile->eolChar) {
+				$useStatementPlacePointer = $commentEndPointer;
+			} else {
+				$newLineAfterComment = $commentEndPointer + 1;
+
+				if (array_key_exists($newLineAfterComment, $tokens) && $tokens[$newLineAfterComment]['content'] === $phpcsFile->eolChar) {
+					$pointerAfterCommentEnd = TokenHelper::findNextExcluding($phpcsFile, T_WHITESPACE, $newLineAfterComment + 1);
+
+					if (TokenHelper::findNextContent(
+						$phpcsFile,
+						T_WHITESPACE,
+						$phpcsFile->eolChar,
+						$newLineAfterComment + 1,
+						$pointerAfterCommentEnd
+					) !== null) {
+						$useStatementPlacePointer = $commentEndPointer;
+					}
+				}
+			}
+		}
+
+		$pointerAfter = TokenHelper::findNextEffective($phpcsFile, $useStatementPlacePointer + 1);
+		if ($tokens[$pointerAfter]['code'] === T_DECLARE) {
+			return TokenHelper::findNext($phpcsFile, T_SEMICOLON, $pointerAfter + 1);
 		}
 
-		return $openTagPointer;
+		return $useStatementPlacePointer;
 	}
 
 	private function isRequiredToBeUsed(string $name): bool

tests/Sniffs/Namespaces/ReferenceUsedNamesOnlySniffTest.php

@@ -987,4 +987,40 @@ public function testReferencingGlobalTypesInGlobalNamespace(): void
 		self::assertNoSniffErrorInFile($report);
 	}
 
+	public function testWithFileComment(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/referenceUsedNamesOnlyWithFileComment.php');
+
+		self::assertSniffError($report, 11, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testWithFileCommentAndDeclare(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/referenceUsedNamesOnlyWithFileCommentAndDeclare.php');
+
+		self::assertSniffError($report, 13, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testWithInlineFileComment(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/referenceUsedNamesOnlyWithInlineFileComment.php');
+
+		self::assertSniffError($report, 9, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testWithClassComment(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/referenceUsedNamesOnlyWithClassComment.php');
+
+		self::assertSniffError($report, 11, ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME);
+
+		self::assertAllFixedInFile($report);
+	}
+
 }

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

@@ -0,0 +1,15 @@
+<?php
+
+use F\Q\N;
+/**
+ * Class comment
+ */
+class Foo
+{
+
+	public function test()
+	{
+		N::doStuff();
+	}
+
+}

tests/Sniffs/Namespaces/data/referenceUsedNamesOnlyWithClassComment.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Class comment
+ */
+class Foo
+{
+
+	public function test()
+	{
+		\F\Q\N::doStuff();
+	}
+
+}

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

@@ -0,0 +1,15 @@
+<?php
+/*
+ * File header
+ */
+use F\Q\N;
+
+class Foo
+{
+
+	public function test()
+	{
+		N::doStuff();
+	}
+
+}

tests/Sniffs/Namespaces/data/referenceUsedNamesOnlyWithFileComment.php

@@ -0,0 +1,14 @@
+<?php
+/*
+ * File header
+ */
+
+class Foo
+{
+
+	public function test()
+	{
+		\F\Q\N::doStuff();
+	}
+
+}

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

@@ -0,0 +1,17 @@
+<?php
+/*
+ * File header
+ */
+
+declare(strict_types = 1);
+use F\Q\N;
+
+class Foo
+{
+
+	public function test()
+	{
+		N::doStuff();
+	}
+
+}

tests/Sniffs/Namespaces/data/referenceUsedNamesOnlyWithFileCommentAndDeclare.php

@@ -0,0 +1,16 @@
+<?php
+/*
+ * File header
+ */
+
+declare(strict_types = 1);
+
+class Foo
+{
+
+	public function test()
+	{
+		\F\Q\N::doStuff();
+	}
+
+}

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

@@ -0,0 +1,13 @@
+<?php
+// File header
+
+use F\Q\N;
+class Foo
+{
+
+	public function test()
+	{
+		N::doStuff();
+	}
+
+}

tests/Sniffs/Namespaces/data/referenceUsedNamesOnlyWithInlineFileComment.php

@@ -0,0 +1,12 @@
+<?php
+// File header
+
+class Foo
+{
+
+	public function test()
+	{
+		\F\Q\N::doStuff();
+	}
+
+}