Merge pull request #157 from moufmouf/dao_factory_zend_code

moufmouf · web-flow · commit 56218278afcc · 2019-08-02T16:30:36.000+02:00
Generating DaoFactory with ZendCode
diff --git a/src/Utils/BaseCodeGeneratorListener.php b/src/Utils/BaseCodeGeneratorListener.php
@@ -135,4 +135,30 @@ public function onBaseDaoFindByIndexGenerated(MethodGenerator $methodGenerator,
     {
         return $methodGenerator;
     }
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryGenerated(FileGenerator $fileGenerator, array $beanDescriptors, ConfigurationInterface $configuration): ?FileGenerator
+    {
+        return $fileGenerator;
+    }
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryConstructorGenerated(MethodGenerator $methodGenerator, array $beanDescriptors, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        return $methodGenerator;
+    }
+
+    public function onDaoFactoryGetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        return $methodGenerator;
+    }
+
+    public function onDaoFactorySetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        return $methodGenerator;
+    }
 }
diff --git a/src/Utils/CodeGeneratorEventDispatcher.php b/src/Utils/CodeGeneratorEventDispatcher.php
@@ -263,4 +263,54 @@ public function onBaseDaoFindByIndexGenerated(MethodGenerator $methodGenerator,
         }
         return $methodGenerator;
     }
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryGenerated(FileGenerator $fileGenerator, array $beanDescriptors, ConfigurationInterface $configuration): ?FileGenerator
+    {
+        foreach ($this->listeners as $listener) {
+            $fileGenerator = $listener->onDaoFactoryGenerated($fileGenerator, $beanDescriptors, $configuration);
+            if ($fileGenerator === null) {
+                break;
+            }
+        }
+        return $fileGenerator;
+    }
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryConstructorGenerated(MethodGenerator $methodGenerator, array $beanDescriptors, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        foreach ($this->listeners as $listener) {
+            $methodGenerator = $listener->onDaoFactoryConstructorGenerated($methodGenerator, $beanDescriptors, $configuration, $classGenerator);
+            if ($methodGenerator === null) {
+                break;
+            }
+        }
+        return $methodGenerator;
+    }
+
+    public function onDaoFactoryGetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        foreach ($this->listeners as $listener) {
+            $methodGenerator = $listener->onDaoFactoryGetterGenerated($methodGenerator, $beanDescriptor, $configuration, $classGenerator);
+            if ($methodGenerator === null) {
+                break;
+            }
+        }
+        return $methodGenerator;
+    }
+
+    public function onDaoFactorySetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+    {
+        foreach ($this->listeners as $listener) {
+            $methodGenerator = $listener->onDaoFactorySetterGenerated($methodGenerator, $beanDescriptor, $configuration, $classGenerator);
+            if ($methodGenerator === null) {
+                break;
+            }
+        }
+        return $methodGenerator;
+    }
 }
