feature #1785 [make:entity] Autocompletion for enum classes (tcoch, GromNaN)

This PR was merged into the 1.x branch.

Discussion
----------

[make:entity] Autocompletion for enum classes

This PR aims to provide autocompletion for `enum` classes, just like it exists for doctrine relations.

Two tests on generating entity with enum types already exist (https://github.com/symfony/maker-bundle/blob/1.x/tests/Maker/MakeEntityTest.php#L697-L741) to cover that this new feature won't break anything.

Commits
-------

370a910 Fix CS
56c662c Inject the directory path and namespace in the EnumHelper instead of the FileManager
80264ad Replace functional test for EnumHelper with a unit test
87d4d93 First try to create unit tests
d04d1d5 Fix: handle if no src folder is found
f0f1231 Use CPP for $enumHelper
2c357eb Re-organise constructor to ensure it doesn't break BC promise
2033b9f Fix Fabbot PHP code style
aaa64b3 Add test failing if enum does not exists
bf9ab35 Use enum_exists() function instead of class_exists()
34b11a5 Add licensing informations
24bf99c Fix for CS / Fabbot / Checks
ca1c53d Fix for CI Static Analysis / PHP-CS-Fixer
a976a34 feat: autocompletion for enum classes

Author: GromNaN

src/Maker/MakeEntity.php

@@ -31,6 +31,7 @@
 use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassProperty;
 use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
 use Symfony\Bundle\MakerBundle\Util\CliOutputHelper;
+use Symfony\Bundle\MakerBundle\Util\EnumHelper;
 use Symfony\Bundle\MakerBundle\Validator;
 use Symfony\Bundle\MercureBundle\DependencyInjection\MercureExtension;
 use Symfony\Component\Console\Command\Command;
@@ -292,7 +293,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
 
                         break;
                     default:
-                        throw new \Exception('Invalid relation type');
+                        throw new \Exception('Invalid relation type.');
                 }
 
                 // save the inverse side if it's being mapped
@@ -431,7 +432,7 @@ private function askForNextField(ConsoleStyle $io, array $fields, string $entity
             $classProperty->scale = $io->ask('Scale (number of decimals to store: 100.00 would be 2)', '0', Validator::validateScale(...));
         } elseif ('enum' === $type) {
             // ask for valid backed enum class
-            $classProperty->enumType = $io->ask('Enum class', null, Validator::classIsBackedEnum(...));
+            $classProperty->enumType = $this->askEnumDetails($io);
 
             // set type according to user decision
             $classProperty->type = $io->confirm('Can this field store multiple enum values', false) ? 'simple_array' : 'string';
@@ -556,6 +557,35 @@ private function createEntityClassQuestion(string $questionText): Question
         return $question;
     }
 
+    private function askEnumDetails(ConsoleStyle $io): string
+    {
+        $targetEnumClass = null;
+        while (null === $targetEnumClass) {
+            $question = $this->createEnumQuestion('Enum class (e.g. <fg=yellow>App\Enum\Foo</>)');
+
+            $answeredEnumClass = $io->askQuestion($question);
+
+            if (enum_exists($answeredEnumClass)) {
+                $targetEnumClass = $answeredEnumClass;
+            } else {
+                $io->error(\sprintf('Unknown enum "%s"', $answeredEnumClass));
+            }
+        }
+
+        return $targetEnumClass;
+    }
+
+    private function createEnumQuestion(string $questionText): Question
+    {
+        $question = new Question($questionText);
+        $question->setValidator(Validator::classIsBackedEnum(...));
+
+        $enumHelper = new EnumHelper($this->fileManager->getRootDirectory().'/src', 'App');
+        $question->setAutocompleterValues($enumHelper->getAllEnums());
+
+        return $question;
+    }
+
     private function askRelationDetails(ConsoleStyle $io, string $generatedEntityClass, string $type, string $newFieldName): EntityRelation
     {
         // ask the targetEntity

src/Util/EnumHelper.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Util;
+
+use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * @internal
+ */
+class EnumHelper
+{
+    public function __construct(
+        private string $directory,
+        private string $namespace = 'App',
+    ) {
+    }
+
+    public function getAllEnums(): array
+    {
+        $enums = [];
+        $finder = new Finder();
+
+        // Check all PHP files in the directory
+        try {
+            $finder->files()
+                ->in($this->directory)
+                ->name('*.php');
+        } catch (DirectoryNotFoundException $e) {
+            return [];
+        }
+
+        foreach ($finder as $file) {
+            $relativePath = str_replace([$this->directory.'/', '.php'], ['', ''], $file->getRealPath());
+            $className = $this->namespace.'\\'.str_replace('/', '\\', $relativePath);
+
+            if (enum_exists($className)) {
+                $enums[] = $className;
+            }
+        }
+
+        return $enums;
+    }
+}

tests/Maker/MakeEntityTest.php

@@ -716,6 +716,26 @@ public static function getTestDetails(): \Generator
             }),
         ];
 
