Add AbstractFixerTestCase::getConfigurationOptions (#931)

kubawerlos · web-flow · commit b3a520127edf · 2023-12-23T12:51:53.000Z
diff --git a/tests/Fixer/AbstractFixerTestCase.php b/tests/Fixer/AbstractFixerTestCase.php
@@ -16,6 +16,7 @@
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
+use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
 use PhpCsFixer\Linter\Linter;
 use PhpCsFixer\Linter\ProcessLinter;
 use PhpCsFixer\Tokenizer\Tokens;
@@ -203,6 +204,16 @@ final protected function doTest(string $expected, ?string $input = null, ?array
         self::assertFalse($expectedTokens->isChanged());
     }
 
+    /**
+     * @return array<FixerOptionInterface>
+     */
+    final protected function getConfigurationOptions(): array
+    {
+        self::assertInstanceOf(ConfigurableFixerInterface::class, $this->fixer);
+
+        return $this->fixer->getConfigurationDefinition()->getOptions();
+    }
+
     final protected function lintSource(string $source): ?string
     {
         static $linter;
diff --git a/tests/Fixer/CommentedOutFunctionFixerTest.php b/tests/Fixer/CommentedOutFunctionFixerTest.php
@@ -11,20 +11,16 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\CommentedOutFunctionFixer
  */
 final class CommentedOutFunctionFixerTest extends AbstractFixerTestCase
 {
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('functions', $options[0]->getName());
     }
@@ -41,8 +37,7 @@ public function testIsRisky(): void
      */
     public function testFix(string $expected, ?string $input = null, ?array $configuration = null): void
     {
-        $this->fixer->configure($configuration ?? []);
-        $this->doTest($expected, $input);
+        $this->doTest($expected, $input, $configuration);
     }
 
     /**
diff --git a/tests/Fixer/DataProviderNameFixerTest.php b/tests/Fixer/DataProviderNameFixerTest.php
@@ -11,23 +11,20 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
-use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
+ * @property DeprecatedFixerInterface $fixer
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderNameFixer
  */
 final class DataProviderNameFixerTest extends AbstractFixerTestCase
 {
     public function testConfiguration(): void
     {
-        /** @var array<FixerOptionInterface> $options */
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('prefix', $options[0]->getName());
         self::assertSame('provide', $options[0]->getDefault());
diff --git a/tests/Fixer/DataProviderReturnTypeFixerTest.php b/tests/Fixer/DataProviderReturnTypeFixerTest.php
@@ -11,13 +11,12 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
+ * @property DeprecatedFixerInterface $fixer
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderReturnTypeFixer
  */
diff --git a/tests/Fixer/DataProviderStaticFixerTest.php b/tests/Fixer/DataProviderStaticFixerTest.php
@@ -11,13 +11,12 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
+ * @property DeprecatedFixerInterface $fixer
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderStaticFixer
  */
@@ -35,7 +34,7 @@ public function testSuccessorName(): void
 
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('force', $options[0]->getName());
     }
diff --git a/tests/Fixer/MultilinePromotedPropertiesFixerTest.php b/tests/Fixer/MultilinePromotedPropertiesFixerTest.php
@@ -11,15 +11,9 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
-use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface&WhitespacesAwareFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\MultilinePromotedPropertiesFixer
  *
  * @requires PHP 8.0
@@ -28,8 +22,7 @@ final class MultilinePromotedPropertiesFixerTest extends AbstractFixerTestCase
 {
     public function testConfiguration(): void
     {
-        /** @var array<FixerOptionInterface> $options */
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('keep_blank_lines', $options[0]->getName());
         self::assertFalse($options[0]->getDefault());
diff --git a/tests/Fixer/NoDuplicatedArrayKeyFixerTest.php b/tests/Fixer/NoDuplicatedArrayKeyFixerTest.php
@@ -11,13 +11,9 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\NoDuplicatedArrayKeyFixer
  */
 final class NoDuplicatedArrayKeyFixerTest extends AbstractFixerTestCase
@@ -29,7 +25,7 @@ public function testIsRisky(): void
 
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('ignore_expressions', $options[0]->getName());
     }
diff --git a/tests/Fixer/NoSuperfluousConcatenationFixerTest.php b/tests/Fixer/NoSuperfluousConcatenationFixerTest.php
@@ -11,13 +11,9 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\NoSuperfluousConcatenationFixer
  */
 final class NoSuperfluousConcatenationFixerTest extends AbstractFixerTestCase
@@ -29,7 +25,7 @@ public function testIsRisky(): void
 
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('allow_preventing_trailing_spaces', $options[0]->getName());
     }
diff --git a/tests/Fixer/NumericLiteralSeparatorFixerTest.php b/tests/Fixer/NumericLiteralSeparatorFixerTest.php
@@ -11,14 +11,11 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Tokenizer\Tokens;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\NumericLiteralSeparatorFixer
  */
 final class NumericLiteralSeparatorFixerTest extends AbstractFixerTestCase
@@ -30,7 +27,7 @@ public function testIsRisky(): void
 
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('binary', $options[0]->getName());
         self::assertArrayHasKey(1, $options);
diff --git a/tests/Fixer/PhpdocOnlyAllowedAnnotationsFixerTest.php b/tests/Fixer/PhpdocOnlyAllowedAnnotationsFixerTest.php
@@ -11,20 +11,16 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\PhpdocOnlyAllowedAnnotationsFixer
  */
 final class PhpdocOnlyAllowedAnnotationsFixerTest extends AbstractFixerTestCase
 {
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('elements', $options[0]->getName());
     }
diff --git a/tests/Fixer/PhpdocParamOrderFixerTest.php b/tests/Fixer/PhpdocParamOrderFixerTest.php
@@ -11,13 +11,12 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
+ * @property DeprecatedFixerInterface $fixer
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\PhpdocParamOrderFixer
  */
diff --git a/tests/Fixer/PromotedConstructorPropertyFixerTest.php b/tests/Fixer/PromotedConstructorPropertyFixerTest.php
@@ -11,13 +11,9 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\PromotedConstructorPropertyFixer
  *
  * @requires PHP 8.0
@@ -26,7 +22,7 @@ final class PromotedConstructorPropertyFixerTest extends AbstractFixerTestCase
 {
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('promote_only_existing_properties', $options[0]->getName());
     }
diff --git a/tests/Fixer/SingleSpaceAfterStatementFixerTest.php b/tests/Fixer/SingleSpaceAfterStatementFixerTest.php
@@ -11,16 +11,13 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixerCustomFixers\Fixer\SingleSpaceAfterStatementFixer;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
- *
  * @covers \PhpCsFixerCustomFixers\Fixer\SingleSpaceAfterStatementFixer
  */
 final class SingleSpaceAfterStatementFixerTest extends AbstractFixerTestCase
@@ -105,7 +102,7 @@ interface    FooInterface {
 
     public function testConfiguration(): void
     {
-        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        $options = self::getConfigurationOptions();
         self::assertArrayHasKey(0, $options);
         self::assertSame('allow_linebreak', $options[0]->getName());
     }

Original file line number	Diff line number	Diff line change
`@@ -11,20 +11,16 @@`
`11`	`11`
`12`	`12`	`namespace Tests\Fixer;`
`13`	`13`
`14`		`-use PhpCsFixer\Fixer\ConfigurableFixerInterface;`
`15`		`-`
`16`	`14`	`/**`
`17`	`15`	`* @internal`
`18`	`16`	`*`
`19`		`- * @property ConfigurableFixerInterface $fixer`
`20`		`- *`
`21`	`17`	`* @covers \PhpCsFixerCustomFixers\Fixer\CommentedOutFunctionFixer`
`22`	`18`	`*/`
`23`	`19`	`final class CommentedOutFunctionFixerTest extends AbstractFixerTestCase`
`24`	`20`	`{`
`25`	`21`	`public function testConfiguration(): void`
`26`	`22`	`{`
`27`		`- $options = $this->fixer->getConfigurationDefinition()->getOptions();`
	`23`	`+ $options = self::getConfigurationOptions();`
`28`	`24`	`self::assertArrayHasKey(0, $options);`
`29`	`25`	`self::assertSame('functions', $options[0]->getName());`
`30`	`26`	`}`
`@@ -41,8 +37,7 @@ public function testIsRisky(): void`
`41`	`37`	`*/`
`42`	`38`	`public function testFix(string $expected, ?string $input = null, ?array $configuration = null): void`
`43`	`39`	`{`
`44`		`- $this->fixer->configure($configuration ?? []);`
`45`		`- $this->doTest($expected, $input);`
	`40`	`+ $this->doTest($expected, $input, $configuration);`
`46`	`41`	`}`
`47`	`42`
`48`	`43`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -11,23 +11,20 @@`
`11`	`11`
`12`	`12`	`namespace Tests\Fixer;`
`13`	`13`
`14`		`-use PhpCsFixer\Fixer\ConfigurableFixerInterface;`
`15`	`14`	`use PhpCsFixer\Fixer\DeprecatedFixerInterface;`
`16`		`-use PhpCsFixer\FixerConfiguration\FixerOptionInterface;`
`17`	`15`
`18`	`16`	`/**`
`19`	`17`	`* @internal`
`20`	`18`	`*`
`21`		`- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer`
	`19`	`+ * @property DeprecatedFixerInterface $fixer`
`22`	`20`	`*`
`23`	`21`	`* @covers \PhpCsFixerCustomFixers\Fixer\DataProviderNameFixer`
`24`	`22`	`*/`
`25`	`23`	`final class DataProviderNameFixerTest extends AbstractFixerTestCase`
`26`	`24`	`{`
`27`	`25`	`public function testConfiguration(): void`
`28`	`26`	`{`
`29`		`- /** @var array<FixerOptionInterface> $options */`
`30`		`- $options = $this->fixer->getConfigurationDefinition()->getOptions();`
	`27`	`+ $options = self::getConfigurationOptions();`
`31`	`28`	`self::assertArrayHasKey(0, $options);`
`32`	`29`	`self::assertSame('prefix', $options[0]->getName());`
`33`	`30`	`self::assertSame('provide', $options[0]->getDefault());`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,12 @@`
`11`	`11`
`12`	`12`	`namespace Tests\Fixer;`
`13`	`13`
`14`		`-use PhpCsFixer\Fixer\ConfigurableFixerInterface;`
`15`	`14`	`use PhpCsFixer\Fixer\DeprecatedFixerInterface;`
`16`	`15`
`17`	`16`	`/**`
`18`	`17`	`* @internal`
`19`	`18`	`*`
`20`		`- * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer`
	`19`	`+ * @property DeprecatedFixerInterface $fixer`
`21`	`20`	`*`
`22`	`21`	`* @covers \PhpCsFixerCustomFixers\Fixer\DataProviderReturnTypeFixer`
`23`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,9 @@`
`11`	`11`
`12`	`12`	`namespace Tests\Fixer;`
`13`	`13`
`14`		`-use PhpCsFixer\Fixer\ConfigurableFixerInterface;`
`15`		`-use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;`
`16`		`-use PhpCsFixer\FixerConfiguration\FixerOptionInterface;`
`17`		`-`
`18`	`14`	`/**`
`19`	`15`	`* @internal`
`20`	`16`	`*`
`21`		`- * @property ConfigurableFixerInterface&WhitespacesAwareFixerInterface $fixer`
`22`		`- *`
`23`	`17`	`* @covers \PhpCsFixerCustomFixers\Fixer\MultilinePromotedPropertiesFixer`
`24`	`18`	`*`
`25`	`19`	`* @requires PHP 8.0`
`@@ -28,8 +22,7 @@ final class MultilinePromotedPropertiesFixerTest extends AbstractFixerTestCase`
`28`	`22`	`{`
`29`	`23`	`public function testConfiguration(): void`
`30`	`24`	`{`
`31`		`- /** @var array<FixerOptionInterface> $options */`
`32`		`- $options = $this->fixer->getConfigurationDefinition()->getOptions();`
	`25`	`+ $options = self::getConfigurationOptions();`
`33`	`26`	`self::assertArrayHasKey(0, $options);`
`34`	`27`	`self::assertSame('keep_blank_lines', $options[0]->getName());`
`35`	`28`	`self::assertFalse($options[0]->getDefault());`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,9 @@`
`11`	`11`
`12`	`12`	`namespace Tests\Fixer;`
`13`	`13`
`14`		`-use PhpCsFixer\Fixer\ConfigurableFixerInterface;`
`15`		`-`
`16`	`14`	`/**`
`17`	`15`	`* @internal`
`18`	`16`	`*`
`19`		`- * @property ConfigurableFixerInterface $fixer`
`20`		`- *`
`21`	`17`	`* @covers \PhpCsFixerCustomFixers\Fixer\NoDuplicatedArrayKeyFixer`
`22`	`18`	`*/`
`23`	`19`	`final class NoDuplicatedArrayKeyFixerTest extends AbstractFixerTestCase`
`@@ -29,7 +25,7 @@ public function testIsRisky(): void`
`29`	`25`
`30`	`26`	`public function testConfiguration(): void`
`31`	`27`	`{`
`32`		`- $options = $this->fixer->getConfigurationDefinition()->getOptions();`
	`28`	`+ $options = self::getConfigurationOptions();`
`33`	`29`	`self::assertArrayHasKey(0, $options);`
`34`	`30`	`self::assertSame('ignore_expressions', $options[0]->getName());`
`35`	`31`	`}`