A new identifier matching service

spaze · May 26, 2023 · 245c927 · 245c927
1 parent ed205b4
commit 245c927
Show file tree

Hide file tree

Showing 32 changed files with 160 additions and 60 deletions.
diff --git a/extension.neon b/extension.neon
@@ -99,6 +99,7 @@ services:
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedNamespaceFactory
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedSuperglobalFactory
 	- Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter
+	- Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier
 	- Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer
 	- Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedAttributeRuleErrors
 	- Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedConstantRuleErrors

diff --git a/src/Identifier/Identifier.php b/src/Identifier/Identifier.php
@@ -0,0 +1,25 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed\Identifier;
+
+class Identifier
+{
+
+	/**
+	 * @param string $pattern
+	 * @param string $value
+	 * @return bool
+	 */
+	public function matches(string $pattern, string $value): bool
+	{
+		$matches = false;
+		if ($pattern === $value) {
+			$matches = true;
+		} elseif (fnmatch($pattern, $value, FNM_NOESCAPE | FNM_CASEFOLD)) {
+			$matches = true;
+		}
+		return $matches;
+	}
+
+}
diff --git a/src/RuleErrors/DisallowedAttributeRuleErrors.php b/src/RuleErrors/DisallowedAttributeRuleErrors.php
@@ -9,17 +9,22 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\Allowed;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedAttribute;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 
 class DisallowedAttributeRuleErrors
 {
 
 	/** @var Allowed */
 	private $allowed;
 
+	/** @var Identifier */
+	private $identifier;
 
-	public function __construct(Allowed $allowed)
+
+	public function __construct(Allowed $allowed, Identifier $identifier)
 	{
 		$this->allowed = $allowed;
+		$this->identifier = $identifier;
 	}
 
 
@@ -33,7 +38,7 @@ public function get(Attribute $attribute, Scope $scope, array $disallowedAttribu
 	{
 		foreach ($disallowedAttributes as $disallowedAttribute) {
 			$attributeName = $attribute->name->toString();
-			if (!$this->matchesAttribute($disallowedAttribute->getAttribute(), $attributeName)) {
+			if (!$this->identifier->matches($disallowedAttribute->getAttribute(), $attributeName)) {
 				continue;
 			}
 			if ($this->allowed->isAllowed($scope, $attribute->args, $disallowedAttribute)) {
@@ -60,18 +65,4 @@ public function get(Attribute $attribute, Scope $scope, array $disallowedAttribu
 		return [];
 	}
 
-
-	private function matchesAttribute(string $pattern, string $value): bool
-	{
-		if ($pattern === $value) {
-			return true;
-		}
-
-		if (fnmatch($pattern, $value, FNM_NOESCAPE | FNM_CASEFOLD)) {
-			return true;
-		}
-
-		return false;
-	}
-
 }
diff --git a/src/RuleErrors/DisallowedCallsRuleErrors.php b/src/RuleErrors/DisallowedCallsRuleErrors.php
@@ -10,17 +10,22 @@
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\Allowed;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 
 class DisallowedCallsRuleErrors
 {
 
 	/** @var Allowed */
 	private $allowed;
 
+	/** @var Identifier */
+	private $identifier;
 
-	public function __construct(Allowed $allowed)
+
+	public function __construct(Allowed $allowed, Identifier $identifier)
 	{
 		$this->allowed = $allowed;
+		$this->identifier = $identifier;
 	}
 
 
@@ -37,7 +42,7 @@ public function __construct(Allowed $allowed)
 	public function get(?CallLike $node, Scope $scope, string $name, ?string $displayName, array $disallowedCalls, ?string $message = null): array
 	{
 		foreach ($disallowedCalls as $disallowedCall) {
-			$callMatches = $name === $disallowedCall->getCall() || fnmatch($disallowedCall->getCall(), $name, FNM_NOESCAPE | FNM_CASEFOLD);
+			$callMatches = $this->identifier->matches($disallowedCall->getCall(), $name);
 			if ($callMatches && !$this->allowed->isAllowed($scope, isset($node) ? $node->getArgs() : null, $disallowedCall)) {
 				$errorBuilder = RuleErrorBuilder::message(sprintf(
 					$message ?? 'Calling %s is forbidden, %s%s',

diff --git a/src/RuleErrors/DisallowedNamespaceRuleErrors.php b/src/RuleErrors/DisallowedNamespaceRuleErrors.php
@@ -8,17 +8,22 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedNamespace;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 
 class DisallowedNamespaceRuleErrors
 {
 
 	/** @var AllowedPath */
 	private $allowedPath;
 
+	/** @var Identifier */
+	private $identifier;
 
-	public function __construct(AllowedPath $allowedPath)
+
+	public function __construct(AllowedPath $allowedPath, Identifier $identifier)
 	{
 		$this->allowedPath = $allowedPath;
+		$this->identifier = $identifier;
 	}
 
 
@@ -36,7 +41,7 @@ public function getDisallowedMessage(string $namespace, string $description, Sco
 				continue;
 			}
 
-			if (!$this->matchesNamespace($disallowedNamespace->getNamespace(), $namespace)) {
+			if (!$this->identifier->matches($disallowedNamespace->getNamespace(), $namespace)) {
 				continue;
 			}
 
@@ -61,18 +66,4 @@ public function getDisallowedMessage(string $namespace, string $description, Sco
 		return [];
 	}
 
-
-	private function matchesNamespace(string $pattern, string $value): bool
-	{
-		if ($pattern === $value) {
-			return true;
-		}
-
-		if (fnmatch($pattern, $value, FNM_NOESCAPE | FNM_CASEFOLD)) {
-			return true;
-		}
-
-		return false;
-	}
-
 }
diff --git a/tests/Calls/EchoCallsTest.php b/tests/Calls/EchoCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EchoCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/EmptyCallsTest.php b/tests/Calls/EmptyCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EmptyCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/EvalCallsTest.php b/tests/Calls/EvalCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new EvalCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/ExitDieCallsTest.php b/tests/Calls/ExitDieCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new ExitDieCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsAllowInFunctionsTest.php b/tests/Calls/FunctionCallsAllowInFunctionsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsAllowInMethodsTest.php b/tests/Calls/FunctionCallsAllowInMethodsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsInMultipleNamespacesTest.php b/tests/Calls/FunctionCallsInMultipleNamespacesTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsNamedParamsTest.php b/tests/Calls/FunctionCallsNamedParamsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -29,7 +30,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsTest.php b/tests/Calls/FunctionCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 use Waldo\Quux\Blade;
@@ -27,7 +28,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php b/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php
@@ -10,6 +10,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -27,7 +28,7 @@ public function testUnsupportedArrayInParamConfig(): void
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		new FunctionCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/MethodCallsTest.php b/tests/Calls/MethodCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedMethodRuleErrors;
@@ -29,7 +30,7 @@ protected function getRule(): Rule
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new MethodCalls(
 			new DisallowedMethodRuleErrors(
-				new DisallowedCallsRuleErrors($allowed),
+				new DisallowedCallsRuleErrors($allowed, new Identifier()),
 				new TypeResolver(),
 				$formatter
 			),

diff --git a/tests/Calls/NewCallsTest.php b/tests/Calls/NewCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new NewCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[

diff --git a/tests/Calls/PrintCallsTest.php b/tests/Calls/PrintCallsTest.php
@@ -11,6 +11,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedPath;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
+use Spaze\PHPStan\Rules\Disallowed\Identifier\Identifier;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 
@@ -26,7 +27,7 @@ protected function getRule(): Rule
 		$formatter = new Formatter($normalizer);
 		$allowed = new Allowed($formatter, $normalizer, new AllowedPath(new FileHelper(__DIR__)));
 		return new PrintCalls(
-			new DisallowedCallsRuleErrors($allowed),
+			new DisallowedCallsRuleErrors($allowed, new Identifier()),
 			new DisallowedCallFactory($formatter, $normalizer, $allowed),
 			[
 				[