MinutesToSecondsInCacheRector.php

<?php

declare(strict_types=1);

namespace RectorLaravel\Rector\StaticCall;

use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\BinaryOp\Mul;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Scalar\LNumber;
use Rector\Rector\AbstractRector;
use RectorLaravel\ValueObject\TypeToTimeMethodAndPosition;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @changelog https://github.com/laravel/framework/pull/27276
 * @changelog https://laravel.com/docs/5.8/upgrade#cache-ttl-in-seconds
 *
 * @see \RectorLaravel\Tests\Rector\StaticCall\MinutesToSecondsInCacheRector\MinutesToSecondsInCacheRectorTest
 */
final class MinutesToSecondsInCacheRector extends AbstractRector
{
    /**
     * @var string
     */
    private const PUT = 'put';

    /**
     * @var string
     */
    private const ADD = 'add';

    /**
     * @var string
     */
    private const REMEMBER = 'remember';

    /**
     * @var TypeToTimeMethodAndPosition[]
     */
    private array $typeToTimeMethodsAndPositions = [];

    public function __construct()
    {
        $this->typeToTimeMethodsAndPositions = [
            new TypeToTimeMethodAndPosition('Illuminate\Support\Facades\Cache', self::PUT, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Repository', self::PUT, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Store', self::PUT, 2),

            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Repository', self::ADD, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Store', self::ADD, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Support\Facades\Cache', self::ADD, 2),

            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Repository', self::REMEMBER, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Support\Facades\Cache', self::REMEMBER, 2),
            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Store', self::REMEMBER, 2),

            new TypeToTimeMethodAndPosition('Illuminate\Contracts\Cache\Store', 'putMany', 1),
        ];
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Change minutes argument to seconds in Illuminate\Contracts\Cache\Store and Illuminate\Support\Facades\Cache',
            [
                new CodeSample(
                    <<<'CODE_SAMPLE'
class SomeClass
{
    public function run()
    {
        Illuminate\Support\Facades\Cache::put('key', 'value', 60);
    }
}
CODE_SAMPLE
                    ,
                    <<<'CODE_SAMPLE'
class SomeClass
{
    public function run()
    {
        Illuminate\Support\Facades\Cache::put('key', 'value', 60 * 60);
    }
}
CODE_SAMPLE
                ),
            ]
        );
    }

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

    /**
     * @param  StaticCall|MethodCall  $node
     */
    public function refactor(Node $node): ?Node
    {
        foreach ($this->typeToTimeMethodsAndPositions as $typeToTimeMethodAndPosition) {
            if (! $this->isObjectType(
                $node instanceof MethodCall ? $node->var : $node->class,
                $typeToTimeMethodAndPosition->getObjectType()
            )) {
                continue;
            }

            if (! $this->isName($node->name, $typeToTimeMethodAndPosition->getMethodName())) {
                continue;
            }

            if (! isset($node->args[$typeToTimeMethodAndPosition->getPosition()])) {
                continue;
            }

            if (! $node->args[$typeToTimeMethodAndPosition->getPosition()] instanceof Arg) {
                continue;
            }

            $argValue = $node->args[$typeToTimeMethodAndPosition->getPosition()]->value;

            return $this->processArgumentOnPosition($node, $argValue, $typeToTimeMethodAndPosition->getPosition());
        }

        return $node;
    }

    private function processArgumentOnPosition(
        StaticCall|MethodCall $node,
        Expr $argExpr,
        int $argumentPosition
    ): StaticCall|MethodCall|null {
        if (! $this->nodeTypeResolver->isNumberType($argExpr)) {
            return null;
        }

        // already multiplied
        if ($argExpr instanceof Mul) {
            return null;
        }

        $mul = new Mul($argExpr, new LNumber(60));
        $node->args[$argumentPosition] = new Arg($mul);

        return $node;
    }
}