123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603 |
- <?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\FunctionNotation;
- use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- /**
- * @author Denis Sokolov <denis@sokolov.cc>
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer>
- *
- * @phpstan-import-type _AutogeneratedInputConfiguration from \PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer
- */
- final class FunctionDeclarationFixerTest extends AbstractFixerTestCase
- {
- /**
- * @var array<string, string>
- */
- private static $configurationClosureSpacingNone = ['closure_function_spacing' => FunctionDeclarationFixer::SPACING_NONE];
- /**
- * @var array<string, string>
- */
- private static $configurationArrowSpacingNone = ['closure_fn_spacing' => FunctionDeclarationFixer::SPACING_NONE];
- public function testInvalidConfigurationClosureFunctionSpacing(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessageMatches(
- '#^\[function_declaration\] Invalid configuration: The option "closure_function_spacing" with value "neither" is invalid\. Accepted values are: "none", "one"\.$#'
- );
- $this->fixer->configure(['closure_function_spacing' => 'neither']); // @phpstan-ignore-line
- }
- public function testInvalidConfigurationClosureFnSpacing(): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->expectExceptionMessageMatches(
- '#^\[function_declaration\] Invalid configuration: The option "closure_fn_spacing" with value "neither" is invalid\. Accepted values are: "none", "one"\.$#'
- );
- $this->fixer->configure(['closure_fn_spacing' => 'neither']); // @phpstan-ignore-line
- }
- /**
- * @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 [
- // non-PHP test
- 'function foo () {}',
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo() {}',
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo () {}',
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo () {}',
- ];
- yield [
- '<?php function foo() {}',
- '<?php function
- foo () {}',
- ];
- yield [
- '<?php function ($i) {};',
- '<?php function($i) {};',
- ];
- yield [
- '<?php function _function() {}',
- '<?php function _function () {}',
- ];
- yield [
- '<?php function foo($a, $b = true) {}',
- '<?php function foo($a, $b = true){}',
- ];
- yield [
- '<?php function foo($a, $b = true) {}',
- '<?php function foo($a, $b = true) {}',
- ];
- yield [
- '<?php function foo($a)
- {}',
- ];
- yield [
- '<?php function ($a) use ($b) {};',
- '<?php function ($a) use ($b) {};',
- ];
- yield [
- '<?php $foo = function ($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo) use($bar, $baz) {};',
- ];
- yield [
- '<?php $foo = function ($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo)use ($bar, $baz) {};',
- ];
- yield [
- '<?php $foo = function ($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo)use($bar, $baz) {};',
- ];
- yield [
- '<?php function &foo($a) {}',
- '<?php function &foo( $a ) {}',
- ];
- yield [
- '<?php function foo($a)
- {}',
- '<?php function foo( $a)
- {}',
- ];
- yield [
- '<?php
- function foo(
- $a,
- $b,
- $c
- ) {}',
- ];
- yield [
- '<?php $function = function () {};',
- '<?php $function = function(){};',
- ];
- yield [
- '<?php $function("");',
- ];
- yield [
- '<?php function ($a) use ($b) {};',
- '<?php function($a)use($b) {};',
- ];
- yield [
- '<?php function ($a) use ($b) {};',
- '<?php function($a) use ($b) {};',
- ];
- yield [
- '<?php function ($a) use ($b) {};',
- '<?php function ($a) use ( $b ) {};',
- ];
- yield [
- '<?php function &($a) use ($b) {};',
- '<?php function &( $a ) use ( $b ) {};',
- ];
- yield [
- '<?php
- interface Foo
- {
- public function setConfig(ConfigInterface $config);
- }',
- ];
- // do not remove multiline space before { when end of previous line is a comment
- yield [
- '<?php
- function foo() // bar
- { // baz
- }',
- ];
- yield [
- '<?php
- function foo() /* bar */
- { /* baz */
- }',
- ];
- yield [
- // non-PHP test
- 'function foo () {}',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo() {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo () {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo() {}',
- '<?php function foo () {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo() {}',
- '<?php function
- foo () {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function($i) {};',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function _function() {}',
- '<?php function _function () {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo($a, $b = true) {}',
- '<?php function foo($a, $b = true){}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo($a, $b = true) {}',
- '<?php function foo($a, $b = true) {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo($a)
- {}',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function($a) use ($b) {};',
- '<?php function ($a) use ($b) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php $foo = function($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo) use($bar, $baz) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php $foo = function($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo)use ($bar, $baz) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php $foo = function($foo) use ($bar, $baz) {};',
- '<?php $foo = function ($foo)use($bar, $baz) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function &foo($a) {}',
- '<?php function &foo( $a ) {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function foo($a)
- {}',
- '<?php function foo( $a)
- {}',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php
- function foo(
- $a,
- $b,
- $c
- ) {}',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php $function = function() {};',
- '<?php $function = function (){};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php $function("");',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function($a) use ($b) {};',
- '<?php function ($a)use($b) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function($a) use ($b) {};',
- '<?php function ($a) use ($b) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function($a) use ($b) {};',
- '<?php function ($a) use ( $b ) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function&($a) use ($b) {};',
- '<?php function &( $a ) use ( $b ) {};',
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php
- interface Foo
- {
- public function setConfig(ConfigInterface $config);
- }',
- null,
- self::$configurationClosureSpacingNone,
- ];
- // do not remove multiline space before { when end of previous line is a comment
- yield [
- '<?php
- function foo() // bar
- { // baz
- }',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php
- function foo() /* bar */
- { /* baz */
- }',
- null,
- self::$configurationClosureSpacingNone,
- ];
- yield [
- '<?php function #
- foo#
- (#
- ) #
- {#
- }#',
- ];
- yield [
- '<?php
- $b = static function ($a) {
- echo $a;
- };
- ',
- '<?php
- $b = static function( $a ) {
- echo $a;
- };
- ',
- ];
- yield [
- '<?php
- $b = static function($a) {
- echo $a;
- };
- ',
- '<?php
- $b = static function ( $a ) {
- echo $a;
- };
- ',
- self::$configurationClosureSpacingNone,
- ];
- yield ['<?php use function Foo\bar; bar ( 1 );'];
- yield ['<?php use function some\test\{fn_a, fn_b, fn_c};'];
- yield ['<?php use function some\test\{fn_a, fn_b, fn_c} ?>'];
- yield ['<?php use function Foo\bar; bar ( 1 );', null, self::$configurationClosureSpacingNone];
- yield ['<?php use function some\test\{fn_a, fn_b, fn_c};', null, self::$configurationClosureSpacingNone];
- yield ['<?php use function some\test\{fn_a, fn_b, fn_c} ?>', null, self::$configurationClosureSpacingNone];
- yield [
- '<?php fn ($i) => null;',
- '<?php fn($i) => null;',
- ];
- yield [
- '<?php fn ($a) => null;',
- '<?php fn ($a) => null;',
- ];
- yield [
- '<?php $fn = fn () => null;',
- '<?php $fn = fn()=> null;',
- ];
- yield [
- '<?php fn &($a) => null;',
- '<?php fn &( $a ) => null;',
- ];
- yield [
- '<?php fn($i) => null;',
- null,
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php fn($a) => null;',
- '<?php fn ($a) => null;',
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php $fn = fn() => null;',
- '<?php $fn = fn ()=> null;',
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php $fn("");',
- null,
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php fn&($a) => null;',
- '<?php fn &( $a ) => null;',
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php fn&($a,$b) => null;',
- '<?php fn &( $a,$b ) => null;',
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php $b = static fn ($a) => $a;',
- '<?php $b = static fn( $a ) => $a;',
- ];
- yield [
- '<?php $b = static fn($a) => $a;',
- '<?php $b = static fn ( $a ) => $a;',
- self::$configurationArrowSpacingNone,
- ];
- }
- /**
- * @param _AutogeneratedInputConfiguration $configuration
- *
- * @dataProvider provideFixPhp80Cases
- *
- * @requires PHP 8.0
- */
- public function testFixPhp80(string $expected, ?string $input = null, array $configuration = []): void
- {
- $this->fixer->configure($configuration);
- $this->doTest($expected, $input);
- }
- public static function provideFixPhp80Cases(): iterable
- {
- yield [
- '<?php function ($i) {};',
- '<?php function( $i, ) {};',
- ];
- yield [
- '<?php function (
- $a,
- $b,
- $c,
- ) {};',
- '<?php function(
- $a,
- $b,
- $c,
- ) {};',
- ];
- yield [
- '<?php function foo(
- $a,
- $b,
- $c,
- ) {}',
- '<?php function foo (
- $a,
- $b,
- $c,
- ){}',
- ];
- yield [
- '<?php
- $b = static function ($a,$b) {
- echo $a;
- };
- ',
- '<?php
- $b = static function( $a,$b, ) {
- echo $a;
- };
- ',
- ];
- yield [
- '<?php fn&($a,$b) => null;',
- '<?php fn &( $a,$b, ) => null;',
- self::$configurationArrowSpacingNone,
- ];
- yield [
- '<?php
- function ($a) use ($b) {};
- function ($y) use (
- $b,
- $c,
- ) {};
- ',
- '<?php
- function ($a) use ($b , ) {};
- function ($y) use (
- $b,
- $c,
- ) {};
- ',
- ];
- yield [
- '<?php function ($i,) {};',
- '<?php function( $i, ) {};',
- ['trailing_comma_single_line' => true],
- ];
- }
- }
|