#[GenerateFactory] attribute to substitute implement neon key

Author: ondrejmirtes

conf/config.neon

@@ -243,39 +243,3 @@ services:
 
 	-
 		class: PHPStan\Rules\Properties\UninitializedPropertyRule
-
-	-
-		implement: PHPStan\Analyser\ResultCache\ResultCacheManagerFactory
-		arguments:
-			scanFileFinder: @fileFinderScan
-			cacheFilePath: %resultCachePath%
-			analysedPaths: %analysedPaths%
-			analysedPathsFromConfig: %analysedPathsFromConfig%
-			composerAutoloaderProjectPaths: %composerAutoloaderProjectPaths%
-			usedLevel: %usedLevel%
-			cliAutoloadFile: %cliAutoloadFile%
-			bootstrapFiles: %bootstrapFiles%
-			scanFiles: %scanFiles%
-			scanDirectories: %scanDirectories%
-			checkDependenciesOfProjectExtensionFiles: %resultCacheChecksProjectExtensionFilesDependencies%
-			parametersNotInvalidatingCache: %parametersNotInvalidatingCache%
-			skipResultCacheIfOlderThanDays: %resultCacheSkipIfOlderThanDays%
-
-	-
-		implement: PHPStan\File\FileExcluderRawFactory
-
-	-
-		implement: PHPStan\Reflection\FunctionReflectionFactory
-		arguments:
-			parser: @defaultAnalysisParser
-
-	-
-		implement: PHPStan\Reflection\BetterReflection\SourceLocator\OptimizedPsrAutoloaderLocatorFactory
-
-	-
-		implement: PHPStan\Reflection\BetterReflection\SourceLocator\OptimizedSingleFileSourceLocatorFactory
-
-	-
-		implement: PHPStan\Reflection\Php\PhpMethodReflectionFactory
-		arguments:
-			parser: @defaultAnalysisParser

src/Analyser/ResultCache/ResultCacheManager.php

@@ -11,7 +11,9 @@
 use PHPStan\Dependency\ExportedNode\ExportedTraitNode;
 use PHPStan\Dependency\ExportedNodeFetcher;
 use PHPStan\Dependency\RootExportedNode;
+use PHPStan\DependencyInjection\AutowiredParameter;
 use PHPStan\DependencyInjection\Container;
+use PHPStan\DependencyInjection\GenerateFactory;
 use PHPStan\DependencyInjection\ProjectConfigHelper;
 use PHPStan\File\CouldNotReadFileException;
 use PHPStan\File\FileFinder;
@@ -53,6 +55,7 @@
  * @phpstan-import-type LinesToIgnore from FileAnalyserResult
  * @phpstan-import-type CollectorData from CollectedData
  */
+#[GenerateFactory(interface: ResultCacheManagerFactory::class)]
 final class ResultCacheManager
 {
 
@@ -77,22 +80,35 @@ final class ResultCacheManager
 	public function __construct(
 		private Container $container,
 		private ExportedNodeFetcher $exportedNodeFetcher,
+		#[AutowiredParameter(ref: '@fileFinderScan')]
 		private FileFinder $scanFileFinder,
 		private ReflectionProvider $reflectionProvider,
 		private StubFilesProvider $stubFilesProvider,
 		private FileHelper $fileHelper,
+		#[AutowiredParameter(ref: '%resultCachePath%')]
 		private string $cacheFilePath,
+		#[AutowiredParameter]
 		private array $analysedPaths,
+		#[AutowiredParameter]
 		private array $analysedPathsFromConfig,
+		#[AutowiredParameter]
 		private array $composerAutoloaderProjectPaths,
+		#[AutowiredParameter]
 		private string $usedLevel,
+		#[AutowiredParameter]
 		private ?string $cliAutoloadFile,
+		#[AutowiredParameter]
 		private array $bootstrapFiles,
+		#[AutowiredParameter]
 		private array $scanFiles,
+		#[AutowiredParameter]
 		private array $scanDirectories,
 		private array $fileReplacements,
+		#[AutowiredParameter(ref: '%resultCacheChecksProjectExtensionFilesDependencies%')]
 		private bool $checkDependenciesOfProjectExtensionFiles,
+		#[AutowiredParameter]
 		private array $parametersNotInvalidatingCache,
+		#[AutowiredParameter(ref: '%resultCacheSkipIfOlderThanDays%')]
 		private int $skipResultCacheIfOlderThanDays,
 	)
 	{

src/DependencyInjection/AutowiredAttributeServicesExtension.php

@@ -61,6 +61,15 @@ public function loadConfiguration(): void
 			}
 		}
 
