RequireMultiLineCallSniff: Don't report lines that will be longer when splitted

Author: kukulich

SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php

@@ -12,6 +12,7 @@
 use function in_array;
 use function sprintf;
 use function strlen;
+use function trim;
 use const T_CLOSE_PARENTHESIS;
 use const T_CLOSE_SHORT_ARRAY;
 use const T_COMMA;
@@ -110,7 +111,17 @@ public function process(File $phpcsFile, $stringPointer): void
 			$lineLength = strlen($lineStart . $lineEnd);
 		}
 
-		if (!$this->shouldReportError($lineLength)) {
+		$firstNonWhitespaceOnLine = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $stringPointer);
+		$indentation = IndentationHelper::getIndentation($phpcsFile, $firstNonWhitespaceOnLine);
+		$oneIndentation = IndentationHelper::getOneIndentationLevel($indentation);
+
+		if (!$this->shouldReportError(
+			$lineLength,
+			$lineStart,
+			$lineEnd,
+			count($parametersPointers),
+			strlen(IndentationHelper::convertTabsToSpaces($phpcsFile, $oneIndentation))
+		)) {
 			return;
 		}
 
@@ -130,10 +141,7 @@ public function process(File $phpcsFile, $stringPointer): void
 			return;
 		}
 
-		$firstNonWhitespaceOnLine = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $stringPointer);
-		$indentation = IndentationHelper::getIndentation($phpcsFile, $firstNonWhitespaceOnLine);
 		$parametersIndentation = IndentationHelper::addIndentation($indentation);
-		$oneIndentation = IndentationHelper::getOneIndentationLevel($indentation);
 
 		$phpcsFile->fixer->beginChangeset();
 
@@ -192,15 +200,29 @@ private function shouldBeSkipped(File $phpcsFile, int $stringPointer, int $paren
 		return false;
 	}
 
-	private function shouldReportError(int $lineLength): bool
+	private function shouldReportError(
+		int $lineLength,
+		string $lineStart,
+		string $lineEnd,
+		int $parametersCount,
+		int $indentationLength
+	): bool
 	{
 		$minLineLength = SniffSettingsHelper::normalizeInteger($this->minLineLength);
 
 		if ($minLineLength === 0) {
 			return true;
 		}
 
-		return $lineLength >= $minLineLength;
+		if ($lineLength < $minLineLength) {
+			return false;
+		}
+
+		if ($parametersCount > 1) {
+			return true;
+		}
+
+		return strlen(trim($lineStart) . trim($lineEnd)) > $indentationLength;
 	}
 
 }

tests/Sniffs/Functions/RequireMultiLineCallSniffTest.php

@@ -17,7 +17,7 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/requireMultiLineCallErrors.php');
 
-		self::assertSame(13, $report->getErrorCount());
+		self::assertSame(15, $report->getErrorCount());
 
 		self::assertSniffError(
 			$report,
@@ -97,6 +97,18 @@ public function testErrors(): void
 			RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL,
 			'Call of method sendDelayedMessage() should be splitted to more lines.'
 		);
+		self::assertSniffError(
+			$report,
+			51,
+			RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL,
+			'Call of function sprintf() should be splitted to more lines.'
+		);
+		self::assertSniffError(
+			$report,
+			54,
+			RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL,
+			'Call of function _() should be splitted to more lines.'
+		);
 
 		self::assertAllFixedInFile($report);
 	}
@@ -115,9 +127,10 @@ public function testAllCallsErrors(): void
 			'minLineLength' => 0,
 		]);
 
-		self::assertSame(1, $report->getErrorCount());
+		self::assertSame(2, $report->getErrorCount());
 
 		self::assertSniffError($report, 7, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
+		self::assertSniffError($report, 12, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -10,3 +10,12 @@ public function __construct()
 		);
 	}
 }
+
+function ($text) {
+	return sprintf(
+		_(
+			'very looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter'
+		),
+		$text
+	);
+};

tests/Sniffs/Functions/data/requireMultiLineCallAllCallsErrors.php

@@ -7,3 +7,7 @@ public function __construct()
 		$this->doAnything('true', false);
 	}
 }
+
+function ($text) {
+	return sprintf(_('very looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter'), $text);
+};

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

@@ -90,3 +90,14 @@ function () use ($message, $originalQueueName, $delayedQueueName, $nextAttemptTi
 		);
 	}
 }
+
+function ($text) {
+	return sprintf(
+		_('very looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter'),
+		$text
+	);
+};
+
+$a = _(
+	'very loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter'
+);

tests/Sniffs/Functions/data/requireMultiLineCallErrors.php

@@ -46,3 +46,9 @@ public function commit($message, $originalQueueName, $delayedQueueName, $nextAtt
 		});
 	}
 }
+
+function ($text) {
+	return sprintf(_('very looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter'), $text);
+};
+
+$a = _('very loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong parameter');