RequireSingleLineMethodDeclarationSniff renamed to RequireSingleLineMethodSignatureSniff

Author: kukulich

README.md

@@ -374,13 +374,13 @@ Sniff provides the following settings:
 * `$minLinesCountBeforeWithoutComment`: minimum number of lines before property without a doc comment
 * `$maxLinesCountBeforeWithoutComment`: maximum number of lines before property without a doc comment
 
-#### SlevomatCodingStandard.Classes.RequireSingleLineMethodDeclaration 🔧
+#### SlevomatCodingStandard.Classes.RequireSingleLineMethodSignature 🔧
 
-Enforces method declaration to be on a single line if it fits on it (or all the time; depends on settings).
+Enforces method signature to be on a single line.
 
 Sniff provides the following settings:
 
-* `maxLineLength`: specifies max allowed line length; if declaration would fit on it, it's enforced. Use 0 value to enforce for all methods, regardless of length.
+* `maxLineLength`: specifies max allowed line length. If signature would fit on it, it's enforced. Use 0 value to enforce for all methods, regardless of length.
 
 #### SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming
 

SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodDeclarationSniff.php

@@ -0,0 +1,110 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Classes;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\FunctionHelper;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+use function assert;
+use function in_array;
+use function is_bool;
+use function is_int;
+use function is_string;
+use function preg_replace;
+use function preg_replace_callback;
+use function rtrim;
+use function sprintf;
+use function str_repeat;
+use function str_replace;
+use function strlen;
+use const T_FUNCTION;
+use const T_OPEN_CURLY_BRACKET;
+use const T_OPEN_TAG;
+use const T_SEMICOLON;
+
+class RequireSingleLineMethodSignatureSniff implements Sniff
+{
+
+	public const CODE_REQUIRED_SINGLE_LINE_SIGNATURE = 'RequiredSingleLineSignature';
+
+	/** @var int */
+	public $maxLineLength = 120;
+
+	/**
+	 * @return array<int, (int|string)>
+	 */
+	public function register(): array
+	{
+		return [T_FUNCTION];
+	}
+
+	/**
+	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile
+	 * @param int $pointer
+	 */
+	public function process(File $phpcsFile, $pointer): void
+	{
+		if (!FunctionHelper::isMethod($phpcsFile, $pointer)) {
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$lineStartPointer = $phpcsFile->findFirstOnLine(T_OPEN_TAG, $pointer, true);
+		assert(!is_bool($lineStartPointer));
+
+		$methodSignatureEndPointer = $phpcsFile->findNext([T_OPEN_CURLY_BRACKET, T_SEMICOLON], $pointer);
+		assert(is_int($methodSignatureEndPointer));
+
+		$signatureEndLine = $tokens[$methodSignatureEndPointer]['line'];
+		if (in_array($tokens[$lineStartPointer]['line'], [$signatureEndLine, $signatureEndLine - 1], true)) {
+			return;
+		}
+
+		$singleLineMethodSignatureEndPointer = $methodSignatureEndPointer;
+		if ($tokens[$methodSignatureEndPointer]['code'] === T_OPEN_CURLY_BRACKET) {
+			$singleLineMethodSignatureEndPointer--;
+		}
+
+		$methodSignature = TokenHelper::getContent($phpcsFile, $lineStartPointer, $singleLineMethodSignatureEndPointer);
+		$methodSignature = preg_replace(sprintf('~%s[ \t]*~', $phpcsFile->eolChar), ' ', $methodSignature);
+		assert(is_string($methodSignature));
+
+		$methodSignature = str_replace(['( ', ' )'], ['(', ')'], $methodSignature);
+		$methodSignature = rtrim($methodSignature);
+
+		$methodSignatureWithoutTabIndetation = preg_replace_callback('~^(\t+)~', static function (array $matches): string {
+			return str_repeat('    ', strlen($matches[1]));
+		}, $methodSignature);
+
+		if ($this->maxLineLength !== 0 && strlen($methodSignatureWithoutTabIndetation) > $this->maxLineLength) {
+			return;
+		}
+
+		$error = sprintf('Signature of method "%s" should be placed on a single line.', FunctionHelper::getName($phpcsFile, $pointer));
+		$fix = $phpcsFile->addFixableError($error, $pointer, self::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+		if (!$fix) {
+			return;
+		}
+
+		$whitespaceBeforeMethod = $tokens[$lineStartPointer]['content'];
+
+		$phpcsFile->fixer->beginChangeset();
+
+		for ($i = $lineStartPointer; $i <= $methodSignatureEndPointer; $i++) {
+			$phpcsFile->fixer->replaceToken($i, '');
+		}
+
+		$replacement = $methodSignature;
+		if ($tokens[$methodSignatureEndPointer]['code'] === T_OPEN_CURLY_BRACKET) {
+			$replacement = sprintf("%s\n%s{", $methodSignature, $whitespaceBeforeMethod);
+		}
+
+		$phpcsFile->fixer->replaceToken($lineStartPointer, $replacement);
+
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodSignatureSniff.php

@@ -63,7 +63,7 @@
 	<rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
 	<rule ref="SlevomatCodingStandard.Classes.ParentCallSpacing"/>
 	<rule ref="SlevomatCodingStandard.Classes.PropertySpacing"/>
-	<rule ref="SlevomatCodingStandard.Classes.RequireSingleLineMethodDeclaration"/>
+	<rule ref="SlevomatCodingStandard.Classes.RequireSingleLineMethodSignature"/>
 	<rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming">
 		<exclude-pattern>SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyAndConstantSpacing.php</exclude-pattern>
 		<exclude-pattern>SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php</exclude-pattern>

build/phpcs.xml

@@ -0,0 +1,39 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Classes;
+
+use SlevomatCodingStandard\Sniffs\TestCase;
+
+final class RequireSingleLineMethodSignatureSniffTest extends TestCase
+{
+
+	public function testNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireSingleLineMethodSignatureNoErrors.php');
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireSingleLineMethodSignatureErrors.php');
+		self::assertSame(4, $report->getErrorCount());
+
+		self::assertSniffError($report, 5, RequireSingleLineMethodSignatureSniff::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+		self::assertSniffError($report, 11, RequireSingleLineMethodSignatureSniff::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+		self::assertSniffError($report, 20, RequireSingleLineMethodSignatureSniff::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+		self::assertSniffError($report, 25, RequireSingleLineMethodSignatureSniff::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testForAllMethods(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireSingleLineMethodSignatureAllMethodsErrors.php', ['maxLineLength' => 0]);
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 5, RequireSingleLineMethodSignatureSniff::CODE_REQUIRED_SINGLE_LINE_SIGNATURE);
+
+		self::assertAllFixedInFile($report);
+	}
+
+}