Merge pull request #13 from php/DEVXP-372_do_not_remove_never_return_type_from_rewritten_code

[DEVXP-372]: Do not remove 'never' return type from rewritten code.

Author: quentin389

src/Badoo/SoftMocks.php

@@ -276,7 +276,7 @@ protected function pStmt_ClassMethod(\PhpParser\Node\Stmt\ClassMethod $node): st
             . $this->pModifiers($node->flags)
             . 'function ' . ($node->byRef ? '&' : '') . $node->name
             . '(' . $this->pCommaSeparated($node->params) . ')'
-            . ($this->functionShouldReturn($node) ? ' : ' . $this->p($node->returnType) : '')
+            . ($this->functionShouldHaveReturnType($node) ? ' : ' . $this->p($node->returnType) : '')
             . (null !== $node->stmts ? '{' . $this->pStmts($node->stmts) . '}' : ';');
     }
 
@@ -288,7 +288,7 @@ protected function pStmt_Function(\PhpParser\Node\Stmt\Function_ $node): string
         return $ret
             . 'function ' . ($node->byRef ? '&' : '') . $node->name
             . '(' . $this->pCommaSeparated($node->params) . ')'
-            . ($this->functionShouldReturn($node) ? ' : ' . $this->p($node->returnType) : '')
+            . ($this->functionShouldHaveReturnType($node) ? ' : ' . $this->p($node->returnType) : '')
             . '{' . $this->pStmts($node->stmts) . '}';
     }
 
@@ -436,17 +436,9 @@ protected function addAttributeGroupsBeforeStatement(\PhpParser\Node\Stmt $node)
      * @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_ $node
      * @noinspection PhpDocSignatureInspection - PHP 7.4 compatibility
      */
-    protected function functionShouldReturn(\PhpParser\Node\Stmt $node): bool
+    protected function functionShouldHaveReturnType(\PhpParser\Node\Stmt $node): bool
     {
-        if ($node->returnType === null) {
-            return false;
-        }
-
-        if ($node->returnType instanceof \PhpParser\Node\Identifier && $node->returnType->name === 'never') {
-            return false;
-        }
-
-        return true;
+        return $node->returnType !== null;
     }
 }
 
@@ -2790,7 +2782,7 @@ public function rewriteStmt_ClassMethod(\PhpParser\Node\Stmt\ClassMethod $Node)
         //     $mm_callback = SoftMocks::getMockForGenerator();
         //     foreach ($mm_callback(...) as $mm_val) { yield $mm_val; }
         //
-        // also functions with void return type declarations cannot return values
+        // also functions with 'void' or 'never' return type declarations cannot return values
         if ($this->has_yield) {
             $args = [$static, $function];
 
@@ -2845,9 +2837,12 @@ public function rewriteStmt_ClassMethod(\PhpParser\Node\Stmt\ClassMethod $Node)
                 new \PhpParser\Node\Expr\Variable("__softmocksvariableforcode")
             );
 
