Skip to content

Create Helpers class for pure functions #34

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 10 commits into from
Feb 12, 2018
Merged

Create Helpers class for pure functions #34

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
100b7a2
Move findContainingBrackets to Helpers class
sirbrillig Feb 12, 2018
eaff857
Move areAnyConditionsAClosure/Class to Helpers
sirbrillig Feb 12, 2018
85b6f07
Move findPreviousFunctionPtr to Helpers
sirbrillig Feb 12, 2018
e62ef1b
Move findFunctionCall/Arguments to Helpers
sirbrillig Feb 12, 2018
9b9ea6f
Move findWhereAssignExecuted to Helpers
sirbrillig Feb 12, 2018
0dd69ca
Move isNextThingAnAssign to Helpers
sirbrillig Feb 12, 2018
ebfda73
Move normalizeVarName to Helpers
sirbrillig Feb 12, 2018
894a0e8
Move findVariableScope to Helpers
sirbrillig Feb 12, 2018
55072df
Move getStackPtrIfVariableIsUnused to Helpers
sirbrillig Feb 12, 2018
089e287
Rename findContainingBrackets to findContainingOpeningBracket
sirbrillig Feb 12, 2018
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move findVariableScope to Helpers
  • Loading branch information
@sirbrillig
sirbrillig committed Feb 12, 2018
commit 894a0e87be1ec26b40b5a076ea0cb540c98cfdda
46 changes: 46 additions & 0 deletions VariableAnalysis/Lib/Helpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,50 @@ public static function isNextThingAnAssign(File $phpcsFile, int $stackPtr) {
public static function normalizeVarName($varName) {
return preg_replace('/[{}$]/', '', $varName);
}

public static function findFunctionPrototype(File $phpcsFile, int $stackPtr) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];

$openPtr = Helpers::findContainingBrackets($phpcsFile, $stackPtr);
if ($openPtr === false) {
return false;
}
$functionPtr = Helpers::findPreviousFunctionPtr($phpcsFile, $openPtr);
if (($functionPtr !== false) && ($tokens[$functionPtr]['code'] === T_FUNCTION)) {
return $functionPtr;
}
return false;
}

public static function findVariableScope(File $phpcsFile, int $stackPtr) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];

$in_class = false;
if (!empty($token['conditions'])) {
foreach (array_reverse($token['conditions'], true) as $scopePtr => $scopeCode) {
if (($scopeCode === T_FUNCTION) || ($scopeCode === T_CLOSURE)) {
return $scopePtr;
}
if (($scopeCode === T_CLASS) || ($scopeCode === T_INTERFACE)) {
$in_class = true;
}
}
}

$scopePtr = Helpers::findFunctionPrototype($phpcsFile, $stackPtr);
if ($scopePtr !== false) {
return $scopePtr;
}

if ($in_class) {
// Member var of a class, we don't care.
return false;
}

// File scope, hmm, lets use first token of file?
return 0;
}

}
51 changes: 3 additions & 48 deletions VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,51 +218,6 @@ protected function markVariableReadAndWarnIfUndefined($phpcsFile, $varName, $sta
}
}

protected function findFunctionPrototype(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];

$openPtr = Helpers::findContainingBrackets($phpcsFile, $stackPtr);
if ($openPtr === false) {
return false;
}
$functionPtr = Helpers::findPreviousFunctionPtr($phpcsFile, $openPtr);
if (($functionPtr !== false) && ($tokens[$functionPtr]['code'] === T_FUNCTION)) {
return $functionPtr;
}
return false;
}

protected function findVariableScope(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];

$in_class = false;
if (!empty($token['conditions'])) {
foreach (array_reverse($token['conditions'], true) as $scopePtr => $scopeCode) {
if (($scopeCode === T_FUNCTION) || ($scopeCode === T_CLOSURE)) {
return $scopePtr;
}
if (($scopeCode === T_CLASS) || ($scopeCode === T_INTERFACE)) {
$in_class = true;
}
}
}

$scopePtr = $this->findFunctionPrototype($phpcsFile, $stackPtr);
if ($scopePtr !== false) {
return $scopePtr;
}

if ($in_class) {
// Member var of a class, we don't care.
return false;
}

// File scope, hmm, lets use first token of file?
return 0;
}

protected function checkForFunctionPrototype(File $phpcsFile, $stackPtr, $varName, $currScope) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];
Expand Down Expand Up @@ -684,7 +639,7 @@ protected function processVariable(File $phpcsFile, $stackPtr) {
$token = $tokens[$stackPtr];

$varName = Helpers::normalizeVarName($token['content']);
$currScope = $this->findVariableScope($phpcsFile, $stackPtr);
$currScope = Helpers::findVariableScope($phpcsFile, $stackPtr);
if ($currScope === false) {
return;
}
Expand Down Expand Up @@ -795,7 +750,7 @@ protected function processVariableInString(File $phpcsFile, $stackPtr) {
return;
}

$currScope = $this->findVariableScope($phpcsFile, $stackPtr);
$currScope = Helpers::findVariableScope($phpcsFile, $stackPtr);
foreach ($matches[1] as $varName) {
$varName = Helpers::normalizeVarName($varName);
// Are we $this within a class?
Expand Down Expand Up @@ -867,7 +822,7 @@ protected function processCompact(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$token = $tokens[$stackPtr];

$currScope = $this->findVariableScope($phpcsFile, $stackPtr);
$currScope = Helpers::findVariableScope($phpcsFile, $stackPtr);

$arguments = Helpers::findFunctionCallArguments($phpcsFile, $stackPtr);
if ($arguments !== false) {
Expand Down