Register conditionally enabled rules with attributes

Adds the optional enabledBy parameter to RegisteredRule and
RegisteredCollector. It accepts a boolean parameter reference and only
adds the rule or collector tag when that parameter is enabled.

This moves PHPStan's 18 conditionally registered rules out of
conditionalTags and service definitions and onto the rule classes. The
five conditional restricted-usage extension tags remain in NEON because
they are not rules or collectors.

Author: calebdw

conf/config.level0.neon

@@ -12,13 +12,8 @@ conditionalTags:
 		phpstan.restrictedClassNameUsageExtension: %featureToggles.internalTag%
 	PHPStan\Rules\InternalTag\RestrictedInternalFunctionUsageExtension:
 		phpstan.restrictedFunctionUsageExtension: %featureToggles.internalTag%
-	PHPStan\Rules\Classes\NewStaticInAbstractClassStaticMethodRule:
-		phpstan.rules.rule: %featureToggles.newStaticInAbstractClassStaticMethod%
 
 services:
-	-
-		class: PHPStan\Rules\Classes\NewStaticInAbstractClassStaticMethodRule
-
 	-
 		class: PHPStan\Rules\InternalTag\RestrictedInternalClassConstantUsageExtension
 

conf/config.level1.neon

@@ -10,11 +10,3 @@ parameters:
 autowiredAttributeServices:
 	# registers rules with #[RegisteredRule] attribute
 	level: 1
-
-conditionalTags:
-	PHPStan\Rules\Variables\AssignToByRefExprFromForeachRule:
-		phpstan.rules.rule: %featureToggles.assignToByRefForeachExpr%
-
-services:
-	-
-		class: PHPStan\Rules\Variables\AssignToByRefExprFromForeachRule

conf/config.level2.neon

@@ -15,20 +15,10 @@ conditionalTags:
 		phpstan.restrictedPropertyUsageExtension: %featureToggles.internalTag%
 	PHPStan\Rules\InternalTag\RestrictedInternalMethodUsageExtension:
 		phpstan.restrictedMethodUsageExtension: %featureToggles.internalTag%
-	PHPStan\Rules\Constants\ValueAssignedToDefineRule:
-		phpstan.rules.rule: %featureToggles.checkDynamicConstantNameValues%
-	PHPStan\Rules\Constants\ValueAssignedToGlobalConstantRule:
-		phpstan.rules.rule: %featureToggles.checkDynamicConstantNameValues%
 
 services:
 	-
 		class: PHPStan\Rules\InternalTag\RestrictedInternalPropertyUsageExtension
 
 	-
 		class: PHPStan\Rules\InternalTag\RestrictedInternalMethodUsageExtension
-
-	-
-		class: PHPStan\Rules\Constants\ValueAssignedToDefineRule
-
-	-
-		class: PHPStan\Rules\Constants\ValueAssignedToGlobalConstantRule

conf/config.level4.neon

@@ -5,47 +5,5 @@ autowiredAttributeServices:
 	# registers rules with #[RegisteredRule] and #[RegisteredCollector] attributes
 	level: 4
 
-conditionalTags:
-	PHPStan\Rules\Exceptions\TooWideFunctionThrowTypeRule:
-		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
-	PHPStan\Rules\Exceptions\TooWideMethodThrowTypeRule:
-		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
-	PHPStan\Rules\Exceptions\TooWidePropertyHookThrowTypeRule:
-		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
-	PHPStan\Rules\Keywords\UnusedLabelRule:
-		phpstan.rules.rule: %featureToggles.unusedLabel%
-	PHPStan\Rules\Comparison\ImpossibleInArrayHaystackFiniteTypesRule:
-		phpstan.rules.rule: %featureToggles.finiteTypesInHaystack%
-	PHPStan\Rules\Comparison\SwitchConditionRule:
-		phpstan.rules.rule: %featureToggles.switchConditionAlwaysFalse%
-
 parameters:
 	checkAdvancedIsset: true
