AssertTrueFalseToSpecificMethodRector.php

<?php

declare(strict_types=1);

namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall;

use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\Empty_;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\StringType;
use Rector\PHPUnit\Enum\PHPUnitClassName;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\PHPUnit\ValueObject\FunctionNameWithAssertMethods;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\AssertTrueFalseToSpecificMethodRector\AssertTrueFalseToSpecificMethodRectorTest
 */
final class AssertTrueFalseToSpecificMethodRector extends AbstractRector
{
    /**
     * @var array<string,array<array-key,string>>
     */
    private const array FUNCTION_NAME_WITH_ASSERT_METHOD_NAMES = [
        'is_readable' => ['is_readable', 'assertIsReadable', 'assertNotIsReadable'],
        'array_key_exists' => ['array_key_exists', 'assertArrayHasKey', 'assertArrayNotHasKey'],
        'array_search' => ['array_search', 'assertContains', 'assertNotContains'],
        'in_array' => ['in_array', 'assertContains', 'assertNotContains'],
        'empty' => ['empty', 'assertEmpty', 'assertNotEmpty'],
        'file_exists' => ['file_exists', 'assertFileExists', 'assertFileNotExists'],
        'is_dir' => ['is_dir', 'assertDirectoryExists', 'assertDirectoryNotExists'],
        'is_infinite' => ['is_infinite', 'assertInfinite', 'assertFinite'],
        'is_null' => ['is_null', 'assertNull', 'assertNotNull'],
        'is_writable' => ['is_writable', 'assertIsWritable', 'assertNotIsWritable'],
        'is_nan' => ['is_nan', 'assertNan', ''],
        'is_a' => ['is_a', 'assertInstanceOf', 'assertNotInstanceOf'],
        'str_contains' => ['str_contains', 'assertStringContainsString', 'assertStringNotContainsString'],
    ];

    /**
     * Some assert methods were renamed in newer PHPUnit versions
     * @var array<string, string>
     */
    private const array RENAMED_ASSERT_METHOD_NAMES = [
        'assertFileNotExists' => 'assertFileDoesNotExist',
        'assertDirectoryNotExists' => 'assertDirectoryDoesNotExist',
    ];

