123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085 |
- <?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 Filippo Tessarotto <zoeslam@gmail.com>
- * @author Andreas Möller <am@localheinz.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Phpdoc\PhpdocOrderByValueFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Phpdoc\PhpdocOrderByValueFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Phpdoc\PhpdocOrderByValueFixer
- */
- final class PhpdocOrderByValueFixerTest extends AbstractFixerTestCase
- {
- /**
- * @dataProvider provideConfigureRejectsInvalidControlStatementCases
- *
- * @param mixed $annotation
- */
- public function testConfigureRejectsInvalidControlStatement($annotation): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->fixer->configure([
- 'annotations' => [
- $annotation,
- ],
- ]);
- }
- public static function provideConfigureRejectsInvalidControlStatementCases(): iterable
- {
- yield 'null' => [null];
- yield 'false' => [false];
- yield 'true' => [true];
- yield 'int' => [0];
- yield 'float' => [3.14];
- yield 'array' => [[]];
- yield 'object' => [new \stdClass()];
- yield 'unknown' => ['foo'];
- }
- /**
- * @dataProvider provideFixWithCoversCases
- */
- public function testFixWithDefaultConfiguration(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @dataProvider provideFixWithAuthorCases
- */
- public function testFixWithAuthor(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'author',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithAuthorCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @author Bob
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @author Alice
- * @author Bob
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @author Bob
- * @author Alice
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @author Alice
- * Comment 3
- * @author Bob
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @author Bob
- * Comment 2
- * @author Alice
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @author Alice
- * @author chris
- * @author Daniel
- * @author Erna
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @author Alice
- * @author Erna
- * @author chris
- * @author Daniel
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @author Alice
- * @dataProvider provide
- * @author Bob
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @author Bob
- * @dataProvider provide
- * @author Alice
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithCoversCases
- */
- public function testFixWithCovers(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'covers',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithCoversCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @covers Foo
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @covers Bar
- * @covers Foo
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @covers Foo
- * @covers Bar
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @covers Bar
- * Comment 3
- * @covers Foo
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @covers Foo
- * Comment 2
- * @covers Bar
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @covers A
- * @covers c
- * @covers D
- * @covers E
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @covers A
- * @covers E
- * @covers c
- * @covers D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @covers Bar
- * @dataProvider provide
- * @covers Foo
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @covers Foo
- * @dataProvider provide
- * @covers Bar
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithCoversNothingCases
- */
- public function testFixWithCoversNothing(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'coversNothing',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithCoversNothingCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @coversNothing Foo
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @coversNothing Bar
- * @coversNothing Foo
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @coversNothing Foo
- * @coversNothing Bar
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @coversNothing Bar
- * Comment 3
- * @coversNothing Foo
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @coversNothing Foo
- * Comment 2
- * @coversNothing Bar
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @coversNothing A
- * @coversNothing c
- * @coversNothing D
- * @coversNothing E
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @coversNothing A
- * @coversNothing E
- * @coversNothing c
- * @coversNothing D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @coversNothing Bar
- * @dataProvider provide
- * @coversNothing Foo
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @coversNothing Foo
- * @dataProvider provide
- * @coversNothing Bar
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithDataProviderCases
- */
- public function testFixWithDataProvider(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'dataProvider',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithDataProviderCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @dataProvider Foo::provideData()
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @dataProvider Bar::provideData()
- * @dataProvider Foo::provideData()
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @dataProvider Foo::provideData()
- * @dataProvider Bar::provideData()
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @dataProvider Bar::provideData()
- * Comment 3
- * @dataProvider Foo::provideData()
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @dataProvider Foo::provideData()
- * Comment 2
- * @dataProvider Bar::provideData()
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @dataProvider A::provideData()
- * @dataProvider c::provideData()
- * @dataProvider D::provideData()
- * @dataProvider E::provideData()
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @dataProvider A::provideData()
- * @dataProvider E::provideData()
- * @dataProvider c::provideData()
- * @dataProvider D::provideData()
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @dataProvider Bar::provideData()
- * @dataProvider dataProvider
- * @dataProvider Foo::provideData()
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @dataProvider Foo::provideData()
- * @dataProvider dataProvider
- * @dataProvider Bar::provideData()
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithDependsCases
- */
- public function testFixWithDepends(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'depends',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithDependsCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @depends testFoo
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @depends testBar
- * @depends testFoo
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @depends testFoo
- * @depends testBar
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @depends testBar
- * Comment 3
- * @depends testFoo
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @depends testFoo
- * Comment 2
- * @depends testBar
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @depends testA
- * @depends testc
- * @depends testD
- * @depends testE
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @depends testA
- * @depends testE
- * @depends testc
- * @depends testD
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @depends testBar
- * @dataProvider provide
- * @depends testFoo
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @depends testFoo
- * @dataProvider provide
- * @depends testBar
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithGroupCases
- */
- public function testFixWithGroup(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'group',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithGroupCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @group slow
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @group fast
- * @group slow
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @group slow
- * @group fast
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @group fast
- * Comment 3
- * @group slow
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @group slow
- * Comment 2
- * @group fast
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @group A
- * @group c
- * @group D
- * @group E
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @group A
- * @group E
- * @group c
- * @group D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @group fast
- * @dataProvider provide
- * @group slow
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @group slow
- * @dataProvider provide
- * @group fast
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithInternalCases
- */
- public function testFixWithInternal(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'internal',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithInternalCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @internal Foo
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @internal Bar
- * @internal Foo
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @internal Foo
- * @internal Bar
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @internal Bar
- * Comment 3
- * @internal Foo
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @internal Foo
- * Comment 2
- * @internal Bar
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @internal A
- * @internal c
- * @internal D
- * @internal E
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @internal A
- * @internal E
- * @internal c
- * @internal D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @internal Bar
- * @dataProvider provide
- * @internal Foo
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @internal Foo
- * @dataProvider provide
- * @internal Bar
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithMethodCases
- */
- public function testFixWithMethod(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'method',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithMethodCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- /**
- * @method int foo(array $b)
- */
- class Foo {}
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @method bool bar(int $a, bool $b)
- * @method array|null baz()
- * @method int foo(array $b)
- */
- class Foo {}
- ',
- '<?php
- /**
- * @method int foo(array $b)
- * @method bool bar(int $a, bool $b)
- * @method array|null baz()
- */
- class Foo {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @method bool bar(int $a, bool $b)
- * Comment 3
- * @method int foo(array $b)
- * Comment 2
- */
- class Foo {}
- ',
- '<?php
- /**
- * Comment 1
- * @method int foo(array $b)
- * Comment 2
- * @method bool bar(int $a, bool $b)
- * Comment 3
- */
- class Foo {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @method int A()
- * @method bool b()
- * @method array|null c()
- * @method float D()
- */
- class Foo {}
- ',
- '<?php
- /**
- * @method array|null c()
- * @method float D()
- * @method bool b()
- * @method int A()
- */
- class Foo {}
- ',
- ];
- yield 'with-possibly-unexpected-comparable' => [
- '<?php
- /**
- * @method int foo(Z $b)
- * @method int fooA( $b)
- */
- class Foo {}
- ',
- '<?php
- /**
- * @method int fooA( $b)
- * @method int foo(Z $b)
- */
- class Foo {}
- ',
- ];
- yield 'with-and-without-types' => [
- '<?php
- /**
- * @method int A()
- * @method b()
- * @method array|null c()
- * @method D()
- */
- class Foo {}
- ',
- '<?php
- /**
- * @method array|null c()
- * @method D()
- * @method b()
- * @method int A()
- */
- class Foo {}
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithMixinCases
- */
- public function testFixWithMixin(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'mixin',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithMixinCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- /**
- * @package SomePackage
- * @mixin Bar
- * @license MIT
- */
- class Foo {
- }
- /**
- * @package SomePackage
- * @license MIT
- */
- class Foo2 {
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @mixin Bar1
- * @mixin Bar2
- * @mixin Bar3
- */
- class Foo {
- }
- ',
- '<?php
- /**
- * @mixin Bar2
- * @mixin Bar3
- * @mixin Bar1
- */
- class Foo {
- }
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @mixin Bar1
- * Comment 3
- * @mixin Bar2
- * Comment 2
- */
- class Foo {
- }
- ',
- '<?php
- /**
- * Comment 1
- * @mixin Bar2
- * Comment 2
- * @mixin Bar1
- * Comment 3
- */
- class Foo {
- }
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @mixin A
- * @mixin b
- * @mixin C
- */
- class Foo {
- }
- ',
- '<?php
- /**
- * @mixin b
- * @mixin A
- * @mixin C
- */
- class Foo {
- }
- ',
- ];
- yield 'fully-qualified' => [
- '<?php
- /**
- * @mixin \A\B\Bar2
- * @mixin Bar1
- * @mixin Bar3
- */
- class Foo {
- }
- ',
- '<?php
- /**
- * @mixin Bar3
- * @mixin Bar1
- * @mixin \A\B\Bar2
- */
- class Foo {
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithPropertyCases
- */
- public function testFixWithProperty(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'property',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithPropertyCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- /**
- * @property int|\stdClass $foo
- */
- class Foo {}
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @property bool $bar
- * @property array|null $baz
- * @property int|\stdClass $foo
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property int|\stdClass $foo
- * @property bool $bar
- * @property array|null $baz
- */
- class Foo {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @property bool $bar
- * Comment 3
- * @property int|\stdClass $foo
- * Comment 2
- */
- class Foo {}
- ',
- '<?php
- /**
- * Comment 1
- * @property int|\stdClass $foo
- * Comment 2
- * @property bool $bar
- * Comment 3
- */
- class Foo {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @property int|\stdClass $A
- * @property bool $b
- * @property array|null $C
- * @property float $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property array|null $C
- * @property float $D
- * @property bool $b
- * @property int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- yield 'with-and-without-types' => [
- '<?php
- /**
- * @property int|\stdClass $A
- * @property $b
- * @property array|null $C
- * @property $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property array|null $C
- * @property $D
- * @property $b
- * @property int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithPropertyReadCases
- */
- public function testFixWithPropertyRead(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'property-read',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithPropertyReadCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- /**
- * @property-read int|\stdClass $foo
- */
- class Foo {}
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @property-read bool $bar
- * @property-read array|null $baz
- * @property-read int|\stdClass $foo
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-read int|\stdClass $foo
- * @property-read bool $bar
- * @property-read array|null $baz
- */
- class Foo {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @property-read bool $bar
- * Comment 3
- * @property-read int|\stdClass $foo
- * Comment 2
- */
- class Foo {}
- ',
- '<?php
- /**
- * Comment 1
- * @property-read int|\stdClass $foo
- * Comment 2
- * @property-read bool $bar
- * Comment 3
- */
- class Foo {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @property-read int|\stdClass $A
- * @property-read bool $b
- * @property-read array|null $C
- * @property-read float $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-read array|null $C
- * @property-read float $D
- * @property-read bool $b
- * @property-read int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- yield 'with-and-without-types' => [
- '<?php
- /**
- * @property-read int|\stdClass $A
- * @property-read $b
- * @property-read array|null $C
- * @property-read $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-read array|null $C
- * @property-read $D
- * @property-read $b
- * @property-read int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithPropertyWriteCases
- */
- public function testFixWithPropertyWrite(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'property-write',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithPropertyWriteCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- /**
- * @property-write int|\stdClass $foo
- */
- class Foo {}
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @property-write bool $bar
- * @property-write array|null $baz
- * @property-write int|\stdClass $foo
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-write int|\stdClass $foo
- * @property-write bool $bar
- * @property-write array|null $baz
- */
- class Foo {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @property-write bool $bar
- * Comment 3
- * @property-write int|\stdClass $foo
- * Comment 2
- */
- class Foo {}
- ',
- '<?php
- /**
- * Comment 1
- * @property-write int|\stdClass $foo
- * Comment 2
- * @property-write bool $bar
- * Comment 3
- */
- class Foo {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @property-write int|\stdClass $A
- * @property-write bool $b
- * @property-write array|null $C
- * @property-write float $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-write array|null $C
- * @property-write float $D
- * @property-write bool $b
- * @property-write int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- yield 'with-and-without-types' => [
- '<?php
- /**
- * @property-write int|\stdClass $A
- * @property-write $b
- * @property-write array|null $C
- * @property-write $D
- */
- class Foo {}
- ',
- '<?php
- /**
- * @property-write array|null $C
- * @property-write $D
- * @property-write $b
- * @property-write int|\stdClass $A
- */
- class Foo {}
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithRequiresCases
- */
- public function testFixWithRequires(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'requires',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithRequiresCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @requires function json_decode
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @requires extension redis
- * @requires function json_decode
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @requires function json_decode
- * @requires extension redis
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @requires extension redis
- * Comment 3
- * @requires function json_decode
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @requires function json_decode
- * Comment 2
- * @requires extension redis
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @requires extension redis
- * @requires function json_decode
- * @requires OS Linux
- * @requires PHP 7.2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @requires PHP 7.2
- * @requires function json_decode
- * @requires extension redis
- * @requires OS Linux
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @requires extension redis
- * @dataProvider provide
- * @requires function json_decode
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @requires function json_decode
- * @dataProvider provide
- * @requires extension redis
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithThrowsCases
- */
- public function testFixWithThrows(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'throws',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithThrowsCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class Foo {
- /**
- * @throws Bar
- * @params bool $bool
- * @return void
- */
- public function bar() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function baz() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- class Foo
- {
- /**
- * @throws Bar
- * @throws Baz
- */
- public function bar() {}
- }
- ',
- '<?php
- class Foo
- {
- /**
- * @throws Baz
- * @throws Bar
- */
- public function bar() {}
- }
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- class Foo
- {
- /**
- * Comment 1
- * @throws Bar
- * Comment 3
- * @throws Baz
- * Comment 2
- */
- public function bar() {}
- }
- ',
- '<?php
- class Foo
- {
- /**
- * Comment 1
- * @throws Baz
- * Comment 2
- * @throws Bar
- * Comment 3
- */
- public function bar() {}
- }
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- class Foo
- {
- /**
- * @throws A
- * @throws b
- * @throws C
- */
- public function bar() {}
- }
- ',
- '<?php
- class Foo
- {
- /**
- * @throws b
- * @throws C
- * @throws A
- */
- public function bar() {}
- }
- ',
- ];
- yield 'fully-qualified' => [
- '<?php
- class Foo
- {
- /**
- * @throws \Bar\Baz\Qux
- * @throws Bar
- * @throws Foo
- */
- public function bar() {}
- }
- ',
- '<?php
- class Foo
- {
- /**
- * @throws Bar
- * @throws \Bar\Baz\Qux
- * @throws Foo
- */
- public function bar() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithUsesCases
- */
- public function testFixWithUses(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'uses',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithUsesCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @uses Foo
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @uses Bar
- * @uses Foo
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @uses Foo
- * @uses Bar
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @uses Bar
- * Comment 3
- * @uses Foo
- * Comment 2
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @uses Foo
- * Comment 2
- * @uses Bar
- * Comment 3
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @uses A
- * @uses c
- * @uses D
- * @uses E
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @uses A
- * @uses E
- * @uses c
- * @uses D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @uses Bar
- * @dataProvider provide
- * @uses Foo
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @uses Foo
- * @dataProvider provide
- * @uses Bar
- */
- public function testMe() {}
- }
- ',
- ];
- }
- /**
- * @dataProvider provideFixWithMultipleConfiguredAnnotationsCases
- */
- public function testFixWithMultipleConfiguredAnnotations(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([
- 'annotations' => [
- 'covers',
- 'uses',
- ],
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{0: string, 1?: string}>
- */
- public static function provideFixWithMultipleConfiguredAnnotationsCases(): iterable
- {
- yield 'skip on 1 or 0 occurrences' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase {
- /**
- * @uses Foo
- * @covers Baz
- * @params bool $bool
- * @return void
- */
- public function testMe() {}
- /**
- * @params bool $bool
- * @return void
- */
- public function testMe2() {}
- }
- ',
- ];
- yield 'base case' => [
- '<?php
- /**
- * @uses Bar
- * @uses Foo
- * @covers Baz
- * @covers Qux
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @uses Foo
- * @uses Bar
- * @covers Qux
- * @covers Baz
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'preserve positions if other docblock parts are present' => [
- '<?php
- /**
- * Comment 1
- * @uses Bar
- * Comment 3
- * @uses Foo
- * Comment 2
- * @covers Baz
- * Comment 5
- * @covers Qux
- * Comment 4
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * Comment 1
- * @uses Foo
- * Comment 2
- * @uses Bar
- * Comment 3
- * @covers Qux
- * Comment 4
- * @covers Baz
- * Comment 5
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'case-insensitive' => [
- '<?php
- /**
- * @uses A
- * @uses c
- * @covers D
- * @covers e
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- '<?php
- /**
- * @uses c
- * @uses A
- * @covers e
- * @covers D
- */
- class FooTest extends \PHPUnit_Framework_TestCase {}
- ',
- ];
- yield 'data provider' => [
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @uses Bar
- * @dataProvider provideOne
- * @uses Foo
- * @dataProvider provideTwo
- * @covers Baz
- * @dataProvider provideThree
- * @covers Qux
- */
- public function testMe() {}
- }
- ',
- '<?php
- class FooTest extends \PHPUnit_Framework_TestCase
- {
- /**
- * @uses Foo
- * @dataProvider provideOne
- * @uses Bar
- * @dataProvider provideTwo
- * @covers Qux
- * @dataProvider provideThree
- * @covers Baz
- */
- public function testMe() {}
- }
- ',
- ];
- }
- }
|