DataProviderStaticFixer - allow forcing static method when having dynamic call (#741)

Author: kubawerlos

CHANGELOG.md

@@ -1,8 +1,11 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.8.0
+- DataProviderStaticFixer - add option "force"
+
 ## v3.7.0
 - Add NoTrailingCommaInSinglelineFixer
--
+
 ## v3.6.0
 - Add IssetToArrayKeyExistsFixer
 - Add PhpdocVarAnnotationToAssertFixer

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3370-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3373-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -105,6 +105,9 @@ The types returned by data providers must be `iterable`.
 
 #### DataProviderStaticFixer
 Data providers must be static.
+  *Risky: when `force` is set to `true`.*
+Configuration options:
+- `force` (`bool`): whether to make static data providers having dynamic class calls; defaults to `false`
 ```diff
  <?php
  class FooTest extends TestCase {

src/Fixer/DataProviderStaticFixer.php

@@ -11,6 +11,10 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
+use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
@@ -20,8 +24,11 @@
 use PhpCsFixer\Tokenizer\TokensAnalyzer;
 use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderStaticFixer extends AbstractFixer
+final class DataProviderStaticFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    /** @var bool */
+    private $force = false;
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
@@ -38,10 +45,32 @@ public function provideSomethingCases() {}
 }
 '
                 ),
-            ]
+            ],
+            null,
+            'when `force` is set to `true`'
         );
     }
 
+    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    {
+        return new FixerConfigurationResolver([
+            (new FixerOptionBuilder('force', 'whether to make static data providers having dynamic class calls'))
+                ->setAllowedTypes(['bool'])
+                ->setDefault($this->force)
+                ->getOption(),
+        ]);
+    }
+
+    /**
+     * @param array<string, bool> $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        if (\array_key_exists('force', $configuration)) {
+            $this->force = $configuration['force'];
+        }
+    }
+
     public function getPriority(): int
     {
         return 0;
@@ -54,7 +83,7 @@ public function isCandidate(Tokens $tokens): bool
 
     public function isRisky(): bool
     {
-        return false;
+        return true;
     }
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
@@ -77,7 +106,7 @@ private function fixStatic(Tokens $tokens, int $startIndex, int $endIndex): void
             if ($methodStartIndex !== null) {
                 $methodEndIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $methodStartIndex);
 
-                if ($tokens->findSequence([[\T_VARIABLE, '$this']], $methodStartIndex, $methodEndIndex) !== null) {
+                if (!$this->force && $tokens->findSequence([[\T_VARIABLE, '$this']], $methodStartIndex, $methodEndIndex) !== null) {
                     continue;
                 }
             }

tests/Fixer/DataProviderStaticFixerTest.php

@@ -20,23 +20,63 @@ final class DataProviderStaticFixerTest extends AbstractFixerTestCase
 {
     public function testIsRisky(): void
     {
-        self::assertFalse($this->fixer->isRisky());
+        self::assertTrue($this->fixer->isRisky());
+    }
+
+    public function testConfiguration(): void
+    {
+        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        self::assertArrayHasKey(0, $options);
+        self::assertSame('force', $options[0]->getName());
     }
 
     /**
+     * @param null|array<string, bool> $configuration
      * @dataProvider provideFixCases
      */
-    public function testFix(string $expected, ?string $input = null): void
+    public function testFix(string $expected, ?string $input = null, ?array $configuration = null): void
     {
-        $this->doTest($expected, $input);
+        $this->doTest($expected, $input, $configuration);
     }
 
     /**
-     * @return iterable<array{0: string, 1?: string}>
+     * @return iterable<array{0: string, 1?: null|string, 2?: array<string, bool>}>
      */
     public static function provideFixCases(): iterable
     {
-        yield 'do not fix when containing dynamic calls' => [
+        yield 'do not fix when containing dynamic calls by default' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider provideFoo1Cases
+     */
+    public function testFoo1() {}
+    public function provideFoo1Cases() { $this->init(); }
+}',
+        ];
+
+        yield 'do not fix when containing dynamic calls and with `force` disabled' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider provideFoo1Cases
+     */
+    public function testFoo1() {}
+    public function provideFoo1Cases() { $this->init(); }
+}',
+            null,
+            ['force' => false],
+        ];
+
+        yield 'fix when containing dynamic calls and with `force` enabled' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider provideFoo1Cases
+     */
+    public function testFoo1() {}
+    public static function provideFoo1Cases() { $this->init(); }
+}',
             '<?php
 class FooTest extends TestCase {
     /**
@@ -45,6 +85,7 @@ class FooTest extends TestCase {
     public function testFoo1() {}
     public function provideFoo1Cases() { $this->init(); }
 }',
+            ['force' => true],
         ];
 
         yield 'fix single' => [