UselessVariableSniff: Fixed false positives

Author: kukulich

SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php

@@ -9,6 +9,7 @@
 use const T_AND_EQUAL;
 use const T_CONCAT_EQUAL;
 use const T_DIV_EQUAL;
+use const T_DO;
 use const T_DOC_COMMENT_CLOSE_TAG;
 use const T_ELSEIF;
 use const T_EQUAL;
@@ -31,6 +32,8 @@
 use const T_WHITESPACE;
 use const T_XOR_EQUAL;
 use function array_key_exists;
+use function array_keys;
+use function array_reverse;
 use function count;
 use function in_array;
 use function preg_match;
@@ -244,7 +247,7 @@ private function hasAnotherAssigmentBefore(File $phpcsFile, int $variablePointer
 			return false;
 		}
 
-		return $this->areBothPointersNearby($phpcsFile, $previousVariablePointer, $variablePointer);
+		return $this->areBothVariablesNearby($phpcsFile, $previousVariablePointer, $variablePointer);
 	}
 
 	private function areBothPointersNearby(File $phpcsFile, int $firstPointer, int $secondPointer): bool
@@ -255,6 +258,23 @@ private function areBothPointersNearby(File $phpcsFile, int $firstPointer, int $
 		return $pointerAfterFirstVariableSemicolon === $secondPointer;
 	}
 
+	private function areBothVariablesNearby(File $phpcsFile, int $firstVariablePointer, int $secondVariablePointer): bool
+	{
+		if ($this->areBothPointersNearby($phpcsFile, $firstVariablePointer, $secondVariablePointer)) {
+			return true;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$lastConditionPointer = array_reverse(array_keys($tokens[$firstVariablePointer]['conditions']))[0];
+		$lastConditionScopeCloserPointer = $tokens[$lastConditionPointer]['scope_closer'];
+		if ($tokens[$lastConditionPointer]['code'] === T_DO) {
+			$lastConditionScopeCloserPointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $lastConditionScopeCloserPointer + 1);
+		}
+
+		return TokenHelper::findNextEffective($phpcsFile, $lastConditionScopeCloserPointer + 1) === $secondVariablePointer;
+	}
+
 	private function findSemicolon(File $phpcsFile, int $pointer): int
 	{
 		$tokens = $phpcsFile->getTokens();

tests/Sniffs/Variables/data/uselessVariableNoErrors.php

@@ -54,6 +54,52 @@ function moreAssigments() {
 	return $i;
 }
 
+function moreAssigmentsWithIf() {
+	$i = 'i';
+	if (true) {
+		$i .= 'ii';
+	}
+	$i .= 'ii';
+	return $i;
+}
+
+function moreAssigmentsWithFor($values) {
+	$i = 'i';
+	for ($x = 0; $x < count($values); $x++) {
+		$i .= $values[$x];
+	}
+	$i .= 'ii';
+	return $i;
+}
+
+function moreAssigmentsWithForeach($values) {
+	$i = 'i';
+	foreach ($values as $value) {
+		$i .= $value;
+	}
+	$i .= 'ii';
+	return $i;
+}
+
+function moreAssigmentsWithWhile($values) {
+	$i = 'i';
+	while ($value = current($values)) {
+		$i .= $value;
+	}
+	$i .= 'ii';
+	return $i;
+}
+
+function moreAssigmentsWithDo($values) {
+	$i = 'i';
+	$value = current($values);
+	do {
+		$i .= $value;
+	} while ($value = next($values));
+	$i .= 'ii';
+	return $i;
+}
+
 function somethingBetweenAssigmentAndReturn() {
 	$j = 'j';
 	doSomething();