Skip to content

Squiz/NonExecutableCode: simplify + improve handling of comments and closures #3898

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

Closed
wants to merge 3 commits into from
Closed

Squiz/NonExecutableCode: simplify + improve handling of comments and closures #3898

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
328f2fd
Squiz/NonExecutableCode: make sniff more code style independent
jrfnl Oct 12, 2023
e83b12b
Squiz/NonExecutableCode: flag redundant `return` statements in closur…
jrfnl Oct 12, 2023
15fceb3
Squiz/NonExecutableCode: fold duplicate code
jrfnl Jun 8, 2023
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
45 changes: 12 additions & 33 deletions src/Standards/Squiz/Sniffs/PHP/NonExecutableCodeSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,35 +94,29 @@ public function process(File $phpcsFile, $stackPtr)
}
}//end if

// Check if this token is actually part of a one-line IF or ELSE statement.
for ($i = ($stackPtr - 1); $i > 0; $i--) {
if ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS) {
$i = $tokens[$i]['parenthesis_opener'];
continue;
} else if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
continue;
}

break;
}

if ($tokens[$i]['code'] === T_IF
|| $tokens[$i]['code'] === T_ELSE
|| $tokens[$i]['code'] === T_ELSEIF
// This token may be part of an inline condition.
// If we find a closing parenthesis that belongs to a condition,
// or an "else", we should ignore this token.
if ($tokens[$prev]['code'] === T_ELSE
|| (isset($tokens[$prev]['parenthesis_owner']) === true
&& ($tokens[$tokens[$prev]['parenthesis_owner']]['code'] === T_IF
|| $tokens[$tokens[$prev]['parenthesis_owner']]['code'] === T_ELSEIF))
) {
return;
}

if ($tokens[$stackPtr]['code'] === T_RETURN) {
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
$next = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
if ($tokens[$next]['code'] === T_SEMICOLON) {
$next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
$next = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true);
if ($tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) {
// If this is the closing brace of a function
// then this return statement doesn't return anything
// and is not required anyway.
$owner = $tokens[$next]['scope_condition'];
if ($tokens[$owner]['code'] === T_FUNCTION) {
if ($tokens[$owner]['code'] === T_FUNCTION
|| $tokens[$owner]['code'] === T_CLOSURE
) {
$warning = 'Empty return statement not required here';
$phpcsFile->addWarning($warning, $stackPtr, 'ReturnNotRequired');
return;
Expand Down Expand Up @@ -174,21 +168,6 @@ public function process(File $phpcsFile, $stackPtr)
}//end if
}//end if

// This token may be part of an inline condition.
// If we find a closing parenthesis that belongs to a condition
// we should ignore this token.
if (isset($tokens[$prev]['parenthesis_owner']) === true) {
$owner = $tokens[$prev]['parenthesis_owner'];
$ignore = [
T_IF => true,
T_ELSE => true,
T_ELSEIF => true,
];
if (isset($ignore[$tokens[$owner]['code']]) === true) {
return;
}
}

$ourConditions = array_keys($tokens[$stackPtr]['conditions']);

if (empty($ourConditions) === false) {
Expand Down
23 changes: 23 additions & 0 deletions src/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,5 +396,28 @@ function executionStoppingThrowExpressionsE() {
echo 'non-executable';
}

function returnNotRequiredIgnoreCommentsA()
{
if ($something === TRUE) {
return /*comment*/;
}

echo 'foo';
return /*comment*/;
}

function returnNotRequiredIgnoreCommentsB()
{
echo 'foo';
return;
/*comment*/
}

$closure = function ()
{
echo 'foo';
return; // This return should be flagged as not required.
};

// Intentional syntax error.
return array_map(
3 changes: 3 additions & 0 deletions src/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ public function getWarningList($testFile='')
386 => 1,
391 => 1,
396 => 1,
406 => 1,
412 => 1,
419 => 1,
];
break;
case 'NonExecutableCodeUnitTest.2.inc':
Expand Down