Add SlevomatCodingStandard.Classes.RequireAbstractOrFinal

Author: roslov

README.md

@@ -184,6 +184,10 @@ Disallows late static binding for constants.
 
 Disallows using public properties.
 
+#### SlevomatCodingStandard.Classes.RequireAbstractOrFinal 🔧
+
+Requires the class to be declared either as abstract or as final.
+
 #### SlevomatCodingStandard.Classes.RequireConstructorPropertyPromotion 🔧
 
 Requires use of constructor property promotion.

SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Classes;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+use function in_array;
+use const T_ABSTRACT;
+use const T_CLASS;
+use const T_FINAL;
+
+class RequireAbstractOrFinalSniff implements Sniff
+{
+
+	public const CODE_NO_ABSTRACT_OR_FINAL = 'ClassNeitherAbstractNorFinal';
+
+	/**
+	 * @return array<int, (int|string)>
+	 */
+	public function register(): array
+	{
+		return [
+			T_CLASS,
+		];
+	}
+
+	/**
+	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
+	 * @param File $phpcsFile
+	 * @param int $classPointer
+	 */
+	public function process(File $phpcsFile, $classPointer): void
+	{
+		$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $classPointer - 1);
+
+		$tokens = $phpcsFile->getTokens();
+
+		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,
+			self::CODE_NO_ABSTRACT_OR_FINAL
+		);
+
+		if (!$fix) {
+			return;
+		}
+
+		$phpcsFile->fixer->beginChangeset();
+		$phpcsFile->fixer->addContent($classPointer - 1, 'final ');
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

tests/Sniffs/Classes/RequireAbstractOrFinalSniffTest.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Classes;
+
+use SlevomatCodingStandard\Sniffs\TestCase;
+
+class RequireAbstractOrFinalSniffTest extends TestCase
+{
+
+	public function testErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireAbstractOrFinalErrors.php');
+
+		self::assertSame(4, $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, 44, RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL);
+
+		self::assertAllFixedInFile($report);
+	}
+
+}

tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.fixed.php

@@ -0,0 +1,47 @@
+<?php
+
+final class C1
+{
+
+}
+
+abstract class A1
+{
+	public $prop1;
+}
+
+final class F1
+{
+
+}
+
+final class E1 extends \Exception
+{
+
+}
+
+final
+
+class F2
+{
+
+}
+
+
+final
+// Some comment
+class F3
+{
+
+}
+
+// Another comment
+final class C2
+{
+
+}
+
+/* One more comment */ final class E2 extends \Exception
+{
+
+}

tests/Sniffs/Classes/data/requireAbstractOrFinalErrors.php

@@ -0,0 +1,47 @@
+<?php
+
+class C1
+{
+
+}
+
+abstract class A1
+{
+	public $prop1;
+}
+
+final class F1
+{
+
+}
+
+class E1 extends \Exception
+{
+
+}
+
+final
+
+class F2
+{
+
+}
+
+
+final
+// Some comment
+class F3
+{
+
+}
+
+// Another comment
+class C2
+{
+
+}
+
+/* One more comment */ class E2 extends \Exception
+{
+
+}