bug #1062 Make blog post titles unique (javiereguiluz, Javier Eguiluz)

This PR was merged into the master branch.

Discussion
----------

Make blog post titles unique

I'm trying to fix #1045.

We should make the `slug` unique because it's what we use to look for blog posts in the database. However, I can't make this work. If I define `UniqueEntity` on `title`, it works ... but if I define it on `slug`, it doesn't work (I can create any number of posts with the same slug). Anybody sees the error? Thanks!

Commits
-------

178e2b1 Added a functional test
7486dc8 Added a form event to set the slug
a4a316a Make blog post titles unique

Author: javiereguiluz

src/Controller/Admin/BlogController.php

@@ -21,7 +21,6 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
-use Symfony\Component\String\Slugger\SluggerInterface;
 
 /**
  * Controller used to manage blog contents in the backend.
@@ -70,7 +69,7 @@ public function index(PostRepository $posts): Response
      * to constraint the HTTP methods each controller responds to (by default
      * it responds to all methods).
      */
-    public function new(Request $request, SluggerInterface $slugger): Response
+    public function new(Request $request): Response
     {
         $post = new Post();
         $post->setAuthor($this->getUser());
@@ -86,8 +85,6 @@ public function new(Request $request, SluggerInterface $slugger): Response
         // However, we explicitly add it to improve code readability.
         // See https://symfony.com/doc/current/forms.html#processing-forms
         if ($form->isSubmitted() && $form->isValid()) {
-            $post->setSlug($slugger->slug($post->getTitle())->lower());
-
             $em = $this->getDoctrine()->getManager();
             $em->persist($post);
             $em->flush();
@@ -133,13 +130,12 @@ public function show(Post $post): Response
      * @Route("/{id<\d+>}/edit", methods="GET|POST", name="admin_post_edit")
      * @IsGranted("edit", subject="post", message="Posts can only be edited by their authors.")
      */
-    public function edit(Request $request, Post $post, SluggerInterface $slugger): Response
+    public function edit(Request $request, Post $post): Response
     {
         $form = $this->createForm(PostType::class, $post);
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
-            $post->setSlug($slugger->slug($post->getTitle())->lower());
             $this->getDoctrine()->getManager()->flush();
 
             $this->addFlash('success', 'post.updated_successfully');

src/Entity/Post.php

@@ -14,11 +14,13 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * @ORM\Entity(repositoryClass="App\Repository\PostRepository")
  * @ORM\Table(name="symfony_demo_post")
+ * @UniqueEntity(fields={"slug"}, errorPath="title", message="This title was already used in another blog post, but they must be unique.")
  *
  * Defines the properties of the Post entity to represent the blog posts.
  *

src/Form/PostType.php

@@ -17,7 +17,10 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\String\Slugger\SluggerInterface;
 
 /**
  * Defines the form used to create and manipulate blog posts.
@@ -28,6 +31,14 @@
  */
 class PostType extends AbstractType
 {
+    private $slugger;
+
+    // Form types are services, so you can inject other services in them if needed
+    public function __construct(SluggerInterface $slugger)
+    {
+        $this->slugger = $slugger;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -64,6 +75,16 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'label.tags',
                 'required' => false,
             ])
+            // form events let you modify information or fields at different steps
+            // of the form handling process.
+            // See https://symfony.com/doc/current/form/events.html
+            ->addEventListener(FormEvents::SUBMIT, function (FormEvent $event) {
+                /** @var Post */
+                $post = $event->getData();
+                if (null !== $postTitle = $post->getTitle()) {
+                    $post->setSlug($this->slugger->slug($postTitle)->lower());
+                }
+            })
         ;
     }
 

tests/Controller/Admin/BlogControllerTest.php

@@ -105,6 +105,31 @@ public function testAdminNewPost()
         $this->assertSame($postContent, $post->getContent());
     }
 
+    public function testAdminNewDuplicatedPost()
+    {
+        $postTitle = 'Blog Post Title '.mt_rand();
+        $postSummary = $this->generateRandomString(255);
+        $postContent = $this->generateRandomString(1024);
+
+        $client = static::createClient([], [
+            'PHP_AUTH_USER' => 'jane_admin',
+            'PHP_AUTH_PW' => 'kitten',
+        ]);
+        $crawler = $client->request('GET', '/en/admin/post/new');
+        $form = $crawler->selectButton('Create post')->form([
+            'post[title]' => $postTitle,
+            'post[summary]' => $postSummary,
+            'post[content]' => $postContent,
+        ]);
+        $client->submit($form);
+
+        // post titles must be unique, so trying to create the same post twice should result in an error
+        $client->submit($form);
+
+        $this->assertSelectorTextSame('form .form-group.has-error label', 'Title');
+        $this->assertSelectorTextContains('form .form-group.has-error .help-block', 'This title was already used in another blog post, but they must be unique.');
+    }
+
     public function testAdminShowPost()
     {
         $client = static::createClient([], [