diff --git a/src/Utils/CodeGeneratorListenerInterface.php b/src/Utils/CodeGeneratorListenerInterface.php
@@ -79,4 +79,18 @@ public function onBaseDaoFindOneFromSqlGenerated(MethodGenerator $methodGenerato
     public function onBaseDaoSetDefaultSortGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator;
 
     public function onBaseDaoFindByIndexGenerated(MethodGenerator $methodGenerator, Index $index, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator;
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryGenerated(FileGenerator $fileGenerator, array $beanDescriptors, ConfigurationInterface $configuration): ?FileGenerator;
+
+    /**
+     * @param BeanDescriptor[] $beanDescriptors
+     */
+    public function onDaoFactoryConstructorGenerated(MethodGenerator $methodGenerator, array $beanDescriptors, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator;
+
+    public function onDaoFactoryGetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator;
+
+    public function onDaoFactorySetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator;
 }
diff --git a/src/Utils/TDBMDaoGenerator.php b/src/Utils/TDBMDaoGenerator.php
@@ -7,12 +7,26 @@
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Type;
+use Psr\Container\ContainerInterface;
+use TheCodingMachine\TDBM\Schema\ForeignKeys;
+use TheCodingMachine\TDBM\TDBMService;
+use Zend\Code\Generator\AbstractMemberGenerator;
+use Zend\Code\Generator\ClassGenerator;
+use Zend\Code\Generator\DocBlock\Tag\VarTag;
+use Zend\Code\Generator\DocBlockGenerator;
+use Zend\Code\Generator\FileGenerator;
+use Zend\Code\Generator\MethodGenerator;
+use Zend\Code\Generator\ParameterGenerator;
+use Zend\Code\Generator\PropertyGenerator;
 use function str_replace;
 use TheCodingMachine\TDBM\ConfigurationInterface;
 use TheCodingMachine\TDBM\TDBMException;
 use TheCodingMachine\TDBM\TDBMSchemaAnalyzer;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Filesystem\Filesystem;
+use function strpos;
+use function substr;
+use function var_export;
 
 /**
  * This class generates automatically DAOs and Beans for TDBM.
@@ -88,7 +102,7 @@ public function generateAllDaosAndBeans(): void
         }
 
 
-        $this->generateFactory($tableList);
+        $this->generateFactory($beanDescriptors);
 
         // Let's call the list of listeners
         $this->eventDispatcher->onGenerate($this->configuration, $beanDescriptors);
@@ -279,93 +293,105 @@ private function psr2Fix(string $content): string
     /**
      * Generates the factory bean.
      *
-     * @param Table[] $tableList
+     * @param BeanDescriptor[] $beanDescriptors
      * @throws TDBMException
      */
-    private function generateFactory(array $tableList) : void
+    private function generateFactory(array $beanDescriptors) : void
     {
         $daoNamespace = $this->configuration->getDaoNamespace();
         $daoFactoryClassName = $this->namingStrategy->getDaoFactoryClassName();
 
+        $file = new FileGenerator();
+        $file->setDocBlock(
+            new DocBlockGenerator(
+                <<<DOC
+This file has been automatically generated by TDBM.
+DO NOT edit this file, as it might be overwritten.
+DOC
+            )
+        );
+        $class = new ClassGenerator();
+        $file->setClass($class);
+        $class->setName($daoFactoryClassName);
+        $file->setNamespace($daoNamespace.'\\Generated');
+
+        $class->setDocBlock(new DocBlockGenerator("The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM."));
+
+        $containerProperty = new PropertyGenerator('container');
+        $containerProperty->setVisibility(AbstractMemberGenerator::VISIBILITY_PRIVATE);
+        $containerProperty->setDocBlock(new DocBlockGenerator(null, null, [new VarTag(null, ['\\'.ContainerInterface::class])]));
+        $class->addPropertyFromGenerator($containerProperty);
+
+        $constructorMethod = new MethodGenerator(
+            '__construct',
+            [ new ParameterGenerator('container', ContainerInterface::class) ],
+            MethodGenerator::FLAG_PUBLIC,
+            '$this->container = $container;'
+        );
+        $constructorMethod = $this->configuration->getCodeGeneratorListener()->onDaoFactoryConstructorGenerated($constructorMethod, $beanDescriptors, $this->configuration, $class);
+        if ($constructorMethod !== null) {
+            $class->addMethodFromGenerator($constructorMethod);
+        }
+
         // For each table, let's write a property.
+        foreach ($beanDescriptors as $beanDescriptor) {
+            $daoClassName = $beanDescriptor->getDaoClassName();
+            $daoInstanceName = self::toVariableName($daoClassName);
 
-        $str = "<?php
-declare(strict_types=1);
+            $daoInstanceProperty = new PropertyGenerator($daoInstanceName);
+            $daoInstanceProperty->setVisibility(AbstractMemberGenerator::VISIBILITY_PRIVATE);
+            $daoInstanceProperty->setDocBlock(new DocBlockGenerator(null, null, [new VarTag(null, ['\\' . $daoNamespace . '\\' . $daoClassName, 'null'])]));
+            $class->addPropertyFromGenerator($daoInstanceProperty);
 
-/*
- * This file has been automatically generated by TDBM.
- * DO NOT edit this file, as it might be overwritten.
- */
+            $fullClassNameVarExport = var_export($daoNamespace.'\\'.$daoClassName, true);
+            $getterBody = <<<BODY
+if (!\$this->$daoInstanceName) {
+    \$this->$daoInstanceName = \$this->container->get($fullClassNameVarExport);
+}
 
-namespace {$daoNamespace}\\Generated;
+return \$this->$daoInstanceName;
+BODY;
+
+            $getterMethod = new MethodGenerator(
+                'get' . $daoClassName,
+                [],
+                MethodGenerator::FLAG_PUBLIC,
+                $getterBody
+            );
+            $getterMethod->setReturnType($daoNamespace.'\\'.$daoClassName);
+            $getterMethod = $this->configuration->getCodeGeneratorListener()->onDaoFactoryGetterGenerated($getterMethod, $beanDescriptor, $this->configuration, $class);
+            if ($getterMethod !== null) {
+                $class->addMethodFromGenerator($getterMethod);
+            }
 
-use Psr\Container\ContainerInterface;
-";
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $str .= "use {$daoNamespace}\\".$daoClassName.";\n";
+            $setterMethod = new MethodGenerator(
+                'set' . $daoClassName,
+                [new ParameterGenerator($daoInstanceName, '\\' . $daoNamespace . '\\' . $daoClassName)],
+                MethodGenerator::FLAG_PUBLIC,
+                '$this->' . $daoInstanceName . ' = $' . $daoInstanceName . ';'
+            );
+            $setterMethod->setReturnType('void');
+            $setterMethod = $this->configuration->getCodeGeneratorListener()->onDaoFactorySetterGenerated($setterMethod, $beanDescriptor, $this->configuration, $class);
+            if ($setterMethod !== null) {
+                $class->addMethodFromGenerator($setterMethod);
+            }
         }
 
-        $str .= "
-/**
- * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM.
- *
- */
-class $daoFactoryClassName
-{
-    private \$container;
-
-    public function __construct(ContainerInterface \$container)
-    {
-        \$this->container = \$container;
-    }
-
+        $file = $this->configuration->getCodeGeneratorListener()->onDaoFactoryGenerated($file, $beanDescriptors, $this->configuration);
 
-";
+        if ($file !== null) {
+            $possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
 
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $daoInstanceName = self::toVariableName($daoClassName);
+            $fileContent = $file->generate();
 
-            $str .= '    /**
-     * @var '.$daoClassName.'|null
-     */
-    private $'.$daoInstanceName.';
-
-    /**
-     * Returns an instance of the '.$daoClassName.' class.
-     *
-     * @return '.$daoClassName.'
-     */
-    public function get'.$daoClassName.'() : '.$daoClassName.'
-    {
-        if (!$this->'.$daoInstanceName.') {
-            $this->'.$daoInstanceName.' = $this->container->get('.$daoClassName.'::class);
-        }
-    
-        return $this->'.$daoInstanceName.';
-    }
+            // Hard code PSR-2 fix
+            $fileContent = $this->psr2Fix($fileContent);
+            // Add the declare strict-types directive
+            $commentEnd = strpos($fileContent, ' */') + 3;
+            $fileContent = substr($fileContent, 0, $commentEnd) . "\n\ndeclare(strict_types=1);" . substr($fileContent, $commentEnd + 1);
 
-    /**
-     * Override the instance of the '.$daoClassName.' class that will be returned by the factory getter.
-     *
-     * @param '.$daoClassName.' $'.$daoInstanceName.'
-     */
-    public function set'.$daoClassName.'('.$daoClassName.' $'.$daoInstanceName.') : void
-    {
-        $this->'.$daoInstanceName.' = $'.$daoInstanceName.';
-    }';
+            $this->dumpFile($possibleFileName, $fileContent);
         }
-
-        $str .= '
-}
-';
-
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
-
-        $this->dumpFile($possibleFileName, $str);
     }
 
     /**
diff --git a/tests/Utils/CodeGeneratorEventDispatcherTest.php b/tests/Utils/CodeGeneratorEventDispatcherTest.php
@@ -131,6 +131,38 @@ public function onBaseDaoFindByIndexGenerated(MethodGenerator $methodGenerator,
             {
                 return null;
             }
+
+            /**
+             * @param BeanDescriptor[] $beanDescriptors
+             */
+            public function onDaoFactoryGenerated(FileGenerator $fileGenerator, array $beanDescriptors, ConfigurationInterface $configuration): ?FileGenerator
+            {
+                return null;
+            }
+
+            /**
+             * @param BeanDescriptor[] $beanDescriptors
+             */
+            public function onDaoFactoryConstructorGenerated(MethodGenerator $methodGenerator, array $beanDescriptors, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+            {
+                return null;
+            }
+
+            /**
+             * @param BeanDescriptor[] $beanDescriptor
+             */
+            public function onDaoFactoryGetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+            {
+                return null;
+            }
+
+            /**
+             * @param BeanDescriptor[] $beanDescriptor
+             */
+            public function onDaoFactorySetterGenerated(MethodGenerator $methodGenerator, BeanDescriptor $beanDescriptor, ConfigurationInterface $configuration, ClassGenerator $classGenerator): ?MethodGenerator
+            {
+                return null;
+            }
         }]);
         $this->method1 = new MethodGenerator();
         $this->method2 = new MethodGenerator();
