DX: rename data providers (#7058)

PHP-CS-Fixer · Jun 16, 2023 · 617aaba · 617aaba
1 parent 376a987
commit 617aaba
Show file tree

Hide file tree

Showing 99 changed files with 337 additions and 337 deletions.
diff --git a/tests/AbstractDoctrineAnnotationFixerTestCase.php b/tests/AbstractDoctrineAnnotationFixerTestCase.php
@@ -25,7 +25,7 @@ abstract class AbstractDoctrineAnnotationFixerTestCase extends AbstractFixerTest
     /**
      * @param array<mixed> $configuration
      *
-     * @dataProvider provideInvalidConfigurationCases
+     * @dataProvider provideConfigureWithInvalidConfigurationCases
      */
     public function testConfigureWithInvalidConfiguration(array $configuration): void
     {
@@ -34,7 +34,7 @@ public function testConfigureWithInvalidConfiguration(array $configuration): voi
         $this->fixer->configure($configuration);
     }
 
-    public static function provideInvalidConfigurationCases(): array
+    public static function provideConfigureWithInvalidConfigurationCases(): array
     {
         return [
             [['foo' => 'bar']],

diff --git a/tests/AutoReview/DocumentationTest.php b/tests/AutoReview/DocumentationTest.php
@@ -38,7 +38,7 @@
 final class DocumentationTest extends TestCase
 {
     /**
-     * @dataProvider provideFixerCases
+     * @dataProvider provideFixerDocumentationFileIsUpToDateCases
      */
     public function testFixerDocumentationFileIsUpToDate(FixerInterface $fixer): void
     {
@@ -92,7 +92,7 @@ static function (array $matches) use ($actual): string {
         self::assertSame($expected, $actual);
     }
 
-    public static function provideFixerCases(): iterable
+    public static function provideFixerDocumentationFileIsUpToDateCases(): iterable
     {
         foreach (self::getFixers() as $fixer) {
             yield $fixer->getName() => [$fixer];

diff --git a/tests/AutoReview/FixerFactoryTest.php b/tests/AutoReview/FixerFactoryTest.php
@@ -72,7 +72,7 @@ public function testFixersPriority(): void
     /**
      * @param string[] $edges
      *
-     * @dataProvider provideFixersPriorityCasesHaveIntegrationCases
+     * @dataProvider provideFixersPriorityCasesHaveIntegrationTestCases
      */
     public function testFixersPriorityCasesHaveIntegrationTest(string $fixerName, array $edges): void
     {
@@ -137,15 +137,15 @@ public function testFixersPriorityCasesHaveIntegrationTest(string $fixerName, ar
         self::assertCount(0, $missingIntegrationsTests, sprintf("There shall be an integration test. How do you know that priority set up is good, if there is no integration test to check it?\nMissing:\n- %s", implode("\n- ", $missingIntegrationsTests)));
     }
 
-    public static function provideFixersPriorityCasesHaveIntegrationCases(): iterable
+    public static function provideFixersPriorityCasesHaveIntegrationTestCases(): iterable
     {
         foreach (self::getFixersPriorityGraph() as $fixerName => $edges) {
             yield $fixerName => [$fixerName, $edges];
         }
     }
 
     /**
-     * @dataProvider provideIntegrationTestFilesCases
+     * @dataProvider providePriorityIntegrationTestFilesAreListedAsPriorityCasesCases
      */
     public function testPriorityIntegrationTestFilesAreListedAsPriorityCases(\SplFileInfo $file): void
     {
@@ -168,7 +168,7 @@ public function testPriorityIntegrationTestFilesAreListedAsPriorityCases(\SplFil
         );
     }
 
-    public static function provideIntegrationTestFilesCases(): iterable
+    public static function providePriorityIntegrationTestFilesAreListedAsPriorityCasesCases(): iterable
     {
         foreach (new \DirectoryIterator(self::getIntegrationPriorityDirectory()) as $candidate) {
             if (!$candidate->isDot()) {

diff --git a/tests/AutoReview/ProjectCodeTest.php b/tests/AutoReview/ProjectCodeTest.php
@@ -80,7 +80,7 @@ public function testThatClassesWithoutTestsVarIsProper(): void
     }
 
     /**
-     * @dataProvider provideSrcConcreteClassCases
+     * @dataProvider provideThatSrcClassHaveTestClassCases
      */
     public function testThatSrcClassHaveTestClass(string $className): void
     {
@@ -96,7 +96,7 @@ public function testThatSrcClassHaveTestClass(string $className): void
     }
 
     /**
-     * @dataProvider provideSrcClassesNotAbuseInterfacesCases
+     * @dataProvider provideThatSrcClassesNotAbuseInterfacesCases
      */
     public function testThatSrcClassesNotAbuseInterfaces(string $className): void
     {
@@ -374,7 +374,7 @@ public function testThatTestClassCoversAreCorrect(string $testClassName): void
     }
 
     /**
-     * @dataProvider provideClassesWherePregFunctionsAreForbiddenCases
+     * @dataProvider provideThereIsNoPregFunctionUsedDirectlyCases
      */
     public function testThereIsNoPregFunctionUsedDirectly(string $className): void
     {
@@ -591,7 +591,7 @@ static function (string $item): array {
         );
     }
 
-    public static function provideSrcClassesNotAbuseInterfacesCases(): array
+    public static function provideThatSrcClassesNotAbuseInterfacesCases(): array
     {
         return array_map(
             static function (string $item): array {
@@ -637,7 +637,7 @@ static function (string $item): array {
         );
     }
 
-    public static function provideSrcConcreteClassCases(): array
+    public static function provideThatSrcClassHaveTestClassCases(): array
     {
         return array_map(
             static fn (string $item): array => [$item],
@@ -667,7 +667,7 @@ public static function provideTestClassCases(): iterable
         yield from self::$testClassCases;
     }
 
-    public static function provideClassesWherePregFunctionsAreForbiddenCases(): array
+    public static function provideThereIsNoPregFunctionUsedDirectlyCases(): array
     {
         return array_map(
             static fn (string $item): array => [$item],

diff --git a/tests/AutoReview/TransformerTest.php b/tests/AutoReview/TransformerTest.php
@@ -43,7 +43,7 @@ public function testTransformerPriority(TransformerInterface $first, Transformer
     }
 
     /**
-     * @dataProvider provideTransformerCases
+     * @dataProvider provideTransformerPriorityIsListedCases
      */
     public function testTransformerPriorityIsListed(TransformerInterface $transformer): void
     {
@@ -74,7 +74,7 @@ public static function provideTransformerPriorityCases(): array
     {
         $transformers = [];
 
-        foreach (self::provideTransformerCases() as [$transformer]) {
+        foreach (self::provideTransformerPriorityIsListedCases() as [$transformer]) {
             $transformers[$transformer->getName()] = $transformer;
         }
 
@@ -102,7 +102,7 @@ public static function provideTransformerPriorityCases(): array
     /**
      * @return TransformerInterface[]
      */
-    public static function provideTransformerCases(): array
+    public static function provideTransformerPriorityIsListedCases(): array
     {
         static $transformersArray = null;
 

diff --git a/tests/Cache/CacheTest.php b/tests/Cache/CacheTest.php
@@ -108,7 +108,7 @@ public function testFromJsonThrowsInvalidArgumentExceptionIfJsonIsInvalid(): voi
     /**
      * @param array<string, mixed> $data
      *
-     * @dataProvider provideMissingDataCases
+     * @dataProvider provideFromJsonThrowsInvalidArgumentExceptionIfJsonIsMissingKeyCases
      */
     public function testFromJsonThrowsInvalidArgumentExceptionIfJsonIsMissingKey(array $data): void
     {
@@ -119,7 +119,7 @@ public function testFromJsonThrowsInvalidArgumentExceptionIfJsonIsMissingKey(arr
         Cache::fromJson($json);
     }
 
-    public static function provideMissingDataCases(): array
+    public static function provideFromJsonThrowsInvalidArgumentExceptionIfJsonIsMissingKeyCases(): array
     {
         $data = [
             'php' => '7.1.2',

diff --git a/tests/Console/ConfigurationResolverTest.php b/tests/Console/ConfigurationResolverTest.php
@@ -181,7 +181,7 @@ public function testResolveConfigFileSpecified(): void
     }
 
     /**
-     * @dataProvider provideResolveConfigFileDefaultCases
+     * @dataProvider provideResolveConfigFileChooseFileCases
      */
     public function testResolveConfigFileChooseFile(string $expectedFile, string $expectedClass, string $path, ?string $cwdPath = null): void
     {
@@ -195,7 +195,7 @@ public function testResolveConfigFileChooseFile(string $expectedFile, string $ex
         self::assertInstanceOf($expectedClass, $resolver->getConfig());
     }
 
-    public static function provideResolveConfigFileDefaultCases(): array
+    public static function provideResolveConfigFileChooseFileCases(): array
     {
         $dirBase = self::getFixtureDir();
 
@@ -285,7 +285,7 @@ public function testResolveConfigFileChooseFileWithPathArrayAndConfig(): void
      * @param array<int, string> $paths
      * @param array<int, string> $expectedPaths
      *
-     * @dataProvider providePathCases
+     * @dataProvider provideResolvePathCases
      */
     public function testResolvePath(array $paths, string $cwd, array $expectedPaths): void
     {
@@ -298,7 +298,7 @@ public function testResolvePath(array $paths, string $cwd, array $expectedPaths)
         self::assertSame($expectedPaths, $resolver->getPath());
     }
 
-    public static function providePathCases(): iterable
+    public static function provideResolvePathCases(): iterable
     {
         yield [
             ['Command'],
@@ -328,7 +328,7 @@ public static function providePathCases(): iterable
     /**
      * @param array<string> $paths
      *
-     * @dataProvider provideEmptyPathCases
+     * @dataProvider provideRejectInvalidPathCases
      */
     public function testRejectInvalidPath(array $paths, string $expectedMessage): void
     {
@@ -344,7 +344,7 @@ public function testRejectInvalidPath(array $paths, string $expectedMessage): vo
         $resolver->getPath();
     }
 
-    public static function provideEmptyPathCases(): iterable
+    public static function provideRejectInvalidPathCases(): iterable
     {
         yield [
             [''],
@@ -961,7 +961,7 @@ public function testResolveRulesWithOption(): void
     /**
      * @param string[] $rules
      *
-     * @dataProvider provideRenamedRulesCases
+     * @dataProvider provideResolveRenamedRulesWithUnknownRulesCases
      */
     public function testResolveRenamedRulesWithUnknownRules(string $expectedMessage, array $rules): void
     {
@@ -972,7 +972,7 @@ public function testResolveRenamedRulesWithUnknownRules(string $expectedMessage,
         $resolver->getRules();
     }
 
-    public static function provideRenamedRulesCases(): iterable
+    public static function provideResolveRenamedRulesWithUnknownRulesCases(): iterable
     {
         yield 'with config' => [
             'The rules contain unknown fixers: "blank_line_before_return" is renamed (did you mean "blank_line_before_statement"? (note: use configuration "[\'statements\' => [\'return\']]")).
@@ -1069,7 +1069,7 @@ public function testResolveCommandLineInputOverridesDefault(): void
     /**
      * @param null|bool|string $diffConfig
      *
-     * @dataProvider provideDifferCases
+     * @dataProvider provideResolveDifferCases
      */
     public function testResolveDiffer(string $expected, $diffConfig): void
     {
@@ -1080,7 +1080,7 @@ public function testResolveDiffer(string $expected, $diffConfig): void
         self::assertInstanceOf($expected, $resolver->getDiffer());
     }
 
-    public static function provideDifferCases(): array
+    public static function provideResolveDifferCases(): array
     {
         return [
             [

diff --git a/tests/Console/Output/ErrorOutputTest.php b/tests/Console/Output/ErrorOutputTest.php
@@ -29,7 +29,7 @@
 final class ErrorOutputTest extends TestCase
 {
     /**
-     * @dataProvider provideTestCases
+     * @dataProvider provideErrorOutputCases
      */
     public function testErrorOutput(Error $error, int $verbosityLevel, int $lineNumber, int $exceptionLineNumber, string $process): void
     {
@@ -70,7 +70,7 @@ public function testErrorOutput(Error $error, int $verbosityLevel, int $lineNumb
                 '
       PhpCsFixer\Tests\Console\Output\ErrorOutputTest::getErrorAndLineNumber()
         in %s at line %d
-      PhpCsFixer\Tests\Console\Output\ErrorOutputTest::provideTestCases()
+      PhpCsFixer\Tests\Console\Output\ErrorOutputTest::provideErrorOutputCases()
       ReflectionMethod->invoke()
 ',
                 __FILE__,
@@ -81,7 +81,7 @@ public function testErrorOutput(Error $error, int $verbosityLevel, int $lineNumb
         self::assertStringStartsWith($startWith, $displayed);
     }
 
-    public static function provideTestCases(): array
+    public static function provideErrorOutputCases(): array
     {
         $lineNumber = __LINE__;
         [$exceptionLineNumber, $error] = self::getErrorAndLineNumber(); // note: keep call and __LINE__ separated with one line break

diff --git a/tests/Console/SelfUpdate/NewVersionCheckerTest.php b/tests/Console/SelfUpdate/NewVersionCheckerTest.php
@@ -33,7 +33,7 @@ public function testGetLatestVersion(): void
     }
 
     /**
-     * @dataProvider provideLatestVersionOfMajorCases
+     * @dataProvider provideGetLatestVersionOfMajorCases
      */
     public function testGetLatestVersionOfMajor(int $majorVersion, ?string $expectedVersion): void
     {
@@ -42,7 +42,7 @@ public function testGetLatestVersionOfMajor(int $majorVersion, ?string $expected
         self::assertSame($expectedVersion, $checker->getLatestVersionOfMajor($majorVersion));
     }
 
-    public static function provideLatestVersionOfMajorCases(): array
+    public static function provideGetLatestVersionOfMajorCases(): array
     {
         return [
             [1, 'v1.13.2'],

diff --git a/tests/Differ/DiffConsoleFormatterTest.php b/tests/Differ/DiffConsoleFormatterTest.php
@@ -26,7 +26,7 @@
 final class DiffConsoleFormatterTest extends TestCase
 {
     /**
-     * @dataProvider provideTestCases
+     * @dataProvider provideDiffConsoleFormatterCases
      */
     public function testDiffConsoleFormatter(string $expected, bool $isDecoratedOutput, string $template, string $diff, string $lineTemplate): void
     {
@@ -38,7 +38,7 @@ public function testDiffConsoleFormatter(string $expected, bool $isDecoratedOutp
         );
     }
 
-    public static function provideTestCases(): array
+    public static function provideDiffConsoleFormatterCases(): array
     {
         return [
             [

diff --git a/tests/DocBlock/AnnotationTest.php b/tests/DocBlock/AnnotationTest.php
@@ -544,7 +544,7 @@ public function testGetTagsWithTypes(): void
     /**
      * @param NamespaceUseAnalysis[] $namespaceUses
      *
-     * @dataProvider provideTypeExpressionCases
+     * @dataProvider provideGetTypeExpressionCases
      */
     public function testGetTypeExpression(string $line, ?NamespaceAnalysis $namespace, array $namespaceUses, ?string $expectedCommonType): void
     {
@@ -554,7 +554,7 @@ public function testGetTypeExpression(string $line, ?NamespaceAnalysis $namespac
         self::assertSame($expectedCommonType, $result->getCommonType());
     }
 
-    public static function provideTypeExpressionCases(): iterable
+    public static function provideGetTypeExpressionCases(): iterable
     {
         $appNamespace = new NamespaceAnalysis('App', 'App', 0, 999, 0, 999);
         $useTraversable = new NamespaceUseAnalysis('Traversable', 'Traversable', false, 0, 999, NamespaceUseAnalysis::TYPE_CLASS);
@@ -567,15 +567,15 @@ public static function provideTypeExpressionCases(): iterable
     }
 
     /**
-     * @dataProvider provideGetVariableCases
+     * @dataProvider provideGetVariableNameCases
      */
     public function testGetVariableName(string $line, ?string $expectedVariableName): void
     {
         $annotation = new Annotation([new Line($line)]);
         self::assertSame($expectedVariableName, $annotation->getVariableName());
     }
 
-    public static function provideGetVariableCases(): iterable
+    public static function provideGetVariableNameCases(): iterable
     {
         yield ['* @param int $foo', '$foo'];
 

diff --git a/tests/DocBlock/DocBlockTest.php b/tests/DocBlock/DocBlockTest.php
@@ -156,7 +156,7 @@ public function testIsMultiLIne(): void
     }
 
     /**
-     * @dataProvider provideDocBlocksToConvertToMultiLineCases
+     * @dataProvider provideMakeMultiLIneCases
      */
     public function testMakeMultiLIne(string $inputDocBlock, string $outputDocBlock = null, string $indent = '', string $newLine = "\n"): void
     {
@@ -170,7 +170,7 @@ public function testMakeMultiLIne(string $inputDocBlock, string $outputDocBlock
         self::assertSame($outputDocBlock, $doc->getContent());
     }
 
-    public static function provideDocBlocksToConvertToMultiLineCases(): array
+    public static function provideMakeMultiLIneCases(): array
     {
         return [
             'It keeps a multi line doc block as is' => [
@@ -201,7 +201,7 @@ public static function provideDocBlocksToConvertToMultiLineCases(): array
     }
 
     /**
-     * @dataProvider provideDocBlocksToConvertToSingleLineCases
+     * @dataProvider provideMakeSingleLineCases
      */
     public function testMakeSingleLine(string $inputDocBlock, string $outputDocBlock = null): void
     {
@@ -215,7 +215,7 @@ public function testMakeSingleLine(string $inputDocBlock, string $outputDocBlock
         self::assertSame($outputDocBlock, $doc->getContent());
     }
 
-    public static function provideDocBlocksToConvertToSingleLineCases(): array
+    public static function provideMakeSingleLineCases(): array
     {
         return [
             'It keeps a single line doc block as is' => [