chore: ProjectCodeTest::testDataProvidersDeclaredReturnType - use bet…

…ter DataProvider to simplify test logic (PHP-CS-Fixer#7573)
zoonru · Feb 2, 2024 · db7910f · db7910f
1 parent 469adbc
commit db7910f
Showing 1 changed file with 17 additions and 36 deletions.
diff --git a/tests/AutoReview/ProjectCodeTest.php b/tests/AutoReview/ProjectCodeTest.php
@@ -453,53 +453,34 @@ public function testExpectedInputOrder(string $testClassName): void
     }
 
     /**
-     * @dataProvider provideTestClassCases
+     * @dataProvider provideDataProviderMethodCases
      */
-    public function testDataProvidersDeclaredReturnType(string $testClassName): void
+    public function testDataProvidersDeclaredReturnType(string $testClassName, \ReflectionMethod $method): void
     {
-        $reflectionClass = new \ReflectionClass($testClassName);
+        $methodId = $testClassName.'::'.$method->getName();
 
-        $publicMethods = array_filter(
-            $reflectionClass->getMethods(),
-            static fn (\ReflectionMethod $reflectionMethod): bool => $reflectionMethod->getDeclaringClass()->getName() === $reflectionClass->getName()
-        );
+        self::assertSame('iterable', $method->hasReturnType() ? $method->getReturnType()->__toString() : null, sprintf('DataProvider `%s` must provide `iterable` as return in method prototype.', $methodId));
 
-        $dataProviderMethods = array_filter(
-            $publicMethods,
-            static fn (\ReflectionMethod $reflectionMethod): bool => str_starts_with($reflectionMethod->getName(), 'provide')
-        );
+        $doc = new DocBlock(false !== $method->getDocComment() ? $method->getDocComment() : '/** */');
 
-        if ([] === $dataProviderMethods) {
-            $this->expectNotToPerformAssertions(); // no methods to test, all good!
+        $returnDocs = $doc->getAnnotationsOfType('return');
 
-            return;
+        if (\count($returnDocs) > 1) {
+            throw new \UnexpectedValueException(sprintf('Multiple `%s@return` annotations.', $methodId));
         }
 
-        /** @var \ReflectionMethod $method */
-        foreach ($dataProviderMethods as $method) {
-            $methodId = $method->getDeclaringClass()->getName().'::'.$method->getName();
+        if (1 !== \count($returnDocs)) {
+            $this->addToAssertionCount(1); // no @return annotation, all good!
 
-            self::assertSame('iterable', $method->hasReturnType() ? $method->getReturnType()->__toString() : null, sprintf('DataProvider `%s` must provide `iterable` as return in method prototype.', $methodId));
-
-            $doc = new DocBlock(false !== $method->getDocComment() ? $method->getDocComment() : '/** */');
-
-            $returnDocs = $doc->getAnnotationsOfType('return');
-            if (\count($returnDocs) > 1) {
-                throw new \UnexpectedValueException(sprintf('Multiple `%s@return` annotations.', $methodId));
-            }
-            if (1 !== \count($returnDocs)) {
-                $this->addToAssertionCount(1); // no @return annotation, all good!
-
-                continue;
-            }
+            return;
+        }
 
-            $returnDoc = $returnDocs[0];
-            $types = $returnDoc->getTypes();
+        $returnDoc = $returnDocs[0];
+        $types = $returnDoc->getTypes();
 
-            self::assertCount(1, $types, sprintf('DataProvider `%s@return` must provide single type.', $methodId));
-            self::assertMatchesRegularExpression('/^iterable\</', $types[0], sprintf('DataProvider `%s@return` must return iterable.', $methodId));
-            self::assertMatchesRegularExpression('/^iterable\\<(?:(?:int\\|)?string, )?array\\{/', $types[0], sprintf('DataProvider `%s@return` must return iterable of tuples (eg `iterable<string, array{string, string}>`).', $methodId));
-        }
+        self::assertCount(1, $types, sprintf('DataProvider `%s@return` must provide single type.', $methodId));
+        self::assertMatchesRegularExpression('/^iterable\</', $types[0], sprintf('DataProvider `%s@return` must return iterable.', $methodId));
+        self::assertMatchesRegularExpression('/^iterable\\<(?:(?:int\\|)?string, )?array\\{/', $types[0], sprintf('DataProvider `%s@return` must return iterable of tuples (eg `iterable<string, array{string, string}>`).', $methodId));
     }
 
     /**