123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218 |
- <?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
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer
- */
- final class ClassDefinitionFixerTest extends AbstractFixerTestCase
- {
- public function testConfigure(): void
- {
- $defaultConfig = [
- 'inline_constructor_arguments' => true,
- 'multi_line_extends_each_single_line' => false,
- 'single_item_single_line' => false,
- 'single_line' => false,
- 'space_before_parenthesis' => false,
- ];
- $fixer = new ClassDefinitionFixer();
- $fixer->configure($defaultConfig);
- self::assertConfigurationSame($defaultConfig, $fixer);
- $fixer->configure([]);
- self::assertConfigurationSame($defaultConfig, $fixer);
- }
- /**
- * @param _AutogeneratedInputConfiguration $config
- *
- * @dataProvider provideInvalidConfigurationCases
- */
- public function testInvalidConfiguration(array $config, string $exceptionExpression): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessageMatches($exceptionExpression);
- $this->fixer->configure($config);
- }
- /**
- * @return iterable<array{array<string, mixed>, string}>
- */
- public static function provideInvalidConfigurationCases(): iterable
- {
- yield 'invalid configuration key' => [
- ['a' => false],
- '/^\[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"\.$/',
- ];
- yield 'invalid configuration value' => [
- ['single_line' => 'z'],
- '/^\[class_definition\] Invalid configuration: The option "single_line" with value "z" is expected to be of type "bool", but is of type "string"\.$/',
- ];
- }
- /**
- * @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 $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],
- ];
- yield 'single attribute on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- #[FOO]
- class() {};
- EOF,
- ];
- yield 'multiple attributes on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- #[FOO]
- #[\Ns\Bar]
- class() {};
- EOF,
- ];
- yield 'single line phpdoc on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- /** @property string $x */
- class() {};
- EOF,
- ];
- yield 'multi line phpdoc on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- /**
- @property string $x
- */
- class() {};
- EOF,
- ];
- yield 'phpdoc and single attribute on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- /**
- @property string $x
- */
- #[FOO]
- class() {};
- EOF,
- ];
- yield 'phpdoc and multiple attributes on separate line' => [
- <<<'EOF'
- <?php
- $a = new
- /** @property string $x */
- #[FOO] #[\Ns\Bar]
- class() {};
- EOF,
- ];
- yield from self::provideClassyCases('class');
- yield from self::provideClassyExtendingCases('class');
- yield from self::provideClassyImplementsCases();
- 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,
- ],
- ];
- yield from self::provideClassyCases('interface');
- yield from 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 {}
- ',
- ];
- yield from self::provideClassyCases('trait');
- 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,
- ) {};',
- ];
- }
- /**
- * @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],
- ];
- yield [
- '<?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();
- }',
- 'numberOfImplements',
- ['start' => 36, 'numberOfImplements' => 2, 'multiLine' => false],
- ];
- 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],
- ];
- }
- /**
- * @param array<string, mixed> $expected
- *
- * @dataProvider provideClassyInheritanceInfoPre80Cases
- *
- * @requires PHP <8.0
- */
- public function testClassyInheritanceInfoPre80(string $source, string $label, array $expected): void
- {
- $this->doTestClassyInheritanceInfo($source, $label, $expected);
- }
- public static function provideClassyInheritanceInfoPre80Cases(): iterable
- {
- yield [
- '<?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();
- }',
- 'numberOfImplements',
- ['start' => 36, 'numberOfImplements' => 2, 'multiLine' => true],
- ];
- }
- /**
- * @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 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);
- }
- /**
- * @return iterable<string, array{string, string}>
- */
- 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);
- }
- /**
- * @return iterable<array{string, string}>
- */
- 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);
- }
- /**
- * @return iterable<string, array{string, string}>
- */
- 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);
- }
- /**
- * @return iterable<string, array{string, string}>
- */
- 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 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);
- }
- /**
- * @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));
- }
- /**
- * @return iterable<array{string, string}>
- */
- private static function provideClassyCases(string $classy): iterable
- {
- 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
- ),
- ],
- ];
- }
- /**
- * @return iterable<array{string, string}>
- */
- private static function provideClassyExtendingCases(string $classy): iterable
- {
- 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),
- ],
- ];
- }
- /**
- * @return iterable<int|string, array{string, string}>
- */
- private static function provideClassyImplementsCases(): iterable
- {
- 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
- {
- }',
- ],
- ];
- }
- }
|