SlevomatCodingStandard.Commenting.DisallowCommentAfterCodeSniff: don't break multi-line string during auto-fix

Author: schlndh

SlevomatCodingStandard/Sniffs/Commenting/DisallowCommentAfterCodeSniff.php

@@ -4,6 +4,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 use SlevomatCodingStandard\Helpers\CommentHelper;
 use SlevomatCodingStandard\Helpers\IndentationHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
@@ -98,6 +99,17 @@ public function process(File $phpcsFile, $commentPointer): void
 			);
 		} elseif ($tokens[$firstNonWhitespacePointerOnLine]['code'] === T_CLOSE_CURLY_BRACKET) {
 			$phpcsFile->fixer->addContent($firstNonWhiteSpacePointerBeforeComment, $phpcsFile->eolChar . $indentation . $commentContent);
+		} elseif (isset(Tokens::$stringTokens[$tokens[$firstPointerOnLine]['code']])) {
+			$prevNonStringToken = TokenHelper::findPreviousExcluding(
+				$phpcsFile,
+				[T_WHITESPACE] + Tokens::$stringTokens,
+				$firstPointerOnLine - 1
+			);
+			$firstTokenOnNonStringTokenLine = TokenHelper::findFirstTokenOnLine($phpcsFile, $prevNonStringToken);
+			$firstNonWhitespacePointerOnNonStringTokenLine = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $prevNonStringToken);
+			$prevLineIndentation = IndentationHelper::getIndentation($phpcsFile, $firstNonWhitespacePointerOnNonStringTokenLine);
+			$phpcsFile->fixer->addContentBefore($firstTokenOnNonStringTokenLine, $prevLineIndentation . $commentContent);
+			$phpcsFile->fixer->addNewline($firstNonWhiteSpacePointerBeforeComment);
 		} else {
 			$phpcsFile->fixer->addContentBefore($firstPointerOnLine, $indentation . $commentContent);
 			$phpcsFile->fixer->addNewline($firstNonWhiteSpacePointerBeforeComment);

tests/Sniffs/Commenting/DisallowCommentAfterCodeSniffTest.php

@@ -17,9 +17,9 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/disallowCommentAfterCodeErrors.php');
 
-		self::assertSame(19, $report->getErrorCount());
+		self::assertSame(23, $report->getErrorCount());
 
-		foreach ([7, 9, 11, 13, 15, 19, 25, 27, 30, 35, 36, 39, 40, 41, 42, 43, 44, 45, 48] as $line) {
+		foreach ([7, 9, 11, 13, 15, 19, 25, 27, 30, 35, 36, 39, 40, 41, 42, 43, 44, 45, 50, 53, 58, 61, 63] as $line) {
 			self::assertSniffError($report, $line, DisallowCommentAfterCodeSniff::CODE_DISALLOWED_COMMENT_AFTER_CODE);
 		}
 

tests/Sniffs/Commenting/data/disallowCommentAfterCodeErrors.fixed.php

@@ -63,6 +63,25 @@ public function method($items)
 				return;
 		}
 
+		// comment
+		doSomething("
+			aaa
+		");
+		// comment
+		doSomething('
+			aaa
+		');
+		$a = rand()
+			? 5
+			// comment
+			: '
+				aaa
+			';
+		// comment
+		doSomething("
+			{$a}
+		");
+
 		// True
 		return true;
 	}

tests/Sniffs/Commenting/data/disallowCommentAfterCodeErrors.php

@@ -45,6 +45,21 @@ public function method($items)
 				return; // Return
 		}
 
+		doSomething("
+			aaa
+		"); // comment
+		doSomething('
+			aaa
+		'); // comment
+		$a = rand()
+			? 5
+			: '
+				aaa
+			'; // comment
+		doSomething("
+			{$a}
+		"); // comment
+
 		return true; // True
 	}