Normalize data provider names

[paulbalandan]

Description
In php-cs-fixer v3.19, a new fixer php_unit_data_provider_name is released that aims to normalize data provider names used only ONCE.

Description of php_unit_data_provider_name

$ vendor/bin/php-cs-fixer describe php_unit_data_provider_name
Description of php_unit_data_provider_name rule.
Data provider names must match the name of the test.

Fixer applying this rule is risky.
Fixer could be risky if one is calling data provider by name as function.

Fixer is configurable using following options:
* prefix (string): prefix that replaces "test"; defaults to 'provide'
* suffix (string): suffix to be present at the end; defaults to 'Cases'

Fixing examples:
 * Example #1. Fixing with the default configuration.
   ---------- begin diff ----------
   --- Original
   +++ New
   @@ -1,8 +1,8 @@
    <?php
    class FooTest extends TestCase {
        /**
   -     * @dataProvider dataProvider
   +     * @dataProvider provideSomethingCases
         */
        public function testSomething($expected, $actual) {}
   -    public function dataProvider() {}
   +    public function provideSomethingCases() {}
    }

   ----------- end diff -----------

 * Example #2. Fixing with configuration: ['prefix' => 'data_', 'suffix' => ''].
   ---------- begin diff ----------
   --- Original
   +++ New
   @@ -1,8 +1,8 @@
    <?php
    class FooTest extends TestCase {
        /**
   -     * @dataProvider dt_prvdr_ftr
   +     * @dataProvider data_feature
         */
        public function test_feature($expected, $actual) {}
   -    public function dt_prvdr_ftr() {}
   +    public function data_feature() {}
    }

   ----------- end diff -----------

 * Example #3. Fixing with configuration: ['prefix' => 'provides', 'suffix' => 'Data'].
   ---------- begin diff ----------
   --- Original
   +++ New
   @@ -1,25 +1,25 @@
    <?php
    class FooTest extends TestCase {
        /**
         * @dataProvider dataProviderUsedInMultipleTests
         */
        public function testA($expected, $actual) {}
        /**
         * @dataProvider dataProviderUsedInMultipleTests
         */
        public function testB($expected, $actual) {}
        /**
   -     * @dataProvider dataProviderUsedInSingleTest
   +     * @dataProvider providesCData
         */
        public function testC($expected, $actual) {}
        /**
         * @dataProvider dataProviderUsedAsFirstInTest
         * @dataProvider dataProviderUsedAsSecondInTest
         */
        public function testD($expected, $actual) {}

        public function dataProviderUsedInMultipleTests() {}
   -    public function dataProviderUsedInSingleTest() {}
   +    public function providesCData() {}
        public function dataProviderUsedAsFirstInTest() {}
        public function dataProviderUsedAsSecondInTest() {}
    }

   ----------- end diff -----------

Based on the existing naming we have, I used the setting:

'php_unit_data_provider_name' => [
    'prefix' => 'provide',
    'suffix' => '',
],

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[kenjis]

LGTM!

[MGatner]

I like the consistency but don't like some of the resulting method names that got much more convoluted.

[paulbalandan]

@MGatner may I know which ones are convoluted? So I can rename them?

[MGatner]

Oh it was just a comment, not blocking or worth any effort. This makes it very clear which provider is being used so is plenty functional. Names like provideCheckControlStringWithLineBreakAndTabReturnsTheString are awkward but causing no harm.