Format classnames and function names etc. in one place

spaze · Mar 20, 2023 · d598c89 · d598c89
1 parent 9006bb3
commit d598c89
Show file tree

Hide file tree

Showing 30 changed files with 123 additions and 33 deletions.
diff --git a/extension.neon b/extension.neon
@@ -85,6 +85,7 @@ services:
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedConstantFactory
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedNamespaceFactory
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedSuperglobalFactory
+	- Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter
 	- Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedConstantRuleErrors
 	- Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedMethodRuleErrors
 	- Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedNamespaceRuleErrors

diff --git a/src/DisallowedCallFactory.php b/src/DisallowedCallFactory.php
@@ -16,6 +16,16 @@
 class DisallowedCallFactory
 {
 
+	/** @var IdentifierFormatter */
+	private $identifierFormatter;
+
+
+	public function __construct(IdentifierFormatter $identifierFormatter)
+	{
+		$this->identifierFormatter = $identifierFormatter;
+	}
+
+
 	/**
 	 * @param array $config
 	 * @phpstan-param ForbiddenCallsConfig $config
@@ -92,8 +102,7 @@ public function createFromConfig(array $config): array
 					$disallowedCalls[$disallowedCall->getKey()] = $disallowedCall;
 				}
 			} catch (UnsupportedParamTypeInConfigException $e) {
-				$message = count($calls) === 1 ? $calls[0] : '{' . implode(',', $calls) . '}';
-				throw new ShouldNotHappenException("{$message}: {$e->getMessage()}");
+				throw new ShouldNotHappenException(sprintf('%s: %s', $this->identifierFormatter->format($calls), $e->getMessage()));
 			}
 		}
 		return array_values($disallowedCalls);

diff --git a/src/IdentifierFormatter.php b/src/IdentifierFormatter.php
@@ -0,0 +1,18 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed;
+
+class IdentifierFormatter
+{
+
+	/**
+	 * @param list<string> $identifiers
+	 * @return string
+	 */
+	public function format(array $identifiers): string
+	{
+		return count($identifiers) === 1 ? $identifiers[0] : '{' . implode(',', $identifiers) . '}';
+	}
+
+}
diff --git a/src/RuleErrors/DisallowedMethodRuleErrors.php b/src/RuleErrors/DisallowedMethodRuleErrors.php
@@ -13,6 +13,7 @@
 use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class DisallowedMethodRuleErrors
@@ -24,11 +25,15 @@ class DisallowedMethodRuleErrors
 	/** @var TypeResolver */
 	private $typeResolver;
 
+	/** @var IdentifierFormatter */
+	private $identifierFormatter;
 
-	public function __construct(DisallowedRuleErrors $disallowedRuleErrors, TypeResolver $typeResolver)
+
+	public function __construct(DisallowedRuleErrors $disallowedRuleErrors, TypeResolver $typeResolver, IdentifierFormatter $identifierFormatter)
 	{
 		$this->disallowedRuleErrors = $disallowedRuleErrors;
 		$this->typeResolver = $typeResolver;
+		$this->identifierFormatter = $identifierFormatter;
 	}
 
 
