DataProviderNameFixer - add options "prefix" and "suffix" (#269)

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v2.2.0 - [Unreleased]
+- Feature: DataProviderNameFixer - add options "prefix" and "suffix"
+
 ## v2.1.0 - *2020-03-15*
 - Add CommentedOutFunctionFixer
 - Add NoDuplicatedArrayKeyFixer

README.md

@@ -8,7 +8,7 @@
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=master&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
 [![Code coverage](https://img.shields.io/coveralls/github/kubawerlos/php-cs-fixer-custom-fixers/master.svg)](https://coveralls.io/github/kubawerlos/php-cs-fixer-custom-fixers?branch=master)
-![Tests](https://img.shields.io/badge/tests-2168-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-2173-brightgreen.svg)
 [![Mutation testing badge](https://badge.stryker-mutator.io/github.com/kubawerlos/php-cs-fixer-custom-fixers/master)](https://stryker-mutator.github.io)
 [![Psalm type coverage](https://shepherd.dev/github/kubawerlos/php-cs-fixer-custom-fixers/coverage.svg)](https://shepherd.dev/github/kubawerlos/php-cs-fixer-custom-fixers)
 
@@ -59,6 +59,9 @@ Configuration options:
 #### DataProviderNameFixer
 Name of data provider that is used only once must match name of test.
   *Risky: when relying on name of data provider function.*
+Configuration options:
+- `prefix` (`string`): prefix that replaces "test"; defaults to `'provide'`
+- `suffix` (`string`): suffix to be added at the end"; defaults to `'Cases'`
 ```diff
  <?php
  class FooTest extends TestCase {

src/Fixer/DataProviderNameFixer.php

@@ -4,6 +4,9 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
+use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
@@ -13,8 +16,14 @@
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderNameFixer extends AbstractFixer
+final class DataProviderNameFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
 {
+    /** @var string */
+    private $prefix = 'provide';
+
+    /** @var string */
+    private $suffix = 'Cases';
+
     /**
      * {@inheritdoc}
      */
@@ -40,6 +49,34 @@ public function dataProvider() {}
         );
     }
 
+    public function getConfigurationDefinition(): FixerConfigurationResolver
+    {
+        return new FixerConfigurationResolver([
+            (new FixerOptionBuilder('prefix', 'prefix that replaces "test"'))
+                ->setAllowedTypes(['string'])
+                ->setDefault($this->prefix)
+                ->getOption(),
+            (new FixerOptionBuilder('suffix', 'suffix to be added at the end"'))
+                ->setAllowedTypes(['string'])
+                ->setDefault($this->suffix)
+                ->getOption(),
+        ]);
+    }
+
+    public function configure(?array $configuration = null): void
+    {
+        /** @var string[] $configuration */
+        $configuration = $configuration ?? [];
+
+        if (isset($configuration['prefix'])) {
+            $this->prefix = $configuration['prefix'];
+        }
+
+        if (isset($configuration['suffix'])) {
+            $this->suffix = $configuration['suffix'];
+        }
+    }
+
     public function getPriority(): int
     {
         return 0;
@@ -99,6 +136,6 @@ private function getProviderNameForTestName(string $name): string
             $name = \substr($name, 4);
         }
 
-        return 'provide' . \ucfirst($name) . 'Cases';
+        return $this->prefix . \ucfirst($name) . $this->suffix;
     }
 }

tests/Fixer/AbstractFixerTestCase.php

@@ -94,7 +94,7 @@ final public function testPriority(): void
 
     final protected function doTest(string $expected, ?string $input = null, ?array $configuration = null): void
     {
-        if ($configuration !== null) {
+        if ($this->fixer instanceof ConfigurableFixerInterface) {
             $this->fixer->configure($configuration);
         }
 

tests/Fixer/DataProviderNameFixerTest.php

@@ -4,13 +4,27 @@
 
 namespace Tests\Fixer;
 
+use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
+
 /**
  * @internal
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderNameFixer
  */
 final class DataProviderNameFixerTest extends AbstractFixerTestCase
 {
+    public function testConfiguration(): void
+    {
+        /** @var FixerOptionInterface[] $options */
+        $options = $this->fixer->getConfigurationDefinition()->getOptions();
+        self::assertArrayHasKey(0, $options);
+        self::assertSame('prefix', $options[0]->getName());
+        self::assertSame('provide', $options[0]->getDefault());
+        self::assertArrayHasKey(1, $options);
+        self::assertSame('suffix', $options[1]->getName());
+        self::assertSame('Cases', $options[1]->getDefault());
+    }
+
     public function testIsRisky(): void
     {
         self::assertTrue($this->fixer->isRisky());
@@ -19,9 +33,9 @@ public function testIsRisky(): void
     /**
      * @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);
     }
 
     public static function provideFixCases(): iterable
@@ -277,5 +291,93 @@ public function fooDataProvider() {}
                 }', $modifier),
             ];
         }
+
+        yield 'custom prefix' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider theBestPrefixFooCases
+     */
+    public function testFoo() {}
+    public function theBestPrefixFooCases() {}
+}',
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider dp
+     */
+    public function testFoo() {}
+    public function dp() {}
+}',
+            ['prefix' => 'theBestPrefix'],
+        ];
+
+        yield 'custom suffix' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider provideFooTheBestSuffix
+     */
+    public function testFoo() {}
+    public function provideFooTheBestSuffix() {}
+}',
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider dp
+     */
+    public function testFoo() {}
+    public function dp() {}
+}',
+            ['suffix' => 'TheBestSuffix'],
+        ];
+
+        yield 'custom prefix and suffix' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider theBestPrefixFooTheBestSuffix
+     */
+    public function testFoo() {}
+    public function theBestPrefixFooTheBestSuffix() {}
+}',
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider dp
+     */
+    public function testFoo() {}
+    public function dp() {}
+}',
+
+            [
+                'prefix' => 'theBestPrefix',
+                'suffix' => 'TheBestSuffix',
+            ],
+        ];
+
+        yield 'empty suffix' => [
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider dataProviderForFoo
+     */
+    public function testFoo() {}
+    public function dataProviderForFoo() {}
+}',
+            '<?php
+class FooTest extends TestCase {
+    /**
+     * @dataProvider dp
+     */
+    public function testFoo() {}
+    public function dp() {}
+}',
+
+            [
+                'prefix' => 'dataProviderFor',
+                'suffix' => '',
+            ],
+        ];
     }
 }