+        yield 'it_cannot_create_a_new_class_with_fake_enum_field' => [self::createMakeEntityTest()
+            ->run(static function (MakerTestRunner $runner) {
+                $output = $runner->runMaker([
+                    // entity class name
+                    'User',
+                    // add additional field
+                    'fakeEnum',
+                    'enum',
+                    'App\\Enum\\Fake',
+                    '',
+                    // nullable
+                    'y',
+                    // finish adding fields
+                    '',
+                ], '', true);
+
+                self::assertStringContainsString('Class "App\Enum\Fake" doesn\'t exist', $output);
+            }),
+        ];
+
         yield 'it_creates_a_new_class_with_enum_field_multiple_and_nullable' => [self::createMakeEntityTest()
         ->run(static function (MakerTestRunner $runner) {
             self::copyEntity($runner, 'Enum/Role-basic.php');

tests/Util/EnumHelperTest.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Tests\Util;
+
+use Composer\Autoload\ClassLoader;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\MakerBundle\Util\EnumHelper;
+
+class EnumHelperTest extends TestCase
+{
+    private string $fixturesDir = __DIR__.'/fixtures/enum_helper';
+    private ClassLoader $classLoader;
+
+    protected function setUp(): void
+    {
+        $this->classLoader = new ClassLoader();
+        $this->classLoader->addPsr4('App\\', $this->fixturesDir.'/src');
+        $this->classLoader->register(true);
+    }
+
+    protected function tearDown(): void
+    {
+        $this->classLoader?->unregister();
+    }
+
+    public function testGetAllEnumsReturnsEnumClasses()
+    {
+        $enumHelper = new EnumHelper($this->fixturesDir.'/src', 'App');
+        $enums = $enumHelper->getAllEnums();
+
+        $this->assertCount(2, $enums);
+        $this->assertContains('App\\Enum\\Status', $enums);
+        $this->assertContains('App\\Enum\\Priority', $enums);
+    }
+
+    public function testGetAllEnumsExcludesNonEnumClasses()
+    {
+        $enumHelper = new EnumHelper($this->fixturesDir.'/src', 'App');
+        $enums = $enumHelper->getAllEnums();
+
+        $this->assertNotContains('App\\Entity\\User', $enums);
+    }
+
+    public function testGetAllEnumsReturnsEmptyArrayWhenSrcDirDoesNotExist()
+    {
+        $enumHelper = new EnumHelper(__DIR__.'/nonexistent', 'App');
+        $enums = $enumHelper->getAllEnums();
+
+        $this->assertIsArray($enums);
+        $this->assertEmpty($enums);
+    }
+}

tests/Util/fixtures/enum_helper/src/Entity/User.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Entity;
+
+class User
+{
+    private string $name;
+}
+

tests/Util/fixtures/enum_helper/src/Enum/Priority.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Enum;
+
+enum Priority: int
+{
+    case LOW = 1;
+    case MEDIUM = 2;
+    case HIGH = 3;
+}
+

tests/Util/fixtures/enum_helper/src/Enum/Status.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Enum;
+
+enum Status: string
+{
+    case DRAFT = 'draft';
+    case PUBLISHED = 'published';
+    case ARCHIVED = 'archived';
+}
+