-
-services:
-	-
-		class: PHPStan\Rules\Exceptions\TooWideFunctionThrowTypeRule
-
-	-
-		class: PHPStan\Rules\Exceptions\TooWideMethodThrowTypeRule
-		arguments:
-			checkProtectedAndPublicMethods: %checkTooWideThrowTypesInProtectedAndPublicMethods%
-			tooWideImplicitThrows: %exceptions.check.tooWideImplicitThrowType%
-
-	-
-		class: PHPStan\Rules\Exceptions\TooWidePropertyHookThrowTypeRule
-		arguments:
-			checkProtectedAndPublicMethods: %checkTooWideThrowTypesInProtectedAndPublicMethods%
-
-	-
-		class: PHPStan\Rules\Keywords\UnusedLabelRule
-
-	-
-		class: PHPStan\Rules\Comparison\ImpossibleInArrayHaystackFiniteTypesRule
-		arguments:
-			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
-
-	-
-		class: PHPStan\Rules\Comparison\SwitchConditionRule
-		arguments:
-			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%

conf/config.level5.neon

@@ -5,24 +5,6 @@ parameters:
 	checkFunctionArgumentTypes: true
 	checkArgumentsPassedByReference: true
 
-conditionalTags:
-	PHPStan\Rules\Functions\ParameterCastableToNumberRule:
-		phpstan.rules.rule: %featureToggles.checkParameterCastableToNumberFunctions%
-	PHPStan\Rules\Functions\PrintfParameterTypeRule:
-		phpstan.rules.rule: %featureToggles.checkPrintfParameterTypes%
-	PHPStan\Rules\DateIntervalInstantiationRule:
-		phpstan.rules.rule: %featureToggles.checkDateIntervalConstructor%
-
 autowiredAttributeServices:
 	# registers rules with #[RegisteredRule] attribute
 	level: 5
-
-services:
-	-
-		class: PHPStan\Rules\Functions\ParameterCastableToNumberRule
-	-
-		class: PHPStan\Rules\Functions\PrintfParameterTypeRule
-		arguments:
-			checkStrictPrintfPlaceholderTypes: %checkStrictPrintfPlaceholderTypes%
-	-
-		class: PHPStan\Rules\DateIntervalInstantiationRule

conf/config.neon

@@ -260,36 +260,7 @@ parameters:
 autowiredAttributeServices:
 	level: null
 
-conditionalTags:
-	PHPStan\Rules\Exceptions\MissingCheckedExceptionInFunctionThrowsRule:
-		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
-	PHPStan\Rules\Exceptions\MissingCheckedExceptionInMethodThrowsRule:
-		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
-	PHPStan\Rules\Exceptions\MissingCheckedExceptionInPropertyHookThrowsRule:
-		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
-	PHPStan\Rules\Properties\UninitializedPropertyRule:
-		phpstan.rules.rule: %checkUninitializedProperties%
-	PHPStan\Rules\Exceptions\MethodThrowTypeCovarianceRule:
-		phpstan.rules.rule: %exceptions.check.throwTypeCovariance%
-
 services:
-	-
-		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInFunctionThrowsRule
-
-	-
-		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInMethodThrowsRule
-
-	-
-		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInPropertyHookThrowsRule
-
-	-
-		class: PHPStan\Rules\Properties\UninitializedPropertyRule
-
-	-
-		class: PHPStan\Rules\Exceptions\MethodThrowTypeCovarianceRule
-		arguments:
-			implicitThrows: %exceptions.implicitThrows%
-
 	# autowired services are now registered with the help of attributes
 	# like #[PHPStan\DependencyInjection\AutowiredService] or #[PHPStan\DependencyInjection\GenerateFactory]
 

src/DependencyInjection/AutowiredAttributeServicesExtension.php

@@ -28,6 +28,8 @@
 use function explode;
 use function implode;
 use function is_array;
+use function is_bool;
+use function preg_match;
 use function preg_split;
 use function sprintf;
 use function strcasecmp;