@@ -52,10 +57,8 @@ public function get($class, CallLike $node, Scope $scope, array $disallowedCalls
 			$classNames = $calledOnType->getObjectClassNames();
 			if (count($classNames) === 0) {
 				$calledAs = null;
-			} elseif (count($classNames) === 1) {
-				$calledAs = $this->disallowedRuleErrors->getFullyQualified($classNames[0], $method);
 			} else {
-				$calledAs = $this->disallowedRuleErrors->getFullyQualified('{' . implode(',', $classNames) . '}', $method);
+				$calledAs = $this->disallowedRuleErrors->getFullyQualified($this->identifierFormatter->format($classNames), $method);
 			}
 
 			foreach ($method->getDeclaringClass()->getTraits() as $trait) {

diff --git a/src/Usages/ClassConstantUsages.php b/src/Usages/ClassConstantUsages.php
@@ -15,6 +15,7 @@
 use PHPStan\Type\VerbosityLevel;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedConstant;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedConstantFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedConstantRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
@@ -33,6 +34,9 @@ class ClassConstantUsages implements Rule
 	/** @var TypeResolver */
 	private $typeResolver;
 
+	/** @var IdentifierFormatter */
+	private $identifierFormatter;
+
 	/** @var DisallowedConstant[] */
 	private $disallowedConstants;
 
@@ -41,17 +45,20 @@ class ClassConstantUsages implements Rule
 	 * @param DisallowedConstantRuleErrors $disallowedConstantRuleErrors
 	 * @param DisallowedConstantFactory $disallowedConstantFactory
 	 * @param TypeResolver $typeResolver
+	 * @param IdentifierFormatter $identifierFormatter
 	 * @param array<array{class?:string, constant?:string, message?:string, allowIn?:string[]}> $disallowedConstants
 	 * @throws ShouldNotHappenException
 	 */
 	public function __construct(
 		DisallowedConstantRuleErrors $disallowedConstantRuleErrors,
 		DisallowedConstantFactory $disallowedConstantFactory,
 		TypeResolver $typeResolver,
+		IdentifierFormatter $identifierFormatter,
 		array $disallowedConstants
 	) {
 		$this->disallowedConstantRuleErrors = $disallowedConstantRuleErrors;
 		$this->typeResolver = $typeResolver;
+		$this->identifierFormatter = $identifierFormatter;
 		$this->disallowedConstants = $disallowedConstantFactory->createFromConfig($disallowedConstants);
 	}
 
@@ -115,8 +122,7 @@ function (ConstantStringType $constantString): string {
 	 */
 	private function getFullyQualified(array $classNames, string $constant): string
 	{
-		$className = count($classNames) === 1 ? $classNames[0] : '{' . implode(',', $classNames) . '}';
-		return $className . '::' . $constant;
+		return $this->identifierFormatter->format($classNames) . '::' . $constant;
 	}
 
 }
diff --git a/tests/Calls/EchoCallsTest.php b/tests/Calls/EchoCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class EchoCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new EchoCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'echo()',

diff --git a/tests/Calls/EmptyCallsTest.php b/tests/Calls/EmptyCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class EmptyCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new EmptyCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'empty()',

diff --git a/tests/Calls/EvalCallsTest.php b/tests/Calls/EvalCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class EvalCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new EvalCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'eval()',

diff --git a/tests/Calls/ExitDieCallsTest.php b/tests/Calls/ExitDieCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class ExitDieCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new ExitDieCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => [

diff --git a/tests/Calls/FunctionCallsAllowInFunctionsTest.php b/tests/Calls/FunctionCallsAllowInFunctionsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class FunctionCallsAllowInFunctionsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'md*()',

diff --git a/tests/Calls/FunctionCallsAllowInMethodsTest.php b/tests/Calls/FunctionCallsAllowInMethodsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class FunctionCallsAllowInMethodsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'md5_file()',

diff --git a/tests/Calls/FunctionCallsInMultipleNamespacesTest.php b/tests/Calls/FunctionCallsInMultipleNamespacesTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class FunctionCallsInMultipleNamespacesTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => '__()',

diff --git a/tests/Calls/FunctionCallsNamedParamsTest.php b/tests/Calls/FunctionCallsNamedParamsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 /**
@@ -24,7 +25,7 @@ protected function getRule(): Rule
 	{
 		return new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'Foo\Bar\Waldo\foo()',

diff --git a/tests/Calls/FunctionCallsTest.php b/tests/Calls/FunctionCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 use Waldo\Quux\Blade;
 
@@ -22,7 +23,7 @@ protected function getRule(): Rule
 	{
 		return new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => '\var_dump()',

diff --git a/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php b/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php
@@ -8,6 +8,7 @@
 use PHPStan\Testing\PHPStanTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class FunctionCallsUnsupportedParamConfigTest extends PHPStanTestCase
@@ -22,7 +23,7 @@ public function testUnsupportedArrayInParamConfig(): void
 		$this->expectExceptionMessage('{foo(),bar()}: Parameter #2 $definitelyNotScalar has an unsupported type array specified in configuration');
 		new FunctionCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => [

diff --git a/tests/Calls/MethodCallsTest.php b/tests/Calls/MethodCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedMethodRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
@@ -22,8 +23,8 @@ class MethodCallsTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new MethodCalls(
-			new DisallowedMethodRuleErrors(new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))), new TypeResolver()),
-			new DisallowedCallFactory(),
+			new DisallowedMethodRuleErrors(new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))), new TypeResolver(), new IdentifierFormatter()),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'method' => 'Waldo\Quux\Blade::run*()',

diff --git a/tests/Calls/NewCallsTest.php b/tests/Calls/NewCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class NewCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new NewCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'method' => '\Constructor\ClassWithConstructor::__construct()',

diff --git a/tests/Calls/PrintCallsTest.php b/tests/Calls/PrintCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class PrintCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new PrintCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'print()',

diff --git a/tests/Calls/ShellExecCallsTest.php b/tests/Calls/ShellExecCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 
 class ShellExecCallsTest extends RuleTestCase
@@ -21,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new ShellExecCalls(
 			new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))),
-			new DisallowedCallFactory(),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'function' => 'shell_*()',

diff --git a/tests/Calls/StaticCallsTest.php b/tests/Calls/StaticCallsTest.php
@@ -9,6 +9,7 @@
 use PHPStan\Testing\RuleTestCase;
 use Spaze\PHPStan\Rules\Disallowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\IdentifierFormatter;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedMethodRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
@@ -22,8 +23,8 @@ class StaticCallsTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new StaticCalls(
-			new DisallowedMethodRuleErrors(new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))), new TypeResolver()),
-			new DisallowedCallFactory(),
+			new DisallowedMethodRuleErrors(new DisallowedRuleErrors(new AllowedPath(new FileHelper(__DIR__))), new TypeResolver(), new IdentifierFormatter()),
+			new DisallowedCallFactory(new IdentifierFormatter()),
 			[
 				[
 					'method' => 'Fiction\Pulp\Royale::withCheese()',