Skip to content

SlevomatCodingStandard.Classes.ClassMemberSpacing: Prevent deleting code #1756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2025
Merged

SlevomatCodingStandard.Classes.ClassMemberSpacing: Prevent deleting code #1756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions SlevomatCodingStandard/Sniffs/Classes/ClassMemberSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ public function process(File $phpcsFile, $classPointer): void
$tokens = $phpcsFile->getTokens();

$memberPointer = null;
$previousMemberPointer = null;

do {
$previousMemberPointer = $memberPointer;
Expand Down Expand Up @@ -105,7 +104,7 @@ public function process(File $phpcsFile, $classPointer): void
}
}

$memberStartPointer = $this->getMemberStartPointer($phpcsFile, $memberPointer);
$memberStartPointer = $this->getMemberStartPointer($phpcsFile, $memberPointer, $previousMemberEndPointer);

$actualLinesCount = $tokens[$memberStartPointer]['line'] - $tokens[$previousMemberEndPointer]['line'] - 1;

Expand All @@ -117,11 +116,24 @@ public function process(File $phpcsFile, $classPointer): void
? 'Expected 1 blank line between class members, found %2$d.'
: 'Expected %1$d blank lines between class members, found %2$d.';

$fix = $phpcsFile->addFixableError(
$firstPointerOnMemberLine = TokenHelper::findFirstTokenOnLine($phpcsFile, $memberStartPointer);
$nonWhitespaceBetweenMembersPointer = TokenHelper::findNextNonWhitespace(
$phpcsFile,
$previousMemberEndPointer + 1,
$firstPointerOnMemberLine,
);
$errorParameters = [
sprintf($errorMessage, $this->linesCountBetweenMembers, $actualLinesCount),
$memberPointer,
self::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS,
);
];

if ($nonWhitespaceBetweenMembersPointer !== null) {
$phpcsFile->addError(...$errorParameters);
continue;
}

$fix = $phpcsFile->addFixableError(...$errorParameters);
if (!$fix) {
continue;
}
Expand All @@ -131,8 +143,6 @@ public function process(File $phpcsFile, $classPointer): void
$this->linesCountBetweenMembers + ($hasCommentWithNewLineAfterPreviousMember ? 0 : 1),
);

$firstPointerOnMemberLine = TokenHelper::findFirstTokenOnLine($phpcsFile, $memberStartPointer);

$phpcsFile->fixer->beginChangeset();

$phpcsFile->fixer->addContent($previousMemberEndPointer, $newLines);
Expand Down Expand Up @@ -192,24 +202,25 @@ private function findNextMember(File $phpcsFile, int $classPointer, int $previou
return $memberPointer;
}

private function getMemberStartPointer(File $phpcsFile, int $memberPointer): int
private function getMemberStartPointer(File $phpcsFile, int $memberPointer, int $previousMemberEndPointer): int
{
$tokens = $phpcsFile->getTokens();

$memberFirstCodePointer = $this->getMemberFirstCodePointer($phpcsFile, $memberPointer);

do {
if ($memberFirstCodePointer <= $previousMemberEndPointer) {
return TokenHelper::findNextNonWhitespace($phpcsFile, $memberFirstCodePointer + 1);
}

$pointerBefore = TokenHelper::findPreviousNonWhitespace($phpcsFile, $memberFirstCodePointer - 1);

if ($tokens[$pointerBefore]['code'] === T_ATTRIBUTE_END) {
$memberFirstCodePointer = $tokens[$pointerBefore]['attribute_opener'];
continue;
}

if (
in_array($tokens[$pointerBefore]['code'], Tokens::$commentTokens, true)
&& $tokens[$pointerBefore]['line'] + 1 === $tokens[$memberFirstCodePointer]['line']
) {
if (in_array($tokens[$pointerBefore]['code'], Tokens::$commentTokens, true)) {
$pointerBeforeComment = TokenHelper::findPreviousEffective($phpcsFile, $pointerBefore - 1);
if ($tokens[$pointerBeforeComment]['line'] !== $tokens[$pointerBefore]['line']) {
$memberFirstCodePointer = array_key_exists('comment_opener', $tokens[$pointerBefore])
Expand Down
22 changes: 17 additions & 5 deletions tests/Sniffs/Classes/ClassMemberSpacingSniffTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public function testErrors(): void
{
$report = self::checkFile(__DIR__ . '/data/classMemberSpacingErrors.php');

self::assertSame(9, $report->getErrorCount());
self::assertSame(10, $report->getErrorCount());

self::assertSniffError($report, 15, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 21, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
Expand All @@ -26,8 +26,9 @@ public function testErrors(): void
self::assertSniffError($report, 44, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 47, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 50, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 60, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 69, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 58, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 70, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 79, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);

self::assertAllFixedInFile($report);
}
Expand All @@ -38,10 +39,21 @@ public function testErrorsWithModifiedLinesCount(): void
'linesCountBetweenMembers' => 2,
]);

self::assertSame(2, $report->getErrorCount());
self::assertSame(3, $report->getErrorCount());

self::assertSniffError($report, 21, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 69, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 58, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
self::assertSniffError($report, 79, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
}

public function testErrorsDuringLiveCoding(): void
{
$report = self::checkFile(__DIR__ . '/data/classMemberSpacingLiveCodingErrors.php');

self::assertSame(1, $report->getErrorCount());
self::assertSame(0, $report->getFixableCount());

self::assertSniffError($report, 11, ClassMemberSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_BETWEEN_MEMBERS);
}

}
10 changes: 9 additions & 1 deletion tests/Sniffs/Classes/data/classMemberSpacingErrors.fixed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,15 @@ public function third()

final const THIRD = 'third';

readonly int $forth;
readonly int $fourth;

/**
* @return void
*/

public function fifth()
{
}

}

Expand Down
12 changes: 11 additions & 1 deletion tests/Sniffs/Classes/data/classMemberSpacingErrors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,17 @@ public function third()
final const THIRD = 'third';


readonly int $forth;
readonly int $fourth;



/**
* @return void
*/

public function fifth()
{
}

}

Expand Down
13 changes: 13 additions & 0 deletions tests/Sniffs/Classes/data/classMemberSpacingLiveCodingErrors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php // lint >= 99.0

class Test
{

public const FOO = 'foo';

// Live coding/parse error.
pub

public $bar;

}
7 changes: 6 additions & 1 deletion tests/Sniffs/Classes/data/classMemberSpacingNoErrors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ abstract public function thirdWithAttributeAndDocDomment();
*
* @var string
*/
protected $forth;
protected $fourth;
// @codingStandardsIgnoreEnd

#[SomeAttribute]
Expand Down Expand Up @@ -124,6 +124,11 @@ public function withAnonymous($parameter)
};
}

/**
* @var string
*/

protected $fifth;
}

enum Gender: string
Expand Down