bug #1115 [make:crud] fix broken controller with custom repository (j…

…rushlow) This PR was merged into the 1.0-dev branch. Discussion ---------- [make:crud] fix broken controller with custom repository fixes #1113 Commits ------- 1560455 [make:crud] fix broken controller with custom repository
symfony · May 9, 2022 · 5f7249c · 5f7249c
2 parents 4b994df + 1560455
commit 5f7249c
Show file tree

Hide file tree

Showing 15 changed files with 470 additions and 64 deletions.
diff --git a/src/Maker/MakeCrud.php b/src/Maker/MakeCrud.php
@@ -119,6 +119,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             $repositoryClassName = $repositoryClassDetails->getFullName();
 
             $repositoryVars = [
+                'repository_full_class_name' => $repositoryClassName,
                 'repository_class_name' => $repositoryClassDetails->getShortName(),
                 'repository_var' => lcfirst($this->inflector->singularize($repositoryClassDetails->getShortName())),
             ];

diff --git a/src/Resources/skeleton/crud/controller/Controller.tpl.php b/src/Resources/skeleton/crud/controller/Controller.tpl.php
@@ -47,7 +47,8 @@ public function new(Request $request, EntityManagerInterface $entityManager): Re
 
 <?php if (isset($repository_full_class_name) && $generator->repositoryHasAddRemoveMethods($repository_full_class_name)) { ?>
         if ($form->isSubmitted() && $form->isValid()) {
-            $<?= $repository_var ?>->add($<?= $entity_var_singular ?>);
+            $<?= $repository_var ?>->add($<?= $entity_var_singular ?>, true);
+
             return $this->redirectToRoute('<?= $route_name ?>_index', [], Response::HTTP_SEE_OTHER);
         }
 <?php } else { ?>
@@ -92,7 +93,8 @@ public function edit(Request $request, <?= $entity_class_name ?> $<?= $entity_va
 
 <?php if (isset($repository_full_class_name) && $generator->repositoryHasAddRemoveMethods($repository_full_class_name)) { ?>
         if ($form->isSubmitted() && $form->isValid()) {
-            $<?= $repository_var ?>->add($<?= $entity_var_singular ?>);
+            $<?= $repository_var ?>->add($<?= $entity_var_singular ?>, true);
+
             return $this->redirectToRoute('<?= $route_name ?>_index', [], Response::HTTP_SEE_OTHER);
         }
 <?php } else { ?>
@@ -125,7 +127,7 @@ public function delete(Request $request, <?= $entity_class_name ?> $<?= $entity_
     {
 <?php if (isset($repository_full_class_name) && $generator->repositoryHasAddRemoveMethods($repository_full_class_name)) { ?>
         if ($this->isCsrfTokenValid('delete'.$<?= $entity_var_singular ?>->get<?= ucfirst($entity_identifier) ?>(), $request->request->get('_token'))) {
-            $<?= $repository_var ?>->remove($<?= $entity_var_singular ?>);
+            $<?= $repository_var ?>->remove($<?= $entity_var_singular ?>, true);
         }
 <?php } else { ?>
         if ($this->isCsrfTokenValid('delete'.$<?= $entity_var_singular ?>->get<?= ucfirst($entity_identifier) ?>(), $request->request->get('_token'))) {

diff --git a/tests/Maker/MakeCrudTest.php b/tests/Maker/MakeCrudTest.php
@@ -18,6 +18,8 @@
 
 class MakeCrudTest extends MakerTestCase
 {
+    use TestHelpersTrait;
+
     protected function getMakerClass(): string
     {
         return MakeCrud::class;
@@ -28,7 +30,7 @@ public function getTestDetails(): \Generator
         yield 'it_generates_basic_crud' => [$this->createMakerTest()
             ->run(function (MakerTestRunner $runner) {
                 $runner->copy(
-                    'make-crud/SweetFood.php',
+                    $this->getFixturePath('SweetFood.php', $runner),
                     'src/Entity/SweetFood.php'
                 );
 
@@ -48,7 +50,7 @@ public function getTestDetails(): \Generator
         yield 'it_generates_crud_with_custom_controller' => [$this->createMakerTest()
             ->run(function (MakerTestRunner $runner) {
                 $runner->copy(
-                    'make-crud/SweetFood.php',
+                    $this->getFixturePath('SweetFood.php', $runner),
                     'src/Entity/SweetFood.php'
                 );
 
@@ -74,7 +76,7 @@ public function getTestDetails(): \Generator
                 );
 
                 $runner->copy(
-                    'make-crud/SweetFood-custom-namespace.php',
+                    $this->getFixturePath('SweetFood-custom-namespace.php', $runner),
                     'src/Entity/SweetFood.php'
                 );
 
@@ -94,7 +96,7 @@ public function getTestDetails(): \Generator
         yield 'it_generates_crud_using_custom_repository' => [$this->createMakerTest()
             ->run(function (MakerTestRunner $runner) {
                 $runner->copy(
-                    'make-crud/SweetFood.php',
+                    $this->getFixturePath('SweetFoodCustomRepository.php', $runner),
                     'src/Entity/SweetFood.php'
                 );
                 $runner->copy(
@@ -112,13 +114,18 @@ public function getTestDetails(): \Generator
                 $this->assertStringContainsString('created: src/Form/SweetFoodType.php', $output);
 
                 $this->runCrudTest($runner, 'it_generates_basic_crud.php');
+
+                self::assertFileEquals(
+                    sprintf('%s/fixtures/%s', \dirname(__DIR__), $this->getFixturePath('expected/WithCustomRepository.php', $runner)),
+                    $runner->getPath('src/Controller/SweetFoodController.php')
+                );
             }),
         ];
 
         yield 'it_generates_crud_with_no_base_template' => [$this->createMakerTest()
             ->run(function (MakerTestRunner $runner) {
                 $runner->copy(
-                    'make-crud/SweetFood.php',
+                    $this->getFixturePath('SweetFood.php', $runner),
                     'src/Entity/SweetFood.php'
                 );
 
@@ -138,6 +145,14 @@ public function getTestDetails(): \Generator
         ];
     }
 
+    // @legacy - remove when annotations are no longer supported
+    private function getFixturePath(string $sourceName, MakerTestRunner $runner): string
+    {
+        $path = $this->useAttributes($runner) ? 'make-crud' : 'make-crud/legacy';
+
+        return sprintf('%s/%s', $path, $sourceName);
+    }
+
     private function runCrudTest(MakerTestRunner $runner, string $filename): void
     {
         $runner->copy(

diff --git a/tests/Maker/MakeEntityTest.php b/tests/Maker/MakeEntityTest.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Bundle\MakerBundle\Tests\Maker;
 
-use Doctrine\ORM\Mapping\Driver\AttributeReader;
 use Symfony\Bundle\MakerBundle\Maker\MakeEntity;
 use Symfony\Bundle\MakerBundle\Test\MakerTestCase;
 use Symfony\Bundle\MakerBundle\Test\MakerTestDetails;
@@ -21,6 +20,8 @@
 
 class MakeEntityTest extends MakerTestCase
 {
+    use TestHelpersTrait;
+
     protected function getMakerClass(): string
     {
         return MakeEntity::class;
@@ -671,13 +672,6 @@ private function changeToXmlMapping(MakerTestRunner $runner): void
         );
     }
 
-    private function useAttributes(MakerTestRunner $runner): bool
-    {
-        return \PHP_VERSION_ID >= 80000
-            && $runner->doesClassExist(AttributeReader::class)
-            && $runner->getSymfonyVersion() >= 50200;
-    }
-
     private function copyEntity(MakerTestRunner $runner, string $filename): void
     {
         $entityClassName = substr(

diff --git a/tests/Maker/TestHelpersTrait.php b/tests/Maker/TestHelpersTrait.php
@@ -0,0 +1,30 @@
+<?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\Maker;
+
+use Doctrine\ORM\Mapping\Driver\AttributeReader;
+use Symfony\Bundle\MakerBundle\Test\MakerTestRunner;
+
+/**
+ * @author Jesse Rushlow <jr@rushlow.dev>
+ *
+ * @internal
+ */
+trait TestHelpersTrait
+{
+    // @legacy - remove when annotations are no longer supported
+    protected function useAttributes(MakerTestRunner $runner): bool
+    {
+        return \PHP_VERSION_ID >= 80000
+            && $runner->doesClassExist(AttributeReader::class);
+    }
+}
diff --git a/tests/fixtures/make-crud/SweetFood-custom-namespace.php b/tests/fixtures/make-crud/SweetFood-custom-namespace.php
@@ -4,41 +4,31 @@
 
 use Doctrine\ORM\Mapping as ORM;
 
-/**
- * @ORM\Entity()
- */
+#[ORM\Entity()]
 class SweetFood
 {
-    /**
-     * @ORM\Column(name="id", type="integer")
-     * @ORM\Id
-     * @ORM\GeneratedValue(strategy="AUTO")
-     */
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
     private $id;
 
-    /**
-     * @ORM\Column(name="title", type="string", length=255)
-     */
+    #[ORM\Column(type: 'string', length: 255)]
     private $title;
 
     public function getId()
     {
         return $this->id;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->title;
     }
 
-    /**
-     * @param mixed $title
-     */
-    public function setTitle($title)
+    public function setTitle(string $title): self
     {
         $this->title = $title;
+
+        return $this;
     }
 }
diff --git a/tests/fixtures/make-crud/SweetFood.php b/tests/fixtures/make-crud/SweetFood.php
@@ -4,41 +4,31 @@
 
 use Doctrine\ORM\Mapping as ORM;
 
-/**
- * @ORM\Entity()
- */
+#[ORM\Entity()]
 class SweetFood
 {
-    /**
-     * @ORM\Column(name="id", type="integer")
-     * @ORM\Id
-     * @ORM\GeneratedValue(strategy="AUTO")
-     */
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
     private $id;
 
-    /**
-     * @ORM\Column(name="title", type="string", length=255)
-     */
+    #[ORM\Column(type: 'string', length: 255)]
     private $title;
 
     public function getId()
     {
         return $this->id;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->title;
     }
 
-    /**
-     * @param mixed $title
-     */
-    public function setTitle($title)
+    public function setTitle(string $title): self
     {
         $this->title = $title;
+
+        return $this;
     }
 }
diff --git a/tests/fixtures/make-crud/SweetFoodCustomRepository.php b/tests/fixtures/make-crud/SweetFoodCustomRepository.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Entity;
+
+use App\Repository\SweetFoodRepository;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity(repositoryClass: SweetFoodRepository::class)]
+class SweetFood
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
+    private $id;
+
+    #[ORM\Column(type: 'string', length: 255)]
+    private $title;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function setTitle(string $title): self
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+}
diff --git a/tests/fixtures/make-crud/SweetFoodRepository.php b/tests/fixtures/make-crud/SweetFoodRepository.php
@@ -7,6 +7,8 @@
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
+ * @extends ServiceEntityRepository<SweetFood>
+ *
  * @method SweetFood|null find($id, $lockMode = null, $lockVersion = null)
  * @method SweetFood|null findOneBy(array $criteria, array $orderBy = null)
  * @method SweetFood[]    findAll()
@@ -19,16 +21,21 @@ public function __construct(ManagerRegistry $registry)
         parent::__construct($registry, SweetFood::class);
     }
 
-    /*
-    public function findBySomething($value)
+    public function add(SweetFood $entity, bool $flush = false): void
     {
-        return $this->createQueryBuilder('t')
-            ->where('t.something = :value')->setParameter('value', $value)
-            ->orderBy('t.id', 'ASC')
-            ->setMaxResults(10)
-            ->getQuery()
-            ->getResult()
-        ;
+        ($em = $this->getEntityManager())->persist($entity);
+
+        if ($flush) {
+            $em->flush();
+        }
+    }
+
+    public function remove(SweetFood $entity, bool $flush = false): void
+    {
+        ($em = $this->getEntityManager())->remove($entity);
+
+        if ($flush) {
+            $em->flush();
+        }
     }
-    */
 }