bug #164 Doctrine embedded entity 'make:entity --regenerate' bugfix (…

…sadikoff)

This PR was squashed before being merged into the 1.0-dev branch (closes #164).

Discussion
----------

Doctrine embedded entity 'make:entity --regenerate' bugfix

Closes #160

Commits
-------

0e36480 Doctrine embedded entity 'make:entity --regenerate' bugfix

src/Doctrine/EntityRegenerator.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\MakerBundle\Doctrine;
 
 use Doctrine\ORM\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\MappingException;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\FileManager;
 use Symfony\Bundle\MakerBundle\Generator;
@@ -40,7 +41,11 @@ public function __construct(DoctrineHelper $doctrineHelper, FileManager $fileMan
 
     public function regenerateEntities(string $classOrNamespace)
     {
-        $metadata = $this->doctrineHelper->getMetadata($classOrNamespace, true);
+        try {
+            $metadata = $this->doctrineHelper->getMetadata($classOrNamespace);
+        } catch (MappingException $mappingException) {
+            $metadata = $this->doctrineHelper->getMetadata($classOrNamespace, true);
+        }
 
         if ($metadata instanceof ClassMetadata) {
             $metadata = [$metadata];
@@ -67,7 +72,28 @@ public function regenerateEntities(string $classOrNamespace)
             $manipulator = $this->createClassManipulator($classPath);
             $operations[$classPath] = $manipulator;
 
+            $embeddedClasses = [];
+
+            foreach ($classMetadata->embeddedClasses as $fieldName => $mapping) {
+                $className = $mapping['class'];
+
+                $embeddedClasses[$fieldName] = $this->getPathOfClass($className);
+
+                $operations[$embeddedClasses[$fieldName]] = $this->createClassManipulator($embeddedClasses[$fieldName]);
+
+                $manipulator->addEmbeddedEntity($fieldName, $className);
+            }
+
             foreach ($classMetadata->fieldMappings as $fieldName => $mapping) {
+                // skip embedded fields
+                if (false !== strpos($fieldName, '.')) {
+                    list($fieldName, $embeddedFiledName) = explode('.', $fieldName);
+
+                    $operations[$embeddedClasses[$fieldName]]->addEntityField($embeddedFiledName, $mapping);
+
+                    continue;
+                }
+
                 $manipulator->addEntityField($fieldName, $mapping);
             }
 

src/Util/ClassSourceManipulator.php

@@ -106,6 +106,46 @@ public function addEntityField(string $propertyName, array $columnOptions)
         }
     }
 
+    public function addEmbeddedEntity(string $propertyName, string $className)
+    {
+        $typeHint = self::addUseStatementIfNecessary($className);
+
+        $annotations = [
+            $this->buildAnnotationLine(
+                '@ORM\\Embedded',
+                [
+                    'class' => $className,
+                ]
+            ),
+        ];
+
+        $this->addProperty($propertyName, $annotations);
+
+        // logic to avoid re-adding the same ArrayCollection line
+        $addEmbedded = true;
+        if ($this->getConstructorNode()) {
+            // We print the constructor to a string, then
+            // look for "$this->propertyName = "
+
+            $constructorString = $this->printer->prettyPrint([$this->getConstructorNode()]);
+            if (false !== strpos($constructorString, sprintf('$this->%s = ', $propertyName))) {
+                $addEmbedded = false;
+            }
+        }
+
+        if ($addEmbedded) {
+            $this->addStatementToConstructor(
+                new Node\Stmt\Expression(new Node\Expr\Assign(
+                    new Node\Expr\PropertyFetch(new Node\Expr\Variable('this'), $propertyName),
+                    new Node\Expr\New_(new Node\Name($typeHint))
+                ))
+            );
+        }
+
+        $this->addGetter($propertyName, $typeHint, false);
+        $this->addSetter($propertyName, $typeHint, false);
+    }
+
     public function addManyToOneRelation(RelationManyToOne $manyToOne)
     {
         $this->addSingularRelation($manyToOne);

tests/Maker/FunctionalTest.php

@@ -689,6 +689,18 @@ public function getCommandEntityTests()
             ->setRequiredPhpVersion(70100)
         ];
 
+        yield 'entity_regenerate_embeddable' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeEntity::class),
+            [
+                // namespace: use default App\Entity
+                '',
+            ])
+            ->setArgumentsString('--regenerate --overwrite')
+            ->setFixtureFilesPath(__DIR__ . '/../fixtures/MakeEntityRegenerateEmbedable')
+            ->configureDatabase()
+            ->setRequiredPhpVersion(70100)
+        ];
+
         yield 'entity_regenerate_overwrite' => [MakerTestDetails::createTest(
             $this->getMakerInstance(MakeEntity::class),
             [

tests/fixtures/MakeEntityRegenerateEmbedable/src/Entity/Food.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class Food
+{
+    /**
+     * @ORM\Column(name="id", type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @ORM\Column(name="title", type="string", length=255)
+     */
+    private $title;
+
+    /**
+     * @ORM\Embedded(class="App\Entity\Recipe")
+     */
+    private $recipe;
+}

tests/fixtures/MakeEntityRegenerateEmbedable/src/Entity/Recipe.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Embeddable()
+ */
+class Recipe
+{
+    /**
+     * @ORM\Column(type="string", length=255)
+     */
+    private $ingredients;
+
+    /**
+     * @ORM\Column(type="string", length=255)
+     */
+    private $steps;
+}

tests/fixtures/MakeEntityRegenerateEmbedable/tests/GeneratedEntityTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Tests;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Doctrine\ORM\EntityManager;
+use App\Entity\Food;
+use App\Entity\Recipe;
+
+class GeneratedEntityTest extends KernelTestCase
+{
+    public function testGeneratedEntity()
+    {
+        self::bootKernel();
+        /** @var EntityManager $em */
+        $em = self::$kernel->getContainer()
+            ->get('doctrine')
+            ->getManager();
+
+        $em->createQuery('DELETE FROM App\\Entity\\Food f')->execute();
+
+        $food = new Food();
+        // check that the constructor was instantiated properly
+        $this->assertInstanceOf(Recipe::class, $food->getRecipe());
+        // fields should now have setters
+        $food->setTitle('Borscht');
+
+        $recipe = new Recipe();
+        $recipe->setIngredients('ingridients');
+        $recipe->setSteps('steps');
+        $food->setRecipe($recipe);
+
+        $em->persist($food);
+
+        $em->flush();
+        $em->refresh($food);
+
+        /** @var Food[] $actualFood */
+        $actualFood = $em->getRepository(Food::class)
+            ->findAll();
+
+        $this->assertcount(1, $actualFood);
+
+        /** @var Recipe $actualRecipe */
+        $actualRecipe = $actualFood[0]->getRecipe();
+
+        $this->assertInstanceOf(Recipe::class, $actualRecipe);
+        $this->assertEquals('ingridients', $actualRecipe->getIngredients());
+        $this->assertEquals('steps', $actualRecipe->getSteps());
+    }
+}