ConfiguredMockEntityToSetterObjectRector.php

<?php

declare(strict_types=1);

namespace Rector\PHPUnit\CodeQuality\Rector\Expression;

use Nette\Utils\Strings;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Return_;
use PHPStan\Reflection\ReflectionProvider;
use Rector\Doctrine\NodeAnalyzer\DoctrineEntityDetector;
use Rector\PhpParser\AstResolver;
use Rector\PhpParser\Node\Value\ValueResolver;
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\Expression\ConfiguredMockEntityToSetterObjectRector\ConfiguredMockEntityToSetterObjectRectorTest
 */
final class ConfiguredMockEntityToSetterObjectRector extends AbstractRector
{
    public function __construct(
        private readonly ReflectionProvider $reflectionProvider,
        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
        private readonly ValueResolver $valueResolver,
        private readonly AstResolver $astResolver,
        private readonly DoctrineEntityDetector $doctrineEntityDetector,
    ) {
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Change createConfigureMock() on Entity/Document object to direct new instance with setters',
            [
                new CodeSample(
                    <<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;

final class SomeTest extends TestClass
{
    public function test()
    {
        $someObject = $this->createConfiguredMock(SomeObject::class, [
            'name' => 'John',
            'surname' => 'Doe',
        ]);
    }
}
CODE_SAMPLE
                    ,
                    <<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;

final class SomeTest extends TestClass
{
    public function test()
    {
        $someObject = new SomeObject();
        $someObject->setName('John');
        $someObject->setSurname('Doe');
    }
}
CODE_SAMPLE
                ),
            ]
        );
    }

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

    /**
     * @param Expression|Return_ $node
     * @return Stmt[]|null
     */
    public function refactor(Node $node): ?array
    {
        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
            return null;
        }

        $assign = null;
        if ($node instanceof Return_) {
            if ($node->expr instanceof MethodCall) {
                $methodCall = $node->expr;
            } else {
                return null;
            }
        } elseif ($node->expr instanceof Assign) {
            $assign = $node->expr;
            if (! $assign->expr instanceof MethodCall) {
                return null;
            }

            $methodCall = $assign->expr;
        } else {
            return null;
        }

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

        if ($methodCall->isFirstClassCallable()) {
            return null;
        }

        $mockedClassArg = $methodCall->getArgs()[0];

        $doctrineClass = $this->matchDoctrineClassName($mockedClassArg->value);
        if (! is_string($doctrineClass)) {
            return null;
        }

        $definedGettersArg = $methodCall->getArgs()[1];
        if (! $definedGettersArg->value instanceof Array_) {
            return null;
        }

        if ($node instanceof Expression) {
            return $this->createForAssign($doctrineClass, $assign, $definedGettersArg->value, $node);
        }

        return $this->createForReturn($doctrineClass, $definedGettersArg->value, $node);

    }

    /**
     * @return Expression[]
     */
    private function createEntitySetterExpressions(Array_ $definedGettersArray, Expr $expr): array
    {
        $setterExpressions = [];

        foreach ($definedGettersArray->items as $arrayItem) {
            if (! $arrayItem->key instanceof Expr) {
                continue;
            }

            $getterName = $this->valueResolver->getValue($arrayItem->key);
            if (! is_string($getterName)) {
                continue;
            }

            // remove "get" prefix
            if (! str_starts_with($getterName, 'get')) {
                continue;
            }

            $setterName = 'set' . substr($getterName, 3);

            $setterMethodCall = new MethodCall($expr, $setterName, [new Arg($arrayItem->value)]);
            $setterExpressions[] = new Expression($setterMethodCall);
        }

        return $setterExpressions;
    }

    private function matchDoctrineClassName(Expr $expr): string|null
    {
        $mockedClassValue = $this->valueResolver->getValue($expr);
        if (! is_string($mockedClassValue)) {
            return null;
        }

        if (! $this->reflectionProvider->hasClass($mockedClassValue)) {
            return null;
        }

        $classReflection = $this->reflectionProvider->getClass($mockedClassValue);
        if ($classReflection->isInterface() || $classReflection->isAbstract()) {
            return null;
        }

        $mockedClass = $this->astResolver->resolveClassFromName($mockedClassValue);
        if (! $mockedClass instanceof Class_) {
            return null;
        }

        if (! $this->doctrineEntityDetector->detect($mockedClass)) {
            return null;
        }

        return $mockedClassValue;
    }

    /**
     * @return Stmt[]
     */
    private function createForReturn(string $doctrineClass, Array_ $array, Return_ $return): array
    {
        $shortClassName = Strings::after($doctrineClass, '\\', -1);
        $objectVariable = new Variable(lcfirst((string) $shortClassName));

        $new = new New_(new FullyQualified($doctrineClass));
        $assign = new Assign($objectVariable, $new);

        $setterExpressions = $this->createEntitySetterExpressions($array, $objectVariable);

        $return->expr = $objectVariable;

        return array_merge([new Expression($assign)], $setterExpressions, [$return]);
    }

    /**
     * @return Stmt[]
     */
    private function createForAssign(
        string $doctrineClass,
        Assign $assign,
        Array_ $definedGettersArray,
        Expression $expression
    ): array {
        $assign->expr = new New_(new FullyQualified($doctrineClass));
        $objectVariable = $assign->var;

        $setterExpressions = $this->createEntitySetterExpressions($definedGettersArray, $objectVariable);

        return array_merge([$expression], $setterExpressions);
    }
}