-            if ($Node->returnType instanceof \PhpParser\Node\Identifier && $Node->returnType->name === 'void') {
+            $returnTypeName = $Node->returnType instanceof \PhpParser\Node\Identifier ? $Node->returnType->name : null;
+            if ($returnTypeName === 'void') {
                 $body_stmts[] = new \PhpParser\Node\Stmt\Expression($eval);
                 $body_stmts[] = new \PhpParser\Node\Stmt\Return_();
+            } elseif ($returnTypeName === 'never') {
+                $body_stmts[] = new \PhpParser\Node\Stmt\Expression($eval);
             } else {
                 $body_stmts[] = new \PhpParser\Node\Stmt\Return_($eval);
             }

tests/unit/Badoo/fixtures/expected/php81.php

@@ -28,18 +28,28 @@ public function __construct(public readonly \One&\Three $typeIntersection, prote
 
 
 
-    public function testStoppingProgramFlow(){if (isset(\Badoo\SoftMocks::$mocks_by_name[__FUNCTION__]) && false !== $__softmocksvariableforcode = \Badoo\SoftMocks::isMocked(testThings::class, static::class, __FUNCTION__)) {$mm_func_args = func_get_args();$params = [];$variadic_params_idx = '';return eval($__softmocksvariableforcode);/** @codeCoverageIgnore */}
+    public function testStoppingProgramFlowWithExit() : never{if (isset(\Badoo\SoftMocks::$mocks_by_name[__FUNCTION__]) && false !== $__softmocksvariableforcode = \Badoo\SoftMocks::isMocked(testThings::class, static::class, __FUNCTION__)) {$mm_func_args = func_get_args();$params = [];$variadic_params_idx = '';eval($__softmocksvariableforcode);/** @codeCoverageIgnore */}
 
         $value = 1 + 2;
 
         \Badoo\SoftMocks::callExit(666);}
 
 
+    /**
+ * @throws Exception
+ */
+    public function testStoppingProgramFlowWithException() : never{if (isset(\Badoo\SoftMocks::$mocks_by_name[__FUNCTION__]) && false !== $__softmocksvariableforcode = \Badoo\SoftMocks::isMocked(testThings::class, static::class, __FUNCTION__)) {$mm_func_args = func_get_args();$params = [];$variadic_params_idx = '';eval($__softmocksvariableforcode);/** @codeCoverageIgnore */}
+        
+        $value = 1 + 2;
+        
+        throw new \Exception('Some exception');}
+    
+    
     public function testMakeFunctionClosureWithSpreadOperator(\One&\Three $typeIntersection) : void{if (isset(\Badoo\SoftMocks::$mocks_by_name[__FUNCTION__]) && false !== $__softmocksvariableforcode = \Badoo\SoftMocks::isMocked(testThings::class, static::class, __FUNCTION__)) {$mm_func_args = func_get_args();$params = [$typeIntersection];$variadic_params_idx = '';eval($__softmocksvariableforcode);return;/** @codeCoverageIgnore */}
 
         $closureOne = isset(\Badoo\SoftMocks::$func_mocks_by_name['array_merge']) ? fn() => \Badoo\SoftMocks::callFunction('', 'array_merge', \func_get_args()) : \array_merge(...);
         $closureTwo = isset(\Badoo\SoftMocks::$func_mocks_by_name['something']) ? fn() => \Badoo\SoftMocks::callFunction('', 'something', \func_get_args()) : \something(...);
-        $closureThree = $this->testStoppingProgramFlow(...);
+        $closureThree = $this->testStoppingProgramFlowWithExit(...);
 
         \Badoo\SoftMocks::call(__NAMESPACE__, $closureOne, [['will'], ['be'], ['merged'], ['some new octal notation:', 016, 033]]);
         \Badoo\SoftMocks::call(__NAMESPACE__, $closureTwo, [&$typeIntersection, &$typeIntersection]);}}
@@ -50,6 +60,11 @@ function testTypeIntersectionInFunction(\One&\Three $typeIntersection){}
 
 
 
-function neverReturns(){
+function neverReturnsWithExit() : never{
 
     \Badoo\SoftMocks::callExit(111);}
+
+
+function neverReturnsWithException() : never{
+    
+    throw new \RuntimeException('Some runtime exception');}

tests/unit/Badoo/fixtures/original/php81.php

@@ -28,18 +28,28 @@ public function __construct(
     ) {
     }
 
-    public function testStoppingProgramFlow(): never
+    public function testStoppingProgramFlowWithExit(): never
     {
         $value = 1 + 2;
 
         exit(666);
     }
 
+    /**
+     * @throws Exception
+     */
+    public function testStoppingProgramFlowWithException(): never
+    {
+        $value = 1 + 2;
+
+        throw new \Exception('Some exception');
+    }
+
     public function testMakeFunctionClosureWithSpreadOperator(One & Three $typeIntersection): void
     {
         $closureOne = array_merge(...);
         $closureTwo = something(...);
-        $closureThree = $this->testStoppingProgramFlow(...);
+        $closureThree = $this->testStoppingProgramFlowWithExit(...);
 
         $closureOne(['will'], ['be'], ['merged'], ['some new octal notation:', 0o16, 0O33]);
         $closureTwo($typeIntersection, $typeIntersection);
@@ -50,7 +60,12 @@ function testTypeIntersectionInFunction(One & Three $typeIntersection)
 {
 }
 
-function neverReturns(): never
+function neverReturnsWithExit(): never
 {
     exit(111);
 }
+
+function neverReturnsWithException(): never
+{
+    throw new \RuntimeException('Some runtime exception');
+}