Custom rector for 'whereNot'

Author: mamazu

config/sets/sulu/sulu-30.php

@@ -5,6 +5,7 @@
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
 use Rector\Renaming\ValueObject\MethodCallRename;
+use Sulu\Rector\Rector\ListBuilderInterfaceRector;
 use Sulu\Rector\Rector\RequestParameterTraitRector;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -26,4 +27,5 @@
     );
 
     $rectorConfig->rule(RequestParameterTraitRector::class);
+    $rectorConfig->rule(ListBuilderInterfaceRector::class);
 };

src/Rector/ListBuilderInterfaceRector.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sulu\Rector\Rector;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
+use Rector\Contract\Rector\RectorInterface;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use PHPStan\Type\ObjectType;
+
+class ListBuilderInterfaceRector extends AbstractRector implements RectorInterface
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Fixes ListBuilderInterface',
+            [
+                new CodeSample(
+                    <<<CODE_SAMPLE
+                    use Sulu\Component\Rest\ListBuilder\ListBuilderInterface;
+                    class Test implements ListBuilderInterface {
+                        public function invoke() {
+                            \$this->whereNot(\$fieldDescriptor, 'value');
+                        }
+                    }
+                    CODE_SAMPLE,
+                    <<<CODE_SAMPLE
+                    use Sulu\Component\Rest\ListBuilder\ListBuilderInterface;
+                    class Test implements ListBuilderInterface {
+                        public function invoke() {
+                            \$this->where(\$fieldDescriptor, 'value', ListBuilderInterface::WHERE_COMPARATOR_UNEQUAL);
+                        }
+                    }
+                    CODE_SAMPLE
+                ),
+            ],
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    public function refactor(Node $node)
+    {
+        /** @var MethodCall $node */
+        $objectType = new ObjectType('Sulu\Component\Rest\ListBuilder\ListBuilderInterface');
+        if (!$this->nodeTypeResolver->isMethodStaticCallOrClassMethodObjectType($node, $objectType)) {
+            return null;
+        }
+
+        $node->name = new Identifier('where');
+        $node->args[] = new Arg(
+            new ClassConstFetch(
+                new Name(['ListBuilderInterface']),
+                new Identifier('WHERE_COMPARATOR_UNEQUAL'),
+            )
+        );
+
+        return $node;
+    }
+}

tests/Rector/ListBuilderInterfaceRector/Fixture/test_refactor.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+use Sulu\Component\Rest\ListBuilder\ListBuilderInterface;
+
+class Test implements ListBuilderInterface
+{
+    public function invoke() {
+        $this->whereNot($fieldDescriptor, 'value');
+    }
+}
+-----
+<?php
+
+use Sulu\Component\Rest\ListBuilder\ListBuilderInterface;
+
+class Test implements ListBuilderInterface
+{
+    public function invoke() {
+        $this->where($fieldDescriptor, 'value', ListBuilderInterface::WHERE_COMPARATOR_UNEQUAL);
+    }
+}

tests/Rector/ListBuilderInterfaceRector/ListBuilderInterfaceRectorTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sulu\Rector\Tests\Rector\ListBuilderInterfaceRector;
+
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+class ListBuilderInterfaceRectorTest 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/config.php';
+    }
+}

tests/Rector/ListBuilderInterfaceRector/config/config.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Sulu\Rector\Rector\ListBuilderInterfaceRector;
+
+return RectorConfig::configure()
+    ->withRules([
+        ListBuilderInterfaceRector::class,
+    ]);