12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336 |
- <?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\Fixer\ClassNotation\ClassAttributesSeparationFixer;
- 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);
- $result = \Closure::bind(static fn (ClassAttributesSeparationFixer $fixer): int => $fixer->findCommentBlockStart($tokens, $index, 0), null, ClassAttributesSeparationFixer::class)($this->fixer);
- 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,
- ];
- }
- }
|