From 62da80c9eb19ba287795102ada7a867d25ae96ac Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Mon, 16 Nov 2026 22:53:11 +0100 Subject: [PATCH] [Transform] Deprecate WrapReturnRector, replaced by dedicated rule --- .../WrapReturnRector/Fixture/fixture.php.inc | 31 --------- .../Fixture/skip_already_array.php.inc | 13 ---- .../Source/SomeReturnClass.php | 10 --- .../WrapReturnRector/WrapReturnRectorTest.php | 28 -------- .../config/configured_rule.php | 13 ---- .../Rector/ClassMethod/WrapReturnRector.php | 68 +++---------------- rules/Transform/ValueObject/WrapReturn.php | 3 + 7 files changed, 11 insertions(+), 155 deletions(-) delete mode 100644 rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/fixture.php.inc delete mode 100644 rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/skip_already_array.php.inc delete mode 100644 rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Source/SomeReturnClass.php delete mode 100644 rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/WrapReturnRectorTest.php delete mode 100644 rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/config/configured_rule.php diff --git a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/fixture.php.inc b/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/fixture.php.inc deleted file mode 100644 index b8691be577d..00000000000 --- a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/fixture.php.inc +++ /dev/null @@ -1,31 +0,0 @@ - ------ - diff --git a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/skip_already_array.php.inc b/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/skip_already_array.php.inc deleted file mode 100644 index 4d5f48f566e..00000000000 --- a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/Fixture/skip_already_array.php.inc +++ /dev/null @@ -1,13 +0,0 @@ -doTestFile($filePath); - } - - public static function provideData(): Iterator - { - return self::yieldFilesFromDirectory(__DIR__ . '/Fixture'); - } - - public function provideConfigFilePath(): string - { - return __DIR__ . '/config/configured_rule.php'; - } -} diff --git a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/config/configured_rule.php b/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/config/configured_rule.php deleted file mode 100644 index 7c2587fdfeb..00000000000 --- a/rules-tests/Transform/Rector/ClassMethod/WrapReturnRector/config/configured_rule.php +++ /dev/null @@ -1,13 +0,0 @@ -ruleWithConfiguration(WrapReturnRector::class, [new WrapReturn(SomeReturnClass::class, 'getItem', true)]); -}; diff --git a/rules/Transform/Rector/ClassMethod/WrapReturnRector.php b/rules/Transform/Rector/ClassMethod/WrapReturnRector.php index 7b2874662ae..77e3a9d312b 100644 --- a/rules/Transform/Rector/ClassMethod/WrapReturnRector.php +++ b/rules/Transform/Rector/ClassMethod/WrapReturnRector.php @@ -5,29 +5,20 @@ namespace Rector\Transform\Rector\ClassMethod; use PhpParser\Node; -use PhpParser\Node\ArrayItem; -use PhpParser\Node\Expr; -use PhpParser\Node\Expr\Array_; use PhpParser\Node\Stmt\Class_; -use PhpParser\Node\Stmt\ClassMethod; -use PhpParser\Node\Stmt\Return_; +use Rector\Configuration\Deprecation\Contract\DeprecatedInterface; use Rector\Contract\Rector\ConfigurableRectorInterface; +use Rector\Exception\ShouldNotHappenException; use Rector\Rector\AbstractRector; use Rector\RuleDoc\CodeSample\ConfiguredCodeSample; use Rector\RuleDoc\RuleDefinition; use Rector\Transform\ValueObject\WrapReturn; -use Webmozart\Assert\Assert; /** - * @see \Rector\Tests\Transform\Rector\ClassMethod\WrapReturnRector\WrapReturnRectorTest + * @deprecated This rule is deprecated, as only used for 1 case now covered by dedicated GetExtendedTypesReturnArrayRector in rector-symfony. Write a custom rule for the exact project case instead. */ -final class WrapReturnRector extends AbstractRector implements ConfigurableRectorInterface +final class WrapReturnRector extends AbstractRector implements ConfigurableRectorInterface, DeprecatedInterface { - /** - * @var WrapReturn[] - */ - private array $typeMethodWraps = []; - public function getRuleDefinition(): RuleDefinition { return new RuleDefinition('Wrap return value of specific method', [ @@ -70,33 +61,10 @@ public function getNodeTypes(): array */ public function refactor(Node $node): ?Node { - $hasChanged = false; - - foreach ($this->typeMethodWraps as $typeMethodWrap) { - foreach ($node->getMethods() as $classMethod) { - if (! $this->isName($classMethod, $typeMethodWrap->getMethod())) { - continue; - } - - if ($node->stmts === null) { - continue; - } - - if (! $this->isObjectType($node, $typeMethodWrap->getObjectType())) { - continue; - } - - if ($typeMethodWrap->isArrayWrap() && $this->wrap($classMethod)) { - $hasChanged = true; - } - } - } - - if ($hasChanged) { - return $node; - } - - return null; + throw new ShouldNotHappenException(sprintf( + '"%s" rule is deprecated, as only used for 1 case now covered by a dedicated rule; write a custom rule for the exact project case instead', + self::class + )); } /** @@ -104,25 +72,5 @@ public function refactor(Node $node): ?Node */ public function configure(array $configuration): void { - Assert::allIsAOf($configuration, WrapReturn::class); - $this->typeMethodWraps = $configuration; - } - - private function wrap(ClassMethod $classMethod): bool - { - if (! is_iterable($classMethod->stmts)) { - return false; - } - - $hasChanged = false; - foreach ($classMethod->stmts as $stmt) { - if ($stmt instanceof Return_ && $stmt->expr instanceof Expr - && ! $stmt->expr instanceof Array_) { - $stmt->expr = new Array_([new ArrayItem($stmt->expr)]); - $hasChanged = true; - } - } - - return $hasChanged; } } diff --git a/rules/Transform/ValueObject/WrapReturn.php b/rules/Transform/ValueObject/WrapReturn.php index 5782ff77143..b54ace3b889 100644 --- a/rules/Transform/ValueObject/WrapReturn.php +++ b/rules/Transform/ValueObject/WrapReturn.php @@ -7,6 +7,9 @@ use PHPStan\Type\ObjectType; use Rector\Validation\RectorAssert; +/** + * @api used in deprecated WrapReturnRector configs + */ final readonly class WrapReturn { public function __construct(