+		foreach (Attributes::findTargetClasses(GenerateFactory::class) as $class) {
+			$attribute = $class->attribute;
+			$definition = $builder->addFactoryDefinition(null)
+				->setImplement($attribute->interface);
+
+			$resultDefinition = $definition->getResultDefinition();
+			$this->processParameters($class->name, $resultDefinition, $autowiredParameters);
+		}
+
 		/** @var stdClass&object{level: int|null} $config */
 		$config = $this->getConfig();
 		if ($config->level === null) {

src/DependencyInjection/AutowiredParameter.php

@@ -6,7 +6,7 @@
 
 /**
  * Autowires constructor parameters in service classes using #[AutowiredService],
- * #[RegisteredRule] or #[RegisteredCollector] attributes.
+ * #[GeneratedFactory], #[RegisteredRule] or #[RegisteredCollector] attributes.
  *
  * If ref is omitted, it looks for parameter of the same name.
  *

src/DependencyInjection/GenerateFactory.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection;
+
+use Attribute;
+
+/**
+ * Generates concrete factory implementation based on the passed interface name.
+ *
+ * This looks at and compares constructor of the class with the attribute
+ * against the "create" method of the passed interface.
+ *
+ * It subtracts "create" parameters from the constructor parameters.
+ * And the rest is autowired from the dependency injection container.
+ *
+ * Works thanks to https://github.com/ondrejmirtes/composer-attribute-collector
+ * and AutowiredAttributeServicesExtension.
+ */
+#[Attribute(flags: Attribute::TARGET_CLASS)]
+final class GenerateFactory
+{
+
+	/**
+	 * @param class-string $interface
+	 */
+	public function __construct(public string $interface)
+	{
+	}
+
+}

src/File/FileExcluder.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\File;
 
+use PHPStan\DependencyInjection\GenerateFactory;
 use function fnmatch;
 use function in_array;
 use function is_dir;
@@ -14,6 +15,7 @@
 use const FNM_CASEFOLD;
 use const FNM_NOESCAPE;
 
+#[GenerateFactory(interface: FileExcluderRawFactory::class)]
 final class FileExcluder
 {
 

src/Reflection/BetterReflection/SourceLocator/OptimizedPsrAutoloaderLocator.php

@@ -8,8 +8,10 @@
 use PHPStan\BetterReflection\Reflector\Reflector;
 use PHPStan\BetterReflection\SourceLocator\Type\Composer\Psr\PsrAutoloaderMapping;
 use PHPStan\BetterReflection\SourceLocator\Type\SourceLocator;
+use PHPStan\DependencyInjection\GenerateFactory;
 use function is_file;
 
+#[GenerateFactory(interface: OptimizedPsrAutoloaderLocatorFactory::class)]
 final class OptimizedPsrAutoloaderLocator implements SourceLocator
 {
 

src/Reflection/BetterReflection/SourceLocator/OptimizedSingleFileSourceLocator.php

@@ -12,12 +12,14 @@
 use PHPStan\BetterReflection\Reflector\Reflector;
 use PHPStan\BetterReflection\SourceLocator\Ast\Strategy\NodeToReflection;
 use PHPStan\BetterReflection\SourceLocator\Type\SourceLocator;
+use PHPStan\DependencyInjection\GenerateFactory;
 use PHPStan\Reflection\ConstantNameHelper;
 use PHPStan\ShouldNotHappenException;
 use function array_key_exists;
 use function array_keys;
 use function strtolower;
 
+#[GenerateFactory(interface: OptimizedSingleFileSourceLocatorFactory::class)]
 final class OptimizedSingleFileSourceLocator implements SourceLocator
 {
 

src/Reflection/Php/PhpFunctionReflection.php

@@ -4,6 +4,8 @@
 
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionFunction;
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionParameter;
+use PHPStan\DependencyInjection\AutowiredParameter;
+use PHPStan\DependencyInjection\GenerateFactory;
 use PHPStan\Internal\DeprecatedAttributeHelper;
 use PHPStan\Parser\Parser;
 use PHPStan\Parser\VariadicFunctionsVisitor;
@@ -14,6 +16,7 @@
 use PHPStan\Reflection\ExtendedParameterReflection;
 use PHPStan\Reflection\ExtendedParametersAcceptor;
 use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\FunctionReflectionFactory;
 use PHPStan\Reflection\InitializerExprContext;
 use PHPStan\Reflection\InitializerExprTypeResolver;
 use PHPStan\TrinaryLogic;
@@ -27,6 +30,7 @@
 use function is_array;
 use function is_file;
 
+#[GenerateFactory(interface: FunctionReflectionFactory::class)]
 final class PhpFunctionReflection implements FunctionReflection
 {
 
@@ -45,6 +49,7 @@ final class PhpFunctionReflection implements FunctionReflection
 	public function __construct(
 		private InitializerExprTypeResolver $initializerExprTypeResolver,
 		private ReflectionFunction $reflection,
+		#[AutowiredParameter(ref: '@defaultAnalysisParser')]
 		private Parser $parser,
 		private AttributeReflectionFactory $attributeReflectionFactory,
 		private TemplateTypeMap $templateTypeMap,

src/Reflection/Php/PhpMethodReflection.php

@@ -4,6 +4,8 @@
 
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionMethod;
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionParameter;
+use PHPStan\DependencyInjection\AutowiredParameter;
+use PHPStan\DependencyInjection\GenerateFactory;
 use PHPStan\Internal\DeprecatedAttributeHelper;
 use PHPStan\Parser\Parser;
 use PHPStan\Parser\VariadicMethodsVisitor;
@@ -46,6 +48,7 @@
 /**
  * @api
  */
+#[GenerateFactory(interface: PhpMethodReflectionFactory::class)]
 final class PhpMethodReflection implements ExtendedMethodReflection
 {
 
@@ -75,6 +78,7 @@ public function __construct(
 		private ReflectionMethod $reflection,
 		private ReflectionProvider $reflectionProvider,
 		private AttributeReflectionFactory $attributeReflectionFactory,
+		#[AutowiredParameter(ref: '@defaultAnalysisParser')]
 		private Parser $parser,
 		private TemplateTypeMap $templateTypeMap,
 		private array $phpDocParameterTypes,