dumpType dummy function and rule

ondrejmirtes · ondrejmirtes · commit c24c8ef699a8 · 2020-11-04T13:26:39.000+01:00
diff --git a/composer.json b/composer.json
@@ -68,7 +68,8 @@
 			"PHPStan\\": [
 				"src/"
 			]
-		}
+		},
+		"files": ["src/dumpType.php"]
 	},
 	"autoload-dev": {
 		"psr-4": {
diff --git a/conf/config.neon b/conf/config.neon
@@ -268,6 +268,9 @@ parametersSchema:
 	# internal - static reflection
 	singleReflectionFile: schema(string(), nullable())
 
+rules:
+	- PHPStan\Rules\Debug\DumpTypeRule
+
 services:
 	-
 		class: PhpParser\BuilderFactory
diff --git a/src/Rules/Debug/DumpTypeRule.php b/src/Rules/Debug/DumpTypeRule.php
@@ -0,0 +1,63 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Debug;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\VerbosityLevel;
+
+/**
+ * @implements Rule<Node\Expr\FuncCall>
+ */
+class DumpTypeRule implements Rule
+{
+
+	private ReflectionProvider $reflectionProvider;
+
+	public function __construct(ReflectionProvider $reflectionProvider)
+	{
+		$this->reflectionProvider = $reflectionProvider;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Expr\FuncCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->name instanceof Node\Name) {
+			return [];
+		}
+
+		$functionName = $this->reflectionProvider->resolveFunctionName($node->name, $scope);
+		if ($functionName === null) {
+			return [];
+		}
+
+		if (strtolower($functionName) !== 'phpstan\dumptype') {
+			return [];
+		}
+
+		if (count($node->args) === 0) {
+			return [
+				RuleErrorBuilder::message(sprintf('Missing argument for %s() function call.', $functionName))
+					->nonIgnorable()
+					->build(),
+			];
+		}
+
+		return [
+			RuleErrorBuilder::message(
+				sprintf(
+					'Dumped type: %s',
+					$scope->getType($node->args[0]->value)->describe(VerbosityLevel::precise())
+				)
+			)->nonIgnorable()->build(),
+		];
+	}
+
+}
diff --git a/src/dumpType.php b/src/dumpType.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan;
+
+/**
+ * @param mixed $value
+ */
+function dumpType($value): void // phpcs:ignore Squiz.Functions.GlobalFunction.Found
+{
+}
diff --git a/tests/PHPStan/Rules/Debug/DumpTypeRuleTest.php b/tests/PHPStan/Rules/Debug/DumpTypeRuleTest.php
@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Debug;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<DumpTypeRule>
+ */
+class DumpTypeRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new DumpTypeRule($this->createReflectionProvider());
+	}
+
+	public function testRuleInPhpStanNamespace(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-type.php'], [
+			[
+				'Dumped type: array&nonEmpty',
+				10,
+			],
+			[
+				'Missing argument for PHPStan\dumpType() function call.',
+				11,
+			],
+		]);
+	}
+
+	public function testRuleInDifferentNamespace(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-type-ns.php'], [
+			[
+				'Dumped type: array&nonEmpty',
+				10,
+			],
+		]);
+	}
+
+	public function testRuleInUse(): void
+	{
+		$this->analyse([__DIR__ . '/data/dump-type-use.php'], [
+			[
+				'Dumped type: array&nonEmpty',
+				12,
+			],
+			[
+				'Dumped type: array&nonEmpty',
+				13,
+			],
+		]);
+	}
+
+}
diff --git a/tests/PHPStan/Rules/Debug/data/dump-type-ns.php b/tests/PHPStan/Rules/Debug/data/dump-type-ns.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Foo;
+
+function (array $a) {
+	if ($a === []) {
+		return;
+	}
+
+	\PHPStan\dumpType($a);
+	dumpType($a);
+};
diff --git a/tests/PHPStan/Rules/Debug/data/dump-type-use.php b/tests/PHPStan/Rules/Debug/data/dump-type-use.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Foo;
+
+use function PHPStan\dumpType;
+
+function (array $a) {
+	if ($a === []) {
+		return;
+	}
+
+	\PHPStan\dumpType($a);
+	dumpType($a);
+};
diff --git a/tests/PHPStan/Rules/Debug/data/dump-type.php b/tests/PHPStan/Rules/Debug/data/dump-type.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace PHPStan;
+
+function (array $a) {
+	if ($a === []) {
+		return;
+	}
+
+	dumpType($a);
+	dumpType();
+};

Original file line number	Diff line number	Diff line change
`@@ -268,6 +268,9 @@ parametersSchema:`
`268`	`268`	`# internal - static reflection`
`269`	`269`	`singleReflectionFile: schema(string(), nullable())`
`270`	`270`
	`271`	`+rules:`
	`272`	`+ - PHPStan\Rules\Debug\DumpTypeRule`
	`273`	`+`
`271`	`274`	`services:`
`272`	`275`	`-`
`273`	`276`	`class: PhpParser\BuilderFactory`