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

use PhpCsFixer\Tests\Test\AbstractFixerTestCase;

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

    /**
     * @return iterable<array{0: string, 1?: string, 2?: string}>
     */
    public static function provideFixCases(): iterable
    {
        yield [
            "<?php\n/** */class min1{}",
            "<?php\n/** @inheritdoc */class min1{}",
        ];

        yield [
            "<?php\n/** */class min1{}",
            "<?php\n/** @inheritDoc */class min1{}",
        ];

        yield [
            "<?php\nclass min2{/** */}",
            "<?php\nclass min2{/** @inheritdoc */}",
        ];

        yield [
            "<?php\nclass min2{/** */}",
            "<?php\nclass min2{/** @inheritDoc */}",
        ];

        yield [
            '<?php
                class A
                {
                    /** */
                    public function A(){}

                    /**
                     * '.'
                     */
                    public function B(){}

                    /**
                     * Descr.
                     *
                     * @param int $c
                     * '.'
                     */
                    public function C($c){}
                }
                ',
            '<?php
                class A
                {
                    /** @inheritdoc */
                    public function A(){}

                    /**
                     * @inheritdoc
                     */
                    public function B(){}

                    /**
                     * Descr.
                     *
                     * @param int $c
                     * @inheritdoc
                     */
                    public function C($c){}
                }
                ',
        ];

        yield [
            '<?php
                class B
                {
                    /** */
                    public function B(){}
                }
                ',
            '<?php
                class B
                {
                    /** {@INHERITDOC} */
                    public function B(){}
                }
                ',
        ];

        yield [
            '<?php
                /** D C */
                class C
                {
                }
                ',
            '<?php
                /** D {    @INHERITDOC   } C */
                class C
                {
                }
                ',
        ];

        yield [
            '<?php
                /** E */
                class E
                {
                }
                ',
            '<?php
                /**     {{@Inheritdoc}}   E */
                class E
                {
                }
                ',
        ];

        yield [
            '<?php
                /** F */
                class F
                {
                }
                ',
            '<?php
                /** F    @inheritdoc      */
                class F
                {
                }
                ',
        ];

        yield [
            '<?php
                    /** */
                    class G1{}
                    /** */
                    class G2{}
                ',
            '<?php
                    /** @inheritdoc */
                    class G1{}
                    /** @inheritdoc */
                    class G2{}
                ',
        ];

        yield [
            '<?php
                class H
                {
                    /* @inheritdoc comment, not PHPDoc */
                    public function H(){}
                }
                ',
        ];

        yield [
            '<?php
                class J extends Z
                {
                    /** @inheritdoc */
                    public function H(){}
                }
                ',
        ];

        yield [
            '<?php
                interface K extends Z
                {
                    /** @inheritdoc */
                    public function H();
                }
                ',
        ];

        yield [
            '<?php
                /** */
                interface K
                {
                    /** */
                    public function H();
                }
                ',
            '<?php
                /** @{inheritdoc} */
                interface K
                {
                    /** {@Inheritdoc} */
                    public function H();
                }
                ',
        ];

        yield [
            '<?php
                trait T
                {
                    /** @inheritdoc */
                    public function T()
                    {
                    }
                }',
        ];

        yield [
            '<?php
                class B
                {
                    /** */
                    public function falseImportFromTrait()
                    {
                    }
                }

                /** */
                class A
                {
                    use T;

                    /** @inheritdoc */
                    public function importFromTrait()
                    {
                    }
                }
                ',
            '<?php
                class B
                {
                    /** @inheritdoc */
                    public function falseImportFromTrait()
                    {
                    }
                }

                /** @inheritdoc */
                class A
                {
                    use T;

                    /** @inheritdoc */
                    public function importFromTrait()
                    {
                    }
                }
                ',
            '<?php
                class B
                {
                    /** @inheritDoc */
                    public function falseImportFromTrait()
                    {
                    }
                }

                /** @inheritDoc */
                class A
                {
                    use T;

                    /** @inheritDoc */
                    public function importFromTrait()
                    {
                    }
                }
                ',
        ];

        yield [
            '<?php

/** delete 1 */
class A
{
    /** delete 2 */
    public function B()
    {
        $a = new class implements I {

            /** @inheritdoc keep */
            public function A()
            {
                $b = new class extends D {

                    /** @inheritdoc keep */
                    public function C()
                    {
                        $d = new class() {

                            /** delete 3 */
                            public function D()
                            {
                            }
                        };
                    }
                };
            }
        };
    }

    /** delete 4 */
    public function B1()
    {
        $a1 = new class(){ };
    }

    /** delete 5 */
    public function B2()
    {
        //$a1 = new class(){ use D; };
    }
}
',
            '<?php

/** @inheritdoc delete 1 */
class A
{
    /** @inheritdoc delete 2 */
    public function B()
    {
        $a = new class implements I {

            /** @inheritdoc keep */
            public function A()
            {
                $b = new class extends D {

                    /** @inheritdoc keep */
                    public function C()
                    {
                        $d = new class() {

                            /** @inheritdoc delete 3 */
                            public function D()
                            {
                            }
                        };
                    }
                };
            }
        };
    }

    /** @inheritdoc delete 4 */
    public function B1()
    {
        $a1 = new class(){ };
    }

    /** @inheritdoc delete 5 */
    public function B2()
    {
        //$a1 = new class(){ use D; };
    }
}
',
        ];
    }
}