12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175 |
- <?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\ClassDefinitionFixer;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\Tokenizer\Tokens;
- use PhpCsFixer\WhitespacesFixerConfig;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer
- */
- final class ClassDefinitionFixerTest extends AbstractFixerTestCase
- {
- public function testConfigureDefaultToFalse(): void
- {
- $defaultConfig = [
- 'multi_line_extends_each_single_line' => false,
- 'single_item_single_line' => false,
- 'single_line' => false,
- 'space_before_parenthesis' => false,
- 'inline_constructor_arguments' => true,
- ];
- $fixer = new ClassDefinitionFixer();
- $fixer->configure($defaultConfig);
- self::assertConfigurationSame($defaultConfig, $fixer);
- $fixer->configure([]);
- self::assertConfigurationSame($defaultConfig, $fixer);
- }
- /**
- * @param string $expected PHP source code
- * @param string $input PHP source code
- * @param array<string, bool> $config
- *
- * @dataProvider provideFixingAnonymousClassesCases
- */
- public function testFixingAnonymousClasses(string $expected, string $input, array $config = []): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- /**
- * @dataProvider provideFixingClassesCases
- */
- public function testFixingClasses(string $expected, string $input): void
- {
- $this->fixer->configure([]);
- $this->doTest($expected, $input);
- }
- /**
- * @param array<string, mixed> $config
- *
- * @dataProvider provideFixingClassesWithConfigCases
- */
- public function testFixingClassesWithConfig(string $expected, string $input, array $config): void
- {
- $this->fixer->configure($config);
- $this->doTest($expected, $input);
- }
- /**
- * @dataProvider provideFixingInterfacesCases
- */
- public function testFixingInterfaces(string $expected, string $input): void
- {
- $this->fixer->configure([]);
- $this->doTest($expected, $input);
- }
- /**
- * @dataProvider provideFixingTraitsCases
- */
- public function testFixingTraits(string $expected, string $input): void
- {
- $this->fixer->configure([]);
- $this->doTest($expected, $input);
- }
- public function testInvalidConfigurationKey(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessageMatches(
- '/^\[class_definition\] Invalid configuration: The option "a" does not exist\. Defined options are: "inline_constructor_arguments", "multi_line_extends_each_single_line", "single_item_single_line", "single_line", "space_before_parenthesis"\.$/'
- );
- $fixer = new ClassDefinitionFixer();
- $fixer->configure(['a' => false]);
- }
- public function testInvalidConfigurationValueType(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessageMatches(
- '/^\[class_definition\] Invalid configuration: The option "single_line" with value "z" is expected to be of type "bool", but is of type "string"\.$/'
- );
- $fixer = new ClassDefinitionFixer();
- $fixer->configure(['single_line' => 'z']);
- }
- public static function provideFixingAnonymousClassesCases(): iterable
- {
- yield [
- '<?php $a = new class(0) extends SomeClass implements SomeInterface, D {};',
- "<?php \$a = new class(0) extends\nSomeClass\timplements SomeInterface, D {};",
- ];
- yield [
- '<?php $a = new class(1) extends SomeClass implements SomeInterface, D {};',
- "<?php \$a = new class(1) extends\nSomeClass\timplements SomeInterface, D {};",
- ['single_line' => true],
- ];
- yield [
- "<?php \$a = new class('1a') implements\nA\n{};",
- "<?php \$a = new class('1a') implements\nA{};",
- ];
- yield [
- "<?php \$a = new class('1a') implements A {};",
- "<?php \$a = new class('1a') implements\nA{};",
- ['single_item_single_line' => true],
- ];
- yield [
- '<?php $a = new class {};',
- '<?php $a = new class{};',
- ];
- yield [
- '<?php $a = new class {};',
- "<?php \$a = new class\n{};",
- ];
- yield [
- '<?php $a = new class() {};',
- "<?php \$a = new\n class ( ){};",
- ];
- yield [
- '<?php $a = new class( ) {};',
- "<?php \$a = new\n class ( ){};",
- ['inline_constructor_arguments' => false],
- ];
- yield [
- '<?php $a = new class implements Foo {};',
- "<?php \$a = new\n class implements Foo {};",
- ['inline_constructor_arguments' => false],
- ];
- yield [
- '<?php $a = new class( $this->foo() , bar ( $a) ) {};',
- "<?php \$a = new\n class ( \$this->foo() , bar ( \$a) ){};",
- ['inline_constructor_arguments' => false],
- ];
- yield [
- '<?php $a = new class(10, 1, /**/ 2) {};',
- '<?php $a = new class( 10, 1,/**/2 ){};',
- ];
- yield [
- '<?php $a = new class( 10, 1,/**/2 ) {};',
- '<?php $a = new class( 10, 1,/**/2 ){};',
- ['inline_constructor_arguments' => false],
- ];
- yield [
- '<?php $a = new class(2) {};',
- '<?php $a = new class(2){};',
- ];
- yield [
- '<?php $a = new class($this->prop) {};',
- '<?php $a = new class( $this->prop ){};',
- ];
- yield [
- '<?php $a = new class( $this->prop ) {};',
- '<?php $a = new class( $this->prop ){};',
- ['inline_constructor_arguments' => false],
- ];
- yield [
- "<?php \$a = new class(\n\t\$a,\n\t\$b,\n\t\$c,\n\t\$d) implements A, B {};",
- "<?php \$a = new class(\n\t\$a,\n\t\$b,\n\t\$c,\n\t\$d) implements A, \t B{};",
- ['inline_constructor_arguments' => false],
- ];
- yield [
- "<?php \$a = new class(\n\t\$a,\n\t\$b,\n\t\$c,\n\t\$d) implements A, B {};",
- "<?php \$a = new class (\n\t\$a,\n\t\$b,\n\t\$c,\n\t\$d) implements A, \t B{};",
- ['inline_constructor_arguments' => false],
- ];
- yield [
- '<?php $a = new class($this->prop, $v[3], 4) {};',
- '<?php $a = new class( $this->prop,$v[3], 4) {};',
- ];
- yield 'PSR-12 Extends/Implements Parenthesis on the next line.' => [
- '<?php
- $instance = new class extends \Foo implements
- \ArrayAccess,
- \Countable,
- \Serializable
- {};',
- '<?php
- $instance = new class extends \Foo implements
- \ArrayAccess,\Countable,\Serializable{};',
- ];
- yield 'PSR-12 Implements Parenthesis on the next line.' => [
- '<?php
- $instance = new class implements
- \ArrayAccess,
- \Countable,
- \Serializable
- {};',
- '<?php
- $instance = new class implements
- \ArrayAccess,\Countable,\Serializable{};',
- ];
- yield 'PSR-12 Extends Parenthesis on the next line.' => [
- '<?php
- $instance = new class extends
- ArrayAccess
- {};',
- '<?php
- $instance = new class
- extends
- ArrayAccess
- {};',
- ];
- yield [
- "<?php \$a = new #
- class #
- ( #
- '1a', #
- 1 #
- ) #
- implements#
- A, #
- B,
- C #
- {#
- #
- }#
- ;",
- "<?php \$a = new#
- class#
- (#
- '1a',#
- 1 #
- )#
- implements#
- A, #
- B,C#
- {#
- #
- }#
- ;",
- ];
- yield [
- "<?php \$a = new #
- class #
- ( #
- '1a', #
- 1 #
- ) #
- implements #
- A #
- {#
- #
- }#
- ;",
- "<?php \$a = new#
- class#
- (#
- '1a',#
- 1 #
- )#
- implements#
- A#
- {#
- #
- }#
- ;",
- ['single_item_single_line' => true],
- ];
- yield [
- '<?php $a = new class() #
- {};',
- '<?php $a = new class()#
- {};',
- ];
- yield 'space_before_parenthesis 1' => [
- '<?php $z = new class () {};',
- '<?php $z = new class() {};',
- ['space_before_parenthesis' => true],
- ];
- yield 'space_before_parenthesis 2' => [
- '<?php $z = new class () {};',
- '<?php $z = new class () {};',
- ['space_before_parenthesis' => true],
- ];
- yield 'space_before_parenthesis and inline_constructor_arguments' => [
- '<?php $z = new class ( static::foo($this->bar()) ,baz() ) {};',
- '<?php $z = new class ( static::foo($this->bar()) ,baz() ) {};',
- ['space_before_parenthesis' => true, 'inline_constructor_arguments' => false],
- ];
- }
- public static function provideFixingClassesCases(): iterable
- {
- return array_merge(
- self::provideClassyCases('class'),
- self::provideClassyExtendingCases('class'),
- self::provideClassyImplementsCases()
- );
- }
- public static function provideFixingClassesWithConfigCases(): iterable
- {
- yield [
- "<?php class configA implements B, C\n{}",
- "<?php class configA implements\nB, C{}",
- ['single_line' => true],
- ];
- yield [
- "<?php class configA1 extends B\n{}",
- "<?php class configA1\n extends\nB{}",
- ['single_line' => true],
- ];
- yield [
- "<?php class configA1a extends B\n{}",
- "<?php class configA1a\n extends\nB{}",
- ['single_line' => false, 'single_item_single_line' => true],
- ];
- yield [
- "<?php class configA2 extends D implements B, C\n{}",
- "<?php class configA2 extends D implements\nB,\nC{}",
- ['single_line' => true],
- ];
- yield [
- "<?php class configA3 extends D implements B, C\n{}",
- "<?php class configA3\n extends\nD\n\t implements\nB,\nC{}",
- ['single_line' => true],
- ];
- yield [
- "<?php class configA4 extends D implements B, #\nC\n{}",
- "<?php class configA4\n extends\nD\n\t implements\nB,#\nC{}",
- ['single_line' => true],
- ];
- yield [
- "<?php class configA5 implements A\n{}",
- "<?php class configA5 implements\nA{}",
- ['single_line' => false, 'single_item_single_line' => true],
- ];
- yield [
- "<?php interface TestWithMultiExtendsMultiLine extends\n A,\nAb,\n C,\n D\n{}",
- "<?php interface TestWithMultiExtendsMultiLine extends A,\nAb,C,D\n{}",
- [
- 'single_line' => false,
- 'single_item_single_line' => false,
- 'multi_line_extends_each_single_line' => true,
- ],
- ];
- }
- public static function provideFixingInterfacesCases(): iterable
- {
- yield from array_merge(
- self::provideClassyCases('interface'),
- self::provideClassyExtendingCases('interface')
- );
- yield [
- '<?php
- interface Test extends
- /*a*/ /*b*/TestInterface1 , \A\B\C , /* test */
- TestInterface2 , // test
- '.'
- // Note: PSR does not have a rule for multiple extends
- TestInterface3, /**/ TestInterface4 ,
- TestInterface5 , '.'
- /**/TestInterface65
- {}
- ',
- '<?php
- interface Test
- extends
- /*a*/ /*b*/TestInterface1 , \A\B\C , /* test */
- TestInterface2 , // test
- '.'
- // Note: PSR does not have a rule for multiple extends
- TestInterface3, /**/ TestInterface4 ,
- TestInterface5 , '.'
- /**/TestInterface65 {}
- ',
- ];
- }
- public static function provideFixingTraitsCases(): iterable
- {
- return self::provideClassyCases('trait');
- }
- /**
- * @param array<string, mixed> $expected
- *
- * @dataProvider provideClassyDefinitionInfoCases
- */
- public function testClassyDefinitionInfo(string $source, array $expected): void
- {
- Tokens::clearCache();
- $tokens = Tokens::fromCode($source);
- $method = new \ReflectionMethod($this->fixer, 'getClassyDefinitionInfo');
- $method->setAccessible(true);
- $result = $method->invoke($this->fixer, $tokens, $expected['classy']);
- ksort($expected);
- ksort($result);
- self::assertSame($expected, $result);
- }
- public static function provideClassyDefinitionInfoCases(): iterable
- {
- yield [
- '<?php class A{}',
- [
- 'start' => 1,
- 'classy' => 1,
- 'open' => 4,
- 'extends' => false,
- 'implements' => false,
- 'anonymousClass' => false,
- 'final' => false,
- 'abstract' => false,
- 'readonly' => false,
- ],
- ];
- yield [
- '<?php final class A{}',
- [
- 'start' => 1,
- 'classy' => 3,
- 'open' => 6,
- 'extends' => false,
- 'implements' => false,
- 'anonymousClass' => false,
- 'final' => 1,
- 'abstract' => false,
- 'readonly' => false,
- ],
- ];
- yield [
- '<?php abstract /**/ class A{}',
- [
- 'start' => 1,
- 'classy' => 5,
- 'open' => 8,
- 'extends' => false,
- 'implements' => false,
- 'anonymousClass' => false,
- 'final' => false,
- 'abstract' => 1,
- 'readonly' => false,
- ],
- ];
- yield [
- '<?php class A extends B {}',
- [
- 'start' => 1,
- 'classy' => 1,
- 'open' => 9,
- 'extends' => [
- 'start' => 5,
- 'numberOfExtends' => 1,
- 'multiLine' => false,
- ],
- 'implements' => false,
- 'anonymousClass' => false,
- 'final' => false,
- 'abstract' => false,
- 'readonly' => false,
- ],
- ];
- yield [
- '<?php interface A extends B,C,D {}',
- [
- 'start' => 1,
- 'classy' => 1,
- 'open' => 13,
- 'extends' => [
- 'start' => 5,
- 'numberOfExtends' => 3,
- 'multiLine' => false,
- ],
- 'implements' => false,
- 'anonymousClass' => false,
- 'final' => false,
- 'abstract' => false,
- 'readonly' => false,
- ],
- ];
- }
- /**
- * @param array<string, mixed> $expected
- *
- * @dataProvider provideClassyInheritanceInfoCases
- */
- public function testClassyInheritanceInfo(string $source, string $label, array $expected): void
- {
- $this->doTestClassyInheritanceInfo($source, $label, $expected);
- }
- public static function provideClassyInheritanceInfoCases(): iterable
- {
- yield '1' => [
- '<?php
- class X11 implements Z , T,R
- {
- }',
- 'numberOfImplements',
- ['start' => 5, 'numberOfImplements' => 3, 'multiLine' => false],
- ];
- yield '2' => [
- '<?php
- class X10 implements Z , T,R //
- {
- }',
- 'numberOfImplements',
- ['start' => 5, 'numberOfImplements' => 3, 'multiLine' => false],
- ];
- yield '3' => [
- '<?php class A implements B {}',
- 'numberOfImplements',
- ['start' => 5, 'numberOfImplements' => 1, 'multiLine' => false],
- ];
- yield '4' => [
- "<?php class A implements B,\n I{}",
- 'numberOfImplements',
- ['start' => 5, 'numberOfImplements' => 2, 'multiLine' => true],
- ];
- yield '5' => [
- "<?php class A implements Z\\C\\B,C,D {\n\n\n}",
- 'numberOfImplements',
- ['start' => 5, 'numberOfImplements' => 3, 'multiLine' => false],
- ];
- if (\PHP_VERSION_ID < 8_00_00) {
- $multiLine = true;
- $code = '<?php
- namespace A {
- interface X {}
- }
- namespace {
- class B{}
- class A extends //
- B implements /* */ \A
- \C, Z{
- public function test()
- {
- echo 1;
- }
- }
- $a = new A();
- $a->test();
- }';
- } else {
- $multiLine = false;
- $code = '<?php
- namespace A {
- interface X {}
- }
- namespace {
- class B{}
- class A extends //
- B implements /* */ \A\C, Z{
- public function test()
- {
- echo 1;
- }
- }
- $a = new A();
- $a->test();
- }';
- }
- yield [
- $code,
- 'numberOfImplements',
- ['start' => 36, 'numberOfImplements' => 2, 'multiLine' => $multiLine],
- ];
- yield [
- "<?php \$a = new class(3) extends\nSomeClass\timplements SomeInterface, D {};",
- 'numberOfExtends',
- ['start' => 12, 'numberOfExtends' => 1, 'multiLine' => true],
- ];
- yield [
- "<?php \$a = new class(4) extends\nSomeClass\timplements SomeInterface, D\n\n{};",
- 'numberOfImplements',
- ['start' => 16, 'numberOfImplements' => 2, 'multiLine' => false],
- ];
- yield [
- "<?php \$a = new class(5) extends SomeClass\nimplements SomeInterface, D {};",
- 'numberOfExtends',
- ['start' => 12, 'numberOfExtends' => 1, 'multiLine' => true],
- ];
- }
- /**
- * @dataProvider provideFixCases
- */
- public function testFix(string $expected, ?string $input = null): void
- {
- $this->fixer->configure([]);
- $this->doTest($expected, $input);
- }
- public static function provideFixCases(): iterable
- {
- yield [
- '<?php
- $a = new class implements
- \RFb,
- \Fcc,
- \GFddZz
- {
- };',
- '<?php
- $a = new class implements
- \RFb,
- \Fcc, \GFddZz
- {
- };',
- ];
- yield [
- '<?php
- $a = new class implements
- \RFb,
- \Fcc,
- \GFddZz
- {
- }?>',
- '<?php
- $a = new class implements
- \RFb,
- \Fcc, \GFddZz
- {
- }?>',
- ];
- yield [
- '<?php new class(1, 2, 3, ) {};',
- '<?php new class(1, 2, 3,) {};',
- ];
- yield [
- '<?php new class(1, 2, 3, ) {};',
- '<?php new class(
- 1,
- 2,
- 3,
- ) {};',
- ];
- }
- /**
- * @dataProvider provideMessyWhitespacesCases
- */
- public function testMessyWhitespaces(string $expected, ?string $input = null): void
- {
- $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t", "\r\n"));
- $this->fixer->configure([]);
- $this->doTest($expected, $input);
- }
- public static function provideMessyWhitespacesCases(): iterable
- {
- yield [
- "<?php\r\nclass Aaa implements\r\n\tBbb,\r\n\tCcc,\r\n\tDdd\r\n\t{\r\n\t}",
- "<?php\r\nclass Aaa implements\r\n\tBbb, Ccc,\r\n\tDdd\r\n\t{\r\n\t}",
- ];
- }
- /**
- * @dataProvider provideFix80Cases
- *
- * @requires PHP 8.0
- */
- public function testFix80(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- public static function provideFix80Cases(): iterable
- {
- yield 'anonymous class, single attribute' => [
- '<?php $a = new #[FOO] class(2) {};',
- '<?php $a = new #[FOO] class(2){};',
- ];
- yield 'anonymous class, multiple attributes' => [
- '<?php $a = new #[FOO] #[BAR] class {};',
- '<?php $a = new #[FOO] #[BAR] class {};',
- ];
- }
- /**
- * @dataProvider provideFix81Cases
- *
- * @requires PHP 8.1
- */
- public function testFix81(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- public static function provideFix81Cases(): iterable
- {
- yield [
- "<?php enum SomeEnum implements SomeInterface, D\n{};",
- "<?php enum SomeEnum \timplements SomeInterface, D {};",
- ];
- yield [
- "<?php enum SomeEnum : int\n{}",
- '<?php enum SomeEnum : int {}',
- ];
- yield [
- "<?php enum SomeEnum\n{}",
- "<?php enum\tSomeEnum{}",
- ];
- }
- /**
- * @dataProvider provideFix82Cases
- *
- * @requires PHP 8.2
- */
- public function testFix82(string $expected, string $input): void
- {
- $this->doTest($expected, $input);
- }
- public static function provideFix82Cases(): iterable
- {
- yield 'final readonly works' => [
- '<?php final readonly class a
- {}',
- '<?php final readonly class a
- {}',
- ];
- yield 'final - readonly modifiers get sorted' => [
- '<?php final readonly class a
- {}',
- '<?php readonly final class a
- {}',
- ];
- yield 'abstract - readonly modifiers get sorted' => [
- '<?php abstract readonly class a
- {}',
- '<?php readonly abstract class a
- {}',
- ];
- }
- /**
- * @dataProvider provideFix83Cases
- *
- * @requires PHP 8.3
- */
- public function testFix83(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- public static function provideFix83Cases(): iterable
- {
- yield 'anonymous class, readonly, missing spacing' => [
- '<?php $a = new readonly class {};',
- '<?php $a = new readonly class{};',
- ];
- yield 'anonymous class, readonly, to much spacing' => [
- '<?php $a = new readonly class {};',
- '<?php $a = new readonly class {};',
- ];
- yield 'anonymous class, single attribute' => [
- '<?php $a = new #[BAR] readonly class {};',
- '<?php $a = new #[BAR] readonly class{};',
- ];
- yield 'anonymous class, multiple attributes' => [
- '<?php $a = new #[FOO] #[BAR] readonly class {};',
- '<?php $a = new #[FOO] #[BAR] readonly class {};',
- ];
- }
- /**
- * @param array<string, mixed> $expected
- */
- private static function assertConfigurationSame(array $expected, ClassDefinitionFixer $fixer): void
- {
- $reflectionProperty = new \ReflectionProperty($fixer, 'configuration');
- $reflectionProperty->setAccessible(true);
- self::assertSame($expected, $reflectionProperty->getValue($fixer));
- }
- /**
- * @param array<string, mixed> $expected
- */
- private function doTestClassyInheritanceInfo(string $source, string $label, array $expected): void
- {
- Tokens::clearCache();
- $tokens = Tokens::fromCode($source);
- self::assertTrue($tokens[$expected['start']]->isGivenKind([T_IMPLEMENTS, T_EXTENDS]), sprintf('Token must be "implements" or "extends", got "%s".', $tokens[$expected['start']]->getContent()));
- $method = new \ReflectionMethod($this->fixer, 'getClassyInheritanceInfo');
- $method->setAccessible(true);
- $result = $method->invoke($this->fixer, $tokens, $expected['start'], $label);
- self::assertSame($expected, $result);
- }
- private static function provideClassyCases(string $classy): array
- {
- return [
- [
- sprintf("<?php %s A\n{}", $classy),
- sprintf('<?php %s A {}', $classy),
- ],
- [
- sprintf("<?php %s B\n{}", $classy),
- sprintf('<?php %s B{}', $classy),
- ],
- [
- sprintf("<?php %s C\n{}", $classy),
- sprintf("<?php %s\n\tC{}", $classy),
- ],
- [
- sprintf("<?php %s D //\n{}", $classy),
- sprintf("<?php %s D//\n{}", $classy),
- ],
- [
- sprintf("<?php %s /**/ E //\n{}", $classy),
- sprintf("<?php %s/**/E//\n{}", $classy),
- ],
- [
- sprintf(
- "<?php
- %s A
- {}
- %s /**/ B //
- /**/\n{}",
- $classy,
- $classy
- ),
- sprintf(
- '<?php
- %s
- A
- {}
- %s/**/B //
- /**/ {}',
- $classy,
- $classy
- ),
- ],
- [
- sprintf(
- '<?php
- namespace {
- %s IndentedNameSpacedClass
- {
- }
- }',
- $classy
- ),
- sprintf(
- '<?php
- namespace {
- %s IndentedNameSpacedClass {
- }
- }',
- $classy
- ),
- ],
- ];
- }
- private static function provideClassyExtendingCases(string $classy): array
- {
- return [
- [
- sprintf("<?php %s AE0 extends B\n{}", $classy),
- sprintf('<?php %s AE0 extends B {}', $classy),
- ],
- [
- sprintf("<?php %s /**/ AE1 /**/ extends /**/ B /**/\n{}", $classy),
- sprintf('<?php %s/**/AE1/**/extends/**/B/**/{}', $classy),
- ],
- [
- sprintf("<?php %s /*%s*/ AE2 extends\nB\n{}", $classy, $classy),
- sprintf("<?php %s /*%s*/ AE2 extends\nB{}", $classy, $classy),
- ],
- [
- sprintf('<?php
- %s Test124 extends
- \Exception
- {}', $classy),
- sprintf('<?php
- %s
- Test124
- extends
- \Exception {}', $classy),
- ],
- ];
- }
- private static function provideClassyImplementsCases(): array
- {
- return [
- [
- '<?php class LotOfImplements implements A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q
- {}',
- '<?php class LotOfImplements implements A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q{}',
- ],
- [
- "<?php class E implements B\n{}",
- "<?php class E \nimplements B \t{}",
- ],
- [
- "<?php abstract class F extends B implements C\n{}",
- '<?php abstract class F extends B implements C {}',
- ],
- 'multiline abstract extends implements with comments' => [
- "<?php abstract class G extends //
- B /* */ implements C\n{}",
- '<?php abstract class G extends //
- B/* */implements C{}',
- ],
- 'final extends implement' => [
- "<?php final class G extends //
- B /* */ implements C\n{}",
- '<?php final class G extends //
- B/* */implements C{}',
- ],
- 'final' => [
- '<?php final class G //
- /* */
- {}',
- '<?php final class G //
- /* */{}',
- ],
- [
- '<?php
- class Aaa IMPLEMENTS
- \RFb,
- \Fcc,
- \GFddZz
- {
- }',
- '<?php
- class Aaa IMPLEMENTS
- \RFb,
- \Fcc, \GFddZz
- {
- }',
- ],
- [
- '<?php
- class //
- X //
- extends //
- Y //
- implements //
- Z, //
- U //
- {} //',
- '<?php
- class //
- X //
- extends //
- Y //
- implements //
- Z , //
- U //
- {} //',
- ],
- [
- '<?php
- class Aaa implements
- PhpCsFixer\Tests\Fixer,
- \RFb,
- \Fcc1,
- \GFdd
- {
- }',
- '<?php
- class Aaa implements
- PhpCsFixer\Tests\Fixer,\RFb,
- \Fcc1, \GFdd
- {
- }',
- ],
- [
- '<?php
- class /**/ Test123 EXtends /**/ \RuntimeException implements
- TestZ
- {
- }',
- '<?php
- class/**/Test123
- EXtends /**/ \RuntimeException implements
- TestZ
- {
- }',
- ],
- [
- '<?php
- class Aaa implements Ebb, \Ccc
- {
- }',
- '<?php
- class Aaa implements Ebb, \Ccc
- {
- }',
- ],
- [
- '<?php
- class X2 IMPLEMENTS
- Z, //
- U,
- D
- {
- }',
- '<?php
- class X2 IMPLEMENTS
- Z , //
- U, D
- {
- }',
- ],
- [
- '<?php
- class VeryLongClassNameWithLotsOfLetters extends AnotherVeryLongClassName implements
- VeryLongInterfaceNameThatIDontWantOnTheSameLine
- {
- }',
- '<?php
- class VeryLongClassNameWithLotsOfLetters extends AnotherVeryLongClassName implements
- VeryLongInterfaceNameThatIDontWantOnTheSameLine
- {
- }',
- ],
- [
- '<?php
- class /**/ Test125 //aaa
- extends /*
- */
- //
- \Exception //
- {}',
- '<?php
- class/**/Test125 //aaa
- extends /*
- */
- //
- \Exception //
- {}',
- ],
- [
- '<?php
- class Test extends TestInterface8 implements /*a*/ /*b*/
- TestInterface1, /* test */
- TestInterface2, // test
- '.'
- // test
- TestInterface3, /**/
- TestInterface4,
- TestInterface5, '.'
- /**/TestInterface6c
- {
- }',
- '<?php
- class Test
- extends
- TestInterface8
- implements /*a*/ /*b*/TestInterface1 , /* test */
- TestInterface2 , // test
- '.'
- // test
- TestInterface3, /**/ TestInterface4 ,
- TestInterface5 , '.'
- /**/TestInterface6c
- {
- }',
- ],
- ];
- }
- }
|