123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337 |
- <?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\ClassNotation;
- use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\Tokenizer\Tokens;
- use PhpCsFixer\WhitespacesFixerConfig;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer
- */
- final class ClassAttributesSeparationFixerTest extends AbstractFixerTestCase
- {
- /**
- * @param _AutogeneratedInputConfiguration $configuration
- *
- * @dataProvider provideFixCases
- */
- public function testFix(string $expected, ?string $input = null, array $configuration = []): void
- {
- $this->fixer->configure($configuration);
- $this->doTest($expected, $input);
- }
- public static function provideFixCases(): iterable
- {
- yield [
- '<?php
- class Sample
- {
- private $a; // foo
- /** second in a hour */
- private $b;
- }
- ',
- '<?php
- class Sample
- {private $a; // foo
- /** second in a hour */
- private $b;
- }
- ',
- ];
- yield 'empty class' => [
- '<?php class Foo {}',
- ];
- yield 'simple top class' => [
- '<?php class A {
- public function Foo(){}
- }',
- '<?php class A {public function Foo(){}}',
- ];
- yield 'comment' => [
- '<?php class A {
- /* function comment */
- public function Bar(){}
- }',
- '<?php class A {/* function comment */public function Bar(){}
- }',
- ];
- yield 'comment, multiple lines' => [
- '<?php class A {
- /* some comment */
- public function Bar(){}
- }',
- '<?php class A {
- /* some comment */
- public function Bar(){}
- }',
- ];
- yield 'simple PHPDoc case' => [
- '<?php class Foo
- {
- /** Doc 1 */
- public function A(){}
- /** Doc 2 */
- public function B(){}
- }',
- '<?php class Foo
- {/** Doc 1 */public function A(){}
- /** Doc 2 */
- public function B(){}
- }',
- ];
- yield 'add a newline at the end of a class with trait group' => [
- '<?php class A
- {
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }
- }',
- '<?php class A
- {
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }}',
- ];
- yield 'add a newline at the end of a class with trait' => [
- '<?php class A
- {
- use A\B\C;
- }',
- '<?php class A
- {
- use A\B\C;}',
- ];
- yield 'removes extra lines at the end of an interface' => [
- '<?php interface F
- {
- public function A();
- }',
- '<?php interface F
- {
- public function A();
- }',
- ];
- yield 'removes extra lines at the end of an abstract class' => [
- '<?php abstract class F
- {
- public abstract function A();
- }',
- '<?php abstract class F
- {
- public abstract function A();
- }',
- ];
- yield 'add a newline at the end of a class' => [
- '<?php class A
- {
- public function A(){}
- }',
- '<?php class A
- {
- public function A(){}}',
- ];
- yield 'add a newline at the end of a class: with comments' => [
- '<?php class A
- {
- public const A = 1; /* foo */ /* bar */
- }',
- '<?php class A
- {
- public const A = 1; /* foo */ /* bar */}',
- ];
- yield 'add a newline at the end of a class: with comments with trailing space' => [
- '<?php class A
- {
- public const A = 1; /* foo */ /* bar */
- }',
- '<?php class A
- {
- public const A = 1; /* foo */ /* bar */ }',
- ];
- $to = $from = '<?php ';
- for ($i = 0; $i < 15; ++$i) {
- $from .= \sprintf('class A%d{public function GA%d(){return new class {public function B6B%d(){}};}public function otherFunction%d(){}}', $i, $i, $i, $i);
- $to .= \sprintf("class A%d{\npublic function GA%d(){return new class {\npublic function B6B%d(){}\n};}\n\npublic function otherFunction%d(){}\n}", $i, $i, $i, $i);
- }
- yield [$to, $from];
- yield [
- '<?php $a = new class {
- public function H(){}
- public function B7(){}
- private function C(){}
- };',
- '<?php $a = new class {
- public function H(){}
- public function B7(){}
- private function C(){}
- };',
- ];
- yield [
- '<?php
- class A
- {
- public function getFilter()
- {
- return new class () implements FilterInterface {
- private $d = 123;
- public function pass($a, $b) {
- echo $a;
- }
- public $e = 5;
- };}
- }
- ',
- '<?php
- class A
- {public function getFilter()
- {
- return new class () implements FilterInterface {private $d = 123;
- public function pass($a, $b) {
- echo $a;
- }
- public $e = 5;};}
- }
- ',
- ];
- yield ['<?php
- class SomeClass1
- {
- // This comment
- // is multiline.
- public function echoA()
- {
- echo "a";
- }
- }
- '];
- yield [
- '<?php
- class SomeClass2
- {
- // This comment
- /* is multiline. */
- public function echoA()
- {
- echo "a";
- }
- }
- ',
- '<?php
- class SomeClass2
- {
- // This comment
- /* is multiline. */public function echoA()
- {
- echo "a";
- }
- }
- ',
- ];
- yield [
- '<?php
- class SomeClass3
- {
- // This comment
- // is multiline.
- public function echoA()
- {
- echo "a";
- }
- }
- ', ];
- yield [
- '<?php
- class SomeClass1
- {
- private $a; //
- public function methodA()
- {
- }
- private $b;
- //
- public function methodB()
- {
- }
- // C
- public function methodC()
- {
- }
- // D
- public function methodD()
- {
- }
- /* E */
- public function methodE()
- {
- }
- /* F */
- public function methodF()
- {
- }
- }
- ',
- '<?php
- class SomeClass1
- {
- private $a; //
- public function methodA()
- {
- }
- private $b;
- //
- public function methodB()
- {
- }
- // C
- public function methodC()
- {
- }
- // D
- public function methodD()
- {
- }
- /* E */
- public function methodE()
- {
- }
- /* F */
- public function methodF()
- {
- }
- }
- ', ];
- yield ['<?php
- class SomeClass
- {
- // comment
- public function echoA()
- {
- echo "a";
- }
- }
- '];
- yield ['<?php
- class SomeClass
- {
- // This comment
- // is multiline.
- public function echoA()
- {
- echo "a";
- }
- }
- '];
- yield [
- '<?php
- class SomeClass
- {
- // comment
- public function echoA()
- {
- echo "a";
- }
- }
- ',
- '<?php
- class SomeClass
- {
- // comment
- public function echoA()
- {
- echo "a";
- }
- }
- ',
- ];
- yield [
- '<?php
- class SomeClass
- {
- /* comment */
- public function echoB()
- {
- echo "a";
- }
- }
- ',
- '<?php
- class SomeClass
- {
- /* comment */public function echoB()
- {
- echo "a";
- }
- }
- ',
- ];
- yield [
- '<?php
- class SomeClass
- {
- /* comment */
- public function echoC()
- {
- echo "a";
- }
- }
- ',
- '<?php
- class SomeClass
- {
- /* comment */ public function echoC()
- {
- echo "a";
- }
- }
- ',
- ];
- yield [
- '<?php
- abstract class MethodTest2
- {
- public function method045()
- {
- $files = null;
- if (!empty($files)) {
- $this->filter(
- function (\SplFileInfo $file) use ($files) {
- return !in_array($file->getRelativePathname(), $files, true);
- }
- );
- }
- }
- private $a;
- public static function method145()
- {
- }
- abstract protected function method245();
- // comment
- final private function method345()
- {
- }
- }
- function some1(){ echo 1;}
- function some2(){ echo 2;}',
- '<?php
- abstract class MethodTest2
- {
- public function method045()
- {
- $files = null;
- if (!empty($files)) {
- $this->filter(
- function (\SplFileInfo $file) use ($files) {
- return !in_array($file->getRelativePathname(), $files, true);
- }
- );
- }
- }
- private $a;
- public static function method145()
- {
- }
- abstract protected function method245();
- // comment
- final private function method345()
- {
- }
- }
- function some1(){ echo 1;}
- function some2(){ echo 2;}',
- ];
- yield [
- '<?php
- /*
- * This file is part of the PHP CS utility.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Linter;
- /**
- * Dummy linter. No linting is performed. No error is raised.
- *
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * @internal
- */
- final class NullLinter implements LinterInterface
- {
- /**
- * {@inheritdoc}
- */
- public function lintFile($path)
- {
- unset($path);
- }
- /**
- * {@inheritdoc}
- */
- public function lintSource($source)
- {
- unset($source);
- }
- }
- ',
- ];
- // do not touch anonymous functions (since PHP doesn't allow
- // for class attributes being functions :(, we only have to test
- // those used within methods)
- yield [
- '<?php
- class MethodTestAnonymous
- {
- public function method444a()
- {
- $text = "hello";
- $example = function ($arg) use ($message) {
- var_dump($arg . " " . $message);
- };
- $example($text);
- $example = function($arg) use ($message) {
- var_dump($arg . " " . $message);
- };
- $example = function /*test*/ ($arg) use ($message) {
- var_dump($arg . " " . $message);
- };
- }
- }',
- ];
- yield [
- '<?php
- class MethodTest1
- {
- private $c; //
- public function method444a()
- {
- }
- /**
- *
- */
- public function method444b()
- {
- }
- //
- public function method444c()
- {
- }
- private $a;
- public function method444d()
- {
- }
- private $b;
- //
- public function method444e()
- {
- }
- public function method444f()
- {
- }
- private $d; //
- public function method444f1()
- {
- }
- /**/
- public function method444g()
- {
- }
- }',
- '<?php
- class MethodTest1
- {
- private $c; //
- public function method444a()
- {
- }
- /**
- *
- */
- public function method444b()
- {
- }
- //
- public function method444c()
- {
- }
- private $a;
- public function method444d()
- {
- }
- private $b;
- //
- public function method444e()
- {
- }
- public function method444f()
- {
- }
- private $d; //
- public function method444f1()
- {
- }
- /**/
- public function method444g()
- {
- }
- }',
- ];
- // spaces between methods
- yield [
- '<?php
- abstract class MethodTest3
- {
- public function method021()
- {
- }
- public static function method121()
- {
- }
- abstract protected function method221(); '.'
- final private function method321a()
- {
- }
- }',
- '<?php
- abstract class MethodTest3
- {
- public function method021()
- {
- }
- public static function method121()
- {
- }
- abstract protected function method221();
- '.'
- final private function method321a()
- {
- }
- }', ];
- // don't change correct code
- yield [
- '<?php
- class SmallHelperException extends \Exception
- {
- public function getId111()
- {
- return 1;
- }
- public function getMessage111()
- {
- return \'message\';
- }
- }
- class MethodTest123124124
- {
- public function method111a(){}
- public function method211a(){}
- }',
- ];
- // do not touch function out of class scope
- yield [
- '<?php
- function some0() {
- }
- class MethodTest4
- {
- public function method122b()
- {
- }
- public function method222b()
- {
- }
- }
- function some() {
- }
- function some2() {
- }
- ',
- ];
- yield [
- '<?php interface A {
- public function B1(); // allowed comment
- public function C(); // allowed comment
- }',
- '<?php interface A {public function B1(); // allowed comment
- public function C(); // allowed comment
- }',
- ];
- yield [
- '<?php class Foo {
- var $a;
- var $b;
- }',
- '<?php class Foo {
- var $a;
- var $b;
- }',
- ];
- yield [
- '<?php
- class A
- {
- /** 1 */
- function A2() {}
- /** 2 */
- function B2() {}
- }
- ',
- '<?php
- class A
- {
- /** 1 */
- function A2() {}
- /** 2 */
- function B2() {}
- }
- ',
- ];
- // do not touch well formatted traits
- yield [
- '<?php
- trait OkTrait
- {
- function getReturnTypeOk()
- {
- }
- /**
- *
- */
- function getReturnDescriptionOk()
- {
- }
- }',
- ];
- yield [
- '<?php
- trait ezcReflectionReturnInfo {
- public $x = 1;
- protected function getA(){echo 1;}
- function getB(){echo 2;}
- protected function getC(){echo 3;}
- /** Description */
- function getD(){echo 4;}
- protected function getE(){echo 3;}
- private $a;
- function getF(){echo 4;}
- }',
- '<?php
- trait ezcReflectionReturnInfo {
- public $x = 1;
- protected function getA(){echo 1;}function getB(){echo 2;}
- protected function getC(){echo 3;}/** Description */function getD(){echo 4;}
- protected function getE(){echo 3;}private $a;function getF(){echo 4;}
- }',
- ];
- yield [
- '<?php
- trait SomeReturnInfo {
- function getReturnType()
- {
- }
- function getReturnDescription()
- {
- }
- function getReturnDescription2()
- {
- }
- abstract public function getWorld();
- }',
- '<?php
- trait SomeReturnInfo {
- function getReturnType()
- {
- }
- function getReturnDescription()
- {
- } function getReturnDescription2()
- {
- }
- abstract public function getWorld();
- }',
- ];
- yield [
- '<?php
- interface TestInterface
- {
- public function someInterfaceMethod4();
- public function someInterfaceMethod5();
- /**
- * {@link}
- */ '.'
- public function someInterfaceMethod6();
- public function someInterfaceMethod7();
- public function someInterfaceMethod8();
- }',
- '<?php
- interface TestInterface
- { public function someInterfaceMethod4();
- public function someInterfaceMethod5();
- /**
- * {@link}
- */ '.'
- public function someInterfaceMethod6();
- public function someInterfaceMethod7(); public function someInterfaceMethod8();
- }',
- ];
- // do not touch well formatted interfaces
- yield [
- '<?php
- interface TestInterfaceOK
- {
- public function someMethod1();
- public function someMethod2();
- }',
- ];
- // method after trait use
- yield [
- '<?php
- trait ezcReflectionReturnInfo {
- function getReturnDescription() {}
- }
- class ezcReflectionMethod extends ReflectionMethod {
- use ezcReflectionReturnInfo;
- function afterUseTrait(){}
- function afterUseTrait2(){}
- }',
- '<?php
- trait ezcReflectionReturnInfo {
- function getReturnDescription() {}
- }
- class ezcReflectionMethod extends ReflectionMethod {
- use ezcReflectionReturnInfo;function afterUseTrait(){}function afterUseTrait2(){}
- }',
- ];
- yield 'multi line property' => [
- '<?php class Foo
- {
- private $prop = [
- 1 => true,
- 2 => false,
- ];
- // comment2
- private $bar = 1;
- }',
- '<?php class Foo
- {
- private $prop = [
- 1 => true,
- 2 => false,
- ]; // comment2
- private $bar = 1;
- }',
- ['elements' => ['property' => 'one']],
- ];
- yield 'trait group import none' => [
- '<?php class Foo
- {
- use Ao;
- use B0 { X0 as Y0;} // test
- use A;
- use B { X as Y;} // test
- use Char;
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }
- use Dua;
- }',
- '<?php class Foo
- {
- use Ao;
- use B0 { X0 as Y0;} // test
- use A;
- use B { X as Y;} // test
- use Char;
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }
- use Dua;
- }',
- ['elements' => ['trait_import' => 'none']],
- ];
- yield [
- '<?php
- class Foo
- {
- /** A */
- private $email;
- private $foo0; #0 /* test */
- private $foo1; #1
- private $foo2; /* @2 */
- }',
- '<?php
- class Foo
- {
- /** A */
- private $email;
- private $foo0; #0 /* test */
- private $foo1; #1
- private $foo2; /* @2 */
- }',
- ['elements' => ['property' => 'none']],
- ];
- yield [
- '<?php
- class Sample
- {
- /** @var int */
- const FOO = 1;
- /** @var int */
- const BAR = 2;
- const BAZ = 3;
- const OTHER = 4;
- const OTHER2 = 5;
- }',
- '<?php
- class Sample
- {
- /** @var int */
- const FOO = 1;
- /** @var int */
- const BAR = 2;
- const BAZ = 3;
- const OTHER = 4;
- const OTHER2 = 5;
- }',
- ['elements' => ['const' => 'none']],
- ];
- yield 'multiple trait import 5954' => [
- '<?php
- class Foo
- {
- use Bar, Baz;
- }',
- null,
- ['elements' => ['method' => 'one']],
- ];
- yield 'multiple trait import with method 5954' => [
- '<?php
- class Foo
- {
- use Bar, Baz;
- public function f() {}
- }',
- '<?php
- class Foo
- {
- use Bar, Baz;
- public function f() {}
- }',
- ['elements' => ['method' => 'one']],
- ];
- yield 'trait group import 5843' => [
- '<?php
- class Foo
- {
- use Ao;
- use B0 { X0 as Y0;} // test
- use A;
- use B { X as Y;} // test
- use Char;
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }
- use Dua;
- public function aaa()
- {
- }
- }',
- '<?php
- class Foo
- {
- use Ao;
- use B0 { X0 as Y0;} // test
- use A;
- use B { X as Y;} // test
- use Char;
- use Bar {
- __construct as barConstruct;
- baz as barBaz;
- }
- use Dua;
- public function aaa()
- {
- }
- }',
- ['elements' => ['method' => 'one', 'trait_import' => 'one']],
- ];
- yield [
- '<?php
- class Foo
- {
- use SomeTrait1;
- use SomeTrait2;
- public function Bar(){}
- }
- ',
- '<?php
- class Foo
- {
- use SomeTrait1;
- use SomeTrait2;
- public function Bar(){}
- }
- ',
- ['elements' => ['method' => 'one', 'trait_import' => 'one']],
- ];
- yield 'trait group import 5852' => [
- '<?php
- class Foo
- {
- use A;
- use B;
- /**
- *
- */
- public function A(){}
- }',
- '<?php
- class Foo
- {
- use A;
- use B;
- /**
- *
- */
- public function A(){}
- }',
- ['elements' => ['const' => 'one', 'method' => 'one', 'property' => 'one', 'trait_import' => 'none']],
- ];
- yield [
- '<?php
- abstract class Example
- {
- use SomeTrait;
- use AnotherTrait;
- public $property;
- abstract public function method(): void;
- }',
- '<?php
- abstract class Example
- {
- use SomeTrait;
- use AnotherTrait;
- public $property;
- abstract public function method(): void;
- }',
- ['elements' => ['const' => 'one', 'method' => 'one', 'property' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- private $a = null;
- public $b = 1;
- function A() {}
- }
- ',
- '<?php
- class A
- {
- private $a = null;
- public $b = 1;
- function A() {}
- }
- ',
- ['elements' => ['property' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- private $a = null;
- public $b = 1;
- function A() {}
- }
- ',
- '<?php
- class A
- {
- private $a = null;
- public $b = 1;
- function A() {}
- }
- ',
- ['elements' => ['property' => 'none']],
- ];
- yield [
- '<?php
- class A
- {
- const A = 1;
- const THREE = ONE + self::TWO; /* test */ # test
- const B = 2;
- }
- ',
- '<?php
- class A
- {
- const A = 1;
- const THREE = ONE + self::TWO; /* test */ # test
- const B = 2;
- }
- ',
- ['elements' => ['const' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- const A = 1;
- const THREE = ONE + self::TWO;
- const B = 2;
- }
- ',
- '<?php
- class A
- {
- const A = 1;
- const THREE = ONE + self::TWO;
- const B = 2;
- }
- ',
- ['elements' => ['const' => 'none']],
- ];
- yield [
- '<?php
- class A
- {
- function D() {}
- function B4() {}
- }
- ',
- '<?php
- class A
- {
- function D() {}
- function B4() {}
- }
- ',
- ['elements' => ['method' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- function A() {}
- function B() {}
- }
- ',
- '<?php
- class A
- {
- function A() {}
- function B() {}
- }
- ',
- ['elements' => ['method' => 'none']],
- ];
- yield [
- '<?php
- class A
- {
- private $x;
- private $y;
- final function f1() {}
- final function f2() {}
- }
- ',
- '<?php
- class A
- {
- private $x;
- private $y;
- final function f1() {}
- final function f2() {}
- }
- ',
- ['elements' => ['property' => 'none', 'method' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- const FOO = 1;
- const BAR = 2;
- function f1() {}
- function f2() {}
- }
- ',
- '<?php
- class A
- {
- const FOO = 1;
- const BAR = 2;
- function f1() {}
- function f2() {}
- }
- ',
- ['elements' => ['const' => 'none', 'method' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- const FOO = 1;
- const BAR = 2;
- public function f1() {}
- public function f2() {}
- }
- ',
- '<?php
- class A
- {
- const FOO = 1;
- const BAR = 2;
- public function f1() {}
- public function f2() {}
- }
- ',
- ['elements' => ['const' => 'none', 'method' => 'one']],
- ];
- yield [
- '<?php
- class A
- {
- const B = 2;
- const FOO = 1;
- const BAR = 2;
- /** @var int */
- const BAZ = 3;
- /** @var int */
- const NEW = 4;
- /** @var int */
- const A = 5;
- }
- ',
- '<?php
- class A
- {
- const B = 2;
- const FOO = 1;
- const BAR = 2;
- /** @var int */
- const BAZ = 3;
- /** @var int */
- const NEW = 4;
- /** @var int */
- const A = 5;
- }
- ',
- ['elements' => ['const' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class B
- {
- public $foo;
- /** @var string */
- public $bar;
- public $baz;
- }
- ',
- '<?php
- class B
- {
- public $foo;
- /** @var string */
- public $bar;
- public $baz;
- }
- ',
- ['elements' => ['property' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class C
- {
- public function f1() {}
- public function f2() {}
- public function f3() {}
- /** @return string */
- public function f4() {}
- }
- ',
- '<?php
- class C
- {
- public function f1() {}
- public function f2() {}
- public function f3() {}
- /** @return string */
- public function f4() {}
- }
- ',
- ['elements' => ['method' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class Sample
- {
- /** @var int */
- const ART = 1;
- const SCIENCE = 2;
- /** @var string */
- public $a;
- /** @var int */
- public $b;
- public $c;
- /**
- * @param string $a
- * @param int $b
- * @param int $c
- */
- public function __construct($a, $b, $c) {}
- public function __destruct() {}
- }
- ',
- '<?php
- class Sample
- {
- /** @var int */
- const ART = 1;
- const SCIENCE = 2;
- /** @var string */
- public $a;
- /** @var int */
- public $b;
- public $c;
- /**
- * @param string $a
- * @param int $b
- * @param int $c
- */
- public function __construct($a, $b, $c) {}
- public function __destruct() {}
- }
- ',
- ['elements' => ['const' => 'only_if_meta', 'property' => 'only_if_meta', 'method' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class A
- {
- use A;
- use B;
- private $a = null;
- public $b = 1;
- }
- ',
- '<?php
- class A
- {
- use A;
- use B;
- private $a = null;
- public $b = 1;
- }
- ',
- ['elements' => ['property' => 'none', 'trait_import' => 'none']],
- ];
- yield [
- '<?php
- class Foo {
- public function H1(){}
- /** */
- public const BAR = 123;
- /** */
- private const BAZ = "a";
- }',
- '<?php
- class Foo {
- public function H1(){}
- /** */
- public const BAR = 123;
- /** */
- private const BAZ = "a";
- }',
- ];
- yield [
- '<?php
- class Foo {
- private ?int $foo;
- protected string $bar;
- public iterable $baz;
- var ? Foo\Bar $qux;
- }',
- '<?php
- class Foo {
- private ?int $foo;
- protected string $bar;
- public iterable $baz;
- var ? Foo\Bar $qux;
- }',
- ];
- yield [
- '<?php
- class Foo {
- private array $foo;
- private array $bar;
- }',
- '<?php
- class Foo {
- private array $foo;
- private array $bar;
- }',
- ];
- yield [
- '<?php
- class Entity
- {
- /**
- * @ORM\Column(name="one", type="text")
- */
- private string $one;
- /**
- * @ORM\Column(name="two", type="text")
- */
- private string $two;
- private string $three;
- private string $four;
- private string $five;
- }',
- '<?php
- class Entity
- {
- /**
- * @ORM\Column(name="one", type="text")
- */
- private string $one;
- /**
- * @ORM\Column(name="two", type="text")
- */
- private string $two;
- private string $three;
- private string $four;
- private string $five;
- }',
- ['elements' => ['property' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class Foo
- {
- use SomeTrait1;
- use SomeTrait2;
- public function Bar(){}
- }
- ',
- '<?php
- class Foo
- {
- use SomeTrait1;
- use SomeTrait2;
- public function Bar(){}
- }
- ',
- ];
- }
- /**
- * @param _AutogeneratedInputConfiguration $config
- *
- * @dataProvider provideFix80Cases
- *
- * @requires PHP 8.0
- */
- public function testFix80(string $expected, ?string $input, array $config = []): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- public static function provideFix80Cases(): iterable
- {
- yield 'attributes' => [
- '<?php
- class User1
- {
- #[ORM\Id, ORM\Column("integer"), ORM\GeneratedValue]
- private $id;
- #[ORM\Column("string", ORM\Column::UNIQUE)]
- #[Assert\String()]
- #[Assert\Email(["message" => "The email {{ value }} is not a valid email."])]
- private $email;
- #[Assert\String()]
- private $name;
- }',
- '<?php
- class User1
- {
- #[ORM\Id, ORM\Column("integer"), ORM\GeneratedValue]
- private $id;
- #[ORM\Column("string", ORM\Column::UNIQUE)]
- #[Assert\String()]
- #[Assert\Email(["message" => "The email {{ value }} is not a valid email."])]
- private $email;
- #[Assert\String()]
- private $name;
- }',
- ];
- yield 'attributes minimal' => [
- '<?php
- class User2{
- #[ORM\Id, ORM\Column("integer"), ORM\GeneratedValue]
- private $id;
- }',
- '<?php
- class User2{#[ORM\Id, ORM\Column("integer"), ORM\GeneratedValue] private $id;}',
- ];
- yield 'attribute block' => [
- '<?php
- class User3
- {
- private $id;
- #[ORM\Column("string")]
- #[Assert\Email(["message" => "Foo"])]
- private $email;
- }',
- '<?php
- class User3
- {
- private $id;
- #[ORM\Column("string")]
- #[Assert\Email(["message" => "Foo"])] private $email;
- }',
- ];
- yield 'constructor property promotion' => [
- '<?php
- class Foo {
- private array $foo;
- private array $bar;
- public function __construct(
- public float $x = 0.0,
- protected float $y = 0.0,
- private float $z = 0.0,
- ) {}
- }',
- '<?php
- class Foo {
- private array $foo;
- private array $bar;
- public function __construct(
- public float $x = 0.0,
- protected float $y = 0.0,
- private float $z = 0.0,
- ) {}
- }',
- ];
- yield 'typed properties' => [
- '<?php
- class Foo {
- private static int | float | null $a;
- private static int | float | null $b;
- private int | float | null $c;
- private int | float | null $d;
- }',
- '<?php
- class Foo {
- private static int | float | null $a;
- private static int | float | null $b;
- private int | float | null $c;
- private int | float | null $d;
- }',
- ];
- yield 'attributes with conditional spacing' => [
- '<?php
- class User
- {
- private $id;
- #[Assert\String()]
- private $name;
- private $email;
- }
- ',
- '<?php
- class User
- {
- private $id;
- #[Assert\String()]
- private $name;
- private $email;
- }
- ',
- ['elements' => ['property' => 'only_if_meta']],
- ];
- yield 'mixed attributes and phpdoc with conditional spacing' => [
- '<?php
- class User
- {
- private $id;
- /** @var string */
- #[Assert\Email(["message" => "Foo"])]
- private $email;
- #[Assert\String()]
- #[ORM\Column()]
- private $place;
- #[ORM\Column()]
- /** @var string */
- private $hash;
- /** @var string **/
- #[ORM\Column()]
- /** @internal */
- private $updatedAt;
- }
- ',
- '<?php
- class User
- {
- private $id;
- /** @var string */
- #[Assert\Email(["message" => "Foo"])]
- private $email;
- #[Assert\String()]
- #[ORM\Column()]
- private $place;
- #[ORM\Column()]
- /** @var string */
- private $hash;
- /** @var string **/
- #[ORM\Column()]
- /** @internal */
- private $updatedAt;
- }
- ',
- ['elements' => ['property' => 'only_if_meta']],
- ];
- yield [
- '<?php
- class Foo
- {
- #[Assert\Email(["message" => "Foo"])]
- private $email;
- private $foo1; #1
- private $foo2; /* @2 */
- }',
- '<?php
- class Foo
- {
- #[Assert\Email(["message" => "Foo"])]
- private $email;
- private $foo1; #1
- private $foo2; /* @2 */
- }',
- ['elements' => ['property' => 'none']],
- ];
- }
- /**
- * @param _AutogeneratedInputConfiguration $config
- *
- * @dataProvider provideFix81Cases
- *
- * @requires PHP 8.1
- */
- public function testFix81(string $expected, ?string $input, array $config = []): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- public static function provideFix81Cases(): iterable
- {
- yield [
- '<?php class A {
- public int $a0;
- public readonly int $a1;
- readonly public int $a2;
- readonly int $a3;
- public int $a4;
- }',
- '<?php class A {
- public int $a0;
- public readonly int $a1;
- readonly public int $a2;
- readonly int $a3;
- public int $a4;
- }',
- ];
- yield [
- '<?php
- class Foo
- {
- final public const B1 = "1";
- public final const B2 = "2";
- final const B3 = "3";
- }
- ',
- '<?php
- class Foo
- {
- final public const B1 = "1";
- public final const B2 = "2";
- final const B3 = "3";
- }
- ',
- ];
- yield 'intersection properties' => [
- '<?php
- class Foo {
- private static Bar & Something & Baz $a;
- private static Bar & Something & Baz $b;
- private Bar & Something & Baz $c;
- private Bar & Something & Baz $d;
- }',
- '<?php
- class Foo {
- private static Bar & Something & Baz $a;
- private static Bar & Something & Baz $b;
- private Bar & Something & Baz $c;
- private Bar & Something & Baz $d;
- }',
- ];
- $input = '<?php
- enum Cards: string
- {
- protected const Deck = "d.d";
- protected const Pack = "p.p";
- case Hearts = "H";
- case Spades = "S";
- case Diamonds = "D";
- case Clubs = "C";
- protected function test() {
- echo 1;
- }
- protected function test2() {
- echo 2;
- }
- }
- ';
- yield [
- '<?php
- enum Cards: string
- {
- protected const Deck = "d.d";
- protected const Pack = "p.p";
- case Hearts = "H";
- case Spades = "S";
- case Diamonds = "D";
- case Clubs = "C";
- protected function test() {
- echo 1;
- }
- protected function test2() {
- echo 2;
- }
- }
- ',
- $input,
- ['elements' => [
- 'const' => 'one',
- 'method' => 'one',
- 'case' => 'one',
- ]],
- ];
- yield [
- '<?php
- enum Cards: string
- {
- protected const Deck = "d.d";
- protected const Pack = "p.p";
- case Hearts = "H";
- case Spades = "S";
- case Diamonds = "D";
- case Clubs = "C";
- protected function test() {
- echo 1;
- }
- protected function test2() {
- echo 2;
- }
- }
- ',
- $input,
- ['elements' => [
- 'const' => 'none',
- 'method' => 'one',
- 'case' => 'none',
- ]],
- ];
- }
- /**
- * @dataProvider provideFix82Cases
- *
- * @requires PHP 8.2
- */
- public function testFix82(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{0: string, 1?: string}>
- */
- public static function provideFix82Cases(): iterable
- {
- yield [
- '<?php
- trait Foo {
- const Bar = 1;
- const Baz = 2;
- }',
- '<?php
- trait Foo {
- const Bar = 1;
- const Baz = 2;
- }',
- ];
- yield [
- '<?php
- class X
- {
- private A|(B&C) $propertyName;
- }',
- ];
- }
- /**
- * @dataProvider provideWithWhitespacesConfigCases
- */
- public function testWithWhitespacesConfig(string $expected, ?string $input = null): void
- {
- $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t", "\r\n"));
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{string, string}>
- */
- public static function provideWithWhitespacesConfigCases(): iterable
- {
- yield [
- "<?php\r\nclass SomeClass\r\n{\r\n // comment\n\n public function echoA()\r\n {\r\n echo 'a';\r\n }\r\n}\r\n",
- "<?php\r\nclass SomeClass\r\n{\r\n // comment\n\n\n public function echoA()\r\n {\r\n echo 'a';\r\n }\r\n}\r\n",
- ];
- yield [
- "<?php\r\nclass SomeClass\r\n{\r\n // comment\r\n\r\n public function echoA()\r\n {\r\n echo 'a';\r\n }\r\n}\r\n",
- "<?php\r\nclass SomeClass\r\n{\r\n // comment\r\n\r\n\r\n public function echoA()\r\n {\r\n echo 'a';\r\n }\r\n}\r\n",
- ];
- }
- /**
- * @param array<array-key, mixed> $elements
- *
- * @dataProvider provideInvalidConfigurationCases
- */
- public function testInvalidConfiguration(array $elements): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->fixer->configure(['elements' => $elements]);
- }
- public static function provideInvalidConfigurationCases(): iterable
- {
- yield 'numeric keys' => [['method', 'property']];
- yield 'wrong key name' => [['methods' => 'one']];
- yield 'wrong key value' => [['method' => 'two']];
- }
- /**
- * @dataProvider provideCommentBlockStartDetectionCases
- */
- public function testCommentBlockStartDetection(int $expected, string $code, int $index): void
- {
- Tokens::clearCache();
- $tokens = Tokens::fromCode($code);
- $method = new \ReflectionMethod($this->fixer, 'findCommentBlockStart');
- $method->setAccessible(true);
- $result = $method->invoke($this->fixer, $tokens, $index, 0);
- self::assertSame(
- $expected,
- $result,
- \sprintf('Expected index %d (%s) got index %d (%s).', $expected, $tokens[$expected]->toJson(), $result, $tokens[$result]->toJson())
- );
- }
- /**
- * @return iterable<array{int, string, int}>
- */
- public static function provideCommentBlockStartDetectionCases(): iterable
- {
- yield [
- 4,
- '<?php
- //ui
- //j1
- //k2
- ',
- 6,
- ];
- yield [
- 4,
- '<?php
- //ui
- //j1
- //k2
- ',
- 5,
- ];
- yield [
- 4,
- '<?php
- /**/
- //j1
- //k2
- ',
- 6,
- ];
- yield [
- 4,
- '<?php
- $a;//j
- //k
- ',
- 6,
- ];
- yield [
- 2,
- '<?php
- //a
- ',
- 2,
- ];
- yield [
- 2,
- '<?php
- //b
- //c
- ',
- 2,
- ];
- yield [
- 2,
- '<?php
- //d
- //e
- ',
- 4,
- ];
- yield [
- 2,
- '<?php
- /**/
- //f
- //g
- //h
- ',
- 8,
- ];
- }
- }
|