Make ReturnNeverTypeRector work with type declaration, add it to PHP …

…8.1 set (#3852)

build/target-repository/docs/rector_rules_overview.md

@@ -9357,10 +9357,8 @@ Add "never" return-type for methods that never return anything
 ```diff
  final class SomeClass
  {
-+    /**
-+     * @return never
-+     */
-     public function run()
+-    public function run()
++    public function run(): never
      {
          throw new InvalidException();
      }

config/set/php81.php

@@ -17,16 +17,19 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rule(ReturnNeverTypeRector::class);
-    $rectorConfig->rule(MyCLabsClassToEnumRector::class);
-    $rectorConfig->rule(MyCLabsMethodCallToEnumConstRector::class);
-    $rectorConfig->rule(FinalizePublicClassConstantRector::class);
-    $rectorConfig->rule(ReadOnlyPropertyRector::class);
-    $rectorConfig->rule(SpatieEnumClassToEnumRector::class);
-    $rectorConfig->rule(SpatieEnumMethodCallToEnumConstRector::class);
-    $rectorConfig->rule(Php81ResourceReturnToObjectRector::class);
-    $rectorConfig->rule(NewInInitializerRector::class);
-    $rectorConfig->rule(IntersectionTypesRector::class);
-    $rectorConfig->rule(NullToStrictStringFuncCallArgRector::class);
-    $rectorConfig->rule(FirstClassCallableRector::class);
+    $rectorConfig->rules([
+        ReturnNeverTypeRector::class,
+        MyCLabsClassToEnumRector::class,
+        MyCLabsMethodCallToEnumConstRector::class,
+        FinalizePublicClassConstantRector::class,
+        ReadOnlyPropertyRector::class,
+        SpatieEnumClassToEnumRector::class,
+        SpatieEnumMethodCallToEnumConstRector::class,
+        Php81ResourceReturnToObjectRector::class,
+        NewInInitializerRector::class,
+        IntersectionTypesRector::class,
+        NullToStrictStringFuncCallArgRector::class,
+        FirstClassCallableRector::class,
+        ReturnNeverTypeRector::class,
+    ]);
 };

packages/Testing/PHPUnit/AbstractTestCase.php

@@ -9,7 +9,6 @@
 use Rector\Core\Exception\ShouldNotHappenException;
 use Rector\Core\Kernel\RectorKernel;
 use Rector\Core\Util\FileHasher;
-use Webmozart\Assert\Assert;
 
 abstract class AbstractTestCase extends TestCase
 {

rules/TypeDeclaration/Rector/ClassMethod/ReturnNeverTypeRector.php

@@ -15,12 +15,11 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\Node\Stmt\Throw_;
 use PHPStan\Type\NeverType;
-use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
-use Rector\Core\Php\PhpVersionProvider;
 use Rector\Core\Rector\AbstractRector;
 use Rector\Core\ValueObject\PhpVersionFeature;
 use Rector\NodeNestingScope\ValueObject\ControlStructure;
 use Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnTypeOverrideGuard;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -29,12 +28,10 @@
  *
  * @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector\ReturnNeverTypeRectorTest
  */
-final class ReturnNeverTypeRector extends AbstractRector
+final class ReturnNeverTypeRector extends AbstractRector implements MinPhpVersionInterface
 {
     public function __construct(
         private readonly ClassMethodReturnTypeOverrideGuard $classMethodReturnTypeOverrideGuard,
-        private readonly PhpDocTypeChanger $phpDocTypeChanger,
-        private readonly PhpVersionProvider $phpVersionProvider,
     ) {
     }
 
@@ -56,10 +53,7 @@ public function run()
                 <<<'CODE_SAMPLE'
 final class SomeClass
 {
-    /**
-     * @return never
-     */
-    public function run()
+    public function run(): never
     {
         throw new InvalidException();
     }
@@ -86,22 +80,16 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if ($this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::NEVER_TYPE)) {
-            // never-type supported natively
-            $node->returnType = new Identifier('never');
-        } else {
-            // static anlysis based never type
-            $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-            $hasChanged = $this->phpDocTypeChanger->changeReturnType($phpDocInfo, new NeverType());
-
-            if (! $hasChanged) {
-                return null;
-            }
-        }
+        $node->returnType = new Identifier('never');
 
         return $node;
     }
 
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::NEVER_TYPE;
+    }
+
     private function shouldSkip(ClassMethod | Function_ | Closure $node): bool
     {
         $hasReturn = $this->betterNodeFinder->hasInstancesOfInFunctionLikeScoped($node, Return_::class);