Added rector rule

Author: Michael Petri

composer.json

@@ -16,7 +16,8 @@
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.15.1",
     "roave/security-advisories": "dev-latest",
-    "vimeo/psalm": "^5.8.0"
+    "vimeo/psalm": "^5.8.0",
+    "rector/rector": "^0.17.6"
   },
   "autoload": {
     "psr-4": {
@@ -45,6 +46,8 @@
     "security": "composer update --dry-run roave/security-advisories",
     "phpunit": "vendor/bin/phpunit --testdox --order-by=random",
     "phpunit-coverage-report": "vendor/bin/phpunit --coverage-html=.phpunit-coverage-report",
+    "rector-test": "vendor/bin/rector --dry-run",
+    "rector-debug": "vendor/bin/rector --dry-run --xdebug",
     "bash": "bash"
   }
 }

rector-test/ExampleTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpParser\Node;
+use PHPUnit\Framework\TestCase;
+
+final class ExampleTest extends TestCase
+{
+    public function testExample(): void
+    {
+        $mock = $this->createMock(Node::class);
+
+        $mock
+            ->expects(self::exactly(2))
+            ->method('hasAttribute')
+            ->withConsecutive(
+                ['foo'],
+                ['bar']
+            )
+            ->willReturn(true);
+
+        $mock->hasAttribute('foo');
+        $mock->hasAttribute('bar');
+    }
+}

rector.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use MichaelPetri\PhpunitConsecutiveArguments\ConsecutiveArgumentsRectorRule;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/rector-test',
+    ]);
+
+    $rectorConfig->rule(ConsecutiveArgumentsRectorRule::class);
+};

src/ConsecutiveArgumentsRectorRule.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MichaelPetri\PhpunitConsecutiveArguments;
+
+use PhpParser\Node;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class ConsecutiveArgumentsRectorRule extends AbstractRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [
+            Node\Expr\MethodCall::class
+        ];
+    }
+
+    public function refactor(Node $node): ?Node
+    {
+        if (!$node instanceof Node\Expr\MethodCall) {
+            return null;
+        }
+
+        if (
+            $node->name instanceof Node\Identifier &&
+            $node->name->name !== 'withConsecutive'
+        ) {
+            return null;
+        }
+
+        $node->name = new Node\Identifier('with');
+
+        $node->args = [
+            new Node\Arg(
+                new Node\Expr\StaticCall(
+                    new Node\Name(
+                        '\\' . ConsecutiveArguments::class
+                    ),
+                    new Node\Identifier('of'),
+                    $node->args,
+                )
+            )
+        ];
+
+        return $node;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Use $mock->with(ConsecutiveArguments::of(...)) instead of $mock->withConsecutive(...)',
+            [
+                new CodeSample(
+                    <<<PHP
+use MichaelPetri\PhpunitConsecutiveArguments\ConsecutiveArguments;
+use PhpParser\Node;
+use PHPUnit\Framework\TestCase;
+
+final class GoodExample extends TestCase
+{
+    public function testExample(): void
+    {
+        \$mock = \$this->createMock(Node::class);
+
+        \$mock
+            ->expects(self::exactly(2))
+            ->method('hasAttribute')
+            ->with(
+                ConsecutiveArguments::of(
+                    ['foo'],
+                    ['bar']
+                )
+            )
+            ->willReturn(true);
+
+        \$mock->hasAttribute('foo');
+        \$mock->hasAttribute('bar');
+    }
+}
+PHP,
+                    <<<PHP
+use PhpParser\Node;
+use PHPUnit\Framework\TestCase;
+
+final class BadExample extends TestCase
+{
+    public function testExample(): void
+    {
+        \$mock = \$this->createMock(Node::class);
+
+        \$mock
+            ->expects(self::exactly(2))
+            ->method('hasAttribute')
+            ->withConsecutive(
+                ['foo'],
+                ['bar']
+            )
+            ->willReturn(true);
+
+        \$mock->hasAttribute('foo');
+        \$mock->hasAttribute('bar');
+    }
+}
+PHP
+                )
+            ]
+        );
+    }
+}