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

use PhpCsFixer\Tests\Test\AbstractFixerTestCase;

/**
 * @author Gregor Harlan <gharlan@web.de>
 *
 * @internal
 *
 * @covers \PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer
 *
 * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer>
 *
 * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer
 */
final class SingleQuoteFixerTest extends AbstractFixerTestCase
{
    /**
     * @param _AutogeneratedInputConfiguration $configuration
     *
     * @dataProvider provideFixCases
     */
    public function testFix(string $expected, ?string $input = null, array $configuration = []): void
    {
        $this->fixer->configure($configuration);
        $this->doTest($expected, $input);
    }

    public static function provideFixCases(): iterable
    {
        yield [
            '<?php $a = \'\';',
            '<?php $a = "";',
        ];

        yield [
            '<?php $a = \'foo bar\';',
            '<?php $a = "foo bar";',
        ];

        yield [
            '<?php $a = b\'\';',
            '<?php $a = b"";',
        ];

        yield [
            '<?php $a = B\'\';',
            '<?php $a = B"";',
        ];

        yield [
            '<?php $a = b\'foo bar\';',
            '<?php $a = b"foo bar";',
        ];

        yield [
            '<?php $a = B\'foo bar\';',
            '<?php $a = B"foo bar";',
        ];

        yield [
            '<?php $a = \'foo
                    bar\';',
            '<?php $a = "foo
                    bar";',
        ];

        yield [
            '<?php $a = \'foo\'.\'bar\'."$baz";',
            '<?php $a = \'foo\'."bar"."$baz";',
        ];

        yield [
            '<?php $a = \'foo "bar"\';',
            '<?php $a = "foo \"bar\"";',
        ];

        yield [
            <<<'EOF'
                <?php $a = '\\foo\\bar\\\\';
                EOF,
            <<<'EOF'
                <?php $a = "\\foo\\bar\\\\";
                EOF,
        ];

        yield [
            '<?php $a = \'foo $bar7\';',
            '<?php $a = "foo \$bar7";',
        ];

        yield [
            '<?php $a = \'foo $(bar7)\';',
            '<?php $a = "foo \$(bar7)";',
        ];

        yield [
            '<?php $a = \'foo \\\($bar8)\';',
            '<?php $a = "foo \\\(\$bar8)";',
        ];

        yield ['<?php $a = "foo \" \$$bar";'];

        yield ['<?php $a = b"foo \" \$$bar";'];

        yield ['<?php $a = B"foo \" \$$bar";'];

        yield ['<?php $a = "foo \'bar\'";'];

        yield ['<?php $a = b"foo \'bar\'";'];

        yield ['<?php $a = B"foo \'bar\'";'];

        yield ['<?php $a = "foo $bar";'];

        yield ['<?php $a = b"foo $bar";'];

        yield ['<?php $a = B"foo $bar";'];

        yield ['<?php $a = "foo ${bar}";'];

        yield ['<?php $a = b"foo ${bar}";'];

        yield ['<?php $a = B"foo ${bar}";'];

        yield ['<?php $a = "foo\n bar";'];

        yield ['<?php $a = b"foo\n bar";'];

        yield ['<?php $a = B"foo\n bar";'];

        yield [
            <<<'EOF'
                <?php $a = "\\\n";
                EOF,
        ];

        yield [
            '<?php $a = \'foo \\\'bar\\\'\';',
            '<?php $a = "foo \'bar\'";',
            ['strings_containing_single_quote_chars' => true],
        ];

        yield [
            <<<'EOT'
                <?php
                // none
                $a = 'start \' end';
                // one escaped backslash
                $b = 'start \\\' end';
                // two escaped backslash
                $c = 'start \\\\\' end';
                EOT,
            <<<'EOT'
                <?php
                // none
                $a = "start ' end";
                // one escaped backslash
                $b = "start \\' end";
                // two escaped backslash
                $c = "start \\\\' end";
                EOT,
            ['strings_containing_single_quote_chars' => true],
        ];

        yield [
            <<<'EOT'
                <?php
                // one unescaped backslash
                $a = "start \' end";
                // one escaped + one unescaped backslash
                $b = "start \\\' end";
                EOT,
            null,
            ['strings_containing_single_quote_chars' => true],
        ];
    }
}