@@ -266,4 +298,28 @@ public function testOnBaseDaoFindByIndexGenerated(): void
         $this->assertSame($this->method1, $this->dispatcher->onBaseDaoFindByIndexGenerated($this->method1, $index, $this->beanDescriptor, $this->configuration, $this->class));
         $this->assertSame(null, $this->nullDispatcher->onBaseDaoFindByIndexGenerated($this->method1, $index, $this->beanDescriptor, $this->configuration, $this->class));
     }
+
+    public function testOnDaoFactoryGenerated(): void
+    {
+        $this->assertSame($this->file, $this->dispatcher->onDaoFactoryGenerated($this->file, [], $this->configuration));
+        $this->assertSame(null, $this->nullDispatcher->onDaoFactoryGenerated($this->file, [], $this->configuration));
+    }
+
+    public function testOnDaoFactoryConstructorGenerated(): void
+    {
+        $this->assertSame($this->method1, $this->dispatcher->onDaoFactoryConstructorGenerated($this->method1, [], $this->configuration, $this->class));
+        $this->assertSame(null, $this->nullDispatcher->onDaoFactoryConstructorGenerated($this->method1, [], $this->configuration, $this->class));
+    }
+
+    public function testOnDaoFactoryGetterGenerated(): void
+    {
+        $this->assertSame($this->method1, $this->dispatcher->onDaoFactoryGetterGenerated($this->method1, $this->beanDescriptor, $this->configuration, $this->class));
+        $this->assertSame(null, $this->nullDispatcher->onDaoFactoryGetterGenerated($this->method1, $this->beanDescriptor, $this->configuration, $this->class));
+    }
+
+    public function testOnDaoFactorySetterGenerated(): void
+    {
+        $this->assertSame($this->method1, $this->dispatcher->onDaoFactorySetterGenerated($this->method1, $this->beanDescriptor, $this->configuration, $this->class));
+        $this->assertSame(null, $this->nullDispatcher->onDaoFactorySetterGenerated($this->method1, $this->beanDescriptor, $this->configuration, $this->class));
+    }
 }
diff --git a/vendor-bin/couscous/composer.lock b/vendor-bin/couscous/composer.lock
