Builder generation fix

Author: maxbeckers

src/Config/PhpBuilderGeneratorConfig.php

@@ -15,6 +15,7 @@ class PhpBuilderGeneratorConfig
     private string $outputDir = 'generated/php-builder-generator/';
     private string $phpVersion = '8.2';
     private string $namespaceSuffix = '';
+    private string $builderSuffix = 'Builder';
     private bool $autoGenerate = true;
 
     public static function configure(): self
@@ -63,6 +64,13 @@ public function namespaceSuffix(string $suffix): self
         return $this;
     }
 
+    public function builderSuffix(string $suffix): self
+    {
+        $this->builderSuffix = $suffix;
+
+        return $this;
+    }
+
     public function autoGenerate(bool $value): self
     {
         $this->autoGenerate = $value;
@@ -97,6 +105,11 @@ public function getNamespaceSuffix(): string
         return $this->namespaceSuffix;
     }
 
+    public function getBuilderSuffix(): string
+    {
+        return $this->builderSuffix;
+    }
+
     public function isAutoGenerate(): bool
     {
         return $this->autoGenerate;

src/Generator/BuilderGenerator.php

@@ -24,7 +24,7 @@ public function generate(GenerationContext $context): array
         $classContext = $context->classContext;
         $builderConfig = $classContext->builderConfig;
 
-        $builderClassName = $builderConfig->className ?? $classContext->getShortName() . 'Builder';
+        $builderClassName = $builderConfig->className ?? $classContext->getShortName() . $context->config->getBuilderSuffix();
         $builderNamespace = $this->getBuilderNamespace($classContext, $context);
         $properties = $classContext->getBuilderProperties();
 

src/Service/BuilderService.php

@@ -109,7 +109,7 @@ private function resolveClasses(PhpBuilderGeneratorConfig $config): array
         foreach ($config->getScanDirectories() as $scan) {
             $discovered = $this->discoverClassesInDirectory($scan['dir']);
             foreach ($discovered as $className) {
-                if (!isset($classes[$className])) {
+                if (!isset($classes[$className]) && !$this->isBuilderClass($className, $config->getBuilderSuffix())) {
                     $classes[$className] = $scan['config'];
                 }
             }
@@ -118,6 +118,20 @@ private function resolveClasses(PhpBuilderGeneratorConfig $config): array
         return $classes;
     }
 
+    /**
+     * Returns true when the class is itself a generated builder and should not
+     * receive a builder of its own. Generated builders are named with the
+     * configured builder suffix (default "Builder"). Scanning the output directory
+     * alongside the source directory would otherwise produce FooBuilderBuilder
+     * on subsequent runs.
+     */
+    private function isBuilderClass(string $className, string $builderSuffix): bool
+    {
+        $shortName = substr($className, (int) strrpos($className, '\\') + 1);
+
+        return str_ends_with($shortName, $builderSuffix);
+    }
+
     /**
      * @return class-string[]
      */

tests/Integration/BuilderGenerationTest.php

@@ -134,5 +134,82 @@ public function testCleanGeneratedFiles(): void
         $deleted = $this->service->clean($config);
         $this->assertGreaterThan(0, $deleted);
     }
-}
 
+    public function testNoBuilderBuilderGeneratedWhenOutputDirIsAlsoScanned(): void
+    {
+        $config = PhpBuilderGeneratorConfig::configure()
+            ->scanDirectory(__DIR__ . '/../Fixtures')
+            ->outputDir($this->outputDir);
+
+        $firstPass = $this->service->generateBuilders($config);
+        $this->assertGreaterThan(0, $firstPass);
+
+        $firstPassBuilderFiles = $this->findFilesRecursively($this->outputDir, 'Builder.php');
+        $this->assertNotEmpty($firstPassBuilderFiles, 'First pass should produce Builder files');
+
+        $config2 = PhpBuilderGeneratorConfig::configure()
+            ->scanDirectory(__DIR__ . '/../Fixtures')
+            ->scanDirectory($this->outputDir)
+            ->outputDir($this->outputDir);
+
+        $this->service->generateBuilders($config2);
+
+        $builderBuilderFiles = $this->findFilesRecursively($this->outputDir, 'BuilderBuilder.php');
+        $this->assertEmpty(
+            $builderBuilderFiles,
+            'No *BuilderBuilder files should be generated when outputDir is also scanned: ' .
+            implode(', ', $builderBuilderFiles)
+        );
+    }
+
+    public function testCustomBuilderSuffixIsRespectedWhenFilteringScannedClasses(): void
+    {
+        $config = PhpBuilderGeneratorConfig::configure()
+            ->scanDirectory(__DIR__ . '/../Fixtures')
+            ->outputDir($this->outputDir)
+            ->builderSuffix('Factory');
+
+        $firstPass = $this->service->generateBuilders($config);
+        $this->assertGreaterThan(0, $firstPass);
+
+        $factoryFiles = $this->findFilesRecursively($this->outputDir, 'Factory.php');
+        $this->assertNotEmpty($factoryFiles, 'First pass should produce *Factory files');
+
+        $config2 = PhpBuilderGeneratorConfig::configure()
+            ->scanDirectory(__DIR__ . '/../Fixtures')
+            ->scanDirectory($this->outputDir)
+            ->outputDir($this->outputDir)
+            ->builderSuffix('Factory');
+
+        $this->service->generateBuilders($config2);
+
+        $factoryFactoryFiles = $this->findFilesRecursively($this->outputDir, 'FactoryFactory.php');
+        $this->assertEmpty(
+            $factoryFactoryFiles,
+            'No *FactoryFactory files should be generated: ' . implode(', ', $factoryFactoryFiles)
+        );
+    }
+
+    /**
+     * @return string[]
+     */
+    private function findFilesRecursively(string $dir, string $suffix): array
+    {
+        if (!is_dir($dir)) {
+            return [];
+        }
+
+        $result = [];
+        $iterator = new \RecursiveIteratorIterator(
+            new \RecursiveDirectoryIterator($dir, \FilesystemIterator::SKIP_DOTS)
+        );
+
+        foreach ($iterator as $file) {
+            if ($file->isFile() && str_ends_with($file->getFilename(), $suffix)) {
+                $result[] = $file->getPathname();
+            }
+        }
+
+        return $result;
+    }
+}