MakeUser: availability to chose table's name

Author: nikophil

src/Doctrine/DoctrineHelper.php

@@ -15,6 +15,7 @@
 use Doctrine\Common\Persistence\Mapping\ClassMetadata as LegacyClassMetadata;
 use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver as LegacyMappingDriver;
 use Doctrine\Common\Persistence\Mapping\MappingException as LegacyPersistenceMappingException;
+use Doctrine\DBAL\Connection;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\MappingException as ORMMappingException;
 use Doctrine\ORM\Tools\DisconnectedClassMetadataFactory;
@@ -219,4 +220,21 @@ private function isInstanceOf($object, string $class): bool
 
         return $object instanceof $class || $object instanceof $legacyClass;
     }
+
+    public function escapeTableNameIfNeeded(string $tableName): string
+    {
+        if (!$this->isKeyword($tableName)) {
+            return $tableName;
+        }
+
+        return sprintf('`%s`', $tableName);
+    }
+
+    private function isKeyword(string $name): bool
+    {
+        /** @var Connection $connection */
+        $connection = $this->getRegistry()->getConnection();
+
+        return $connection->getDatabasePlatform()->getReservedKeywordsList()->isKeyword($name);
+    }
 }

src/Maker/MakeUser.php

@@ -14,6 +14,7 @@
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\Doctrine\DoctrineHelper;
 use Symfony\Bundle\MakerBundle\Doctrine\EntityClassGenerator;
 use Symfony\Bundle\MakerBundle\Doctrine\ORMDependencyBuilder;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
@@ -49,11 +50,14 @@ final class MakeUser extends AbstractMaker
 
     private $configUpdater;
 
-    public function __construct(FileManager $fileManager, UserClassBuilder $userClassBuilder, SecurityConfigUpdater $configUpdater)
+    private $doctrineHelper;
+
+    public function __construct(FileManager $fileManager, UserClassBuilder $userClassBuilder, SecurityConfigUpdater $configUpdater, DoctrineHelper $doctrineHelper)
     {
         $this->fileManager = $fileManager;
         $this->userClassBuilder = $userClassBuilder;
         $this->configUpdater = $configUpdater;
+        $this->doctrineHelper = $doctrineHelper;
     }
 
     public static function getCommandName(): string
@@ -98,6 +102,15 @@ class_exists(DoctrineBundle::class)
             if ($missingPackagesMessage) {
                 throw new RuntimeCommandException($missingPackagesMessage);
             }
+
+            $question = 'Enter the entity\'s table name. (<comment>It will be auto-escaped.</comment>)';
+            $entityTableName = $io->ask(
+                $question, 'user', function ($name) {
+                return Validator::validateDoctrineTableName($name, $this->doctrineHelper->getRegistry());
+            });
+
+            $command->addOption('entity-table-name', $entityTableName);
+            $input->setOption('entity-table-name', $entityTableName);
         }
         $input->setOption('is-entity', $userIsEntity);
 
@@ -157,9 +170,20 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             $manipulator,
             $userClassConfiguration
         );
+
+        // C) Add @ORM\Table annotation
+        if ($userClassConfiguration->isEntity()) {
+            $manipulator->addAnnotationToClass(
+                'ORM\\Table',
+                [
+                    'name' => $this->doctrineHelper->escapeTableNameIfNeeded($input->getOption('entity-table-name'))
+                ]
+            );
+        }
+
         $generator->dumpFile($classPath, $manipulator->getSourceCode());
 
-        // C) Generate a custom user provider, if necessary
+        // D) Generate a custom user provider, if necessary
         if (!$userClassConfiguration->isEntity()) {
             $userClassConfiguration->setUserProviderClass($generator->getRootNamespace().'\\Security\\UserProvider');
             $customProviderPath = $generator->generateClass(
@@ -171,7 +195,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             );
         }
 
-        // D) Update security.yaml
+        // E) Update security.yaml
         $securityYamlUpdated = false;
         $path = 'config/packages/security.yaml';
         if ($this->fileManager->fileExists($path)) {

src/Resources/config/makers.xml

@@ -97,6 +97,7 @@
                 <argument type="service" id="maker.file_manager" />
                 <argument type="service" id="maker.user_class_builder" />
                 <argument type="service" id="maker.security_config_updater" />
+                <argument type="service" id="maker.doctrine_helper" />
                 <tag name="maker.command" />
             </service>
 

src/Util/ClassSourceManipulator.php

@@ -718,6 +718,12 @@ public function addUseStatementIfNecessary(string $class): string
                         // everywhere and do not add another use statement
                         return '\\'.$class;
                     }
+
+                    // we're dealing with a "directory" namespace (ie: Assert, ORM)
+                    // we should use entire given class as alias
+                    if (0 === strpos($class, $alias)) {
+                        return $class;
+                    }
                 }
 
                 // if $class is alphabetically before this use statement, place it before

src/Validator.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\MakerBundle;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\DBAL\Connection;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Component\Security\Core\User\UserInterface;
 
@@ -167,6 +168,21 @@ public static function validateDoctrineFieldName(string $name, ManagerRegistry $
         return $name;
     }
 
+    public static function validateDoctrineTableName(string $name, ManagerRegistry $registry)
+    {
+        /** @var Connection $connection */
+        $connection = $registry->getConnection();
+        if ($connection->getSchemaManager()->tablesExist($name)) {
+            throw new \InvalidArgumentException(sprintf('Table "%s" already exists.', $name));
+        }
+
+        if (!preg_match('/^([0-9a-zA-Z_$])+$/', $name)) {
+            throw new \InvalidArgumentException(sprintf('"%s" is not a valid table name.', $name));
+        }
+
+        return $name;
+    }
+
     public static function existsOrNull(string $className = null, array $entities = [])
     {
         if (null !== $className) {

tests/Maker/MakeUserTest.php

@@ -25,6 +25,7 @@ public function getTestDetails()
                 // user class name
                 'User',
                 'y', // entity
+                'user', // table name
                 'email', // identity property
                 'y', // with password
                 'y', // argon

tests/Util/ClassSourceManipulatorTest.php

@@ -725,6 +725,35 @@ class Foo
 class Foo
 {
 }
+EOF
+        ];
+
+        yield 'directory_namespace' => [
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar;
+
+class Foo
+{
+}
+EOF
+            ,
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar;
+
+/**
+ * @Bar\SomeAnnotation(message="Foo")
+ */
+class Foo
+{
+}
 EOF
         ];
     }