PHP-CS-Fixer/tests/Fixer/Alias/RandomApiMigrationFixerTest.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Tests\Fixer\Alias;

use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
use PhpCsFixer\Fixer\Alias\RandomApiMigrationFixer;
use PhpCsFixer\Tests\Test\AbstractFixerTestCase;

/**
 * @author Vladimir Reznichenko <kalessil@gmail.com>
 *
 * @internal
 *
 * @covers \PhpCsFixer\AbstractFunctionReferenceFixer
 * @covers \PhpCsFixer\Fixer\Alias\RandomApiMigrationFixer
 *
 * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Alias\RandomApiMigrationFixer>
 *
 * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Alias\RandomApiMigrationFixer
 */
final class RandomApiMigrationFixerTest extends AbstractFixerTestCase
{
    /**
     * @param _AutogeneratedInputConfiguration $configuration
     *
     * @dataProvider provideInvalidConfigurationCases
     */
    public function testInvalidConfiguration(string $message, array $configuration): void
    {
        $this->expectException(InvalidFixerConfigurationException::class);
        $this->expectExceptionMessage($message);

        $this->fixer->configure($configuration);
    }

    public static function provideInvalidConfigurationCases(): iterable
    {
        yield 'not supported function' => [
            '[random_api_migration] Invalid configuration: Function "is_null" is not handled by the fixer.',
            ['replacements' => ['is_null' => 'random_int']],
        ];

        yield 'wrong replacement' => [
            '[random_api_migration] Invalid configuration: The option "replacements" with value array is expected to be of type "string[]", but one of the elements is of type "null".',
            ['replacements' => ['rand' => null]],
        ];
    }

    public function testConfigure(): void
    {
        $this->fixer->configure(['replacements' => ['rand' => 'random_int']]);

        self::assertSame(
            ['replacements' => [
                'rand' => 'random_int',
            ]],
            \Closure::bind(static fn (RandomApiMigrationFixer $fixer): array => $fixer->configuration, null, RandomApiMigrationFixer::class)($this->fixer),
        );
    }

    /**
     * @param _AutogeneratedInputConfiguration $config
     *
     * @dataProvider provideFixCases
     */
    public function testFix(string $expected, ?string $input = null, array $config = []): void
    {
        $this->fixer->configure($config);
        $this->doTest($expected, $input);
    }

    /**
     * @return iterable<array{0: string, 1?: ?string, 2?: array<string, mixed>}>
     */
    public static function provideFixCases(): iterable
    {
        yield [
            '<?php random_int(0, getrandmax());',
            '<?php rand();',
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield [
            '<?php random_int#1
                #2
                (0, getrandmax()#3
                #4
                )#5
                ;',
            '<?php rand#1
                #2
                (#3
                #4
                )#5
                ;',
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield ['<?php $smth->srand($a);'];

        yield ['<?php srandSmth($a);'];

        yield ['<?php smth_srand($a);'];

        yield ['<?php new srand($a);'];

        yield ['<?php new Smth\srand($a);'];

        yield ['<?php Smth\srand($a);'];

        yield ['<?php namespace\srand($a);'];

        yield ['<?php Smth::srand($a);'];

        yield ['<?php new srand\smth($a);'];

        yield ['<?php srand::smth($a);'];

        yield ['<?php srand\smth($a);'];

        yield ['<?php "SELECT ... srand(\$a) ...";'];

        yield ['<?php "SELECT ... SRAND($a) ...";'];

        yield ["<?php 'test'.'srand' . 'in concatenation';"];

        yield ['<?php "test" . "srand"."in concatenation";'];

        yield [
            '<?php
class SrandClass
{
    const srand = 1;
    public function srand($srand)
    {
        if (!defined("srand") || $srand instanceof srand) {
            echo srand;
        }
    }
}

class srand extends SrandClass{
    const srand = "srand";
}
',
        ];

        yield ['<?php mt_srand($a);', '<?php srand($a);'];

        yield ['<?php \mt_srand($a);', '<?php \srand($a);'];

        yield ['<?php $a = &mt_srand($a);', '<?php $a = &srand($a);'];

        yield ['<?php $a = &\mt_srand($a);', '<?php $a = &\srand($a);'];

        yield ['<?php /* foo */ mt_srand /** bar */ ($a);', '<?php /* foo */ srand /** bar */ ($a);'];

        yield ['<?php a(mt_getrandmax ());', '<?php a(getrandmax ());'];

        yield ['<?php a(mt_rand());', '<?php a(rand());'];

        yield ['<?php a(mt_srand());', '<?php a(srand());'];

        yield ['<?php a(\mt_srand());', '<?php a(\srand());'];

        yield [
            '<?php rand(rand($a));',
            null,
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield [
            '<?php random_int($d, random_int($a,$b));',
            '<?php rand($d, rand($a,$b));',
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield [
            '<?php random_int($a, \Other\Scope\mt_rand($a));',
            '<?php rand($a, \Other\Scope\mt_rand($a));',
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield [
            '<?php $a = random_int(1,2) + random_int(3,4);',
            '<?php $a = rand(1,2) + mt_rand(3,4);',
            ['replacements' => ['rand' => 'random_int', 'mt_rand' => 'random_int']],
        ];

        yield [
            '<?php
                interface Test
                {
                    public function getrandmax();
                    public function &rand();
                }',
            null,
            ['replacements' => ['rand' => 'random_int']],
        ];

        yield [
            '<?php rand($d, rand($a,$b));',
            null,
            ['replacements' => ['rand' => 'rand']],
        ];

        yield [
            '<?php $a = random_int(1,2,) + random_int(3,4,);',
            '<?php $a = rand(1,2,) + mt_rand(3,4,);',
            ['replacements' => ['rand' => 'random_int', 'mt_rand' => 'random_int']],
        ];

        yield [
            '<?php mt_srand($a,);',
            '<?php srand($a,);',
        ];
    }

    /**
     * @dataProvider provideFix81Cases
     *
     * @requires PHP 8.1
     */
    public function testFix81(string $expected, ?string $input = null): void
    {
        $this->doTest($expected, $input);
    }

    /**
     * @return iterable<string, array{string}>
     */
    public static function provideFix81Cases(): iterable
    {
        yield 'simple 8.1' => [
            '<?php $f = srand(...);',
        ];
    }
}