123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566 |
- <?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\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\WhitespacesFixerConfig;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer
- */
- final class PhpdocAlignFixerTest extends AbstractFixerTestCase
- {
- /**
- * @dataProvider provideFixCases
- *
- * @param _AutogeneratedInputConfiguration $configuration
- */
- public function testFix(
- array $configuration,
- string $expected,
- ?string $input = null,
- ?WhitespacesFixerConfig $whitespacesFixerConfig = null
- ): void {
- $this->fixer->configure($configuration);
- if (null !== $whitespacesFixerConfig) {
- $this->fixer->setWhitespacesConfig($whitespacesFixerConfig);
- }
- $this->doTest($expected, $input);
- }
- public static function provideFixCases(): iterable
- {
- yield 'none, one and four spaces between type and variable' => [
- ['tags' => ['param']],
- '<?php
- /**
- * @param int $a
- * @param int $b
- * @param int $c
- */',
- '<?php
- /**
- * @param int $a
- * @param int $b
- * @param int$c
- */',
- ];
- yield 'aligning params' => [
- ['tags' => ['param']],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- ];
- yield 'left align' => [
- ['tags' => ['param'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- ];
- yield 'partially untyped' => [
- ['tags' => ['param']],
- '<?php
- /**
- * @param $id
- * @param $parentId
- * @param int $websiteId
- * @param $position
- * @param int[][] $siblings
- */
- ',
- '<?php
- /**
- * @param $id
- * @param $parentId
- * @param int $websiteId
- * @param $position
- * @param int[][] $siblings
- */
- ',
- ];
- yield 'partially untyped left align' => [
- ['tags' => ['param'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param $id
- * @param $parentId
- * @param int $websiteId
- * @param $position
- * @param int[][] $siblings
- */
- ',
- '<?php
- /**
- * @param $id
- * @param $parentId
- * @param int $websiteId
- * @param $position
- * @param int[][] $siblings
- */
- ',
- ];
- yield 'multiline description' => [
- ['tags' => ['param', 'property', 'method']],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- * @property mixed $foo A foo
- * See constants
- * @method static baz($bop) A method that does a thing
- * It does it well
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- * @property mixed $foo A foo
- * See constants
- * @method static baz($bop) A method that does a thing
- * It does it well
- */
- ',
- ];
- yield 'multiline description left align' => [
- ['tags' => ['param', 'property', 'method'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- * @property mixed $foo A foo
- * See constants
- * @method static baz($bop) A method that does a thing
- * It does it well
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- * @property mixed $foo A foo
- * See constants
- * @method static baz($bop) A method that does a thing
- * It does it well
- */
- ',
- ];
- yield 'multiline description with throws' => [
- ['tags' => ['param', 'return', 'throws']],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- */
- ',
- ];
- yield 'multiline description with throws left align' => [
- ['tags' => ['param', 'return', 'throws'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- */
- ',
- ];
- yield 'return and throws' => [
- ['tags' => ['param', 'throws', 'return']],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param mixed &$reference A parameter passed by reference
- * Multiline description
- * @throws Bar description bar
- * @return Foo description foo
- * multiline description
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param mixed &$reference A parameter passed by reference
- * Multiline description
- * @throws Bar description bar
- * @return Foo description foo
- * multiline description
- */
- ',
- ];
- // https://github.com/FriendsOfPhp/PHP-CS-Fixer/issues/55
- yield 'three params with return' => [
- ['tags' => ['param', 'return']],
- '<?php
- /**
- * @param string $param1
- * @param bool $param2 lorem ipsum
- * @param string $param3 lorem ipsum
- * @return int lorem ipsum
- */
- ',
- '<?php
- /**
- * @param string $param1
- * @param bool $param2 lorem ipsum
- * @param string $param3 lorem ipsum
- * @return int lorem ipsum
- */
- ',
- ];
- yield 'only return' => [
- ['tags' => ['return']],
- '<?php
- /**
- * @return Foo description foo
- */
- ',
- '<?php
- /**
- * @return Foo description foo
- */
- ',
- ];
- yield 'return with $this' => [
- ['tags' => ['param', 'return']],
- '<?php
- /**
- * @param Foo $foo
- * @return $this
- */
- ',
- '<?php
- /**
- * @param Foo $foo
- * @return $this
- */
- ',
- ];
- yield 'custom annotations stay untouched' => [
- ['tags' => ['return']],
- '<?php
- /**
- * @return string
- * @SuppressWarnings(PHPMD.UnusedLocalVariable)
- */
- ',
- '<?php
- /**
- * @return string
- * @SuppressWarnings(PHPMD.UnusedLocalVariable)
- */
- ',
- ];
- yield 'custom annotations stay untouched 2' => [
- ['tags' => ['var']],
- '<?php
- class X
- {
- /**
- * @var Collection<Value>|Value[]
- * @ORM\ManyToMany(
- * targetEntity="\Dl\Component\DomainModel\Product\Value\AbstractValue",
- * inversedBy="externalAliases"
- * )
- */
- private $values;
- }
- ',
- ];
- yield 'left align 2' => [
- ['tags' => ['param'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param int $a
- * @param string $b
- *
- * @dataProvider dataJobCreation
- */
- ',
- '<?php
- /**
- * @param int $a
- * @param string $b
- *
- * @dataProvider dataJobCreation
- */
- ',
- ];
- yield 'params and data provider' => [
- ['tags' => ['param']],
- '<?php
- /**
- * @param int $a
- * @param string|null $b
- *
- * @dataProvider dataJobCreation
- */
- ',
- '<?php
- /**
- * @param int $a
- * @param string|null $b
- *
- * @dataProvider dataJobCreation
- */
- ',
- ];
- yield 'var' => [
- ['tags' => ['var']],
- '<?php
- /**
- * @var Type
- */
- ',
- '<?php
- /**
- * @var Type
- */
- ',
- ];
- yield 'type' => [
- ['tags' => ['type']],
- '<?php
- /**
- * @type Type
- */
- ',
- '<?php
- /**
- * @type Type
- */
- ',
- ];
- yield 'var and description' => [
- ['tags' => ['var']],
- '<?php
- /**
- * This is a variable.
- *
- * @var Type
- */
- ',
- '<?php
- /**
- * This is a variable.
- *
- * @var Type
- */
- ',
- ];
- yield 'var and inline description' => [
- ['tags' => ['var']],
- '<?php
- /**
- * @var Type This is a variable.
- */
- ',
- '<?php
- /**
- * @var Type This is a variable.
- */
- ',
- ];
- yield 'type and inline description' => [
- ['tags' => ['type']],
- '<?php
- /**
- * @type Type This is a variable.
- */
- ',
- '<?php
- /**
- * @type Type This is a variable.
- */
- ',
- ];
- yield 'when we are not modifying a docblock, then line endings should not change' => [
- ['tags' => ['param']],
- "<?php\r /**\r * @param Example Hello there!\r */\r",
- ];
- yield 'malformed doc block' => [
- ['tags' => ['return']],
- '<?php
- /**
- * @return string
- * */
- ',
- ];
- yield 'different indentation' => [
- ['tags' => ['param', 'return']],
- '<?php
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- ',
- '<?php
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- ',
- ];
- yield 'different indentation left align' => [
- ['tags' => ['param', 'return'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- ',
- '<?php
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- /**
- * @param int $limit
- * @param string $more
- *
- * @return array
- */
- ',
- ];
- yield 'messy whitespaces 1' => [
- ['tags' => ['type']],
- "<?php\r\n\t/**\r\n\t * @type Type This is a variable.\r\n\t */",
- "<?php\r\n\t/**\r\n\t * @type Type This is a variable.\r\n\t */",
- new WhitespacesFixerConfig("\t", "\r\n"),
- ];
- yield 'messy whitespaces 2' => [
- ['tags' => ['param', 'return']],
- "<?php\r\n/**\r\n * @param int \$limit\r\n * @param string \$more\r\n *\r\n * @return array\r\n */",
- "<?php\r\n/**\r\n * @param int \$limit\r\n * @param string \$more\r\n *\r\n * @return array\r\n */",
- new WhitespacesFixerConfig("\t", "\r\n"),
- ];
- yield 'messy whitespaces 3' => [
- [],
- "<?php\r\n/**\r\n * @param int \$limit\r\n * @param string \$more\r\n *\r\n * @return array\r\n */",
- "<?php\r\n/**\r\n * @param int \$limit\r\n * @param string \$more\r\n *\r\n * @return array\r\n */",
- new WhitespacesFixerConfig("\t", "\r\n"),
- ];
- yield 'messy whitespaces 4' => [
- [],
- "<?php\n/**\n * @param int \$a\n * @param int \$b\n * ABC\n */",
- "<?php\n/**\n * @param int \$a\n * @param int \$b\n * ABC\n */",
- new WhitespacesFixerConfig(' ', "\n"),
- ];
- yield 'messy whitespaces 5' => [
- [],
- "<?php\r\n/**\r\n * @param int \$z\r\n * @param int \$b\r\n * XYZ\r\n */",
- "<?php\r\n/**\r\n * @param int \$z\r\n * @param int \$b\r\n * XYZ\r\n */",
- new WhitespacesFixerConfig(' ', "\r\n"),
- ];
- yield 'badly formatted' => [
- ['tags' => ['var']],
- "<?php\n /**\n * @var Foo */\n",
- ];
- yield 'unicode' => [
- ['tags' => ['param', 'return']],
- '<?php
- /**
- * Method test.
- *
- * @param int $foobar Description
- * @param string $foo Description
- * @param mixed $bar Description word_with_ą
- * @param int|null $test Description
- */
- $a = 1;
- /**
- * @return string
- * @SuppressWarnings(PHPMD.UnusedLocalVariable) word_with_ą
- */
- $b = 1;
- ',
- '<?php
- /**
- * Method test.
- *
- * @param int $foobar Description
- * @param string $foo Description
- * @param mixed $bar Description word_with_ą
- * @param int|null $test Description
- */
- $a = 1;
- /**
- * @return string
- * @SuppressWarnings(PHPMD.UnusedLocalVariable) word_with_ą
- */
- $b = 1;
- ',
- ];
- yield 'does align property by default' => [
- [],
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @property string $foo Hello World
- */
- ',
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @property string $foo Hello World
- */
- ',
- ];
- yield 'aligns property' => [
- ['tags' => ['param', 'property', 'return', 'throws', 'type', 'var']],
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @property string $foo Hello World
- */
- ',
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @property string $foo Hello World
- */
- ',
- ];
- yield 'does align method by default' => [
- [],
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @method string foo(string $bar) Hello World
- */
- ',
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @method string foo(string $bar) Hello World
- */
- ',
- ];
- yield 'aligns method' => [
- ['tags' => ['param', 'method', 'return', 'throws', 'type', 'var']],
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @method int foo(string $bar, string ...$things, int &$baz) Description
- */
- ',
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @method int foo(string $bar, string ...$things, int &$baz) Description
- */
- ',
- ];
- yield 'aligns method without parameters' => [
- ['tags' => ['method', 'property']],
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- */
- ',
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- */
- ',
- ];
- yield 'aligns method without parameters left align' => [
- ['tags' => ['method', 'property'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- */
- ',
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- */
- ',
- ];
- yield 'does not format method' => [
- ['tags' => ['method']],
- '<?php
- /**
- * @method int foo( string $bar ) Description
- */
- ',
- ];
- yield 'aligns method without return type' => [
- ['tags' => ['method', 'property']],
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- * @method bar() Descrip
- */
- ',
- '<?php
- /**
- * @property string $foo Desc
- * @method int foo() Description
- * @method bar() Descrip
- */
- ',
- ];
- yield 'aligns methods without return type' => [
- ['tags' => ['method']],
- '<?php
- /**
- * @method fooBaz() Description
- * @method bar(string $foo) Descrip
- */
- ',
- '<?php
- /**
- * @method fooBaz() Description
- * @method bar(string $foo) Descrip
- */
- ',
- ];
- yield 'aligns static and non-static methods' => [
- ['tags' => ['method', 'property']],
- '<?php
- /**
- * @property string $foo Desc1
- * @property int $bar Desc2
- * @method foo(string $foo) DescriptionFoo
- * @method static bar(string $foo) DescriptionBar
- * @method string|null baz(bool $baz) DescriptionBaz
- * @method static int|false qux(float $qux) DescriptionQux
- * @method static static quux(int $quux) DescriptionQuux
- * @method static $this quuz(bool $quuz) DescriptionQuuz
- */
- ',
- '<?php
- /**
- * @property string $foo Desc1
- * @property int $bar Desc2
- * @method foo(string $foo) DescriptionFoo
- * @method static bar(string $foo) DescriptionBar
- * @method string|null baz(bool $baz) DescriptionBaz
- * @method static int|false qux(float $qux) DescriptionQux
- * @method static static quux(int $quux) DescriptionQuux
- * @method static $this quuz(bool $quuz) DescriptionQuuz
- */
- ',
- ];
- yield 'aligns static and non-static methods left align' => [
- ['tags' => ['method', 'property'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @property string $foo Desc1
- * @property int $bar Desc2
- * @method foo(string $foo) DescriptionFoo
- * @method static bar(string $foo) DescriptionBar
- * @method string|null baz(bool $baz) DescriptionBaz
- * @method static int|false qux(float $qux) DescriptionQux
- * @method static static quux(int $quux) DescriptionQuux
- * @method static $this quuz(bool $quuz) DescriptionQuuz
- */
- ',
- '<?php
- /**
- * @property string $foo Desc1
- * @property int $bar Desc2
- * @method foo(string $foo) DescriptionFoo
- * @method static bar(string $foo) DescriptionBar
- * @method string|null baz(bool $baz) DescriptionBaz
- * @method static int|false qux(float $qux) DescriptionQux
- * @method static static quux(int $quux) DescriptionQuux
- * @method static $this quuz(bool $quuz) DescriptionQuuz
- */
- ',
- ];
- yield 'aligns return static' => [
- ['tags' => ['param', 'return', 'throws']],
- '<?php
- /**
- * @param string $foobar Desc1
- * @param int &$baz Desc2
- * @param ?Qux $qux Desc3
- * @param int|float $quux Desc4
- * @return static DescriptionReturn
- * @throws Exception DescriptionException
- */
- ',
- '<?php
- /**
- * @param string $foobar Desc1
- * @param int &$baz Desc2
- * @param ?Qux $qux Desc3
- * @param int|float $quux Desc4
- * @return static DescriptionReturn
- * @throws Exception DescriptionException
- */
- ',
- ];
- yield 'aligns return static left align' => [
- ['tags' => ['param', 'return', 'throws'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- /**
- * @param string $foobar Desc1
- * @param int &$baz Desc2
- * @param ?Qux $qux Desc3
- * @param int|float $quux Desc4
- * @return static DescriptionReturn
- * @throws Exception DescriptionException
- */
- ',
- '<?php
- /**
- * @param string $foobar Desc1
- * @param int &$baz Desc2
- * @param ?Qux $qux Desc3
- * @param int|float $quux Desc4
- * @return static DescriptionReturn
- * @throws Exception DescriptionException
- */
- ',
- ];
- yield 'does not align with empty config' => [
- ['tags' => []],
- '<?php
- /**
- * @param int $foobar Description
- * @return int
- * @throws Exception
- * @var FooBar
- * @type BarFoo
- * @property string $foo Hello World
- * @method int bar() Description
- */
- ',
- ];
- yield 'variadic params 1' => [
- ['tags' => ['param']],
- '<?php
- final class Sample
- {
- /**
- * @param int[] $a A
- * @param int &$b B
- * @param array ...$c C
- */
- public function sample2($a, &$b, ...$c)
- {
- }
- }
- ',
- '<?php
- final class Sample
- {
- /**
- * @param int[] $a A
- * @param int &$b B
- * @param array ...$c C
- */
- public function sample2($a, &$b, ...$c)
- {
- }
- }
- ',
- ];
- yield 'variadic params 2' => [
- ['tags' => ['param']],
- '<?php
- final class Sample
- {
- /**
- * @param int $a
- * @param int $b
- * @param array[] ...$c
- */
- public function sample2($a, $b, ...$c)
- {
- }
- }
- ',
- '<?php
- final class Sample
- {
- /**
- * @param int $a
- * @param int $b
- * @param array[] ...$c
- */
- public function sample2($a, $b, ...$c)
- {
- }
- }
- ',
- ];
- yield 'variadic params 3' => [
- ['tags' => ['param'], 'align' => PhpdocAlignFixer::ALIGN_LEFT],
- '<?php
- final class Sample
- {
- /**
- * @param int $a
- * @param int $b
- * @param array[] ...$c
- */
- public function sample2($a, $b, ...$c)
- {
- }
- }
- ',
- '<?php
- final class Sample
- {
- /**
- * @param int $a
- * @param int $b
- * @param array[] ...$c
- */
- public function sample2($a, $b, ...$c)
- {
- }
- }
- ',
- ];
- yield 'variadic params 4' => [
- ['tags' => ['property', 'property-read', 'property-write']],
- '<?php
- /**
- * @property string $myMagicProperty magic property
- * @property-read string $myMagicReadProperty magic read-only property
- * @property-write string $myMagicWriteProperty magic write-only property
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property string $myMagicProperty magic property
- * @property-read string $myMagicReadProperty magic read-only property
- * @property-write string $myMagicWriteProperty magic write-only property
- */
- class Foo {}
- ',
- ];
- yield 'invalid PHPDoc 1' => [
- ['tags' => ['param', 'return', 'throws', 'type', 'var']],
- '<?php
- /**
- * @ Security("is_granted(\'CANCEL\', giftCard)")
- */
- ',
- ];
- yield 'invalid PHPDoc 2' => [
- ['tags' => ['param', 'return', 'throws', 'type', 'var', 'method']],
- '<?php
- /**
- * @ Security("is_granted(\'CANCEL\', giftCard)")
- */
- ',
- ];
- yield 'invalid PHPDoc 3' => [
- ['tags' => ['param', 'return', 'throws', 'type', 'var']],
- '<?php
- /**
- * @ Security("is_granted(\'CANCEL\', giftCard)")
- * @ foo bar
- * @ foo
- */
- ',
- ];
- yield 'types containing callables' => [
- [],
- '<?php
- /**
- * @param callable(Foo): Bar $x Description
- * @param callable(FooFoo): BarBar $yy Description
- */
- ',
- '<?php
- /**
- * @param callable(Foo): Bar $x Description
- * @param callable(FooFoo): BarBar $yy Description
- */
- ',
- ];
- yield 'types containing whitespace' => [
- [],
- '<?php
- /**
- * @var int $key
- * @var iterable<int, string> $value
- */
- /**
- * @param array<int, $this> $arrayOfIntegers
- * @param array<string, $this> $arrayOfStrings
- */
- ', ];
- yield 'closure types containing backslash' => [
- [],
- '<?php
- /**
- * @var string $input
- * @var \Closure $fn
- * @var \Closure(bool):int $fn2
- * @var Closure $fn3
- * @var Closure(string):string $fn4
- * @var array<string, array<string, mixed>> $data
- */
- /**
- * @param string $input
- * @param \Closure $fn
- * @param \Closure(bool):int $fn2
- * @param Closure $fn3
- * @param Closure(string):string $fn4
- * @param array<string, array<string, mixed>> $data
- */
- /**
- * @var string $value
- * @var \Closure(string): string $callback
- * @var Closure(int): bool $callback2
- */
- /**
- * @param string $value
- * @param \Closure(string): string $callback
- * @param Closure(int): bool $callback2
- */
- /**
- * @var Closure(array<int, bool>): bool $callback1
- * @var \Closure(string): string $callback2
- */
- /**
- * @param Closure(array<int, bool>): bool $callback1
- * @param \Closure(string): string $callback2
- */
- ', ];
- yield 'types parenthesized' => [
- [],
- '<?php
- /**
- * @param list<string> $allowedTypes
- * @param null|list<\Closure(mixed): (bool|null|scalar)> $allowedValues
- */
- ',
- '<?php
- /**
- * @param list<string> $allowedTypes
- * @param null|list<\Closure(mixed): (bool|null|scalar)> $allowedValues
- */
- ',
- ];
- yield 'callable types with ugly code 1' => [
- [],
- '<?php
- /**
- * @var callable $fn
- * @var callable(bool): int $fn2
- * @var Closure $fn3
- * @var Closure(string|object):string $fn4
- * @var \Closure $fn5
- * @var \Closure(int, bool): bool $fn6
- */
- ',
- '<?php
- /**
- * @var callable $fn
- * @var callable(bool): int $fn2
- * @var Closure $fn3
- * @var Closure(string|object):string $fn4
- * @var \Closure $fn5
- * @var \Closure(int, bool): bool $fn6
- */
- ',
- ];
- yield 'callable types with ugly code 2' => [
- [],
- '<?php
- /**
- * @var callable $fn
- * @var callable(bool): int $fn2
- * @var Closure $fn3
- * @var Closure(string|object):string $fn4
- * @var \Closure $fn5
- * @var \Closure(int, bool): bool $fn6
- */
- ',
- '<?php
- /**
- * @var callable $fn
- * @var callable(bool): int $fn2
- * @var Closure $fn3
- * @var Closure(string|object):string $fn4
- * @var \Closure $fn5
- * @var \Closure(int, bool): bool $fn6
- */
- ',
- ];
- yield 'CUSTOM tags' => [
- ['tags' => ['param', 'xxx-xxxxxxxxx']],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @xxx-xxxxxxxxx int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @xxx-xxxxxxxxx int $code An HTTP response status code
- * @param bool $debug
- * @param mixed &$reference A parameter passed by reference
- */
- ',
- ];
- yield 'no/2+ spaces after comment star' => [
- [],
- '<?php
- /**
- * @property string $age @Atk4\Field()
- * @property string $city @Atk4\Field()
- */
- ',
- '<?php
- /**
- * @property string $age @Atk4\Field()
- *@property string $city @Atk4\Field()
- */
- ',
- ];
- yield 'untyped param with multiline desc' => [
- [],
- '<?php
- /**
- * @param $typeless Foo.
- * Bar.
- */
- function foo($typeless): void {}',
- '<?php
- /**
- * @param $typeless Foo.
- * Bar.
- */
- function foo($typeless): void {}',
- ];
- yield 'left align and @param with 2 spaces' => [
- [
- 'align' => PhpdocAlignFixer::ALIGN_LEFT,
- 'spacing' => ['param' => 2],
- ],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- ];
- yield 'vertical align with various spacing' => [
- [
- 'align' => PhpdocAlignFixer::ALIGN_VERTICAL,
- 'spacing' => ['param' => 2, 'return' => 4],
- ],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo bar hello world!
- * return description continuation
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo bar hello world!
- * return description continuation
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- ];
- yield 'left align with various spacing' => [
- [
- 'align' => PhpdocAlignFixer::ALIGN_LEFT,
- 'spacing' => ['param' => 2, 'return' => 4],
- ],
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- '<?php
- /**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- ];
- yield 'left align with changed default spacing' => [
- [
- 'align' => PhpdocAlignFixer::ALIGN_LEFT,
- 'spacing' => ['_default' => 2, 'return' => 4],
- ],
- '<?php
- /**
- * @property string $bar Foo-Bar lorem ipsum
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- '<?php
- /**
- * @property string $bar Foo-Bar lorem ipsum
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code An HTTP response status code
- * See constants
- * @param bool $debug
- * @param bool $debug See constants
- * See constants
- * @param mixed &$reference A parameter passed by reference
- *
- * @return Foo description foo
- *
- * @throws Foo description foo
- * description foo
- *
- */
- ',
- ];
- }
- /**
- * @dataProvider provideInvalidConfigurationCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testInvalidConfiguration(array $config, string $expectedMessage): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage($expectedMessage);
- $this->fixer->configure($config);
- }
- /**
- * @return iterable<array{array<string,mixed>, string}>
- */
- public static function provideInvalidConfigurationCases(): iterable
- {
- yield 'zero' => [
- ['spacing' => 0],
- 'The option "spacing" is invalid. All spacings must be greater than zero.',
- ];
- yield 'negative' => [
- ['spacing' => -2],
- 'The option "spacing" is invalid. All spacings must be greater than zero.',
- ];
- yield 'zeroInArray' => [
- ['spacing' => ['param' => 1, 'return' => 0]],
- 'The option "spacing" is invalid. All spacings must be greater than zero.',
- ];
- yield 'negativeInArray' => [
- [
- 'align' => PhpdocAlignFixer::ALIGN_LEFT,
- 'spacing' => ['return' => 2, 'param' => -1],
- ],
- 'The option "spacing" is invalid. All spacings must be greater than zero.',
- ];
- }
- }
|