[CodeQuality] Add SingleWithConsecutiveToWithRector (#370)

* register rule to code quality set

* [CodeQuality] Add SingleWithConsecutiveToWithRector

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -26,7 +26,9 @@
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertSameBoolNullToSpecificMethodRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertSameTrueFalseToAssertTrueFalseRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertTrueFalseToSpecificMethodRector;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\NarrowIdenticalWithConsecutiveRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\RemoveExpectAnyFromMockRector;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\UseSpecificWillMethodRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\UseSpecificWithMethodRector;
 
@@ -43,6 +45,10 @@
         AssertEqualsOrAssertSameFloatParameterToSpecificMethodsTypeRector::class,
         DataProviderArrayItemsNewLinedRector::class,
 
+        // narrow with consecutive
+        NarrowIdenticalWithConsecutiveRector::class,
+        SingleWithConsecutiveToWithRector::class,
+
         // specific asserts
         AssertCompareOnCountableWithMethodToAssertCountRector::class,
         AssertCompareToSpecificMethodRector::class,

rules-tests/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector/Fixture/repeated_same.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Source\SomeMockedClass;
+
+final class RepeatedSame extends TestCase
+{
+    public function test()
+    {
+        $someServiceMock = $this->createMock(SomeMockedClass::class);
+        $someServiceMock->expects($this->exactly(3))
+            ->method('prepare')
+            ->withConsecutive(
+                [1],
+            );
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Source\SomeMockedClass;
+
+final class RepeatedSame extends TestCase
+{
+    public function test()
+    {
+        $someServiceMock = $this->createMock(SomeMockedClass::class);
+        $someServiceMock->expects($this->exactly(3))
+            ->method('prepare')
+            ->with(
+                [1],
+            );
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector/Fixture/skip_multiple_values.php.inc

@@ -0,0 +1,20 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\NarrowIdenticalWithConsecutiveRector\Source\SomeMockedClass;
+
+final class SkipMultipleValues extends TestCase
+{
+    public function test()
+    {
+        $someServiceMock = $this->createMock(SomeMockedClass::class);
+        $someServiceMock->expects($this->exactly(3))
+            ->method('prepare')
+            ->withConsecutive(
+                [1],
+                [2],
+            );
+    }
+}

rules-tests/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector/SingleWithConsecutiveToWithRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class SingleWithConsecutiveToWithRectorTest 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';
+    }
+}

rules-tests/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector/Source/SomeMockedClass.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\Source;
+
+class SomeMockedClass
+{
+}

rules-tests/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector/config/configured_rule.php

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

rules/CodeQuality/Rector/MethodCall/NarrowIdenticalWithConsecutiveRector.php

@@ -15,6 +15,9 @@
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\NarrowIdenticalWithConsecutiveRector\NarrowIdenticalWithConsecutiveRectorTest
+ */
 final class NarrowIdenticalWithConsecutiveRector extends AbstractRector
 {
     public function __construct(

rules/CodeQuality/Rector/MethodCall/SingleWithConsecutiveToWithRector.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Identifier;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\SingleWithConsecutiveToWithRector\SingleWithConsecutiveToWithRectorTest
+ */
+final class SingleWithConsecutiveToWithRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change single withConsecutive() to with() call',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function run()
+    {
+        $this->personServiceMock->expects($this->exactly(3))
+            ->method('prepare')
+            ->withConsecutive(
+                [1],
+            );
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function run()
+    {
+        $this->personServiceMock->expects($this->exactly(3))
+            ->method('prepare')
+            ->with([1]);
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<MethodCall|StaticCall>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    /**
+     * @param MethodCall|StaticCall $node
+     */
+    public function refactor(Node $node): MethodCall|StaticCall|null
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        if (! $this->isName($node->name, 'withConsecutive')) {
+            return null;
+        }
+
+        if (count($node->getArgs()) !== 1) {
+            return null;
+        }
+
+        $firstArg = $node->getArgs()[0];
+
+        // use simpler with() instead
+        $node->name = new Identifier('with');
+        $node->args = [new Arg($firstArg->value)];
+
+        return $node;
+    }
+}