Ask the user if they want the inverse side of a relation

Author: weaverryan

src/Maker/MakeEntity.php

@@ -252,12 +252,6 @@ public function afterGenerate(ConsoleStyle $io, array $params)
                 // save the inverse side if it's being mapped
                 if ($newField->getMapInverseRelation()) {
                     $fileManagerOperations[$otherManipulatorFilename] = $otherManipulator;
-                } else {
-                    // print message about it not being saved
-                    $fileManagerOperations[] = sprintf(
-                        'The inverse side of the relation was not mapped in "%s" because it lives in the vendor/ directory.',
-                        $newField->getInverseClass()
-                    );
                 }
                 $currentFields[] = $newFieldName;
             } else {
@@ -579,8 +573,30 @@ function ($name) use ($targetClass) {
             return $io->confirm(sprintf('Do you want to automatically delete orphaned <comment>%s</comment> objects (orphanRemoval)?', $owningClass), false);
         };
 
-        $setMapInverseSide = function (EntityRelation $relation) {
-            $relation->setMapInverseRelation(!$this->isClassInVendor($relation->getInverseClass()));
+        $askInverseSide = function (EntityRelation $relation) use ($io) {
+            if ($this->isClassInVendor($relation->getInverseClass())) {
+                $relation->setMapInverseRelation(false);
+            }
+
+            // recommend an inverse side, except for OneToOne, where it's inefficient
+            $recommendMappingInverse = EntityRelation::ONE_TO_ONE === $relation->getType() ? false : true;
+
+            $getterMethodName = 'get'.Str::asCamelCase(Str::getShortClassName($relation->getOwningClass()));
+            if (EntityRelation::ONE_TO_ONE !== $relation->getType()) {
+                // pluralize!
+                $getterMethodName = Str::singularCamelCaseToPluralCamelCase($getterMethodName);
+            }
+            $mapInverse = $io->confirm(
+                sprintf(
+                    'Do you want to add a new property to <comment>%s</comment> so that you can access/update <comment>%s</comment> objects from it - e.g. <comment>$%s->%s()</comment>?',
+                    Str::getShortClassName($relation->getInverseClass()),
+                    Str::getShortClassName($relation->getOwningClass()),
+                    Str::asLowerCamelCase(Str::getShortClassName($relation->getInverseClass())),
+                    $getterMethodName
+                ),
+                $recommendMappingInverse
+            );
+            $relation->setMapInverseRelation($mapInverse);
         };
 
         switch ($type) {
@@ -597,7 +613,7 @@ function ($name) use ($targetClass) {
                     $relation->getOwningClass()
                 ));
 
-                $setMapInverseSide($relation);
+                $askInverseSide($relation);
                 if ($relation->getMapInverseRelation()) {
                     $io->comment(sprintf(
                         'A new property will also be added to the <comment>%s</comment> class so that you can access the related <comment>%s</comment> objects from it.',
@@ -608,13 +624,14 @@ function ($name) use ($targetClass) {
                         $relation->getInverseClass(),
                         Str::singularCamelCaseToPluralCamelCase(Str::getShortClassName($relation->getOwningClass()))
                     ));
-                }
 
-                if (!$relation->isNullable()) {
-                    $relation->setOrphanRemoval($askOrphanRemoval(
-                        $relation->getOwningClass(),
-                        $relation->getInverseClass()
-                    ));
+                    // orphan removal only applies of the inverse relation is set
+                    if (!$relation->isNullable()) {
+                        $relation->setOrphanRemoval($askOrphanRemoval(
+                            $relation->getOwningClass(),
+                            $relation->getInverseClass()
+                        ));
+                    }
                 }
 
                 break;
@@ -658,7 +675,7 @@ function ($name) use ($targetClass) {
                 );
                 $relation->setOwningProperty($newFieldName);
 
-                $setMapInverseSide($relation);
+                $askInverseSide($relation);
                 if ($relation->getMapInverseRelation()) {
                     $io->comment(sprintf(
                         'A new property will also be added to the <comment>%s</comment> class so that you can access the related <comment>%s</comment> objects from it.',
@@ -685,7 +702,7 @@ function ($name) use ($targetClass) {
                     $relation->getOwningClass()
                 ));
 
-                $setMapInverseSide($relation);
+                $askInverseSide($relation);
                 if ($relation->getMapInverseRelation()) {
                     $io->comment(sprintf(
                         'A new property will also be added to the <comment>%s</comment> class so that you can access the related <comment>%s</comment> object from it.',

tests/Maker/FunctionalTest.php

@@ -139,6 +139,8 @@ public function getCommandTests()
                 'ManyToOne',
                 // nullable
                 'n',
+                // do you want to generate an inverse relation? (default to yes)
+                '',
                 // field name on opposite side - use default 'userAvatarPhotos'
                 '',
                 // orphanRemoval (default to no)
@@ -151,6 +153,31 @@ public function getCommandTests()
             ->updateSchemaAfterCommand()
         ];
 
+        yield 'entity_many_to_one_simple_no_inverse' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeEntity::class),
+            [
+                // entity class name
+                'UserAvatarPhoto',
+                // field name
+                'user',
+                // add a relationship field
+                'relation',
+                // the target entity
+                'User',
+                // relation type
+                'ManyToOne',
+                // nullable
+                'n',
+                // do you want to generate an inverse relation? (default to yes)
+                'n',
+                // finish adding fields
+                ''
+            ])
+            ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeEntityManyToOneNoInverse')
+            ->configureDatabase()
+            ->updateSchemaAfterCommand()
+        ];
+
         yield 'entity_one_to_many_simple' => [MakerTestDetails::createTest(
             $this->getMakerInstance(MakeEntity::class),
             [
@@ -164,6 +191,8 @@ public function getCommandTests()
                 'UserAvatarPhoto',
                 // relation type
                 'OneToMany',
+                // inverse side?
+                'y',
                 // field name on opposite side - use default 'user'
                 '',
                 // nullable
@@ -191,6 +220,8 @@ public function getCommandTests()
                 'User',
                 // relation type
                 'ManyToMany',
+                // inverse side?
+                'y',
                 // field name on opposite side - use default 'courses'
                 '',
                 // finish adding fields
@@ -216,6 +247,8 @@ public function getCommandTests()
                 'OneToOne',
                 // nullable
                 'n',
+                // inverse side?
+                'y',
                 // field name on opposite side - use default 'userProfile'
                 '',
                 // finish adding fields
@@ -243,8 +276,6 @@ public function getCommandTests()
                  * normally, we ask for the field on the *other* side, but we
                  * do not here, since the other side won't be mapped.
                  */
-                // orphanRemoval (default to no)
-                '',
                 // finish adding fields
                 ''
             ])

tests/fixtures/MakeEntityManyToOneNoInverse/src/Entity/User.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity()
+ */
+class User
+{
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     */
+    private $id;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}

tests/fixtures/MakeEntityManyToOneNoInverse/tests/GeneratedEntityTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Tests;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Doctrine\ORM\EntityManager;
+use App\Entity\User;
+use App\Entity\UserAvatarPhoto;
+
+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\\User u')->execute();
+        $em->createQuery('DELETE FROM App\\Entity\\UserAvatarPhoto u')->execute();
+
+        $user = new User();
+        $em->persist($user);
+
+        $photo = new UserAvatarPhoto();
+        $photo->setUser($user);
+        $em->persist($photo);
+
+        $em->flush();
+        $em->refresh($photo);
+
+        $this->assertSame($photo->getUser(), $user);
+    }
+}