Skip to content
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

Generic/IncrementDecrementSpacing: handle more situations #3626

Closed
wants to merge 1 commit into from
+69 −12
Closed

Generic/IncrementDecrementSpacing: handle more situations #3626

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
8 changes: 6 additions & 2 deletions src/Standards/Generic/Sniffs/WhiteSpace/IncrementDecrementSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ public function process(File $phpcsFile, $stackPtr)
// Is this a pre-increment/decrement ?
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
if ($nextNonEmpty !== false
&& (($phpcsFile->tokenizerType === 'PHP' && $tokens[$nextNonEmpty]['code'] === T_VARIABLE)
&& (($phpcsFile->tokenizerType === 'PHP'
&& ($tokens[$nextNonEmpty]['code'] === T_VARIABLE || $tokens[$nextNonEmpty]['code'] === T_STRING))
|| ($phpcsFile->tokenizerType === 'JS' && $tokens[$nextNonEmpty]['code'] === T_STRING))
) {
if ($nextNonEmpty === ($stackPtr + 1)) {
Expand Down Expand Up @@ -116,7 +117,10 @@ public function process(File $phpcsFile, $stackPtr)
// Is this a post-increment/decrement ?
$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
if ($prevNonEmpty !== false
&& (($phpcsFile->tokenizerType === 'PHP' && $tokens[$prevNonEmpty]['code'] === T_VARIABLE)
&& (($phpcsFile->tokenizerType === 'PHP'
&& ($tokens[$prevNonEmpty]['code'] === T_VARIABLE
|| $tokens[$prevNonEmpty]['code'] === T_STRING
|| $tokens[$prevNonEmpty]['code'] === T_CLOSE_SQUARE_BRACKET))
|| ($phpcsFile->tokenizerType === 'JS' && $tokens[$prevNonEmpty]['code'] === T_STRING))
) {
if ($prevNonEmpty === ($stackPtr - 1)) {
Expand Down
20 changes: 20 additions & 0 deletions src/Standards/Generic/Tests/WhiteSpace/IncrementDecrementSpacingUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,23 @@ $i /*comment*/ --;
$i++;
$i ++;
$i /*comment*/ ++;

// Handle properties and array access too.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we expand the test case with pre-increments of the array and object properties?

++$i['key'];
++ $i['key'];
++$i['key']['id'];
++ $i['key']['id'];

++$obj->prop;
++ $obj->prop;
++ $obj?->prop;

++$obj->obj->prop;
++ $obj->obj->prop;
++ $obj?->obj->prop;

++$obj->prop['key'];
++ $obj->prop['key'];

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DannyvdSluijs Good question. In my opinion: no, those tests are not needed as they wouldn't be testing anything (new).

The difference in this case for pre vs post in/decrement is that to identify whether something is a "pre" vs "post" increment (i.e. to identify whether there should be no whitespace after or no whitespace before, the sniff needs to look at different tokens. These extra tests cover the changes I made to that logic.

Adding the same tests for pre-increment wouldn't actually test anything new as it was already handled correctly (as whether something is a plain variable or a non-static property access or array key access on a variable doesn't make a difference in the identification of pre vs post).

For pre-increment, I can think of a further/future iteration for the sniff - checking whether a pre-increment is used on a static property with a fully qualified classname or namespace relative classname, but that is something I choose not to handle (yet) when I made this change last year. When that change would be added, then, yes, extra tests would be needed for pre-in/decrement.

++\ClassName::$prop;
++Relative\ClassName::$prop;
--namespace\Relative\ClassName::$prop;

The reason I did not make that change (yet) is that this would need a different patch for PHPCS 3.x vs PHPCS 4.x, which would make the merge more complex. Also see #3041.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That all makes sense to me. Which makes this PR ready to merge as far as I'm concerned.

$i['key']++;
$i['key'] ++;
$i['key']['id']++;
$i['key']['id'] ++;

$obj->prop++;
$obj->prop ++;
$obj?->prop ++;

$obj->obj->prop++;
$obj->obj->prop ++;
$obj?->obj->prop ++;

$obj->prop['key']++;
$obj->prop['key'] ++;

--ClassName::$prop;
-- ClassName::$prop;
20 changes: 20 additions & 0 deletions src/Standards/Generic/Tests/WhiteSpace/IncrementDecrementSpacingUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,23 @@ $i /*comment*/ --;
$i++;
$i++;
$i /*comment*/ ++;

// Handle properties and array access too.
$i['key']++;
$i['key']++;
$i['key']['id']++;
$i['key']['id']++;

$obj->prop++;
$obj->prop++;
$obj?->prop++;

$obj->obj->prop++;
$obj->obj->prop++;
$obj?->obj->prop++;

$obj->prop['key']++;
$obj->prop['key']++;

--ClassName::$prop;
--ClassName::$prop;
33 changes: 23 additions & 10 deletions src/Standards/Generic/Tests/WhiteSpace/IncrementDecrementSpacingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,32 @@ class IncrementDecrementSpacingUnitTest extends AbstractSniffUnitTest
*/
public function getErrorList($testFile='IncrementDecrementSpacingUnitTest.inc')
{
$errors = [
5 => 1,
6 => 1,
8 => 1,
10 => 1,
13 => 1,
14 => 1,
16 => 1,
17 => 1,
];

switch ($testFile) {
case 'IncrementDecrementSpacingUnitTest.inc':
$errors[21] = 1;
$errors[23] = 1;
$errors[26] = 1;
$errors[27] = 1;
$errors[30] = 1;
$errors[31] = 1;
$errors[34] = 1;
$errors[37] = 1;

return $errors;

case 'IncrementDecrementSpacingUnitTest.js':
return [
5 => 1,
6 => 1,
8 => 1,
10 => 1,
13 => 1,
14 => 1,
16 => 1,
17 => 1,
];
return $errors;

default:
return [];
Expand Down