Skip to content

Improve context detection for PSR12.Operators.OperatorSpacing / Squiz.WhiteSpace.OperatorSpacing - avoids fixer conflict, bow out on parse error #289

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 3 commits into from
Mar 5, 2024
Merged

Improve context detection for PSR12.Operators.OperatorSpacing / Squiz.WhiteSpace.OperatorSpacing - avoids fixer conflict, bow out on parse error #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d6778b0
Squiz.WhiteSpace.OperatorSpacing: rename test file
fredden Mar 4, 2024
676ed65
PSR12.Operators.OperatorSpacing: rename test files
fredden Mar 4, 2024
73ca839
Squiz.WhiteSpace.OperatorSpacing / PSR12.Operators.OperatorSpacing - …
fredden Mar 4, 2024
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
18 changes: 17 additions & 1 deletion src/Standards/PSR12/Sniffs/Operators/OperatorSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ public function register()
$targets[] = T_STRING_CONCAT;
$targets[] = T_INSTANCEOF;

// Also register the contexts we want to specifically skip over.
$targets[] = T_DECLARE;

return $targets;

}//end register()
Expand All @@ -47,12 +50,25 @@ public function register()
* @param int $stackPtr The position of the current token in
* the stack passed in $tokens.
*
* @return void
* @return void|int Optionally returns a stack pointer. The sniff will not be
* called again on the current file until the returned stack
* pointer is reached. Return `$phpcsFile->numTokens` to skip
* the rest of the file.
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();

// Skip over declare statements as those should be handled by different sniffs.
if ($tokens[$stackPtr]['code'] === T_DECLARE) {
if (isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
// Parse error / live coding.
return $phpcsFile->numTokens;
}

return $tokens[$stackPtr]['parenthesis_closer'];
}

