add custom rector to transform EntityTrait set method to patch if first param is an array (#315)

* add custom rector to transform EntityTrait set method to patch if first param is an array
* add custom rector rule to 5.2 config + add test
* fix custom rector applying to non EntityTrait objects

Author: LordSimal

config/rector/sets/cakephp52.php

@@ -1,6 +1,7 @@
 <?php
 declare(strict_types=1);
 
+use Cake\Upgrade\Rector\Rector\MethodCall\ChangeEntityTraitSetArrayToPatchRector;
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
 use Rector\Renaming\ValueObject\MethodCallRename;
@@ -10,4 +11,5 @@
     $rectorConfig->ruleWithConfiguration(RenameMethodRector::class, [
         new MethodCallRename('Cake\Console\Arguments', 'getMultipleOption', 'getArrayOption'),
     ]);
+    $rectorConfig->rule(ChangeEntityTraitSetArrayToPatchRector::class);
 };

src/Rector/Rector/MethodCall/ChangeEntityTraitSetArrayToPatchRector.php

@@ -0,0 +1,80 @@
+<?php
+declare(strict_types=1);
+
+namespace Cake\Upgrade\Rector\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class ChangeEntityTraitSetArrayToPatchRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replaces $this->set(array) with $this->patch(array) when the first param is an array',
+            [
+                new ConfiguredCodeSample(
+                    <<<'CODE_SAMPLE'
+$this->set(['key' => 'value']);
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+$this->patch(['key' => 'value']);
+CODE_SAMPLE,
+                ),
+            ],
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node instanceof MethodCall) {
+            return null;
+        }
+
+        // Check the method name is "set"
+        if (! $this->isName($node->name, 'set')) {
+            return null;
+        }
+
+        // Check that the first argument exists and is an array
+        if (! isset($node->args[0])) {
+            return null;
+        }
+
+        $firstArg = $node->args[0]->value;
+        if (! $firstArg instanceof Array_) {
+            return null;
+        }
+
+        // Make sure the method is called on an object that uses EntityTrait
+        $callerType = $this->getType($node->var);
+        if (! $callerType instanceof ObjectType) {
+            return null;
+        }
+
+        $classReflection = $callerType->getClassReflection();
+        if ($classReflection === null) {
+            return null;
+        }
+        if (! $classReflection->hasTraitUse('Cake\Datasource\EntityTrait')) {
+            return null;
+        }
+
+        // Rename the method to "patch"
+        $node->name = new Identifier('patch');
+
+        return $node;
+    }
+}

tests/TestCase/Rector/MethodCall/ChangeEntityTraitSetArrayToPatch/ChangeEntityTraitSetArrayToPatchTest.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace Cake\Upgrade\Test\TestCase\Rector\MethodCall\ChangeEntityTraitSetArrayToPatch;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ChangeEntityTraitSetArrayToPatchTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/TestCase/Rector/MethodCall/ChangeEntityTraitSetArrayToPatch/Fixture/fixture.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Cake\Upgrade\Test\TestCase\Rector\MethodCall\AddMethodCallArgsRectorTest\Fixture;
+
+use Cake\ORM\Entity;
+use Cake\Upgrade\Test\TestCase\Rector\MethodCall\ChangeEntityTraitSetArrayToPatch\Source\OtherClassWithSetMethod;
+
+function mymethod()
+{
+    $object = new Entity();
+    // This should be changed to patch
+    $object->set(['paging' => 'test']);
+    // This should not be changed
+    $object->set('paging', 'test');
+
+    $otherObject = new OtherClassWithSetMethod();
+    // This should not be changed as well
+    $otherObject->set(['paging' => 'test']);
+}
+
+?>
+-----
+<?php
+
+namespace Cake\Upgrade\Test\TestCase\Rector\MethodCall\AddMethodCallArgsRectorTest\Fixture;
+
+use Cake\ORM\Entity;
+use Cake\Upgrade\Test\TestCase\Rector\MethodCall\ChangeEntityTraitSetArrayToPatch\Source\OtherClassWithSetMethod;
+
+function mymethod()
+{
+    $object = new Entity();
+    // This should be changed to patch
+    $object->patch(['paging' => 'test']);
+    // This should not be changed
+    $object->set('paging', 'test');
+
+    $otherObject = new OtherClassWithSetMethod();
+    // This should not be changed as well
+    $otherObject->set(['paging' => 'test']);
+}
+
+?>

tests/TestCase/Rector/MethodCall/ChangeEntityTraitSetArrayToPatch/Source/OtherClassWithSetMethod.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace Cake\Upgrade\Test\TestCase\Rector\MethodCall\ChangeEntityTraitSetArrayToPatch\Source;
+
+class OtherClassWithSetMethod
+{
+    public function set(array $arg1): void
+    {
+    }
+}

tests/TestCase/Rector/MethodCall/ChangeEntityTraitSetArrayToPatch/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+use Cake\Upgrade\Rector\Rector\MethodCall\ChangeEntityTraitSetArrayToPatchRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ChangeEntityTraitSetArrayToPatchRector::class);
+};

tests/test_apps/original/RectorCommand-testApply52/src/SomeTest.php

@@ -4,12 +4,19 @@
 namespace MyPlugin;
 
 use Cake\Console\Arguments;
+use Cake\ORM\Entity;
 
 class SomeTest extends TestCase
 {
     public function testRenames(): void
     {
         $args = new Arguments([], ['a' => [1, 2]], []);
         $option = $args->getMultipleOption('a');
+
+        $entity = new Entity();
+        // This should be changed to patch
+        $entity->set(['paging' => 'test']);
+        // This should not be changed
+        $entity->set('paging', 'test');
     }
 }

tests/test_apps/upgraded/RectorCommand-testApply52/src/SomeTest.php

@@ -4,12 +4,19 @@
 namespace MyPlugin;
 
 use Cake\Console\Arguments;
+use Cake\ORM\Entity;
 
 class SomeTest extends TestCase
 {
     public function testRenames(): void
     {
         $args = new Arguments([], ['a' => [1, 2]], []);
         $option = $args->getArrayOption('a');
+
+        $entity = new Entity();
+        // This should be changed to patch
+        $entity->patch(['paging' => 'test']);
+        // This should not be changed
+        $entity->set('paging', 'test');
     }
 }