HeredocIndentationFixerTest.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\Whitespace;

use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
use PhpCsFixer\WhitespacesFixerConfig;

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

    public static function provideFixCases(): iterable
    {
        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD
                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD
                EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD

                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD

                EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD
                        abc

                            def
                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD
                abc

                    def
                EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<'EOD'

                        abc
                            def

                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<'EOD'

                abc
                    def

                EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<'EOD'
                        abc
                            def
                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<'EOD'
                            abc
                                def
                            EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD
                        $abc
                            $def
                        {$ghi}
                        EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD
                $abc
                    $def
                {$ghi}
                EOD
                    );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    $a = <<<'EOD'
                        <?php
                            $b = <<<FOO
                        abc
                        FOO;
                        EOD;
                EXPECTED,
            <<<'INPUT'
                <?php
                    $a = <<<'EOD'
                <?php
                    $b = <<<FOO
                abc
                FOO;
                EOD;
                INPUT,
        ];

        yield [
            /* EXPECTED */ '
<?php
    foo(<<<EOD
          '.'
        abc
          '.'
        def
          '.'
        EOD
    );',
            /* INPUT */ '
<?php
    foo(<<<EOD
        '.'
      abc
        '.'
      def
        '.'
      EOD
    );',
        ];

        yield [
            /* EXPECTED */ '
<?php
    foo(<<<EOD

        abc

        def

        EOD
    );',
            /* INPUT */ '
<?php
    foo(<<<EOD
  '.'
      abc
  '.'
      def
  '.'
      EOD
    );',
        ];

        yield [
            <<<'EXPECTED'
                <?php foo(<<<EOD
                    EOD
                );
                EXPECTED,
            <<<'INPUT'
                <?php foo(<<<EOD
                EOD
                );
                INPUT,
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD
                    abc

                        def
                    EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD
                abc

                    def
                EOD
                    );
                INPUT,
            ['indentation' => 'same_as_start'],
        ];

        yield [
            <<<'EXPECTED'
                <?php
                    foo(<<<EOD
                    abc

                        def
                    EOD
                    );
                EXPECTED,
            <<<'INPUT'
                <?php
                    foo(<<<EOD
                        abc

                            def
                        EOD
                    );
                INPUT,
            ['indentation' => 'same_as_start'],
        ];
    }

    public function testWithWhitespacesConfig(): void
    {
        $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t"));

        $expected = <<<EXPECTED
            <?php
            \t\$a = <<<'EOD'
            \t\tabc
            \t\t    def
            \t\t\tghi
            \t\tEOD;
            EXPECTED;

        $input = <<<INPUT
            <?php
            \t\$a = <<<'EOD'
            abc
                def
            \tghi
            EOD;
            INPUT;

        $this->doTest($expected, $input);
    }
}