SlevomatCodingStandard.Variables.UselessVariable: Fixed false positive

Author: kukulich

SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php

@@ -31,6 +31,7 @@
 use const T_MOD_EQUAL;
 use const T_MUL_EQUAL;
 use const T_OPEN_CURLY_BRACKET;
+use const T_OPEN_PARENTHESIS;
 use const T_OR_EQUAL;
 use const T_PLUS_EQUAL;
 use const T_POW_EQUAL;
@@ -39,6 +40,7 @@
 use const T_SL_EQUAL;
 use const T_SR_EQUAL;
 use const T_STATIC;
+use const T_STRING;
 use const T_SWITCH;
 use const T_VARIABLE;
 use const T_WHILE;
@@ -109,6 +111,10 @@ public function process(File $phpcsFile, $returnPointer): void
 			return;
 		}
 
+		if ($this->isAssignedInFunctionCall($phpcsFile, $previousVariablePointer)) {
+			return;
+		}
+
 		if ($this->hasVariableVarAnnotation($phpcsFile, $previousVariablePointer)) {
 			return;
 		}
@@ -233,6 +239,24 @@ private function isAssignedInControlStructure(File $phpcsFile, int $pointer): bo
 		return $tokens[$controlStructure]['parenthesis_opener'] < $pointer && $pointer < $tokens[$controlStructure]['parenthesis_closer'];
 	}
 
+	private function isAssignedInFunctionCall(File $phpcsFile, int $pointer): bool
+	{
+		$possibleFunctionNamePointer = TokenHelper::findPrevious($phpcsFile, T_STRING, $pointer - 1);
+
+		if ($possibleFunctionNamePointer === null) {
+			return false;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$parenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $possibleFunctionNamePointer + 1);
+		if ($tokens[$parenthesisOpenerPointer]['code'] !== T_OPEN_PARENTHESIS) {
+			return false;
+		}
+
+		return $parenthesisOpenerPointer < $pointer && $pointer < $tokens[$parenthesisOpenerPointer]['parenthesis_closer'];
+	}
+
 	private function isAssigmentToVariable(File $phpcsFile, int $pointer): bool
 	{
 		$assigmentPointer = TokenHelper::findNextEffective($phpcsFile, $pointer + 1);

tests/Sniffs/Variables/UselessVariableSniffTest.php

@@ -17,7 +17,7 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/uselessVariableErrors.php');
 
-		self::assertSame(19, $report->getErrorCount());
+		self::assertSame(18, $report->getErrorCount());
 
 		self::assertSniffError($report, 4, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $a.');
 		self::assertSniffError($report, 9, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $b.');
@@ -34,10 +34,9 @@ public function testErrors(): void
 		self::assertSniffError($report, 64, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $m.');
 		self::assertSniffError($report, 69, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $n.');
 		self::assertSniffError($report, 78, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $o.');
-		self::assertSniffError($report, 84, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $p.');
-		self::assertSniffError($report, 89, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $q.');
-		self::assertSniffError($report, 99, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $r.');
-		self::assertSniffError($report, 103, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $z.');
+		self::assertSniffError($report, 89, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $r.');
+		self::assertSniffError($report, 94, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $s.');
+		self::assertSniffError($report, 98, UselessVariableSniff::CODE_USELESS_VARIABLE, 'Useless variable $z.');
 
 		self::assertAllFixedInFile($report);
 	}

tests/Sniffs/Variables/data/uselessVariableErrors.fixed.php

@@ -63,16 +63,6 @@ function moreVariableOneWithoutAssigment() {
 	return 10;
 }
 
-function assigmentAsFunctionParametr() {
-	doSomething($p = 0);
-	return $p;
-}
-
-function assigmentAfterAssignment() {
-	doSomething($qq = $q = 0);
-	return $q;
-}
-
 function afterIfStatement(float $seconds): string
 {
 	if ($seconds < 1) {
@@ -82,4 +72,9 @@ function afterIfStatement(float $seconds): string
 	return round($seconds, 2) . 's';
 }
 
+function moreAssigments($object) {
+	$object->title = $s = $object->url ?: $object->somethingElse;
+	return $s;
+}
+
 return null;

tests/Sniffs/Variables/data/uselessVariableErrors.php

@@ -80,16 +80,6 @@ function moreVariableOneWithoutAssigment() {
 	return $o;
 }
 
-function assigmentAsFunctionParametr() {
-	doSomething($p = 0);
-	return $p;
-}
-
-function assigmentAfterAssignment() {
-	doSomething($qq = $q = 0);
-	return $q;
-}
-
 function afterIfStatement(float $seconds): string
 {
 	if ($seconds < 1) {
@@ -100,5 +90,10 @@ function afterIfStatement(float $seconds): string
 	return $r;
 }
 
+function moreAssigments($object) {
+	$object->title = $s = $object->url ?: $object->somethingElse;
+	return $s;
+}
+
 $z = null;
 return $z;

tests/Sniffs/Variables/data/uselessVariableNoErrors.php

@@ -191,3 +191,13 @@ function boo($backtrace) {
     for ($class = $backtrace[$frame]['class']; ($parent = get_parent_class($class)) !== false; $class = $parent);
     return $class;
 }
+
+function assigmentAsFunctionParametr() {
+	doSomething($p = 0);
+	return $p;
+}
+
+function assigmentAfterAssignment() {
+	doSomething($qq = $q = 0);
+	return $q;
+}