GetMockBuilderGetMockToCreateMockRector.php

<?php

declare(strict_types=1);

namespace Rector\PHPUnit\PHPUnit60\Rector\MethodCall;

use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\Variable;
use PHPStan\Type\ObjectType;
use Rector\Rector\AbstractRector;
use Rector\VersionBonding\Contract\ComposerPackageConstraintInterface;
use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @changelog https://github.com/lmc-eu/steward/pull/187/files#diff-c7e8c65e59b8b4ff8b54325814d4ba55L80
 *
 * @see \Rector\PHPUnit\Tests\PHPUnit60\Rector\MethodCall\GetMockBuilderGetMockToCreateMockRector\GetMockBuilderGetMockToCreateMockRectorTest
 */
final class GetMockBuilderGetMockToCreateMockRector extends AbstractRector implements ComposerPackageConstraintInterface
{
    /**
     * createMock() was added in PHPUnit 5.4
     */
    public function provideComposerPackageConstraint(): ComposerPackageConstraint
    {
        return new ComposerPackageConstraint('phpunit/phpunit', '>=5.4');
    }

    /**
     * @var string[]
     */
    private const array USELESS_METHOD_NAMES = [
        'disableOriginalConstructor',
        'disableOriginalClone',
        'disableArgumentCloning',
        'disallowMockingUnknownTypes',
    ];

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Remove getMockBuilder() to createMock()', [
            new CodeSample(
                <<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;

final class SomeTest extends TestCase
{
    public function test()
    {
        $applicationMock = $this->getMockBuilder('SomeClass')
           ->disableOriginalConstructor()
           ->getMock();
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;

final class SomeTest extends TestCase
{
    public function test()
    {
        $applicationMock = $this->createMock('SomeClass');
    }
}
CODE_SAMPLE
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [MethodCall::class];
    }

    /**
     * @param MethodCall $node
     */
    public function refactor(Node $node): ?Node
    {
        if (! $this->isName($node->name, 'getMock')) {
            return null;
        }

        if (! $node->var instanceof MethodCall) {
            return null;
        }

        // traverse up over useless methods until we reach the top one
        $currentMethodCall = $node->var;

        while ($currentMethodCall instanceof MethodCall && $this->isNames(
            $currentMethodCall->name,
            self::USELESS_METHOD_NAMES
        )) {
            $currentMethodCall = $currentMethodCall->var;
        }

        if (! $currentMethodCall instanceof MethodCall) {
            return null;
        }

        // can be only local call, as createMock() is protected method
        if (! $this->isLocalScopeCaller($currentMethodCall)) {
            return null;
        }

        // must be be test case class
        if (! $this->isObjectType($currentMethodCall->var, new ObjectType('PHPUnit\Framework\TestCase'))) {
            return null;
        }

        if (! $this->isName($currentMethodCall->name, 'getMockBuilder')) {
            return null;
        }

        $args = $currentMethodCall->args;
        $thisVariable = $currentMethodCall->var;

        return new MethodCall($thisVariable, 'createMock', $args);
    }

    private function isLocalScopeCaller(MethodCall $currentMethodCall): bool
    {
        if (! $currentMethodCall->var instanceof Variable) {
            return false;
        }

        return $currentMethodCall->var->name === 'this';
    }
}