Asking to add UniqueEntity during make:registration-form

Author: weaverryan

src/Maker/MakeEntity.php

@@ -26,6 +26,7 @@
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Doctrine\EntityRegenerator;
 use Symfony\Bundle\MakerBundle\FileManager;
+use Symfony\Bundle\MakerBundle\Util\ClassDetails;
 use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
 use Symfony\Bundle\MakerBundle\Doctrine\EntityRelation;
 use Symfony\Bundle\MakerBundle\Validator;
@@ -774,7 +775,9 @@ private function createClassManipulator(string $path, ConsoleStyle $io, bool $ov
 
     private function getPathOfClass(string $class): string
     {
-        return (new \ReflectionClass($class))->getFileName();
+        $classDetails = new ClassDetails($class);
+
+        return $classDetails->getPath();
     }
 
     private function isClassInVendor(string $class): bool

src/Maker/MakeRegistrationForm.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\Common\Annotations\Annotation;
+use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
@@ -22,7 +23,9 @@
 use Symfony\Bundle\MakerBundle\Renderer\FormTypeRenderer;
 use Symfony\Bundle\MakerBundle\Security\InteractiveSecurityHelper;
 use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Bundle\MakerBundle\Util\ClassDetails;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
+use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
 use Symfony\Bundle\MakerBundle\Util\YamlSourceManipulator;
 use Symfony\Bundle\SecurityBundle\SecurityBundle;
 use Symfony\Bundle\TwigBundle\TwigBundle;
@@ -80,6 +83,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
             ->addOption('auto-login-authenticator')
             ->addOption('firewall-name')
             ->addOption('redirect-route-name')
+            ->addOption('add-unique-entity-constraint')
         ;
 
         $interactiveSecurityHelper = new InteractiveSecurityHelper();
@@ -112,6 +116,17 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
             $interactiveSecurityHelper->guessPasswordField($io, $userClass)
         );
 
+        // see if it makes sense to add the UniqueEntity constraint
+        $userClassDetails = new ClassDetails($userClass);
+        $addAnnotation = false;
+        if (!$userClassDetails->doesDocBlockContainAnnotation('@UniqueEntity')) {
+            $addAnnotation = $io->confirm(sprintf('Do you want to add a <comment>@UniqueEntity</comment> validation annotation on your <comment>%s</comment> class to make sure duplicate accounts aren\'t created?', Str::getShortClassName($userClass)));
+        }
+        $input->setOption(
+            'add-unique-entity-constraint',
+            $addAnnotation
+        );
+
         if ($io->confirm('Do you want to automatically authenticate the user after registration?')) {
             $this->interactAuthenticatorQuestions(
                 $input,
@@ -172,13 +187,15 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             'Entity\\'
         );
 
+        // 1) Generate the form class
         $usernameField = $input->getArgument('username-field');
         $formClassDetails = $this->generateFormClass(
             $userClassNameDetails,
             $generator,
             $usernameField
         );
 
+        // 2) Generate the controller
         $controllerClassNameDetails = $generator->createClassNameDetails(
             'RegistrationController',
             'Controller\\'
@@ -203,6 +220,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             ]
         );
 
+        // 3) Generate the template
         $generator->generateFile(
             'templates/registration/register.html.twig',
             'registration/twig_template.tpl.php',
@@ -211,11 +229,29 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             ]
         );
 
+        // 4) Update the User class if necessary
+        if ($input->getOption('add-unique-entity-constraint')) {
+            $classDetails = new ClassDetails($userClass);
+            $userManipulator = new ClassSourceManipulator(
+                file_get_contents($classDetails->getPath())
+            );
+            $userManipulator->setIo($io);
+
+            $userManipulator->addAnnotationToClass(
+                UniqueEntity::class,
+                [
+                    'fields' => [$usernameField],
+                    'message' => sprintf('There is already an account with this '.$usernameField),
+                ]
+            );
+            $this->fileManager->dumpFile($classDetails->getPath(), $userManipulator->getSourceCode());
+        }
+
         $generator->writeChanges();
 
         $this->writeSuccessMessage($io);
         $io->text('Next: Go to /register to check out your new form!');
-        $io->text('Then, make any changes you need to the form, controller & template.');
+        $io->text('Make any changes you need to the form, controller & template.');
     }
 
     public function configureDependencies(DependencyBuilder $dependencies)

src/Util/ClassDetails.php

@@ -53,4 +53,25 @@ private function getProperties(): array
 
         return $propertiesList;
     }
+
+    public function getPath(): string
+    {
+        return (new \ReflectionClass($this->fullClassName))->getFileName();
+    }
+
+    /**
+     * An imperfect, but simple way to check for the presence of an annotation.
+     *
+     * @param string $annotation The annotation - e.g. @UniqueEntity
+     */
+    public function doesDocBlockContainAnnotation(string $annotation): bool
+    {
+        $docComment = (new \ReflectionClass($this->fullClassName))->getDocComment();
+
+        if (false === $docComment) {
+            return false;
+        }
+
+        return false !== strpos($docComment, $annotation);
+    }
 }

src/Util/ClassSourceManipulator.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use PhpParser\BuilderHelpers;
+use PhpParser\Comment\Doc;
 use PhpParser\Lexer;
 use PhpParser\Node;
 use PhpParser\Parser;
@@ -270,6 +271,44 @@ public function addProperty(string $name, array $annotationLines = [], $defaultV
         $this->addNodeAfterProperties($newPropertyNode);
     }
 
