123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 |
- <?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\Comment;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- /**
- * @author Kuba Werłos <werlos@gmail.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Comment\CommentToPhpdocFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Comment\CommentToPhpdocFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Comment\CommentToPhpdocFixer
- */
- final class CommentToPhpdocFixerTest 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 [
- '<?php /* header comment */ $foo = true; /* string $bar */ $bar = "baz";',
- ];
- yield [
- '<?php /* header comment */ $foo = true; /* $yoda string @var */',
- ];
- yield [
- '<?php /* header comment */ $foo = true; /* $yoda @var string */',
- ];
- yield [
- '<?php /* header comment */ $foo = true; /** @var string $bar */ $bar = "baz";',
- '<?php /* header comment */ $foo = true; /* @var string $bar */ $bar = "baz";',
- ];
- yield [
- '<?php /* header comment */ $foo = true; /** @var string $bar */ $bar = "baz";',
- '<?php /* header comment */ $foo = true; /*@var string $bar */ $bar = "baz";',
- ];
- yield [
- '<?php /* header comment */ $foo = true;
- /** @var string $bar */
- $bar = "baz";
- ',
- '<?php /* header comment */ $foo = true;
- /*** @var string $bar */
- $bar = "baz";
- ',
- ];
- yield [
- '<?php /* header comment */ $foo = true;
- /** @var string $bar */
- $bar = "baz";
- ',
- '<?php /* header comment */ $foo = true;
- // @var string $bar
- $bar = "baz";
- ',
- ];
- yield [
- '<?php /* header comment */ $foo = true;
- /** @var string $bar */
- $bar = "baz";
- ',
- '<?php /* header comment */ $foo = true;
- //@var string $bar
- $bar = "baz";
- ',
- ];
- yield [
- '<?php /* header comment */ $foo = true;
- /** @var string $bar */
- $bar = "baz";
- ',
- '<?php /* header comment */ $foo = true;
- # @var string $bar
- $bar = "baz";
- ',
- ];
- yield [
- '<?php /* header comment */ $foo = true;
- /** @var string $bar */
- $bar = "baz";
- ',
- '<?php /* header comment */ $foo = true;
- #@var string $bar
- $bar = "baz";
- ',
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * @var string $bar
- */
- $bar = "baz";
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /*
- * @var string $bar
- */
- $bar = "baz";
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * This is my var
- * @var string $foo
- * stop using it
- * @deprecated since 1.2
- */
- $foo = 1;
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // This is my var
- // @var string $foo
- // stop using it
- // @deprecated since 1.2
- $foo = 1;
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- for (;;) {
- /**
- * This is my var
- * @var string $foo
- */
- $foo = someValue();
- }
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- for (;;) {
- // This is my var
- // @var string $foo
- $foo = someValue();
- }
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * This is my var
- * @var string $foo
- * stop using it
- * @deprecated since 1.3
- */
- $foo = 1;
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- # This is my var
- # @var string $foo
- # stop using it
- # @deprecated since 1.3
- $foo = 1;
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * @Column(type="string", length=32, unique=true, nullable=false)
- */
- $bar = 'baz';
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /*
- * @Column(type="string", length=32, unique=true, nullable=false)
- */
- $bar = 'baz';
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * @ORM\Column(name="id", type="integer")
- */
- $bar = 42;
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /*
- * @ORM\Column(name="id", type="integer")
- */
- $bar = 42;
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // This is my var
- // /** @var string $foo */
- $foo = 1;
- EOT,
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // @todo do something later
- $foo = 1;
- EOT,
- null,
- ['ignored_tags' => ['todo']],
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // @TODO do something later
- $foo = 1;
- EOT,
- null,
- ['ignored_tags' => ['todo']],
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * @todo do something later
- * @var int $foo
- */
- $foo = 1;
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // @todo do something later
- // @var int $foo
- $foo = 1;
- EOT,
- ['ignored_tags' => ['todo']],
- ];
- yield [
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- /**
- * @var int $foo
- * @todo do something later
- */
- $foo = 1;
- EOT,
- <<<'EOT'
- <?php /* header comment */ $foo = true;
- // @var int $foo
- // @todo do something later
- $foo = 1;
- EOT,
- ['ignored_tags' => ['todo']],
- ];
- yield [
- '<?php // header
- /** /@foo */
- namespace Foo\Bar;
- ',
- '<?php // header
- ///@foo
- namespace Foo\Bar;
- ',
- ];
- yield [
- '<?php // header
- /**
- * / @foo
- * / @bar
- */
- namespace Foo\Bar;
- ',
- '<?php // header
- /// @foo
- /// @bar
- namespace Foo\Bar;
- ',
- ];
- yield [
- '<?php /* header comment */ $foo = true; class Foo { /** @phpstan-use Bar<Baz> $bar */ use Bar; }',
- '<?php /* header comment */ $foo = true; class Foo { /* @phpstan-use Bar<Baz> $bar */ use Bar; }',
- ];
- }
- }
|