Add excludedCallPatterns option to RequireMultiLineCallSniff

Author: parth391

SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php

@@ -2,6 +2,7 @@
 
 namespace SlevomatCodingStandard\Sniffs\Functions;
 
+use Exception;
 use PHP_CodeSniffer\Files\File;
 use SlevomatCodingStandard\Helpers\FixerHelper;
 use SlevomatCodingStandard\Helpers\IndentationHelper;
@@ -12,6 +13,7 @@
 use function count;
 use function in_array;
 use function ltrim;
+use function preg_match;
 use function sprintf;
 use function strlen;
 use function trim;
@@ -34,6 +36,12 @@ class RequireMultiLineCallSniff extends AbstractLineCall
 
 	public ?int $minParametersCount = null;
 
+	/** @var list<string> */
+	public array $excludedCallPatterns = [];
+
+	/** @var list<string>|null */
+	public ?array $excludedCallNormalizedPatterns = null;
+
 	public function process(File $phpcsFile, int $stringPointer): void
 	{
 		$this->minLineLength = SniffSettingsHelper::normalizeNullableInteger($this->minLineLength);
@@ -139,6 +147,13 @@ public function process(File $phpcsFile, int $stringPointer): void
 
 		$name = ltrim($tokens[$stringPointer]['content'], '\\');
 
+		if (
+			count($this->excludedCallPatterns) !== 0
+			&& $this->isCallNameInPatterns($name, $this->getExcludedCallNormalizedPatterns())
+		) {
+			return;
+		}
+
 		if (in_array($tokens[$previousPointer]['code'], [T_OBJECT_OPERATOR, T_DOUBLE_COLON], true)) {
 			$error = sprintf('Call of method %s() should be split to more lines.', $name);
 		} elseif ($tokens[$previousPointer]['code'] === T_NEW) {
@@ -257,4 +272,31 @@ private function shouldReportError(
 		return strlen(trim($lineStart) . trim($lineEnd)) > $indentationLength;
 	}
 
+	/**
+	 * @param list<string> $normalizedPatterns
+	 */
+	private function isCallNameInPatterns(string $callName, array $normalizedPatterns): bool
+	{
+		foreach ($normalizedPatterns as $pattern) {
+			if (!SniffSettingsHelper::isValidRegularExpression($pattern)) {
+				throw new Exception(sprintf('%s is not valid PCRE pattern.', $pattern));
+			}
+
+			if (preg_match($pattern, $callName) !== 0) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return list<string>
+	 */
+	private function getExcludedCallNormalizedPatterns(): array
+	{
+		$this->excludedCallNormalizedPatterns ??= SniffSettingsHelper::normalizeArray($this->excludedCallPatterns);
+		return $this->excludedCallNormalizedPatterns;
+	}
+
 }

tests/Sniffs/Functions/RequireMultiLineCallSniffTest.php

@@ -162,4 +162,34 @@ public function testErrorsBasedOnParamCount(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testThrowExceptionForInvalidPattern(): void
+	{
+		$this->expectException(Throwable::class);
+
+		self::checkFile(
+			__DIR__ . '/data/requireMultiLineCallErrors.php',
+			['includedCallPatterns' => ['invalidPattern']],
+		);
+
+		self::checkFile(
+			__DIR__ . '/data/requireMultiLineCallErrors.php',
+			['excludedCallPatterns' => ['invalidPattern']],
+		);
+	}
+
+	public function testExcludedCallPatterns(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireMultiLineCallExcludedCallsErrors.php', [
+			'minLineLength' => 0,
+			'excludedCallPatterns' => ['/dontReportError/'],
+		], [RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL]);
+
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 7, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
+		self::assertSniffError($report, 13, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
+
+		self::assertAllFixedInFile($report);
+	}
+
 }

tests/Sniffs/Functions/data/requireMultiLineCallExcludedCallsErrors.fixed.php

@@ -0,0 +1,21 @@
+<?php
+
+class Whatever
+{
+	public function __construct()
+	{
+		$this->reportError(
+			'false',
+			true
+		);
+		$this->dontReportError('true', false);
+	}
+}
+
+function () {
+	reportError(
+		'false',
+		true
+	);
+	dontReportError('true', false);
+};

tests/Sniffs/Functions/data/requireMultiLineCallExcludedCallsErrors.php

@@ -0,0 +1,15 @@
+<?php
+
+class Whatever
+{
+	public function __construct()
+	{
+		$this->reportError('false', true);
+		$this->dontReportError('true', false);
+	}
+}
+
+function () {
+	reportError('false', true);
+	dontReportError('true', false);
+};