123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827 |
- <?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\Tests\Test\AbstractFixerTestCase;
- /**
- * @author Graham Campbell <hello@gjcampbell.co.uk>
- * @author Jakub Kwaśniewski <jakub@zero-85.pl>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Phpdoc\PhpdocOrderFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Phpdoc\PhpdocOrderFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Phpdoc\PhpdocOrderFixer
- */
- final class PhpdocOrderFixerTest extends AbstractFixerTestCase
- {
- public function testEmptyOrderConfiguration(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('The option "order" value is invalid. Minimum two tags are required.');
- $this->fixer->configure(['order' => []]);
- }
- public function testInvalidOrderConfiguration(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessage('The option "order" value is invalid. Minimum two tags are required.');
- $this->fixer->configure(['order' => ['param']]);
- }
- public function testNoChanges(): void
- {
- $expected = <<<'EOF'
- <?php
- /**
- * Do some cool stuff.
- *
- * @param EngineInterface $templating
- * @param string $name
- *
- * @throws Exception
- *
- * @return void|bar
- */
- EOF;
- $this->doTest($expected);
- }
- /**
- * @dataProvider provideDifferentOrderCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testOnlyParams(array $config): void
- {
- $this->fixer->configure($config);
- $expected = <<<'EOF'
- <?php
- /**
- * @param EngineInterface $templating
- * @param string $name
- */
- EOF;
- $this->doTest($expected);
- }
- /**
- * @dataProvider provideDifferentOrderCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testOnlyReturns(array $config): void
- {
- $this->fixer->configure($config);
- $expected = <<<'EOF'
- <?php
- /**
- *
- * @return void|bar
- *
- */
- EOF;
- $this->doTest($expected);
- }
- /**
- * @dataProvider provideDifferentOrderCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testEmpty(array $config): void
- {
- $this->fixer->configure($config);
- $this->doTest('/***/');
- }
- /**
- * @dataProvider provideDifferentOrderCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testNoAnnotations(array $config): void
- {
- $this->fixer->configure($config);
- $expected = <<<'EOF'
- <?php
- /**
- *
- *
- *
- */
- EOF;
- $this->doTest($expected);
- }
- public function testFixBasicCase(): void
- {
- $expected = <<<'EOF'
- <?php
- /**
- * @param string $foo
- * @throws Exception
- * @return bool
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * @throws Exception
- * @return bool
- * @param string $foo
- */
- EOF;
- $this->doTest($expected, $input);
- }
- public function testFixCompleteCase(): void
- {
- $expected = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- * @internal
- *
- *
- * @custom Test!
- * asldnaksdkjasdasd
- *
- *
- *
- * @param string $foo
- * @param bool $bar Bar
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- * @internal
- *
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- *
- * @custom Test!
- * asldnaksdkjasdasd
- *
- *
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- *
- * @param string $foo
- * @param bool $bar Bar
- */
- EOF;
- $this->doTest($expected, $input);
- }
- public function testExampleFromSymfony(): void
- {
- $expected = <<<'EOF'
- <?php
- /**
- * Renders a template.
- *
- * @param mixed $name A template name
- * @param array $parameters An array of parameters to pass to the template
- *
- * @throws \InvalidArgumentException if the template does not exist
- * @throws \RuntimeException if the template cannot be rendered
- * @return string The evaluated template as a string
- *
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * Renders a template.
- *
- * @param mixed $name A template name
- * @param array $parameters An array of parameters to pass to the template
- *
- * @return string The evaluated template as a string
- *
- * @throws \InvalidArgumentException if the template does not exist
- * @throws \RuntimeException if the template cannot be rendered
- */
- EOF;
- $this->doTest($expected, $input);
- }
- public function testNoChangesWithLaravelStyle(): void
- {
- $this->fixer->configure(['order' => ['param', 'return', 'throws']]);
- $expected = <<<'EOF'
- <?php
- /**
- * Do some cool stuff.
- *
- * @param EngineInterface $templating
- * @param string $name
- *
- * @return void|bar
- *
- * @throws Exception
- */
- EOF;
- $this->doTest($expected);
- }
- public function testFixBasicCaseWithLaravelStyle(): void
- {
- $this->fixer->configure(['order' => ['param', 'return', 'throws']]);
- $expected = <<<'EOF'
- <?php
- /**
- * @param string $foo
- * @return bool
- * @throws Exception
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * @throws Exception
- * @return bool
- * @param string $foo
- */
- EOF;
- $this->doTest($expected, $input);
- }
- public function testFixCompleteCaseWithLaravelStyle(): void
- {
- $this->fixer->configure(['order' => ['param', 'return', 'throws']]);
- $expected = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- * @internal
- *
- *
- * @custom Test!
- * asldnaksdkjasdasd
- *
- *
- *
- * @param string $foo
- * @param bool $bar Bar
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- * @internal
- *
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- *
- * @custom Test!
- * asldnaksdkjasdasd
- *
- *
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- *
- * @param string $foo
- * @param bool $bar Bar
- */
- EOF;
- $this->doTest($expected, $input);
- }
- public function testExampleFromSymfonyWithLaravelStyle(): void
- {
- $this->fixer->configure(['order' => ['param', 'return', 'throws']]);
- $input = <<<'EOF'
- <?php
- /**
- * Renders a template.
- *
- * @param mixed $name A template name
- * @param array $parameters An array of parameters to pass to the template
- *
- * @return string The evaluated template as a string
- *
- * @throws \InvalidArgumentException if the template does not exist
- * @throws \RuntimeException if the template cannot be rendered
- */
- EOF;
- $this->doTest($input);
- }
- /**
- * @return iterable<array{array<string, mixed>}>
- */
- public static function provideDifferentOrderCases(): iterable
- {
- yield [['order' => ['param', 'throw', 'return']]];
- yield [['order' => ['param', 'return', 'throw']]];
- }
- /**
- * @dataProvider provideFixBasicCaseWithDifferentOrdersCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testFixBasicCaseWithDifferentOrders(string $expected, ?string $input = null, ?array $config = null): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{0: string, 1?: ?string, 2?: array<string, mixed>}>
- */
- public static function provideFixBasicCaseWithDifferentOrdersCases(): iterable
- {
- $input = <<<'EOF'
- <?php
- /**
- * @throws Exception
- * @return bool
- * @param string $foo
- */
- EOF;
- yield [
- <<<'EOF'
- <?php
- /**
- * @return bool
- * @throws Exception
- * @param string $foo
- */
- EOF,
- $input,
- ['order' => ['return', 'throws', 'param']],
- ];
- yield [
- <<<'EOF'
- <?php
- /**
- * @throws Exception
- * @return bool
- * @param string $foo
- */
- EOF,
- null,
- ['order' => ['throws', 'return', 'param']],
- ];
- }
- public function testFixCompleteCaseWithCustomOrder(): void
- {
- $this->fixer->configure(['order' => [
- 'throws',
- 'return',
- 'param',
- 'custom',
- 'internal',
- ]]);
- $expected = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- *
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- *
- *
- *
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- *
- * @param string $foo
- * @param bool $bar Bar
- * @custom Test!
- * asldnaksdkjasdasd
- * @internal
- */
- EOF;
- $input = <<<'EOF'
- <?php
- /**
- * Hello there!
- *
- * Long description
- * goes here.
- *
- * @internal
- *
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- *
- * @custom Test!
- * asldnaksdkjasdasd
- *
- *
- * @return bool Return false on failure.
- * @return int Return the number of changes.
- *
- * @param string $foo
- * @param bool $bar Bar
- */
- EOF;
- $this->doTest($expected, $input);
- }
- /**
- * @dataProvider provideFixCompleteCasesWithCustomOrdersCases
- *
- * @param _AutogeneratedInputConfiguration $config
- */
- public function testFixCompleteCasesWithCustomOrders(string $expected, string $input, array $config): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: ?string, 2?: array<string, mixed>}>
- */
- public static function provideFixCompleteCasesWithCustomOrdersCases(): iterable
- {
- yield 'intepacuthre' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @custom Test!
- * asldnaksdkjasdasd
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- * @return bool Return false on failure
- * @return int Return the number of changes.
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['internal', 'template', 'param', 'custom', 'throws', 'return']],
- ];
- yield 'pare' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['param', 'return']],
- ];
- yield 'pareth' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['param', 'return', 'throws']],
- ];
- yield 'pathre' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- * @return bool Return false on failure
- * @return int Return the number of changes.
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['param', 'throws', 'return']],
- ];
- yield 'tepathre' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @template T of Extension\Extension
- * @custom Test!
- * asldnaksdkjasdasd
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['template', 'param', 'throws', 'return']],
- ];
- yield 'tepathre2' => [
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @template T of Extension\Extension
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @custom Test!
- * asldnaksdkjasdasd
- **/
- EOF,
- <<<'EOF'
- <?php
- /**
- * Hello there
- *
- * Long description
- * goes here.
- *
- * @internal
- * @param string $foo
- * @param bool $bar Bar
- * @param class-string<T> $id
- * @return bool Return false on failure
- * @return int Return the number of changes.
- * @template T of Extension\Extension
- * @custom Test!
- * asldnaksdkjasdasd
- * @throws Exception|RuntimeException dfsdf
- * jkaskdnaksdnkasndansdnansdajsdnkasd
- **/
- EOF,
- ['order' => ['template', 'param', 'throws', 'return']],
- ];
- }
- }
|