Use camelCase config parameters (old ones still work)

lookyman · ondrejmirtes · commit 39ac41f418dd · 2022-01-09T13:08:20.000+01:00
diff --git a/README.md b/README.md
@@ -61,11 +61,11 @@ You have to provide a path to `srcDevDebugProjectContainer.xml` or similar XML f
 ```yaml
 parameters:
     symfony:
-        container_xml_path: var/cache/dev/srcDevDebugProjectContainer.xml
+        containerXmlPath: var/cache/dev/srcDevDebugProjectContainer.xml
         # or with Symfony 4.2+
-        container_xml_path: var/cache/dev/srcApp_KernelDevDebugContainer.xml
+        containerXmlPath: var/cache/dev/srcApp_KernelDevDebugContainer.xml
         # or with Symfony 5+
-        container_xml_path: var/cache/dev/App_KernelDevDebugContainer.xml
+        containerXmlPath: var/cache/dev/App_KernelDevDebugContainer.xml
     # If you're using PHP config files for Symfony 5.3+, you also need this for auto-loading of `Symfony\Config`:
     scanDirectories:
         - var/cache/dev/Symfony/Config
@@ -86,7 +86,7 @@ In that case, you can disable the `::has()` method return type resolving like th
 ```
 parameters:
 	symfony:
-		constant_hassers: false
+		constantHassers: false
 ```
 
 Be aware that it may hide genuine errors in your application.
@@ -99,7 +99,7 @@ by providing the console application from your own application. This will allow
 ```neon
 parameters:
 	symfony:
-		console_application_loader: tests/console-application.php
+		consoleApplicationLoader: tests/console-application.php
 ```
 
 Symfony 4:
diff --git a/extension.neon b/extension.neon
@@ -6,8 +6,11 @@ parameters:
 			- 'Symfony\Component\Console\Exception\InvalidArgumentException'
 	symfony:
 		container_xml_path: null
+		containerXmlPath: null
 		constant_hassers: true
+		constantHassers: true
 		console_application_loader: null
+		consoleApplicationLoader: null
 	stubFiles:
 		- stubs/Symfony/Bundle/FrameworkBundle/KernelBrowser.stub
 		- stubs/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.stub
@@ -53,43 +56,47 @@ parameters:
 parametersSchema:
 	symfony: structure([
 		container_xml_path: schema(string(), nullable())
+		containerXmlPath: schema(string(), nullable())
 		constant_hassers: bool()
+		constantHassers: bool()
 		console_application_loader: schema(string(), nullable())
+		consoleApplicationLoader: schema(string(), nullable())
 	])
 
 services:
+	-
+		factory: PHPStan\Symfony\Configuration(%symfony%)
+
 	# console resolver
 	-
 		factory: PHPStan\Symfony\ConsoleApplicationResolver
-		arguments:
-		    consoleApplicationLoader: %symfony.console_application_loader%
 
 	# service map
 	symfony.serviceMapFactory:
 		class: PHPStan\Symfony\ServiceMapFactory
-		factory: PHPStan\Symfony\XmlServiceMapFactory(%symfony.container_xml_path%)
+		factory: PHPStan\Symfony\XmlServiceMapFactory
 	-
 		factory: @symfony.serviceMapFactory::create()
 
 	# parameter map
 	symfony.parameterMapFactory:
 		class: PHPStan\Symfony\ParameterMapFactory
-		factory: PHPStan\Symfony\XmlParameterMapFactory(%symfony.container_xml_path%)
+		factory: PHPStan\Symfony\XmlParameterMapFactory
 	-
 		factory: @symfony.parameterMapFactory::create()
 
 	# ControllerTrait::get()/has() return type
 	-
-		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ContainerInterface, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ContainerInterface)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Psr\Container\ContainerInterface, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Psr\Container\ContainerInterface)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 
 	# ControllerTrait::has() type specification
@@ -233,20 +240,20 @@ services:
 
 	# ParameterBagInterface::get()/has() return type
 	-
-		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface, 'get', 'has', %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface, 'get', 'has')
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 
 	# ContainerInterface::getParameter()/hasParameter() return type
 	-
-		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ContainerInterface, 'getParameter', 'hasParameter', %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ContainerInterface, 'getParameter', 'hasParameter')
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 
 	# (Abstract)Controller::getParameter() return type
 	-
-		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController, 'getParameter', null, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController, 'getParameter', null)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller, 'getParameter', null, %symfony.constant_hassers%)
+		factory: PHPStan\Type\Symfony\ParameterDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller, 'getParameter', null)
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: PHPStan\Symfony\InputBagStubFilesExtension
diff --git a/src/Symfony/Configuration.php b/src/Symfony/Configuration.php
@@ -0,0 +1,34 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+final class Configuration
+{
+
+	/** @var array<string, mixed> */
+	private $parameters;
+
+	/**
+	 * @param array<string, mixed> $parameters
+	 */
+	public function __construct(array $parameters)
+	{
+		$this->parameters = $parameters;
+	}
+
+	public function getContainerXmlPath(): ?string
+	{
+		return $this->parameters['containerXmlPath'] ?? $this->parameters['container_xml_path'] ?? null;
+	}
+
+	public function hasConstantHassers(): bool
+	{
+		return $this->parameters['constantHassers'] ?? $this->parameters['constant_hassers'] ?? true;
+	}
+
+	public function getConsoleApplicationLoader(): ?string
+	{
+		return $this->parameters['consoleApplicationLoader'] ?? $this->parameters['console_application_loader'] ?? null;
+	}
+
+}
diff --git a/src/Symfony/ConsoleApplicationResolver.php b/src/Symfony/ConsoleApplicationResolver.php
@@ -16,8 +16,9 @@ final class ConsoleApplicationResolver
 	/** @var \Symfony\Component\Console\Application|null */
 	private $consoleApplication;
 
-	public function __construct(?string $consoleApplicationLoader)
+	public function __construct(Configuration $configuration)
 	{
+		$consoleApplicationLoader = $configuration->getConsoleApplicationLoader();
 		if ($consoleApplicationLoader === null) {
 			return;
 		}
diff --git a/src/Symfony/XmlParameterMapFactory.php b/src/Symfony/XmlParameterMapFactory.php
@@ -10,9 +10,9 @@ final class XmlParameterMapFactory implements ParameterMapFactory
 	/** @var string|null */
 	private $containerXml;
 
-	public function __construct(?string $containerXml)
+	public function __construct(Configuration $configuration)
 	{
-		$this->containerXml = $containerXml;
+		$this->containerXml = $configuration->getContainerXmlPath();
 	}
 
 	public function create(): ParameterMap
diff --git a/src/Symfony/XmlServiceMapFactory.php b/src/Symfony/XmlServiceMapFactory.php
@@ -13,9 +13,9 @@ final class XmlServiceMapFactory implements ServiceMapFactory
 	/** @var string|null */
 	private $containerXml;
 
-	public function __construct(?string $containerXml)
+	public function __construct(Configuration $configuration)
 	{
-		$this->containerXml = $containerXml;
+		$this->containerXml = $configuration->getContainerXmlPath();
 	}
 
 	public function create(): ServiceMap
diff --git a/src/Type/Symfony/ParameterDynamicReturnTypeExtension.php b/src/Type/Symfony/ParameterDynamicReturnTypeExtension.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\ParameterMap;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\BooleanType;
@@ -43,12 +44,12 @@ final class ParameterDynamicReturnTypeExtension implements DynamicMethodReturnTy
 	/** @var \PHPStan\Symfony\ParameterMap */
 	private $parameterMap;
 
-	public function __construct(string $className, ?string $methodGet, ?string $methodHas, bool $constantHassers, ParameterMap $symfonyParameterMap)
+	public function __construct(string $className, ?string $methodGet, ?string $methodHas, Configuration $configuration, ParameterMap $symfonyParameterMap)
 	{
 		$this->className = $className;
 		$this->methodGet = $methodGet;
 		$this->methodHas = $methodHas;
-		$this->constantHassers = $constantHassers;
+		$this->constantHassers = $configuration->hasConstantHassers();
 		$this->parameterMap = $symfonyParameterMap;
 	}
 
diff --git a/src/Type/Symfony/ServiceDynamicReturnTypeExtension.php b/src/Type/Symfony/ServiceDynamicReturnTypeExtension.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\ServiceMap;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
@@ -26,10 +27,10 @@ final class ServiceDynamicReturnTypeExtension implements DynamicMethodReturnType
 	/** @var \PHPStan\Symfony\ServiceMap */
 	private $serviceMap;
 
-	public function __construct(string $className, bool $constantHassers, ServiceMap $symfonyServiceMap)
+	public function __construct(string $className, Configuration $configuration, ServiceMap $symfonyServiceMap)
 	{
 		$this->className = $className;
-		$this->constantHassers = $constantHassers;
+		$this->constantHassers = $configuration->hasConstantHassers();
 		$this->serviceMap = $symfonyServiceMap;
 	}
 
diff --git a/tests/Rules/Symfony/ContainerInterfacePrivateServiceRuleFakeTest.php b/tests/Rules/Symfony/ContainerInterfacePrivateServiceRuleFakeTest.php
@@ -3,6 +3,7 @@
 namespace PHPStan\Rules\Symfony;
 
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\XmlServiceMapFactory;
 use PHPStan\Testing\RuleTestCase;
 
@@ -14,7 +15,7 @@ final class ContainerInterfacePrivateServiceRuleFakeTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(null))->create());
+		return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(new Configuration([])))->create());
 	}
 
 	public function testGetPrivateService(): void
diff --git a/tests/Rules/Symfony/ContainerInterfacePrivateServiceRuleTest.php b/tests/Rules/Symfony/ContainerInterfacePrivateServiceRuleTest.php
@@ -3,6 +3,7 @@
 namespace PHPStan\Rules\Symfony;
 
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\XmlServiceMapFactory;
 use PHPStan\Testing\RuleTestCase;
 
@@ -14,7 +15,7 @@ final class ContainerInterfacePrivateServiceRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(__DIR__ . '/container.xml'))->create());
+		return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/container.xml'])))->create());
 	}
 
 	public function testGetPrivateService(): void
diff --git a/tests/Rules/Symfony/ContainerInterfaceUnknownServiceRuleFakeTest.php b/tests/Rules/Symfony/ContainerInterfaceUnknownServiceRuleFakeTest.php
@@ -4,6 +4,7 @@
 
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\XmlServiceMapFactory;
 use PHPStan\Testing\RuleTestCase;
 use PHPStan\Type\Symfony\ServiceTypeSpecifyingExtension;
@@ -16,7 +17,7 @@ final class ContainerInterfaceUnknownServiceRuleFakeTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new ContainerInterfaceUnknownServiceRule((new XmlServiceMapFactory(null))->create(), new Standard());
+		return new ContainerInterfaceUnknownServiceRule((new XmlServiceMapFactory(new Configuration([])))->create(), new Standard());
 	}
 
 	/**
diff --git a/tests/Rules/Symfony/ContainerInterfaceUnknownServiceRuleTest.php b/tests/Rules/Symfony/ContainerInterfaceUnknownServiceRuleTest.php
@@ -4,6 +4,7 @@
 
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\XmlServiceMapFactory;
 use PHPStan\Testing\RuleTestCase;
 
@@ -15,7 +16,7 @@ final class ContainerInterfaceUnknownServiceRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new ContainerInterfaceUnknownServiceRule((new XmlServiceMapFactory(__DIR__ . '/container.xml'))->create(), new Standard());
+		return new ContainerInterfaceUnknownServiceRule((new XmlServiceMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/container.xml'])))->create(), new Standard());
 	}
 
 	public function testGetPrivateService(): void
diff --git a/tests/Rules/Symfony/UndefinedArgumentRuleTest.php b/tests/Rules/Symfony/UndefinedArgumentRuleTest.php
@@ -4,6 +4,7 @@
 
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\ConsoleApplicationResolver;
 use PHPStan\Testing\RuleTestCase;
 
@@ -15,7 +16,7 @@ final class UndefinedArgumentRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new UndefinedArgumentRule(new ConsoleApplicationResolver(__DIR__ . '/console_application_loader.php'), new Standard());
+		return new UndefinedArgumentRule(new ConsoleApplicationResolver(new Configuration(['consoleApplicationLoader' => __DIR__ . '/console_application_loader.php'])), new Standard());
 	}
 
 	public function testGetArgument(): void
diff --git a/tests/Rules/Symfony/UndefinedOptionRuleTest.php b/tests/Rules/Symfony/UndefinedOptionRuleTest.php
@@ -4,6 +4,7 @@
 
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Rules\Rule;
+use PHPStan\Symfony\Configuration;
 use PHPStan\Symfony\ConsoleApplicationResolver;
 use PHPStan\Testing\RuleTestCase;
 
@@ -15,7 +16,7 @@ final class UndefinedOptionRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new UndefinedOptionRule(new ConsoleApplicationResolver(__DIR__ . '/console_application_loader.php'), new Standard());
+		return new UndefinedOptionRule(new ConsoleApplicationResolver(new Configuration(['consoleApplicationLoader' => __DIR__ . '/console_application_loader.php'])), new Standard());
 	}
 
 	public function testGetArgument(): void
diff --git a/tests/Symfony/DefaultParameterMapTest.php b/tests/Symfony/DefaultParameterMapTest.php
@@ -13,13 +13,13 @@ final class DefaultParameterMapTest extends TestCase
 	 */
 	public function testGetParameter(string $key, callable $validator): void
 	{
-		$factory = new XmlParameterMapFactory(__DIR__ . '/container.xml');
+		$factory = new XmlParameterMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/container.xml']));
 		$validator($factory->create()->getParameter($key));
 	}
 
 	public function testGetParameterEscapedPath(): void
 	{
-		$factory = new XmlParameterMapFactory(__DIR__ . '/containers/bugfix%2Fcontainer.xml');
+		$factory = new XmlParameterMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/containers/bugfix%2Fcontainer.xml']));
 		$serviceMap = $factory->create();
 
 		self::assertNotNull($serviceMap->getParameter('app.string'));
diff --git a/tests/Symfony/DefaultServiceMapTest.php b/tests/Symfony/DefaultServiceMapTest.php
@@ -13,13 +13,13 @@ final class DefaultServiceMapTest extends TestCase
 	 */
 	public function testGetService(string $id, callable $validator): void
 	{
-		$factory = new XmlServiceMapFactory(__DIR__ . '/container.xml');
+		$factory = new XmlServiceMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/container.xml']));
 		$validator($factory->create()->getService($id));
 	}
 
 	public function testGetContainerEscapedPath(): void
 	{
-		$factory = new XmlServiceMapFactory(__DIR__ . '/containers/bugfix%2Fcontainer.xml');
+		$factory = new XmlServiceMapFactory(new Configuration(['containerXmlPath' => __DIR__ . '/containers/bugfix%2Fcontainer.xml']));
 		$serviceMap = $factory->create();
 
 		self::assertNotNull($serviceMap->getService('withClass'));

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,9 @@ final class ConsoleApplicationResolver`
`16`	`16`	`/** @var \Symfony\Component\Console\Application\|null */`
`17`	`17`	`private $consoleApplication;`
`18`	`18`
`19`		`- public function __construct(?string $consoleApplicationLoader)`
	`19`	`+ public function __construct(Configuration $configuration)`
