PHP-CS-Fixer/tests/Fixer/FunctionNotation/NoUselessSprintfFixerTest.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\FunctionNotation;

use PhpCsFixer\Tests\Test\AbstractFixerTestCase;

/**
 * @internal
 *
 * @covers \PhpCsFixer\Fixer\FunctionNotation\NoUselessSprintfFixer
 *
 * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\FunctionNotation\NoUselessSprintfFixer>
 */
final class NoUselessSprintfFixerTest extends AbstractFixerTestCase
{
    /**
     * @dataProvider provideFixCases
     */
    public function testFix(string $expected, ?string $input = null): void
    {
        $this->doTest($expected, $input);
    }

    /**
     * @return iterable<int|string, array{0: string, 1?: string}>
     */
    public static function provideFixCases(): iterable
    {
        yield 'simple' => [
            '<?php echo "bar";',
            '<?php echo sprintf("bar");',
        ];

        yield 'simple II' => [
            "<?php echo 'bar' ?>",
            "<?php echo sprintf('bar') ?>",
        ];

        yield 'simple III' => [
            '<?php echo $bar;',
            '<?php echo sprintf($bar);',
        ];

        yield 'simple IV' => [
            '<?php echo 1;',
            '<?php echo sprintf(1);',
        ];

        yield 'minimal' => [
            '<?php $foo;',
            '<?php sprintf($foo);',
        ];

        yield 'case insensitive' => [
            '<?php echo "bar";',
            '<?php echo SPRINTF("bar");',
        ];

        yield 'nested' => [
            '<?php echo /* test */"bar";',
            '<?php echo sprintf(sprintf(sprintf(/* test */sprintf(sprintf(sprintf("bar"))))));',
        ];

        yield [
            '<?php namespace Foo {
                function sprintf($foo) {
                    echo $foo;
                }
            }',
        ];

        yield [
            '<?php namespace Foo;
                function sprintf($foo) {
                    echo $foo;
                }
            ',
        ];

        yield [
            '<?php
                echo \Foo\sprintf("abc");
                echo $bar->sprintf($foo);
                echo Bar::sprintf($foo);
                echo sprint(...$foo);
                echo sprint("%d", 1);
                echo sprint("%d%d%d", 1, 2, 3);
                echo sprint();
            ',
        ];

        yield [
            '<?php echo sprint[2]("foo");',
        ];

        yield 'trailing comma' => [
            '<?php echo "bar";',
            '<?php echo sprintf("bar",);',
        ];
    }

    /**
     * @dataProvider provideFixPre80Cases
     *
     * @requires PHP <8.0
     */
    public function testFixPre80(string $expected, ?string $input = null): void
    {
        $this->doTest($expected, $input);
    }

    /**
     * @return iterable<array{0: string, 1?: string}>
     */
    public static function provideFixPre80Cases(): iterable
    {
        yield [
            '<?php echo  "bar";',
            '<?php echo \ sprintf("bar");',
        ];

        yield [
            '<?php echo A /* 1 */ \ B \ sprintf("bar");',
        ];
    }
}