123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863 |
- <?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\Basic;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Basic\CurlyBracesPositionFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Basic\CurlyBracesPositionFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\Basic\CurlyBracesPositionFixer
- */
- final class CurlyBracesPositionFixerTest 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 'if (default)' => [
- '<?php
- if ($foo) {
- foo();
- }',
- '<?php
- if ($foo)
- {
- foo();
- }',
- ];
- yield 'if (next line)' => [
- '<?php
- if ($foo)
- {
- foo();
- }',
- '<?php
- if ($foo) {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'else (default)' => [
- '<?php
- if ($foo) {
- foo();
- }
- else {
- bar();
- }',
- '<?php
- if ($foo)
- {
- foo();
- }
- else
- {
- bar();
- }',
- ];
- yield 'else (next line)' => [
- '<?php
- if ($foo)
- {
- foo();
- }
- else
- {
- bar();
- }',
- '<?php
- if ($foo) {
- foo();
- }
- else {
- bar();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'elseif (default)' => [
- '<?php
- if ($foo) {
- foo();
- }
- elseif ($bar) {
- bar();
- }',
- '<?php
- if ($foo)
- {
- foo();
- }
- elseif ($bar)
- {
- bar();
- }',
- ];
- yield 'elseif (next line)' => [
- '<?php
- if ($foo)
- {
- foo();
- }
- elseif ($bar)
- {
- bar();
- }',
- '<?php
- if ($foo) {
- foo();
- }
- elseif ($bar) {
- bar();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'else if (default)' => [
- '<?php
- if ($foo) {
- foo();
- }
- else if ($bar) {
- bar();
- }',
- '<?php
- if ($foo)
- {
- foo();
- }
- else if ($bar)
- {
- bar();
- }',
- ];
- yield 'else if (next line)' => [
- '<?php
- if ($foo)
- {
- foo();
- }
- else if ($bar)
- {
- bar();
- }',
- '<?php
- if ($foo) {
- foo();
- }
- else if ($bar) {
- bar();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'for (default)' => [
- '<?php
- for (;;) {
- foo();
- }',
- '<?php
- for (;;)
- {
- foo();
- }',
- ];
- yield 'for (next line)' => [
- '<?php
- for (;;)
- {
- foo();
- }',
- '<?php
- for (;;) {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'foreach (default)' => [
- '<?php
- foreach ($foo as $bar) {
- foo();
- }',
- '<?php
- foreach ($foo as $bar)
- {
- foo();
- }',
- ];
- yield 'foreach (next line)' => [
- '<?php
- foreach ($foo as $bar)
- {
- foo();
- }',
- '<?php
- foreach ($foo as $bar) {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'while (default)' => [
- '<?php
- while ($foo) {
- foo();
- }',
- '<?php
- while ($foo)
- {
- foo();
- }',
- ];
- yield 'while (next line)' => [
- '<?php
- while ($foo)
- {
- foo();
- }',
- '<?php
- while ($foo) {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'do while (default)' => [
- '<?php
- do {
- foo();
- } while ($foo);',
- '<?php
- do
- {
- foo();
- } while ($foo);',
- ];
- yield 'do while (next line)' => [
- '<?php
- do
- {
- foo();
- } while ($foo);',
- '<?php
- do {
- foo();
- } while ($foo);',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'switch (default)' => [
- '<?php
- switch ($foo) {
- case 1:
- foo();
- }',
- '<?php
- switch ($foo)
- {
- case 1:
- foo();
- }',
- ];
- yield 'switch (next line)' => [
- '<?php
- switch ($foo)
- {
- case 1:
- foo();
- }',
- '<?php
- switch ($foo) {
- case 1:
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'try catch finally (open brace on the same line)' => [
- '<?php
- try {
- foo();
- }
- catch (Exception $e) {
- bar();
- }
- finally {
- baz();
- }',
- '<?php
- try
- {
- foo();
- }
- catch (Exception $e)
- {
- bar();
- }
- finally
- {
- baz();
- }',
- ];
- yield 'try catch finally (open brace on the next line)' => [
- '<?php
- try
- {
- foo();
- }
- catch (Exception $e)
- {
- bar();
- }
- finally
- {
- baz();
- }',
- '<?php
- try {
- foo();
- }
- catch (Exception $e) {
- bar();
- }
- finally {
- baz();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'class (default)' => [
- '<?php
- class Foo
- {
- }',
- '<?php
- class Foo {
- }',
- ];
- yield 'class (same line)' => [
- '<?php
- class Foo {
- }',
- '<?php
- class Foo
- {
- }',
- ['classes_opening_brace' => 'same_line'],
- ];
- yield 'function (default)' => [
- '<?php
- function foo()
- {
- }',
- '<?php
- function foo() {
- }',
- ];
- yield 'function (same line)' => [
- '<?php
- function foo() {
- }',
- '<?php
- function foo()
- {
- }',
- ['functions_opening_brace' => 'same_line'],
- ];
- yield 'anonymous function (default)' => [
- '<?php
- $foo = function () {
- };',
- '<?php
- $foo = function ()
- {
- };',
- ];
- yield 'anonymous function (next line)' => [
- '<?php
- $foo = function ()
- {
- };',
- '<?php
- $foo = function () {
- };',
- ['anonymous_functions_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'with blank lines inside braces' => [
- '<?php
- class Foo
- {
- public function foo()
- {
- if (true) {
- echo "foo";
- }
- }
- }',
- '<?php
- class Foo {
- public function foo() {
- if (true)
- {
- echo "foo";
- }
- }
- }',
- ];
- yield 'with comment after opening brace (default)' => [
- '<?php
- function foo() /* foo */ // foo
- {
- }',
- '<?php
- function foo() /* foo */ { // foo
- }',
- ];
- yield 'with comment after opening brace (same line)' => [
- '<?php
- function foo() { // foo
- /* foo */
- }',
- '<?php
- function foo() // foo
- { /* foo */
- }',
- ['functions_opening_brace' => 'same_line'],
- ];
- yield 'next line with multiline signature' => [
- '<?php
- if (
- $foo
- ) {
- foo();
- }',
- '<?php
- if (
- $foo
- )
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with newline before closing parenthesis' => [
- '<?php
- if ($foo
- ) {
- foo();
- }',
- '<?php
- if ($foo
- )
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with newline in signature but not before closing parenthesis' => [
- '<?php
- if (
- $foo)
- {
- foo();
- }',
- '<?php
- if (
- $foo) {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'anonymous class (same line)' => [
- '<?php
- $foo = new class() {
- };',
- '<?php
- $foo = new class()
- {
- };',
- ];
- yield 'anonymous class (next line)' => [
- '<?php
- $foo = new class()
- {
- };',
- '<?php
- $foo = new class() {
- };',
- ['anonymous_classes_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with multiline signature and return type' => [
- '<?php
- function foo(
- $foo
- ): int {
- foo();
- }',
- '<?php
- function foo(
- $foo
- ): int
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with multiline signature and return type (nullable)' => [
- '<?php
- function foo(
- $foo
- ): ?int {
- foo();
- }',
- '<?php
- function foo(
- $foo
- ): ?int
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with multiline signature and return type (array)' => [
- '<?php
- function foo(
- $foo
- ): array {
- foo();
- }',
- '<?php
- function foo(
- $foo
- ): array
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with multiline signature and return type (class name)' => [
- '<?php
- function foo(
- $foo
- ): \Foo\Bar {
- foo();
- }',
- '<?php
- function foo(
- $foo
- ): \Foo\Bar
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with newline before closing parenthesis and return type' => [
- '<?php
- function foo($foo
- ): int {
- foo();
- }',
- '<?php
- function foo($foo
- ): int
- {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with newline before closing parenthesis and callable type' => [
- '<?php
- function foo($foo
- ): callable {
- return function (): void {};
- }',
- '<?php
- function foo($foo
- ): callable
- {
- return function (): void {};
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'next line with newline in signature but not before closing parenthesis and return type' => [
- '<?php
- function foo(
- $foo): int
- {
- foo();
- }',
- '<?php
- function foo(
- $foo): int {
- foo();
- }',
- ['control_structures_opening_brace' => 'next_line_unless_newline_at_signature_end'],
- ];
- yield 'multiple elseifs' => [
- '<?php if ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- } elseif ($foo) {
- }',
- '<?php if ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- } elseif ($foo){
- }',
- ];
- yield 'open brace preceded by comment and whitespace' => [
- '<?php
- if (true) { /* foo */
- foo();
- }',
- '<?php
- if (true) /* foo */ {
- foo();
- }',
- ];
- yield 'open brace surrounded by comment and whitespace' => [
- '<?php
- if (true) { /* foo */ /* bar */
- foo();
- }',
- '<?php
- if (true) /* foo */ { /* bar */
- foo();
- }',
- ];
- yield 'open brace not preceded by space and followed by a comment' => [
- '<?php class test
- {
- public function example()// example
- {
- }
- }
- ',
- '<?php class test
- {
- public function example(){// example
- }
- }
- ',
- ];
- yield 'open brace not preceded by space and followed by a space and comment' => [
- '<?php class test
- {
- public function example() // example
- {
- }
- }
- ',
- '<?php class test
- {
- public function example(){ // example
- }
- }
- ',
- ];
- }
- /**
- * @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 'function (multiline + union return)' => [
- '<?php
- function sum(
- int|float $first,
- int|float $second,
- ): int|float {
- }',
- '<?php
- function sum(
- int|float $first,
- int|float $second,
- ): int|float
- {
- }',
- ];
- yield 'function (multiline + union return with whitespace)' => [
- '<?php
- function sum(
- int|float $first,
- int|float $second,
- ): int | float {
- }',
- '<?php
- function sum(
- int|float $first,
- int|float $second,
- ): int | float
- {
- }',
- ];
- yield 'method with static return type' => [
- '<?php
- class Foo
- {
- function sum(
- $foo
- ): static {
- }
- }',
- '<?php
- class Foo
- {
- function sum(
- $foo
- ): static
- {
- }
- }',
- ];
- }
- /**
- * @dataProvider provideFix81Cases
- *
- * @requires PHP 8.1
- */
- public function testFix81(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{string}>
- */
- public static function provideFix81Cases(): iterable
- {
- yield 'function (multiline + intersection return)' => [
- '<?php
- function foo(
- mixed $bar,
- mixed $baz,
- ): Foo&Bar {
- }',
- ];
- }
- /**
- * @dataProvider provideFix82Cases
- *
- * @requires PHP 8.2
- */
- public function testFix82(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<string, array{string}>
- */
- public static function provideFix82Cases(): iterable
- {
- yield 'function (multiline + DNF return)' => [
- '<?php
- function foo(
- mixed $bar,
- mixed $baz,
- ): (Foo&Bar)|int|null {
- }',
- ];
- }
- }
|