SlevomatCodingStandard.Classes.RequireAbstractOrFinal: Fixed false po…

…sitive for readonly classes
slevomat · Jan 9, 2023 · 6460e72 · 6460e72
1 parent ed5b2aa
commit 6460e72
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 9 deletions.
diff --git a/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php b/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php
@@ -9,6 +9,7 @@
 use const T_ABSTRACT;
 use const T_CLASS;
 use const T_FINAL;
+use const T_READONLY;
 
 class RequireAbstractOrFinalSniff implements Sniff
 {
@@ -31,17 +32,21 @@ public function register(): array
 	 */
 	public function process(File $phpcsFile, $classPointer): void
 	{
+		$tokens = $phpcsFile->getTokens();
+
 		$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $classPointer - 1);
 
-		$tokens = $phpcsFile->getTokens();
+		if ($tokens[$previousPointer]['code'] === T_READONLY) {
+			$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
+		}
 
 		if (in_array($tokens[$previousPointer]['code'], [T_ABSTRACT, T_FINAL], true)) {
 			return;
 		}
 
 		$fix = $phpcsFile->addFixableError(
 			'All classes should be declared using either the "abstract" or "final" keyword.',
-			$classPointer - 1,
+			$classPointer,
 			self::CODE_NO_ABSTRACT_OR_FINAL
 		);
 
@@ -50,7 +55,7 @@ public function process(File $phpcsFile, $classPointer): void
 		}
 
 		$phpcsFile->fixer->beginChangeset();
-		$phpcsFile->fixer->addContent($classPointer - 1, 'final ');
+		$phpcsFile->fixer->addContentBefore($classPointer, 'final ');
 		$phpcsFile->fixer->endChangeset();
 	}
 

diff --git a/tests/Sniffs/Classes/RequireAbstractOrFinalSniffTest.php b/tests/Sniffs/Classes/RequireAbstractOrFinalSniffTest.php
@@ -11,12 +11,13 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/requireAbstractOrFinalErrors.php');
 
-		self::assertSame(4, $report->getErrorCount());
+		self::assertSame(5, $report->getErrorCount());
 
-		self::assertSniffError($report, 2, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
-		self::assertSniffError($report, 17, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
-		self::assertSniffError($report, 38, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
+		self::assertSniffError($report, 3, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
+		self::assertSniffError($report, 18, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
+		self::assertSniffError($report, 39, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
 		self::assertSniffError($report, 44, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
+		self::assertSniffError($report, 53, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
 
 		self::assertAllFixedInFile($report);
 	}

diff --git a/tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.fixed.php b/tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.fixed.php
@@ -1,4 +1,4 @@
-<?php
+<?php // lint >= 8.2
 
 final class C1
 {
@@ -45,3 +45,11 @@ final class C2
 {
 
 }
+
+final readonly class G
+{
+}
+
+readonly final class G2
+{
+}
diff --git a/tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.php b/tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.php
@@ -1,4 +1,4 @@
-<?php
+<?php // lint >= 8.2
 
 class C1
 {
@@ -45,3 +45,11 @@ class C2
 {
 
 }
+
+final readonly class G
+{
+}
+
+readonly class G2
+{
+}