@@ -39,6 +41,9 @@
 final class AutowiredAttributeServicesExtension extends CompilerExtension
 {
 
+	/** @var list<array{ServiceDefinition, string, string}> */
+	private array $conditionalTags = [];
+
 	#[Override]
 	public function getConfigSchema(): Schema
 	{
@@ -140,9 +145,9 @@ public function loadConfiguration(): void
 
 			$definition = $builder->addDefinition(null)
 				->setFactory($class->name)
-				->setAutowired($class->name)
-				->addTag(LazyRegistry::RULE_TAG);
+				->setAutowired($class->name);
 
+			$this->tag($definition, LazyRegistry::RULE_TAG, $attribute->enabledBy);
 			self::processConstructorParameters($builder, $class->name, $definition, $constructorParameters);
 		}
 
@@ -154,13 +159,59 @@ public function loadConfiguration(): void
 
 			$definition = $builder->addDefinition(null)
 				->setFactory($class->name)
-				->setAutowired($class->name)
-				->addTag(RegistryFactory::COLLECTOR_TAG);
+				->setAutowired($class->name);
 
+			$this->tag($definition, RegistryFactory::COLLECTOR_TAG, $attribute->enabledBy);
 			self::processConstructorParameters($builder, $class->name, $definition, $constructorParameters);
 		}
 	}
 
+	private function tag(ServiceDefinition $definition, string $tag, ?string $enabledBy): void
+	{
+		if ($enabledBy === null) {
+			$definition->addTag($tag);
+
+			return;
+		}
+
+		$this->conditionalTags[] = [$definition, $tag, $enabledBy];
+	}
+
+	#[Override]
+	public function beforeCompile(): void
+	{
+		$builder = $this->getContainerBuilder();
+		foreach ($this->conditionalTags as [$definition, $tag, $enabledBy]) {
+			if (!self::resolveCondition($builder, $enabledBy)) {
+				continue;
+			}
+
+			$definition->addTag($tag);
+		}
+	}
+
+	private static function resolveCondition(ContainerBuilder $builder, string $enabledBy): bool
+	{
+		if (preg_match('#^%([\w.-]+)%$#D', $enabledBy, $matches) !== 1) {
+			throw new ShouldNotHappenException(sprintf('enabledBy must be a parameter reference, %s given.', $enabledBy));
+		}
+
+		$parameter = $builder->parameters;
+		foreach (explode('.', $matches[1]) as $key) {
+			if (!is_array($parameter) || !array_key_exists($key, $parameter)) {
+				throw new ShouldNotHappenException(sprintf("Missing parameter '%s'.", $matches[1]));
+			}
+
+			$parameter = $parameter[$key];
+		}
+
+		if (!is_bool($parameter)) {
+			throw new ShouldNotHappenException(sprintf('Parameter %s referenced by enabledBy must be bool.', $enabledBy));
+		}
+
+		return $parameter;
+	}
+
 	/**
 	 * @param class-string $className
 	 * @param array<lowercase-string, non-empty-list<TargetMethodParameter<AutowiredParameter>>> $constructorParameters

src/DependencyInjection/RegisteredCollector.php

@@ -7,6 +7,10 @@
 /**
  * Registers a collector in the DI container on the set rule level.
  *
+ * Pass enabledBy a `%parameter%` reference to make the registration depend on
+ * configuration, the way a `conditionalTags` entry would. The collector is only
+ * tagged when the parameter is truthy.
+ *
  * Works thanks to https://github.com/ondrejmirtes/composer-attribute-collector
  * and AutowiredAttributeServicesExtension.
  *
@@ -19,7 +23,7 @@
 final class RegisteredCollector
 {
 
-	public function __construct(public int $level)
+	public function __construct(public int $level, public ?string $enabledBy = null)
 	{
 	}
 

src/DependencyInjection/RegisteredRule.php

@@ -7,6 +7,10 @@
 /**
  * Registers a rule in the DI container on the set rule level.
  *
+ * Pass enabledBy a `%parameter%` reference to make the registration depend on
+ * configuration, the way a `conditionalTags` entry would. The rule is only
+ * tagged when the parameter is truthy.
+ *
  * Works thanks to https://github.com/ondrejmirtes/composer-attribute-collector
  * and AutowiredAttributeServicesExtension.
  *
@@ -19,7 +23,7 @@
 final class RegisteredRule
 {
 
-	public function __construct(public int $level)
+	public function __construct(public int $level, public ?string $enabledBy = null)
 	{
 	}
 

src/Rules/Classes/NewStaticInAbstractClassStaticMethodRule.php

@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
@@ -13,6 +14,7 @@
 /**
  * @implements Rule<Node\Expr\New_>
  */
+#[RegisteredRule(level: 0, enabledBy: '%featureToggles.newStaticInAbstractClassStaticMethod%')]
 final class NewStaticInAbstractClassStaticMethodRule implements Rule
 {