Extract creating disallowed objects into respective factories

spaze · Aug 2, 2021 · 0e73b99 · 0e73b99
1 parent c98448c
commit 0e73b99
Show file tree

Hide file tree

Showing 33 changed files with 189 additions and 102 deletions.
diff --git a/extension.neon b/extension.neon
@@ -56,7 +56,10 @@ parametersSchema:
 
 services:
 	- Spaze\PHPStan\Rules\Disallowed\FileHelper
+	- Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory
+	- Spaze\PHPStan\Rules\Disallowed\DisallowedConstantFactory
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedHelper
+	- Spaze\PHPStan\Rules\Disallowed\DisallowedNamespaceFactory
 	- Spaze\PHPStan\Rules\Disallowed\DisallowedNamespaceHelper
 	-
 		factory: Spaze\PHPStan\Rules\Disallowed\Usages\NamespaceUsages(forbiddenNamespaces: %disallowedNamespaces%)

diff --git a/src/Calls/EchoCalls.php b/src/Calls/EchoCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -29,15 +30,16 @@ class EchoCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/EmptyCalls.php b/src/Calls/EmptyCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -29,15 +30,16 @@ class EmptyCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/EvalCalls.php b/src/Calls/EvalCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -29,15 +30,16 @@ class EvalCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/ExitDieCalls.php b/src/Calls/ExitDieCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -29,15 +30,16 @@ class ExitDieCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/FunctionCalls.php b/src/Calls/FunctionCalls.php
@@ -10,6 +10,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -30,15 +31,16 @@ class FunctionCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/MethodCalls.php b/src/Calls/MethodCalls.php
@@ -10,6 +10,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -32,15 +33,16 @@ class MethodCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/NewCalls.php b/src/Calls/NewCalls.php
@@ -12,6 +12,7 @@
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ConstantScalarType;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -32,15 +33,16 @@ class NewCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/PrintCalls.php b/src/Calls/PrintCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -29,15 +30,16 @@ class PrintCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/ShellExecCalls.php b/src/Calls/ShellExecCalls.php
@@ -9,6 +9,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -33,15 +34,16 @@ class ShellExecCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/Calls/StaticCalls.php b/src/Calls/StaticCalls.php
@@ -10,6 +10,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedHelper;
 
 /**
@@ -32,15 +33,16 @@ class StaticCalls implements Rule
 
 	/**
 	 * @param DisallowedHelper $disallowedHelper
+	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
 	 * @throws ShouldNotHappenException
 	 */
-	public function __construct(DisallowedHelper $disallowedHelper, array $forbiddenCalls)
+	public function __construct(DisallowedHelper $disallowedHelper, DisallowedCallFactory $disallowedCallFactory, array $forbiddenCalls)
 	{
 		$this->disallowedHelper = $disallowedHelper;
-		$this->disallowedCalls = $this->disallowedHelper->createCallsFromConfig($forbiddenCalls);
+		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 	}
 
 

diff --git a/src/DisallowedCallFactory.php b/src/DisallowedCallFactory.php
@@ -0,0 +1,40 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed;
+
+use PHPStan\ShouldNotHappenException;
+
+class DisallowedCallFactory
+{
+
+	/**
+	 * @param array $config
+	 * @phpstan-param ForbiddenCallsConfig $config
+	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
+	 * @return DisallowedCall[]
+	 * @throws ShouldNotHappenException
+	 */
+	public function createFromConfig(array $config): array
+	{
+		$calls = [];
+		foreach ($config as $disallowedCall) {
+			$call = $disallowedCall['function'] ?? $disallowedCall['method'] ?? null;
+			if (!$call) {
+				throw new ShouldNotHappenException("Either 'method' or 'function' must be set in configuration items");
+			}
+			$disallowedCall = new DisallowedCall(
+				$call,
+				$disallowedCall['message'] ?? null,
+				$disallowedCall['allowIn'] ?? [],
+				$disallowedCall['allowParamsInAllowed'] ?? [],
+				$disallowedCall['allowParamsAnywhere'] ?? [],
+				$disallowedCall['allowExceptParams'] ?? [],
+				$disallowedCall['allowExceptCaseInsensitiveParams'] ?? []
+			);
+			$calls[$disallowedCall->getKey()] = $disallowedCall;
+		}
+		return array_values($calls);
+	}
+
+}
diff --git a/src/DisallowedConstantFactory.php b/src/DisallowedConstantFactory.php
@@ -0,0 +1,35 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed;
+
+use PHPStan\ShouldNotHappenException;
+
+class DisallowedConstantFactory
+{
+
+	/**
+	 * @param array<array{class?:string, constant?:string, message?:string, allowIn?:string[]}> $config
+	 * @return DisallowedConstant[]
+	 * @throws ShouldNotHappenException
+	 */
+	public function createFromConfig(array $config): array
+	{
+		$constants = [];
+		foreach ($config as $disallowedConstant) {
+			$constant = $disallowedConstant['constant'] ?? null;
+			if (!$constant) {
+				throw new ShouldNotHappenException("'constant' must be set in configuration items");
+			}
+			$class = $disallowedConstant['class'] ?? null;
+			$disallowedConstant = new DisallowedConstant(
+				$class ? "{$class}::{$constant}" : $constant,
+				$disallowedConstant['message'] ?? null,
+				$disallowedConstant['allowIn'] ?? []
+			);
+			$constants[$disallowedConstant->getConstant()] = $disallowedConstant;
+		}
+		return array_values($constants);
+	}
+
+}