+    public function addAnnotationToClass(string $annotationClass, array $options)
+    {
+        $annotationClassAlias = $this->addUseStatementIfNecessary($annotationClass);
+        $docComment = $this->getClassNode()->getDocComment();
+
+        $docLines = $docComment ? explode("\n", $docComment->getText()) : [];
+        if (0 === \count($docLines)) {
+            $docLines = ['/**', ' */'];
+        } elseif (1 === \count($docLines)) {
+            // /** inline doc syntax */
+            // imperfect way to try to find where to split the lines
+            $endOfOpening = strpos($docLines[0], '* ');
+            $endingPosition = strrpos($docLines[0], ' *', $endOfOpening);
+            $extraComments = trim(substr($docLines[0], $endOfOpening + 2, $endingPosition - $endOfOpening - 2));
+            $newDocLines = [
+                substr($docLines[0], 0, $endOfOpening + 1),
+            ];
+
+            if ($extraComments) {
+                $newDocLines[] = ' * '.$extraComments;
+            }
+
+            $newDocLines[] = substr($docLines[0], $endingPosition);
+            $docLines = $newDocLines;
+        }
+
+        array_splice(
+            $docLines,
+            \count($docLines) - 1,
+            0,
+            ' * '.$this->buildAnnotationLine('@'.$annotationClassAlias, $options)
+        );
+
+        $docComment = new Doc(implode("\n", $docLines));
+        $this->getClassNode()->setDocComment($docComment);
+        $this->updateSourceCodeFromNewStmts();
+    }
+
     private function addCustomGetter(string $propertyName, string $methodName, $returnType, bool $isReturnTypeNullable, array $commentLines = [], $typeCast = null)
     {
         $propertyFetch = new Node\Expr\PropertyFetch(new Node\Expr\Variable('this'), $propertyName);

tests/Maker/FunctionalTest.php

@@ -695,6 +695,7 @@ function (string $output, string $directory) {
                 // username field guessed
                 // password guessed
                 // firewall name guessed
+                '', // yes to add UniqueEntity
                 '', // yes authenticate after
                 // 1 authenticator will be guessed
             ])
@@ -710,6 +711,7 @@ function (string $output, string $directory) {
                 'App\\Entity\\User',
                 'emailAlt', // username field
                 'passwordAlt', // password field
+                'n', // no UniqueEntity
                 '', // yes authenticate after
                 'main', // firewall
                 '1' // authenticator
@@ -721,6 +723,7 @@ function (string $output, string $directory) {
             $this->getMakerInstance(MakeRegistrationForm::class),
             [
                 // all basic data guessed
+                'y', // add UniqueEntity
                 'n', // no authenticate after
                 'app_anonymous', // route name to redirect to
             ])

tests/Util/ClassSourceManipulatorTest.php

@@ -565,4 +565,136 @@ public function testAddMethodWithBody()
 
         $this->assertSame($expectedSource, $manipulator->getSourceCode());
     }
+
+    /**
+     * @dataProvider getTestsForAddAnnotationToClass
+     */
+    public function testAddAnnotationToClass(string $source, string $expectedSource)
+    {
+        $manipulator = new ClassSourceManipulator($source);
+        $manipulator->addAnnotationToClass('Bar\\SomeAnnotation', [
+            'message' => 'Foo'
+        ]);
+
+        $this->assertEquals($expectedSource, $manipulator->getSourceCode());
+    }
+
+    public function getTestsForAddAnnotationToClass()
+    {
+        yield 'no_doc_block' => [
+            <<<EOF
+<?php
+
+namespace Acme;
+
+class Foo
+{
+}
+EOF
+            ,
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar\SomeAnnotation;
+
+/**
+ * @SomeAnnotation(message="Foo")
+ */
+class Foo
+{
+}
+EOF
+        ];
+
+        yield 'normal_doc_block' => [
+            <<<EOF
+<?php
+
+namespace Acme;
+
+/**
+ * I'm a class!
+ */
+class Foo
+{
+}
+EOF
+            ,
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar\SomeAnnotation;
+
+/**
+ * I'm a class!
+ * @SomeAnnotation(message="Foo")
+ */
+class Foo
+{
+}
+EOF
+        ];
+
+        yield 'simple_inline_doc_block' => [
+            <<<EOF
+<?php
+
+namespace Acme;
+
+/** I'm a class! */
+class Foo
+{
+}
+EOF
+            ,
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar\SomeAnnotation;
+
+/**
+ * I'm a class!
+ * @SomeAnnotation(message="Foo")
+ */
+class Foo
+{
+}
+EOF
+        ];
+
+        yield 'weird_inline_doc_block' => [
+            <<<EOF
+<?php
+
+namespace Acme;
+
+/** **I'm a class!** ***/
+class Foo
+{
+}
+EOF
+            ,
+            <<<EOF
+<?php
+
+namespace Acme;
+
+use Bar\SomeAnnotation;
+
+/**
+ * **I'm a class!**
+ * @SomeAnnotation(message="Foo")
+ ***/
+class Foo
+{
+}
+EOF
+        ];
+    }
 }

tests/fixtures/MakeRegistrationFormEntity/tests/RegistrationFormTest.php

@@ -51,16 +51,17 @@ public function testRegistrationValidationError()
         $crawler = $client->request('GET', '/register');
         $form = $crawler->selectButton('Register')->form();
         $form['registration_form[email]'] = '[email protected]';
-        $form['registration_form[password]'] = 'foo';
+        $form['registration_form[plainPassword]'] = 'foo';
         $client->submit($form);
 
         $this->assertSame(200, $client->getResponse()->getStatusCode());
+        $this->assertContains(
+            'There is already an account with this email',
+            $client->getResponse()->getContent()
+        );
         $this->assertContains(
             'Your password should be at least 6 characters',
             $client->getResponse()->getContent()
         );
-        $client->followRedirect();
-        $this->assertSame(200, $client->getResponse()->getStatusCode());
-        $this->assertSame('Page Success', $client->getResponse()->getContent());
     }
 }