    public function __construct(
        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
        private readonly ReflectionProvider $reflectionProvider
    ) {
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Turns true/false comparisons to their method name alternatives in PHPUnit TestCase when possible',
            [
                new CodeSample(
                    '$this->assertTrue(is_readable($readmeFile), "message");',
                    '$this->assertIsReadable($readmeFile, "message");'
                ),
            ]
        );
    }

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

    /**
     * @param MethodCall|StaticCall $node
     */
    public function refactor(Node $node): ?Node
    {
        if (! $this->testsNodeAnalyzer->isPHPUnitMethodCallNames(
            $node,
            ['assertTrue', 'assertFalse', 'assertNotTrue', 'assertNotFalse']
        )) {
            return null;
        }

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

        $arguments = $node->getArgs();
        if ($arguments === []) {
            return null;
        }

        $firstArgumentValue = $arguments[0]->value;
        if (! $firstArgumentValue instanceof FuncCall && ! $firstArgumentValue instanceof Empty_) {
            return null;
        }

        $firstArgumentName = $this->resolveFirstArgument($firstArgumentValue);

        if ($firstArgumentName === null || ! array_key_exists(
            $firstArgumentName,
            self::FUNCTION_NAME_WITH_ASSERT_METHOD_NAMES
        )) {
            return null;
        }

        if ($firstArgumentName === 'is_a') {
            /** @var FuncCall $firstArgumentValue */
            $args = $firstArgumentValue->getArgs();

            /** @var array<Arg> $args */
            if ($args === []) {
                return null;
            }

            $firstArgumentType = $this->nodeTypeResolver->getType($args[0]->value);
            if ($firstArgumentType instanceof StringType) {
                return null;
            }
        }

        [$functionName, $assetMethodName, $notAssertMethodName] = self::FUNCTION_NAME_WITH_ASSERT_METHOD_NAMES[$firstArgumentName];

        $functionNameWithAssertMethods = new FunctionNameWithAssertMethods($assetMethodName, $notAssertMethodName);

        $this->renameMethod($node, $functionNameWithAssertMethods);

        $this->moveFunctionArgumentsUp($node);

        return $node;
    }

    private function resolveFirstArgument(FuncCall|Empty_ $firstArgumentValue): ?string
    {
        return $firstArgumentValue instanceof Empty_
            ? 'empty'
            : $this->getName($firstArgumentValue);
    }

    private function renameMethod(
        MethodCall|StaticCall $node,
        FunctionNameWithAssertMethods $functionNameWithAssertMethods
    ): void {
        /** @var Identifier $identifierNode */
        $identifierNode = $node->name;
        $oldMethodName = $identifierNode->toString();

        if (in_array($oldMethodName, ['assertTrue', 'assertNotFalse'], true)) {
            $node->name = new Identifier(
                $this->resolveExistingAssertMethodName($functionNameWithAssertMethods->getAssetMethodName())
            );
        }

        if ($functionNameWithAssertMethods->getNotAssertMethodName() === '') {
            return;
        }

        if (! in_array($oldMethodName, ['assertFalse', 'assertNotTrue'], true)) {
            return;
        }

        $node->name = new Identifier(
            $this->resolveExistingAssertMethodName($functionNameWithAssertMethods->getNotAssertMethodName())
        );
    }

    /**
     * Verify the assert method exists on the PHPUnit Assert class,
     * as some methods were renamed in newer PHPUnit versions
     */
    private function resolveExistingAssertMethodName(string $methodName): string
    {
        if (! $this->reflectionProvider->hasClass(PHPUnitClassName::ASSERT)) {
            return $methodName;
        }

        $assertClassReflection = $this->reflectionProvider->getClass(PHPUnitClassName::ASSERT);
        if ($assertClassReflection->hasNativeMethod($methodName)) {
            return $methodName;
        }

        return self::RENAMED_ASSERT_METHOD_NAMES[$methodName] ?? $methodName;
    }

    /**
     * Before:
     * - $this->assertTrue(array_key_exists('...', ['...']), 'second argument');
     *
     * After:
     * - $this->assertArrayHasKey('...', ['...'], 'second argument');
     */
    private function moveFunctionArgumentsUp(MethodCall|StaticCall $node): void
    {
        $funcCallOrEmptyNode = $node->getArgs()[0]
            ->value;

        if ($funcCallOrEmptyNode instanceof FuncCall) {
            $funcCallOrEmptyNodeName = $this->getName($funcCallOrEmptyNode);
            if ($funcCallOrEmptyNodeName === null) {
                return;
            }

            $funcCallOrEmptyNodeArgs = $funcCallOrEmptyNode->getArgs();
            $oldArguments = $node->getArgs();
            unset($oldArguments[0]);

            $node->args = $this->buildNewArguments(
                $funcCallOrEmptyNodeName,
                $funcCallOrEmptyNodeArgs,
                $oldArguments
            );
        }

        if ($funcCallOrEmptyNode instanceof Empty_) {
            $node->args[0] = new Arg($funcCallOrEmptyNode->expr);
        }
    }

    /**
     * @param Arg[] $funcCallOrEmptyNodeArgs
     * @param Arg[] $oldArguments
     * @return mixed[]
     */
    private function buildNewArguments(
        string $funcCallOrEmptyNodeName,
        array $funcCallOrEmptyNodeArgs,
        array $oldArguments
    ): array {
        if (in_array($funcCallOrEmptyNodeName, ['in_array', 'array_search'], true)
            && count($funcCallOrEmptyNodeArgs) === 3) {
            unset($funcCallOrEmptyNodeArgs[2]);

            return [...$funcCallOrEmptyNodeArgs, ...$oldArguments];
        }

        if (in_array($funcCallOrEmptyNodeName, ['is_a', 'str_contains'], true)) {
            // flip arguments
            $newArgs = [$funcCallOrEmptyNodeArgs[1], $funcCallOrEmptyNodeArgs[0]];

            return [...$newArgs, ...$oldArguments];
        }

        return [...$funcCallOrEmptyNodeArgs, ...$oldArguments];
    }
}