TraitUseSpacingSniff: Fix for uses with comments

slevomat · Aug 25, 2020 · a5dda73 · a5dda73
1 parent 6f45c01
commit a5dda73
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 2 deletions.
diff --git a/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php b/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php
@@ -4,10 +4,12 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 use SlevomatCodingStandard\Helpers\ClassHelper;
 use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
 use function count;
+use function in_array;
 use function sprintf;
 use function substr_count;
 use const T_ANON_CLASS;
@@ -74,14 +76,22 @@ private function checkLinesBeforeFirstUse(File $phpcsFile, int $firstUsePointer)
 	{
 		$tokens = $phpcsFile->getTokens();
 
+		$useStartPointer = $firstUsePointer;
+
 		/** @var int $pointerBeforeFirstUse */
 		$pointerBeforeFirstUse = TokenHelper::findPreviousExcluding($phpcsFile, T_WHITESPACE, $firstUsePointer - 1);
+
+		if (in_array($tokens[$pointerBeforeFirstUse]['code'], Tokens::$commentTokens, true)) {
+			$pointerBeforeFirstUse = TokenHelper::findPreviousEffective($phpcsFile, $pointerBeforeFirstUse - 1);
+			$useStartPointer = TokenHelper::findNext($phpcsFile, Tokens::$commentTokens, $pointerBeforeFirstUse + 1);
+		}
+
 		$isAtTheStartOfClass = $tokens[$pointerBeforeFirstUse]['code'] === T_OPEN_CURLY_BRACKET;
 
 		$whitespaceBeforeFirstUse = '';
 
 		if ($pointerBeforeFirstUse + 1 !== $firstUsePointer) {
-			$whitespaceBeforeFirstUse .= TokenHelper::getContent($phpcsFile, $pointerBeforeFirstUse + 1, $firstUsePointer - 1);
+			$whitespaceBeforeFirstUse .= TokenHelper::getContent($phpcsFile, $pointerBeforeFirstUse + 1, $useStartPointer - 1);
 		}
 
 		$requiredLinesCountBeforeFirstUse = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirstUse);
@@ -91,6 +101,7 @@ private function checkLinesBeforeFirstUse(File $phpcsFile, int $firstUsePointer)
 		) {
 			$requiredLinesCountBeforeFirstUse = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirstUseWhenFirstInClass);
 		}
+
 		$actualLinesCountBeforeFirstUse = substr_count($whitespaceBeforeFirstUse, $phpcsFile->eolChar) - 1;
 
 		if ($actualLinesCountBeforeFirstUse === $requiredLinesCountBeforeFirstUse) {
@@ -206,7 +217,14 @@ private function checkLinesBetweenUses(File $phpcsFile, array $usePointers): voi
 				$previousUseEndPointer = $tokens[$previousUseEndPointer]['bracket_closer'];
 			}
 
-			$actualLinesCountAfterPreviousUse = $tokens[$usePointer]['line'] - $tokens[$previousUseEndPointer]['line'] - 1;
+			$useStartPointer = $usePointer;
+			$pointerBeforeUse = TokenHelper::findPreviousExcluding($phpcsFile, T_WHITESPACE, $usePointer - 1);
+
+			if (in_array($tokens[$pointerBeforeUse]['code'], Tokens::$commentTokens, true)) {
+				$useStartPointer = TokenHelper::findNext($phpcsFile, Tokens::$commentTokens, TokenHelper::findPreviousEffective($phpcsFile, $pointerBeforeUse - 1) + 1);
+			}
+
+			$actualLinesCountAfterPreviousUse = $tokens[$useStartPointer]['line'] - $tokens[$previousUseEndPointer]['line'] - 1;
 
 			if ($actualLinesCountAfterPreviousUse === $requiredLinesCountBetweenUses) {
 				$previousUsePointer = $usePointer;

diff --git a/tests/Sniffs/Classes/TraitUseSpacingSniffTest.php b/tests/Sniffs/Classes/TraitUseSpacingSniffTest.php
@@ -58,6 +58,24 @@ public function testOneUseDefaultSettingErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testDefaultSettingWithCommentsNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/traitUseSpacingDefaultSettingsWithCommentsNoErrors.php');
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testDefaultSettingWithCommentsErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/traitUseSpacingDefaultSettingsWithCommentsErrors.php');
+
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 8, TraitUseSpacingSniff::CODE_INCORRECT_LINES_COUNT_BEFORE_FIRST_USE);
+		self::assertSniffError($report, 14, TraitUseSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_USES);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testModifiedSettingNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/traitUseSpacingModifiedSettingsNoErrors.php', [

diff --git a/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsErrors.fixed.php b/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsErrors.fixed.php
@@ -0,0 +1,20 @@
+<?php
+
+class Whatever
+{
+
+	// Comment
+	use A;
+	use B {
+		B::b as bb;
+	}
+	// Comment
+	use C;
+	use D;
+
+	public function __construct()
+	{
+
+	}
+
+}
diff --git a/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsErrors.php b/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsErrors.php
@@ -0,0 +1,22 @@
+<?php
+
+class Whatever
+{
+
+
+	// Comment
+	use A;
+	use B {
+		B::b as bb;
+	}
+
+	// Comment
+	use C;
+	use D;
+
+	public function __construct()
+	{
+
+	}
+
+}
diff --git a/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsNoErrors.php b/tests/Sniffs/Classes/data/traitUseSpacingDefaultSettingsWithCommentsNoErrors.php
@@ -0,0 +1,20 @@
+<?php
+
+class Whatever
+{
+
+	// Comment
+	use A;
+	use B {
+		B::b as bb;
+	}
+	// Comment
+	use C;
+	use D;
+
+	public function __construct()
+	{
+
+	}
+
+}