if ($this->isOperator($phpcsFile, $stackPtr) === false) {
return;
}
Expand Down
2 changes: 2 additions & 0 deletions ...sts/Operators/OperatorSpacingUnitTest.inc → ...s/Operators/OperatorSpacingUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,5 @@ function setDefault(#[ImportValue(
{
// Do something
}

declare(strict_types=1);
2 changes: 2 additions & 0 deletions ...erators/OperatorSpacingUnitTest.inc.fixed → ...ators/OperatorSpacingUnitTest.1.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,5 @@ function setDefault(#[ImportValue(
{
// Do something
}

declare(strict_types=1);
3 changes: 3 additions & 0 deletions src/Standards/PSR12/Tests/Operators/OperatorSpacingUnitTest.2.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<?php
// Safeguard to ensure that sniff handles parse error/live coding correctly.
declare(strict_types=
53 changes: 30 additions & 23 deletions src/Standards/PSR12/Tests/Operators/OperatorSpacingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,32 +26,39 @@ final class OperatorSpacingUnitTest extends AbstractSniffUnitTest
* The key of the array should represent the line number and the value
* should represent the number of errors that should occur on that line.
*
* @param string $testFile The name of the file being tested.
*
* @return array<int, int>
*/
public function getErrorList()
public function getErrorList($testFile='')
{
return [
2 => 1,
3 => 2,
4 => 1,
5 => 2,
6 => 4,
9 => 3,
10 => 2,
11 => 3,
13 => 3,
14 => 2,
18 => 1,
20 => 1,
22 => 2,
23 => 2,
26 => 1,
37 => 4,
39 => 1,
40 => 1,
44 => 2,
47 => 2,
];
switch ($testFile) {
case 'OperatorSpacingUnitTest.1.inc':
return [
2 => 1,
3 => 2,
4 => 1,
5 => 2,
6 => 4,
9 => 3,
10 => 2,
11 => 3,
13 => 3,
14 => 2,
18 => 1,
20 => 1,
22 => 2,
23 => 2,
26 => 1,
37 => 4,
39 => 1,
40 => 1,
44 => 2,
47 => 2,
];
default:
return [];
}//end switch

}//end getErrorList()

Expand Down
27 changes: 22 additions & 5 deletions src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ public function register()
$targets[] = T_INLINE_ELSE;
$targets[] = T_INSTANCEOF;

// Also register the contexts we want to specifically skip over.
$targets[] = T_DECLARE;

return $targets;

}//end register()
Expand All @@ -126,12 +129,25 @@ public function register()
* @param int $stackPtr The position of the current token in
* the stack passed in $tokens.
*
* @return void
* @return void|int Optionally returns a stack pointer. The sniff will not be
* called again on the current file until the returned stack
* pointer is reached. Return `$phpcsFile->numTokens` to skip
* the rest of the file.
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();

// Skip over declare statements as those should be handled by different sniffs.
if ($tokens[$stackPtr]['code'] === T_DECLARE) {
if (isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
// Parse error / live coding.
return $phpcsFile->numTokens;
}

return $tokens[$stackPtr]['parenthesis_closer'];
}

if ($this->isOperator($phpcsFile, $stackPtr) === false) {
return;
}
Expand Down Expand Up @@ -327,11 +343,13 @@ protected function isOperator(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();

if ($tokens[$stackPtr]['code'] === T_DECLARE) {
return false;
}

// Skip default values in function declarations.
// Skip declare statements.
if ($tokens[$stackPtr]['code'] === T_EQUAL
|| $tokens[$stackPtr]['code'] === T_MINUS
) {
if ($tokens[$stackPtr]['code'] === T_EQUAL) {
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
$parenthesis = array_keys($tokens[$stackPtr]['nested_parenthesis']);
$bracket = array_pop($parenthesis);
Expand All @@ -340,7 +358,6 @@ protected function isOperator(File $phpcsFile, $stackPtr)
if ($tokens[$function]['code'] === T_FUNCTION
|| $tokens[$function]['code'] === T_CLOSURE
|| $tokens[$function]['code'] === T_FN
|| $tokens[$function]['code'] === T_DECLARE
) {
return false;
}
Expand Down
0 ...ts/WhiteSpace/OperatorSpacingUnitTest.inc → .../WhiteSpace/OperatorSpacingUnitTest.1.inc
View file
Open in desktop
File renamed without changes.
0 ...teSpace/OperatorSpacingUnitTest.inc.fixed → ...Space/OperatorSpacingUnitTest.1.inc.fixed
View file
Open in desktop
File renamed without changes.
3 changes: 3 additions & 0 deletions src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.2.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<?php
// Safeguard to ensure that sniff handles parse error/live coding correctly.
declare(strict_types=
2 changes: 1 addition & 1 deletion src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ final class OperatorSpacingUnitTest extends AbstractSniffUnitTest
public function getErrorList($testFile='')
{
switch ($testFile) {
case 'OperatorSpacingUnitTest.inc':
case 'OperatorSpacingUnitTest.1.inc':
return [
4 => 1,
5 => 2,
Expand Down
4 changes: 2 additions & 2 deletions tests/Core/Filters/AbstractFilterTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ protected static function getFakeFileList()
$basedir.'/src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php',
$basedir.'/src/Standards/Squiz/Tests',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc.fixed',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js.fixed',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php',
Expand Down
6 changes: 3 additions & 3 deletions tests/Core/Filters/GitModifiedTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ public static function dataAcceptOnlyGitModified()
'.yamllint.yml',
'autoload.php',
'src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php',
Expand All @@ -191,7 +191,7 @@ public static function dataAcceptOnlyGitModified()
$basedir.'/src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php',
$basedir.'/src/Standards/Squiz/Tests',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php',
],
Expand Down
6 changes: 3 additions & 3 deletions tests/Core/Filters/GitStagedTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ public static function dataAcceptOnlyGitStaged()
'.yamllint.yml',
'autoload.php',
'src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js.fixed',
'src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php',
Expand All @@ -191,7 +191,7 @@ public static function dataAcceptOnlyGitStaged()
$basedir.'/src/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php',
$basedir.'/src/Standards/Squiz/Tests',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.1.inc',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js',
$basedir.'/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php',
],
Expand Down