`20`	`20`	`{`
	`21`	`+ $consoleApplicationLoader = $configuration->getConsoleApplicationLoader();`
`21`	`22`	`if ($consoleApplicationLoader === null) {`
`22`	`23`	`return;`
`23`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@ final class XmlParameterMapFactory implements ParameterMapFactory`
`10`	`10`	`/** @var string\|null */`
`11`	`11`	`private $containerXml;`
`12`	`12`
`13`		`- public function __construct(?string $containerXml)`
	`13`	`+ public function __construct(Configuration $configuration)`
`14`	`14`	`{`
`15`		`- $this->containerXml = $containerXml;`
	`15`	`+ $this->containerXml = $configuration->getContainerXmlPath();`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`public function create(): ParameterMap`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,9 @@ final class XmlServiceMapFactory implements ServiceMapFactory`
`13`	`13`	`/** @var string\|null */`
`14`	`14`	`private $containerXml;`
`15`	`15`
`16`		`- public function __construct(?string $containerXml)`
	`16`	`+ public function __construct(Configuration $configuration)`
`17`	`17`	`{`
`18`		`- $this->containerXml = $containerXml;`
	`18`	`+ $this->containerXml = $configuration->getContainerXmlPath();`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public function create(): ServiceMap`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace PHPStan\Rules\Symfony;`
`4`	`4`
`5`	`5`	`use PHPStan\Rules\Rule;`
	`6`	`+use PHPStan\Symfony\Configuration;`
`6`	`7`	`use PHPStan\Symfony\XmlServiceMapFactory;`
`7`	`8`	`use PHPStan\Testing\RuleTestCase;`
`8`	`9`
`@@ -14,7 +15,7 @@ final class ContainerInterfacePrivateServiceRuleFakeTest extends RuleTestCase`
`14`	`15`
`15`	`16`	`protected function getRule(): Rule`
`16`	`17`	`{`
`17`		`- return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(null))->create());`
	`18`	`+ return new ContainerInterfacePrivateServiceRule((new XmlServiceMapFactory(new Configuration([])))->create());`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public function testGetPrivateService(): void`