Add rule to check @dataProvider

phpstan · Dec 7, 2022 · c206996 · c206996
1 parent b906029
commit c206996
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/rules.neon b/rules.neon
@@ -8,7 +8,10 @@ rules:
 services:
 	- class: PHPStan\Rules\PHPUnit\ClassCoversExistsRule
 	- class: PHPStan\Rules\PHPUnit\ClassMethodCoversExistsRule
-	- class: PHPStan\Rules\PHPUnit\DataProviderDeclarationRule
+	-
+		class: PHPStan\Rules\PHPUnit\DataProviderDeclarationRule
+		arguments:
+			checkFunctionNameCase: %checkFunctionNameCase%
 	- class: PHPStan\Rules\PHPUnit\NoMissingSpaceInClassAnnotationRule
 	- class: PHPStan\Rules\PHPUnit\NoMissingSpaceInMethodAnnotationRule
 

diff --git a/src/Rules/PHPUnit/DataProviderDeclarationRule.php b/src/Rules/PHPUnit/DataProviderDeclarationRule.php
@@ -29,13 +29,22 @@ class DataProviderDeclarationRule implements Rule
 	 */
 	private $fileTypeMapper;
 
+	/**
+	 * When set to true, it reports data provider method with incorrect name case.
+	 *
+	 * @var bool
+	 */
+	private $checkFunctionNameCase;
+
 	public function __construct(
 		DataProviderHelper $dataProviderHelper,
-		FileTypeMapper $fileTypeMapper
+		FileTypeMapper $fileTypeMapper,
+		bool $checkFunctionNameCase
 	)
 	{
 		$this->dataProviderHelper = $dataProviderHelper;
 		$this->fileTypeMapper = $fileTypeMapper;
+		$this->checkFunctionNameCase = $checkFunctionNameCase;
 	}
 
 	public function getNodeType(): string
@@ -71,7 +80,7 @@ public function processNode(Node $node, Scope $scope): array
 		foreach ($annotations as $annotation) {
 			$errors = array_merge(
 				$errors,
-				$this->dataProviderHelper->processDataProvider($scope, $annotation)
+				$this->dataProviderHelper->processDataProvider($scope, $annotation, $this->checkFunctionNameCase)
 			);
 		}
 

diff --git a/src/Rules/PHPUnit/DataProviderHelper.php b/src/Rules/PHPUnit/DataProviderHelper.php
@@ -11,7 +11,6 @@
 use function array_merge;
 use function preg_match;
 use function sprintf;
-use function trim;
 
 class DataProviderHelper
 {
@@ -44,7 +43,8 @@ public function getDataProviderAnnotations(?ResolvedPhpDocBlock $phpDoc): array
 	 */
 	public function processDataProvider(
 		Scope $scope,
-		PhpDocTagNode $phpDocTag
+		PhpDocTagNode $phpDocTag,
+		bool $checkFunctionNameCase
 	): array
 	{
 		$dataProviderName = $this->getDataProviderName($phpDocTag);
@@ -72,7 +72,7 @@ public function processDataProvider(
 
 		$errors = [];
 
-		if ($dataProviderName !== $dataProviderMethodReflection->getName()) {
+		if ($checkFunctionNameCase && $dataProviderName !== $dataProviderMethodReflection->getName()) {
 			$errors[] = RuleErrorBuilder::message(sprintf(
 				'@dataProvider %s related method is used with incorrect case: %s.',
 				$dataProviderName,
@@ -87,21 +87,12 @@ public function processDataProvider(
 			))->build();
 		}
 
-		if (!$dataProviderMethodReflection->isStatic()) {
-			$errors[] = RuleErrorBuilder::message(sprintf(
-				'@dataProvider %s related method must be static.',
-				$dataProviderName
-			))->build();
-		}
-
 		return $errors;
 	}
 
 	private function getDataProviderName(PhpDocTagNode $phpDocTag): ?string
 	{
-		$value = trim((string) $phpDocTag->value);
-
-		if (preg_match('/^[\S]+/', $value, $matches) !== 1) {
+		if (preg_match('/^[^ \t]+/', (string) $phpDocTag->value, $matches) !== 1) {
 			return null;
 		}
 

diff --git a/tests/Rules/PHPUnit/DataProviderDeclarationRuleTest.php b/tests/Rules/PHPUnit/DataProviderDeclarationRuleTest.php
@@ -16,7 +16,8 @@ protected function getRule(): Rule
 	{
 		return new DataProviderDeclarationRule(
 			new DataProviderHelper(),
-			self::getContainer()->getByType(FileTypeMapper::class)
+			self::getContainer()->getByType(FileTypeMapper::class),
+			true
 		);
 	}
 
@@ -27,10 +28,6 @@ public function testRule(): void
 				'@dataProvider providebaz related method is used with incorrect case: provideBaz.',
 				13,
 			],
-			[
-				'@dataProvider provideQux related method must be static.',
-				13,
-			],
 			[
 				'@dataProvider provideQuux related method must be public.',
 				13,