Remove the initial namespace separator from class names in one place (#…

…187) After removal, `\\Foo\\Bar` becomes `Foo\\Bar`. This was already done in several places, now there's a method for that.
spaze · Apr 25, 2023 · 084104a · 084104a
2 parents 2baf1ae + 5cd478f
commit 084104a
Show file tree

Hide file tree

Showing 42 changed files with 161 additions and 49 deletions.
diff --git a/src/DisallowedAttribute.php b/src/DisallowedAttribute.php
@@ -36,7 +36,7 @@ public function __construct(
 		?string $errorIdentifier,
 		?string $errorTip
 	) {
-		$this->attribute = ltrim($attribute, '\\');
+		$this->attribute = $attribute;
 		$this->message = $message;
 		$this->allowedConfig = $allowedConfig;
 		$this->errorIdentifier = $errorIdentifier;

diff --git a/src/DisallowedAttributeFactory.php b/src/DisallowedAttributeFactory.php
@@ -4,17 +4,22 @@
 namespace Spaze\PHPStan\Rules\Disallowed;
 
 use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
 class DisallowedAttributeFactory
 {
 
 	/** @var Allowed */
 	private $allowed;
 
+	/** @var Normalizer */
+	private $normalizer;
 
-	public function __construct(Allowed $allowed)
+
+	public function __construct(Allowed $allowed, Normalizer $normalizer)
 	{
 		$this->allowed = $allowed;
+		$this->normalizer = $normalizer;
 	}
 
 
@@ -31,7 +36,7 @@ public function createFromConfig(array $config): array
 			$attributes = $disallowed['attribute'];
 			foreach ((array)$attributes as $attribute) {
 				$disallowedAttribute = new DisallowedAttribute(
-					$attribute,
+					$this->normalizer->normalizeNamespace($attribute),
 					$disallowed['message'] ?? null,
 					$this->allowed->getConfig($disallowed),
 					$disallowed['errorIdentifier'] ?? null,

diff --git a/src/DisallowedConstant.php b/src/DisallowedConstant.php
@@ -43,7 +43,7 @@ public function __construct(
 		?string $errorIdentifier,
 		?string $errorTip
 	) {
-		$this->constant = ltrim($constant, '\\');
+		$this->constant = $constant;
 		$this->message = $message;
 		$this->allowIn = $allowIn;
 		$this->allowExceptIn = $allowExceptIn;

diff --git a/src/DisallowedConstantFactory.php b/src/DisallowedConstantFactory.php
@@ -4,10 +4,21 @@
 namespace Spaze\PHPStan\Rules\Disallowed;
 
 use PHPStan\ShouldNotHappenException;
+use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
 class DisallowedConstantFactory
 {
 
+	/** @var Normalizer */
+	private $normalizer;
+
+
+	public function __construct(Normalizer $normalizer)
+	{
+		$this->normalizer = $normalizer;
+	}
+
+
 	/**
 	 * @param array<array{class?:string, constant?:string, message?:string, allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], errorIdentifier?:string, errorTip?:string}> $config
 	 * @return DisallowedConstant[]
@@ -25,7 +36,7 @@ public function createFromConfig(array $config): array
 			foreach ((array)$constants as $constant) {
 				$class = $disallowed['class'] ?? null;
 				$disallowedConstant = new DisallowedConstant(
-					$class ? "{$class}::{$constant}" : $constant,
+					$this->normalizer->normalizeNamespace($class ? "{$class}::{$constant}" : $constant),
 					$disallowed['message'] ?? null,
 					$disallowed['allowIn'] ?? [],
 					$disallowed['allowExceptIn'] ?? $disallowed['disallowIn'] ?? [],

diff --git a/src/DisallowedNamespace.php b/src/DisallowedNamespace.php
@@ -43,7 +43,7 @@ public function __construct(
 		?string $errorIdentifier,
 		?string $errorTip
 	) {
-		$this->namespace = ltrim($namespace, '\\');
+		$this->namespace = $namespace;
 		$this->message = $message;
 		$this->allowIn = $allowIn;
 		$this->allowExceptIn = $allowExceptIn;

diff --git a/src/DisallowedNamespaceFactory.php b/src/DisallowedNamespaceFactory.php
@@ -4,10 +4,21 @@
 namespace Spaze\PHPStan\Rules\Disallowed;
 
 use PHPStan\ShouldNotHappenException;
+use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
 class DisallowedNamespaceFactory
 {
 
+	/** @var Normalizer */
+	private $normalizer;
+
+
+	public function __construct(Normalizer $normalizer)
+	{
+		$this->normalizer = $normalizer;
+	}
+
+
 	/**
 	 * @param array<array{namespace?:string, class?:string, message?:string, allowIn?:string[], allowExceptIn?:string[], disallowIn?:string[], errorIdentifier?:string, errorTip?:string}> $config
 	 * @return DisallowedNamespace[]
@@ -23,7 +34,7 @@ public function createFromConfig(array $config): array
 			}
 			foreach ((array)$namespaces as $namespace) {
 				$disallowedNamespace = new DisallowedNamespace(
-					$namespace,
+					$this->normalizer->normalizeNamespace($namespace),
 					$disallowed['message'] ?? null,
 					$disallowed['allowIn'] ?? [],
 					$disallowed['allowExceptIn'] ?? $disallowed['disallowIn'] ?? [],

diff --git a/src/Formatter/Formatter.php b/src/Formatter/Formatter.php
@@ -4,10 +4,21 @@
 namespace Spaze\PHPStan\Rules\Disallowed\Formatter;
 
 use PHPStan\Reflection\MethodReflection;
+use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
 class Formatter
 {
 
+	/** @var Normalizer */
+	private $normalizer;
+
+
+	public function __construct(Normalizer $normalizer)
+	{
+		$this->normalizer = $normalizer;
+	}
+
+
 	public function getFullyQualified(string $class, MethodReflection $method): string
 	{
 		return sprintf('%s::%s', $class, $method->getName());
@@ -20,7 +31,14 @@ public function getFullyQualified(string $class, MethodReflection $method): stri
 	 */
 	public function formatIdentifier(array $identifiers): string
 	{
-		return count($identifiers) === 1 ? $identifiers[0] : '{' . implode(',', $identifiers) . '}';
+		if (count($identifiers) === 1) {
+			return $this->normalizer->normalizeNamespace($identifiers[0]);
+		} else {
+			array_walk($identifiers, function (string &$identifier): void {
+				$identifier = $this->normalizer->normalizeNamespace($identifier);
+			});
+			return '{' . implode(',', $identifiers) . '}';
+		}
 	}
 
 }
diff --git a/src/Normalizer/Normalizer.php b/src/Normalizer/Normalizer.php
@@ -9,7 +9,13 @@ class Normalizer
 	public function normalizeCall(string $call): string
 	{
 		$call = substr($call, -2) === '()' ? substr($call, 0, -2) : $call;
-		return ltrim($call, '\\');
+		return $this->normalizeNamespace($call);
+	}
+
+
+	public function normalizeNamespace(string $namespace): string
+	{
+		return ltrim($namespace, '\\');
 	}
 
 }
diff --git a/src/RuleErrors/DisallowedConstantRuleErrors.php b/src/RuleErrors/DisallowedConstantRuleErrors.php
@@ -39,7 +39,7 @@ public function get(string $constant, Scope $scope, ?string $displayName, array
 				$errorBuilder = RuleErrorBuilder::message(sprintf(
 					'Using %s%s is forbidden, %s',
 					$disallowedConstant->getConstant(),
-					$displayName && ltrim($displayName, '\\') !== $disallowedConstant->getConstant() ? ' (as ' . $displayName . ')' : '',
+					$displayName && $displayName !== $disallowedConstant->getConstant() ? ' (as ' . $displayName . ')' : '',
 					$disallowedConstant->getMessage()
 				));
 				if ($disallowedConstant->getErrorIdentifier()) {

diff --git a/src/Usages/ClassConstantUsages.php b/src/Usages/ClassConstantUsages.php
@@ -95,7 +95,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($usedOnType->getConstantStrings()) {
 			$classNames = array_map(
 				function (ConstantStringType $constantString): string {
-					return ltrim($constantString->getValue(), '\\');
+					return $constantString->getValue();
 				},
 				$usedOnType->getConstantStrings()
 			);

diff --git a/src/Usages/NamespaceUsages.php b/src/Usages/NamespaceUsages.php
@@ -20,6 +20,7 @@
 use PHPStan\Rules\RuleError;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedNamespace;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedNamespaceFactory;
+use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedNamespaceRuleErrors;
 
 /**
@@ -34,16 +35,25 @@ class NamespaceUsages implements Rule
 	/** @var DisallowedNamespace[] */
 	private $disallowedNamespace;
 
+	/** @var Normalizer */
+	private $normalizer;
+
 
 	/**
 	 * @param DisallowedNamespaceRuleErrors $disallowedNamespaceRuleErrors
 	 * @param DisallowedNamespaceFactory $disallowNamespaceFactory
+	 * @param Normalizer $normalizer
 	 * @param array<array{namespace:string, message?:string, allowIn?:string[]}> $forbiddenNamespaces
 	 */
-	public function __construct(DisallowedNamespaceRuleErrors $disallowedNamespaceRuleErrors, DisallowedNamespaceFactory $disallowNamespaceFactory, array $forbiddenNamespaces)
-	{
+	public function __construct(
+		DisallowedNamespaceRuleErrors $disallowedNamespaceRuleErrors,
+		DisallowedNamespaceFactory $disallowNamespaceFactory,
+		Normalizer $normalizer,
+		array $forbiddenNamespaces
+	) {
 		$this->disallowedNamespaceRuleErrors = $disallowedNamespaceRuleErrors;
 		$this->disallowedNamespace = $disallowNamespaceFactory->createFromConfig($forbiddenNamespaces);
+		$this->normalizer = $normalizer;
 	}
 
 
@@ -108,7 +118,7 @@ public function processNode(Node $node, Scope $scope): array
 		foreach ($namespaces as $namespace) {
 			$errors = array_merge(
 				$errors,
-				$this->disallowedNamespaceRuleErrors->getDisallowedMessage(ltrim($namespace, '\\'), $description ?? 'Namespace', $scope, $this->disallowedNamespace)
+				$this->disallowedNamespaceRuleErrors->getDisallowedMessage($this->normalizer->normalizeNamespace($namespace), $description ?? 'Namespace', $scope, $this->disallowedNamespace)
 			);
 		}
 

diff --git a/tests/Calls/EchoCallsTest.php b/tests/Calls/EchoCallsTest.php
@@ -22,8 +22,8 @@ class EchoCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EchoCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/EmptyCallsTest.php b/tests/Calls/EmptyCallsTest.php
@@ -22,8 +22,8 @@ class EmptyCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EmptyCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/EvalCallsTest.php b/tests/Calls/EvalCallsTest.php
@@ -22,8 +22,8 @@ class EvalCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EvalCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/ExitDieCallsTest.php b/tests/Calls/ExitDieCallsTest.php
@@ -22,8 +22,8 @@ class ExitDieCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new ExitDieCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsAllowInFunctionsTest.php b/tests/Calls/FunctionCallsAllowInFunctionsTest.php
@@ -22,8 +22,8 @@ class FunctionCallsAllowInFunctionsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsAllowInMethodsTest.php b/tests/Calls/FunctionCallsAllowInMethodsTest.php
@@ -22,8 +22,8 @@ class FunctionCallsAllowInMethodsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsInMultipleNamespacesTest.php b/tests/Calls/FunctionCallsInMultipleNamespacesTest.php
@@ -22,8 +22,8 @@ class FunctionCallsInMultipleNamespacesTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsNamedParamsTest.php b/tests/Calls/FunctionCallsNamedParamsTest.php
@@ -25,8 +25,8 @@ class FunctionCallsNamedParamsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsTest.php b/tests/Calls/FunctionCallsTest.php
@@ -23,8 +23,8 @@ class FunctionCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php b/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php
@@ -23,8 +23,8 @@ public function testUnsupportedArrayInParamConfig(): void
 	{
 		$this->expectException(ShouldNotHappenException::class);
 		$this->expectExceptionMessage('{foo(),bar()}: Parameter #2 $definitelyNotScalar has an unsupported type array specified in configuration');
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		new FunctionCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/MethodCallsTest.php b/tests/Calls/MethodCallsTest.php
@@ -24,8 +24,8 @@ class MethodCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new MethodCalls(
 			new DisallowedMethodRuleErrors(

diff --git a/tests/Calls/NewCallsTest.php b/tests/Calls/NewCallsTest.php
@@ -22,8 +22,8 @@ class NewCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new NewCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/PrintCallsTest.php b/tests/Calls/PrintCallsTest.php
@@ -22,8 +22,8 @@ class PrintCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new PrintCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/ShellExecCallsTest.php b/tests/Calls/ShellExecCallsTest.php
@@ -22,8 +22,8 @@ class ShellExecCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new ShellExecCalls(
 			new DisallowedCallsRuleErrors($allowed),

diff --git a/tests/Calls/StaticCallsTest.php b/tests/Calls/StaticCallsTest.php
@@ -24,8 +24,8 @@ class StaticCallsTest extends RuleTestCase
 	 */
 	protected function getRule(): Rule
 	{
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new StaticCalls(
 			new DisallowedMethodRuleErrors(

diff --git a/tests/Configs/DangerousConfigEvalCallsTest.php b/tests/Configs/DangerousConfigEvalCallsTest.php
@@ -26,8 +26,8 @@ protected function getRule(): Rule
 	{
 		// Load the configuration from this file
 		$config = Neon::decode(file_get_contents(__DIR__ . '/../../disallowed-dangerous-calls.neon'));
-		$formatter = new Formatter();
 		$normalizer = new Normalizer();
+		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EvalCalls(
 			new DisallowedCallsRuleErrors($allowed),