Handle yield termination depending on context

Fix phpmd/phpmd#804
pdepend · Nov 28, 2023 · f653780 · f653780
1 parent 3e059c3
commit f653780
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 7 deletions.
diff --git a/src/main/php/PDepend/Source/Language/PHP/AbstractPHPParser.php b/src/main/php/PDepend/Source/Language/PHP/AbstractPHPParser.php
@@ -3327,7 +3327,7 @@ protected function parseOptionalExpression()
                     $expressions[] = $expr;
                     break;
                 case Tokens::T_YIELD:
-                    $expressions[] = $this->parseYield();
+                    $expressions[] = $this->parseYield(false);
                     break;
                 default:
                     $expressions[] = $this->parseOptionalExpressionForVersion();
@@ -6706,7 +6706,7 @@ private function parseOptionalStatement()
 
                 return $class;
             case Tokens::T_YIELD:
-                return $this->parseYield();
+                return $this->parseYield(true);
         }
 
         $this->tokenStack->push();
@@ -7908,9 +7908,12 @@ private function parseFieldDeclarationClassOrInterfaceReference()
     /**
      * This method parses a yield-statement node.
      *
+     * @param bool $standalone Either yield is the statement (true), or nested in
+     *                         an expression (false).
+     *
      * @return ASTYieldStatement
      */
-    private function parseYield()
+    private function parseYield($standalone)
     {
         $this->tokenStack->push();
 
@@ -7932,12 +7935,10 @@ private function parseYield()
 
         $this->consumeComments();
 
-        if (Tokens::T_PARENTHESIS_CLOSE === $this->tokenizer->peek()) {
-            return $this->setNodePositionsAndReturn($yield);
+        if ($standalone) {
+            $this->parseStatementTermination();
         }
 
-        $this->parseStatementTermination();
-
         return $this->setNodePositionsAndReturn($yield);
     }
 

diff --git a/src/test/php/PDepend/Source/AST/ASTYieldStatementTest.php b/src/test/php/PDepend/Source/AST/ASTYieldStatementTest.php
@@ -65,6 +65,26 @@ public function testYield()
         $this->assertInstanceOf('PDepend\\Source\\AST\\ASTYieldStatement', $stmt);
     }
 
+    /**
+     * testYieldAssignment
+     *
+     * @return void
+     */
+    public function testYieldAssignment()
+    {
+        $stmt = $this->getFirstYieldStatementInFunction(__METHOD__);
+
+        $this->assertInstanceOf('PDepend\\Source\\AST\\ASTYieldStatement', $stmt);
+        $assignment = $stmt->getParent();
+        $this->assertInstanceOf('PDepend\\Source\\AST\\ASTAssignmentExpression', $assignment);
+        $this->assertSame('$result', $assignment->getChild(0)->getImage());
+
+        $this->assertSame(array(
+            'PDepend\\Source\\AST\\ASTLiteral',
+        ), array_map('get_class', $stmt->getChildren()));
+        $this->assertSame('23', $stmt->getChild(0)->getImage());
+    }
+
     /**
      * testYieldWithLiteral
      *

diff --git a/src/test/resources/files/Source/AST/ASTYieldStatement/testYieldAssignment.php b/src/test/resources/files/Source/AST/ASTYieldStatement/testYieldAssignment.php
@@ -0,0 +1,6 @@
+<?php
+
+function testYieldAssignment()
+{
+    $result = yield 23;
+}