SlevomatCodingStandard.Commenting.DocCommentSpacing: Fixed internal error

Author: kukulich

SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php

@@ -30,6 +30,7 @@
 use function strpos;
 use function substr;
 use function substr_count;
+use function trim;
 use function uasort;
 use function usort;
 use const T_DOC_COMMENT_OPEN_TAG;
@@ -608,35 +609,43 @@ private function checkAnnotationsGroupsOrder(
 				$fixedAnnotations .= sprintf(
 					'%s * %s%s',
 					$indentation,
-					TokenHelper::getContent($phpcsFile, $sortedAnnotation->getStartPointer(), $sortedAnnotation->getEndPointer()),
+					trim(TokenHelper::getContent($phpcsFile, $sortedAnnotation->getStartPointer(), $sortedAnnotation->getEndPointer())),
 					$phpcsFile->eolChar
 				);
 			}
 		}
 
+		$tokens = $phpcsFile->getTokens();
+		$docCommentCloserPointer = $tokens[$docCommentOpenerPointer]['comment_closer'];
+
 		$endOfLineBeforeFirstAnnotation = TokenHelper::findPreviousContent(
 			$phpcsFile,
 			T_DOC_COMMENT_WHITESPACE,
 			$phpcsFile->eolChar,
 			$firstAnnotation->getStartPointer() - 1,
 			$docCommentOpenerPointer
 		);
-		$endOfLineAfterLastAnnotation = TokenHelper::findNextContent(
+		$docCommentContentEndPointer = TokenHelper::findNextContent(
 			$phpcsFile,
 			T_DOC_COMMENT_WHITESPACE,
 			$phpcsFile->eolChar,
-			$lastAnnotation->getEndPointer() + 1
+			$lastAnnotation->getEndPointer() + 1,
+			$docCommentCloserPointer
 		);
 
+		if ($docCommentContentEndPointer === null) {
+			$docCommentContentEndPointer = $lastAnnotation->getEndPointer();
+		}
+
 		$phpcsFile->fixer->beginChangeset();
 		if ($endOfLineBeforeFirstAnnotation === null) {
 			$phpcsFile->fixer->replaceToken($docCommentOpenerPointer, '/**' . $phpcsFile->eolChar . $fixedAnnotations);
-			for ($i = $docCommentOpenerPointer + 1; $i <= $endOfLineAfterLastAnnotation; $i++) {
+			for ($i = $docCommentOpenerPointer + 1; $i <= $docCommentContentEndPointer; $i++) {
 				$phpcsFile->fixer->replaceToken($i, '');
 			}
 		} else {
 			$phpcsFile->fixer->replaceToken($endOfLineBeforeFirstAnnotation + 1, $fixedAnnotations);
-			for ($i = $endOfLineBeforeFirstAnnotation + 2; $i <= $endOfLineAfterLastAnnotation; $i++) {
+			for ($i = $endOfLineBeforeFirstAnnotation + 2; $i <= $docCommentContentEndPointer; $i++) {
 				$phpcsFile->fixer->replaceToken($i, '');
 			}
 		}

tests/Sniffs/Commenting/DocCommentSpacingSniffTest.php

@@ -147,7 +147,7 @@ public function testAnnotationsGroupsErrors(): void
 			DocCommentSpacingSniff::CODE_INCORRECT_ORDER_OF_ANNOTATIONS_IN_GROUP,
 		]);
 
-		self::assertSame(9, $report->getErrorCount());
+		self::assertSame(10, $report->getErrorCount());
 
 		self::assertSniffError($report, 20, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 		self::assertSniffError($report, 34, DocCommentSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_ANNOTATIONS_GROUPS);
@@ -158,6 +158,7 @@ public function testAnnotationsGroupsErrors(): void
 		self::assertSniffError($report, 83, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 		self::assertSniffError($report, 92, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 		self::assertSniffError($report, 102, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
+		self::assertSniffError($report, 115, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -113,4 +113,14 @@ public function phpstanAndPhpcsAnnotations($a)
 		return false;
 	}
 
+	/**
+	 * @phpstan-return array<string, string>
+	 *
+	 * @return array<string, string>
+*/
+	public function phpstanReturnAndReturnAnnotations()
+	{
+		return [];
+	}
+
 }

tests/Sniffs/Commenting/data/docCommentSpacingAnnotationsGroupsErrors.php

@@ -112,4 +112,11 @@ public function phpstanAndPhpcsAnnotations($a)
 		return false;
 	}
 
+	/** @phpstan-return array<string, string>
+	* @return array<string, string> */
+	public function phpstanReturnAndReturnAnnotations()
+	{
+		return [];
+	}
+
 }