EarlyExitSniff: Yield does not do early exit

Author: kukulich

SlevomatCodingStandard/Helpers/TokenHelper.php

@@ -36,8 +36,6 @@
 use const T_THROW;
 use const T_TRAIT;
 use const T_WHITESPACE;
-use const T_YIELD;
-use const T_YIELD_FROM;
 
 class TokenHelper
 {
@@ -99,8 +97,6 @@ class TokenHelper
 		T_CONTINUE,
 		T_BREAK,
 		T_THROW,
-		T_YIELD,
-		T_YIELD_FROM,
 		T_EXIT,
 	];
 

SlevomatCodingStandard/Sniffs/ControlStructures/EarlyExitSniff.php

@@ -29,7 +29,6 @@
 use const T_SEMICOLON;
 use const T_WHILE;
 use const T_WHITESPACE;
-use const T_YIELD;
 
 class EarlyExitSniff implements Sniff
 {
@@ -162,15 +161,6 @@ private function processElse(File $phpcsFile, int $elsePointer): void
 			return;
 		}
 
-		if (
-			$previousConditionEarlyExitPointer !== null
-			&& $tokens[$previousConditionEarlyExitPointer]['code'] === T_YIELD
-			&& $elseEarlyExitPointer !== null
-			&& $tokens[$elseEarlyExitPointer]['code'] === T_YIELD
-		) {
-			return;
-		}
-
 		$pointerAfterElseCondition = TokenHelper::findNextEffective($phpcsFile, $tokens[$elsePointer]['scope_closer'] + 1);
 		if ($pointerAfterElseCondition !== null && $tokens[$pointerAfterElseCondition]['code'] !== T_CLOSE_CURLY_BRACKET) {
 			return;
@@ -218,33 +208,18 @@ private function processElseIf(File $phpcsFile, int $elseIfPointer): void
 			return;
 		}
 
-		$elseIfEarlyExitPointer = null;
-		$previousConditionEarlyExitPointer = null;
-
 		foreach ($allConditionsPointers as $conditionPointer) {
 			$conditionEarlyExitPointer = $this->findEarlyExitInScope($phpcsFile, $tokens[$conditionPointer]['scope_opener'], $tokens[$conditionPointer]['scope_closer']);
 
 			if ($conditionPointer === $elseIfPointer) {
-				$elseIfEarlyExitPointer = $conditionEarlyExitPointer;
 				break;
 			}
 
-			$previousConditionEarlyExitPointer = $conditionEarlyExitPointer;
-
 			if ($conditionEarlyExitPointer === null) {
 				return;
 			}
 		}
 
