Improve ReturnTypeWillChangeRector to handle any method of defined ty…

…pe; move PhpDocFromTypeDeclarationDecorator to Downgrade rules (#2754)

build/target-repository/docs/rector_rules_overview.md

@@ -8696,11 +8696,13 @@ Add #[\ReturnTypeWillChange] attribute to configured instanceof class with metho
 ```php
 use Rector\Config\RectorConfig;
 use Rector\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector;
+use Rector\Transform\ValueObject\ClassMethodReference;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->ruleWithConfiguration(ReturnTypeWillChangeRector::class, [
-        ArrayAccess::class => ['offsetGet'],
-    ]);
+    $rectorConfig->ruleWithConfiguration(
+        ReturnTypeWillChangeRector::class,
+        [new ClassMethodReference('ArrayAccess', 'offsetGet')]
+    );
 };
 ```
 

phpstan.neon

@@ -696,7 +696,10 @@ parameters:
                 - rules/TypeDeclaration/Rector/ClassMethod/AddArrayParamDocTypeRector.php
                 - packages/BetterPhpDocParser/PhpDocParser/PhpDocFromTypeDeclarationDecorator.php
 
-        - '#Call to method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with (.*?) and Rector\\Renaming\\Rector\\Name\\RenameClassRector will always evaluate to true#'
+        -
+            message: '#Call to method PHPUnit\\Framework\\Assert\:\:(.*?)\(\) with (.*?) and (.*?) will always evaluate to (.*?)#'
+            path: *Rector.php
+
         -
             message: '#Method call return value that should be used, but is not#'
             path: src/PhpParser/Node/NodeFactory.php
@@ -706,3 +709,6 @@ parameters:
         -
             message: '#This call has duplicate argument#'
             path: rules/Php72/Rector/Assign/ReplaceEachAssignmentWithKeyCurrentRector.php
+
+        # tests
+        - '#Call to method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with (.*?) and Rector\\Renaming\\Rector\\Name\\RenameClassRector will always evaluate to true#'

rules-tests/CodingStyle/Rector/ClassMethod/ReturnArrayClassMethodToYieldRector/Fixture/fixture3.php.inc

@@ -8,7 +8,7 @@ final class MyTestCase3 extends ParentTestCase
 {
     public function dataProvider(): array
     {
-        return [[__DIR__ . '/Fixture/fixture.php.inc', __DIR__ . '/Correct/correct.php.inc']];
+        return [[__DIR__ . '/Fixture/class_extending_array_access.php.inc', __DIR__ . '/Correct/correct.php.inc']];
     }
 }
 
@@ -24,7 +24,7 @@ final class MyTestCase3 extends ParentTestCase
 {
     public function dataProvider(): \Iterator
     {
-        yield [__DIR__ . '/Fixture/fixture.php.inc', __DIR__ . '/Correct/correct.php.inc'];
+        yield [__DIR__ . '/Fixture/class_extending_array_access.php.inc', __DIR__ . '/Correct/correct.php.inc'];
     }
 }
 

rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/Fixture/fixture.php.inc → rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/Fixture/class_extending_array_access.php.inc

@@ -4,7 +4,7 @@ namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\F
 
 use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\Options;
 
-class SomeClass extends Options
+final class ClassExtendingArrayAccess extends Options
 {
     public function offsetGet($offset)
     {
@@ -19,7 +19,7 @@ namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\F
 
 use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\Options;
 
-class SomeClass extends Options
+final class ClassExtendingArrayAccess extends Options
 {
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)

rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/Fixture/skip_extra_public_method.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Fixture;
+
+final class SkipExtraPublicMethod extends \ArrayObject
+{
+    public function extraMethod()
+    {
+    }
+}

rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/FixtureCustomConfig/fixture.php.inc

@@ -2,15 +2,11 @@
 
 namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\FixtureCustomConfig;
 
-use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\Options;
+use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\ClassThatWillChangeReturnType;
 
-class SomeClass extends Options
+final class SomeClass extends ClassThatWillChangeReturnType
 {
-    public function offsetGet($offset)
-    {
-    }
-
-    public function offsetExists($offset)
+    public function changeMyReturn()
     {
     }
 }
@@ -21,17 +17,12 @@ class SomeClass extends Options
 
 namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\FixtureCustomConfig;
 
-use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\Options;
+use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\ClassThatWillChangeReturnType;
 
-class SomeClass extends Options
+final class SomeClass extends ClassThatWillChangeReturnType
 {
     #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
-    {
-    }
-
-    #[\ReturnTypeWillChange]
-    public function offsetExists($offset)
+    public function changeMyReturn()
     {
     }
 }

rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/Source/ClassThatWillChangeReturnType.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source;
+
+abstract class ClassThatWillChangeReturnType
+{
+    public function changeMyReturn()
+    {
+    }
+}

rules-tests/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector/config/custom_config.php

@@ -3,11 +3,12 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Tests\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector\Source\ClassThatWillChangeReturnType;
 use Rector\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector;
+use Rector\Transform\ValueObject\ClassMethodReference;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig
-        ->ruleWithConfiguration(ReturnTypeWillChangeRector::class, [
-            'ArrayAccess' => ['offsetExists'],
-        ]);
+    $rectorConfig->ruleWithConfiguration(ReturnTypeWillChangeRector::class, [
+        new ClassMethodReference(ClassThatWillChangeReturnType::class, 'changeMyReturn'),
+    ]);
 };

rules/Php81/Enum/AttributeName.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php81\Enum;
+
+final class AttributeName
+{
+    /**
+     * Available since PHP 8.1
+     * @see https://php.watch/versions/8.1/ReturnTypeWillChange
+     * @var string
+     */
+    public const RETURN_TYPE_WILL_CHANGE = 'ReturnTypeWillChange';
+}