-		if (
-			$previousConditionEarlyExitPointer !== null
-			&& $tokens[$previousConditionEarlyExitPointer]['code'] === T_YIELD
-			&& $elseIfEarlyExitPointer !== null
-			&& $tokens[$elseIfEarlyExitPointer]['code'] === T_YIELD
-		) {
-			return;
-		}
-
 		$fix = $phpcsFile->addFixableError(
 			'Use "if" instead of "elseif".',
 			$elseIfPointer,

tests/Sniffs/ControlStructures/EarlyExitSniffTest.php

@@ -17,21 +17,21 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/earlyExitErrors.php');
 
-		self::assertSame(65, $report->getErrorCount());
+		self::assertSame(63, $report->getErrorCount());
 
-		foreach ([6, 15, 24, 33, 42, 50, 58, 66, 74, 82, 90, 98, 108, 149, 157, 165, 191, 199, 207, 376] as $line) {
+		foreach ([6, 15, 24, 33, 42, 50, 58, 66, 74, 82, 90, 98, 108, 149, 157, 165, 191, 199, 207] as $line) {
 			self::assertSniffError($report, $line, EarlyExitSniff::CODE_EARLY_EXIT_NOT_USED, 'Use early exit instead of "else".');
 		}
 
-		foreach ([115, 122, 129, 135, 141, 213, 222, 229, 235, 241, 247, 256, 262, 271, 287, 305, 361, 368, 388, 415, 425, 450] as $line) {
+		foreach ([115, 122, 129, 135, 141, 213, 222, 229, 235, 241, 247, 256, 262, 271, 287, 305, 361, 368, 380, 407, 417, 442] as $line) {
 			self::assertSniffError($report, $line, EarlyExitSniff::CODE_EARLY_EXIT_NOT_USED, 'Use early exit to reduce code nesting.');
 		}
 
-		foreach ([173, 182, 328, 353, 398, 440, 462, 475, 505, 514] as $line) {
+		foreach ([173, 182, 328, 353, 390, 432, 454, 467, 495] as $line) {
 			self::assertSniffError($report, $line, EarlyExitSniff::CODE_USELESS_ELSE, 'Remove useless "else" to reduce code nesting.');
 		}
 
-		foreach ([322, 324, 326, 336, 338, 340, 351, 396, 406, 436, 460, 473, 492] as $line) {
+		foreach ([322, 324, 326, 336, 338, 340, 351, 388, 398, 428, 452, 465] as $line) {
 			self::assertSniffError($report, $line, EarlyExitSniff::CODE_USELESS_ELSEIF, 'Use "if" instead of "elseif".');
 		}
 

tests/Sniffs/ControlStructures/data/earlyExitErrors.fixed.php

@@ -46,7 +46,7 @@ function () {
 
 function greateThanOrEqualCondition() {
 	if ($number < 0) {
-		yield [];
+		return [];
 	}
 
 	// Something
@@ -422,14 +422,6 @@ function logicalVeryComplicatedCondition() {
 	doSomething();
 }
 
-function yieldFrom() {
-	if ($number < 0) {
-		yield from [];
-	}
-
-	// Something
-}
-
 function negativeInstanceOf($phpEditor, $jsonEditor) {
 	$this->phpEditor = $phpEditor;
 	$this->jsonEditor = $jsonEditor;
@@ -569,17 +561,6 @@ function nestedIfWhenOneBranchDoesNotHaveEarlyExit($a, $b)
 	}
 };
 
-function yieldWithElse($handle)
-{
-	while (($data = fgetcsv($handle, 0, ',')) !== false) {
-		if (is_numeric($data[0])) {
-			yield $data;
-		}
-
-		echo 'skip';
-	}
-};
-
 // Simple else - needs to be last
 if (true) {
 	return true;

tests/Sniffs/ControlStructures/data/earlyExitErrors.php

@@ -48,7 +48,7 @@ function greateThanOrEqualCondition() {
 	if ($number >= 0) {
 		// Something
 	} else {
-		yield [];
+		return [];
 	}
 }
 
@@ -370,14 +370,6 @@ function logicalVeryComplicatedCondition() {
 	}
 }
 
-function yieldFrom() {
-	if ($number >= 0) {
-		// Something
-	} else {
-		yield from [];
-	}
-}
-
 function negativeInstanceOf($phpEditor, $jsonEditor) {
 	$this->phpEditor = $phpEditor;
 	$this->jsonEditor = $jsonEditor;
@@ -497,17 +489,6 @@ function nestedIfWhenOneBranchDoesNotHaveEarlyExit($a, $b)
 	}
 };
 
-function yieldWithElse($handle)
-{
-	while (($data = fgetcsv($handle, 0, ',')) !== false) {
-		if (is_numeric($data[0])) {
-			yield $data;
-		} else {
-			echo 'skip';
-		}
-	}
-};
-
 // Simple else - needs to be last
 if (true) {
 	return true;

tests/Sniffs/ControlStructures/data/earlyExitNoErrors.php

@@ -42,7 +42,7 @@ function () {
 
 function () {
 	if (false) {
-		yield [];
+		return [];
 	}
 
 	// Something
@@ -191,26 +191,6 @@ function allConditionsWithEarlyExitButCodeAfter($dateTime) {
 	somethingElse();
 }
 
-function twoYields(bool $flag)
-{
-	if ($flag) {
-		yield 1;
-	} else {
-		yield 2;
-	}
-}
-
-function manyYields(bool $flag)
-{
-	if ($flag) {
-		yield 1;
-	} elseif (!$flag) {
-		yield 2;
-	} else {
-		yield 3;
-	}
-}
-
 function nestedIfWhenOneBranchDoesNotHaveEarlyExit($a, $b)
 {
 	if ($a === 1) {