Making the make:registration-form work without authenticating

Author: weaverryan

src/Maker/MakeRegistrationForm.php

@@ -32,6 +32,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\PasswordType;
+use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Validation;
 
@@ -44,10 +45,13 @@ final class MakeRegistrationForm extends AbstractMaker
 
     private $formTypeRenderer;
 
-    public function __construct(FileManager $fileManager, FormTypeRenderer $formTypeRenderer)
+    private $router;
+
+    public function __construct(FileManager $fileManager, FormTypeRenderer $formTypeRenderer, RouterInterface $router)
     {
         $this->fileManager = $fileManager;
         $this->formTypeRenderer = $formTypeRenderer;
+        $this->router = $router;
     }
 
     public static function getCommandName(): string
@@ -64,6 +68,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
             ->addArgument('password-field', InputArgument::OPTIONAL, 'Field on your User class that stores the hashed password')
             ->addOption('auto-login-authenticator', null, InputOption::VALUE_REQUIRED, 'Authenticator class to use for logging in')
             ->addOption('firewall-name', null, InputOption::VALUE_REQUIRED, 'Firewall key used for authentication')
+            ->addOption('redirect-route-name', null, InputOption::VALUE_REQUIRED, 'Route for redirecting if not authenticating')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeRegistrationForm.txt'))
         ;
 
@@ -82,7 +87,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
 
         $manipulator = new YamlSourceManipulator($this->fileManager->getFileContents($path));
         $securityData = $manipulator->getData();
-        $providersData = $securityData['security']['providers'];
+        $providersData = $securityData['security']['providers'] ?? [];
 
         $input->setArgument(
             'user-class',
@@ -112,6 +117,15 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
                 $securityData,
                 $command
             );
+        } else {
+            $routeNames = array_keys($this->router->getRouteCollection()->all());
+            $input->setOption(
+                'redirect-route-name',
+                $io->choice(
+                    'What route should the user be redirected to after registration?',
+                    $routeNames
+                )
+            );
         }
     }
 
@@ -182,6 +196,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 'authenticator_class_name' => $authenticatorClassName ? Str::getShortClassName($authenticatorClassName) : null,
                 'authenticator_full_class_name' => $authenticatorClassName,
                 'firewall_name' => $input->getOption('firewall-name'),
+                'redirect_route_name' => $input->getOption('redirect-route-name'),
             ]
         );
 

src/Resources/config/makers.xml

@@ -55,6 +55,7 @@
             <service id="maker.maker.make_registration_form" class="Symfony\Bundle\MakerBundle\Maker\MakeRegistrationForm">
                 <argument type="service" id="maker.file_manager" />
                 <argument type="service" id="maker.renderer.form_type_renderer" />
+                <argument type="service" id="router" />
                 <tag name="maker.command" />
             </service>
 

src/Resources/skeleton/registration/RegistrationController.tpl.php

@@ -52,9 +52,7 @@ public function register(Request $request, UserPasswordEncoderInterface $passwor
                 '<?= $firewall_name; ?>' // firewall name in security.yaml
             );
 <?php else: ?>
-            throw new \Exception('TODO - in RegistrationController, decide where to redirect the user');
-
-            return $this->redirectToRoute('<?= $route_name ?>_index');
+            return $this->redirectToRoute('<?= $redirect_route_name ?>');
 <?php endif; ?>
         }
 

tests/Maker/FunctionalTest.php

@@ -700,13 +700,34 @@ function (string $output, string $directory) {
             ])
             ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeRegistrationFormEntity')
             ->configureDatabase()
-            ->setGuardAuthenticator('main', 'App\\Security\\StubAuthenticator')
             ->updateSchemaAfterCommand()
         ];
 
-        // non-standard email & password field
-        // no authenticators
-        // saying no to auto-login
+        // sanity check on all the interactive questions
+        yield 'registration_form_no_guessing' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeRegistrationForm::class),
+            [
+                'App\\Entity\\User',
+                'emailAlt', // username field
+                'passwordAlt', // password field
+                '', // yes authenticate after
+                'main', // firewall
+                '1' // authenticator
+            ])
+            ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeRegistrationFormNoGuessing')
+        ];
+
+        yield 'registration_form_entity_no_authenticate' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeRegistrationForm::class),
+            [
+                // all basic data guessed
+                'n', // no authenticate after
+                'app_anonymous', // route name to redirect to
+            ])
+            ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeRegistrationFormEntity')
+            ->configureDatabase()
+            ->updateSchemaAfterCommand()
+        ];
     }
 
     public function getCommandEntityTests()

tests/fixtures/MakeRegistrationFormEntity/config/routes.yaml

@@ -1,3 +1,7 @@
 app_homepage:
     path: /
     controller: App\Controller\TestingController::homepage
+
+app_anonymous:
+    path: /anonymous
+    controller: App\Controller\TestingController::anonymous

tests/fixtures/MakeRegistrationFormEntity/src/Controller/TestingController.php

@@ -11,6 +11,11 @@ public function homepage()
     {
         $this->denyAccessUnlessGranted('ROLE_USER');
 
-        return new Response('Homepage Success');
+        return new Response('Page Success');
+    }
+
+    public function anonymous()
+    {
+        return new Response('Page Success');
     }
 }

tests/fixtures/MakeRegistrationFormEntity/tests/RegistrationFormTest.php

@@ -29,6 +29,6 @@ public function testGeneratedEntity()
         $this->assertSame(302, $client->getResponse()->getStatusCode());
         $client->followRedirect();
         $this->assertSame(200, $client->getResponse()->getStatusCode());
-        $this->assertSame('Homepage Success', $client->getResponse()->getContent());
+        $this->assertSame('Page Success', $client->getResponse()->getContent());
     }
 }

tests/fixtures/MakeRegistrationFormNoGuessing/config/packages/security.yaml

@@ -0,0 +1,14 @@
+security:
+    encoders:
+        App\Entity\User: bcrypt
+
+    firewalls:
+        main_other:
+            anonymous: true
+        main:
+            anonymous: true
+            guard:
+                entry_point: App\Security\AuthenticatorFirst
+                authenticators:
+                    - App\Security\AuthenticatorFirst
+                    - App\Security\AuthenticatorSecond

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

@@ -0,0 +1,109 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+/**
+ * @ORM\Entity()
+ */
+class User implements UserInterface
+{
+    /**
+     * @ORM\Id()
+     * @ORM\GeneratedValue()
+     * @ORM\Column(type="integer")
+     */
+    private $id;
+
+    /**
+     * @ORM\Column(type="string", length=180, unique=true)
+     */
+    private $emailAlt;
+
+    /**
+     * @ORM\Column(type="array")
+     */
+    private $roles = [];
+
+    /**
+     * @var string The hashed password
+     * @ORM\Column(type="string")
+     */
+    private $passwordAlt;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function getEmailAlt()
+    {
+        return $this->emailAlt;
+    }
+
+    public function setEmailAlt(string $email): self
+    {
+        $this->emailAlt = $email;
+
+        return $this;
+    }
+
+    /**
+     * A visual identifier that represents this user.
+     *
+     * @see UserInterface
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->emailAlt;
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function getRoles(): array
+    {
+        $roles = $this->roles;
+        // guarantee every user at least has ROLE_USER
+        $roles[] = 'ROLE_USER';
+
+        return array_unique($roles);
+    }
+
+    public function setRoles(array $roles): self
+    {
+        $this->roles = $roles;
+
+        return $this;
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function getPasswordAlt(): string
+    {
+        return (string) $this->passwordAlt;
+    }
+
+    public function setPasswordAlt(string $password): self
+    {
+        $this->passwordAlt = $password;
+
+        return $this;
+    }
+
+    public function getPassword()
+    {
+        return $this->passwordAlt;
+    }
+
+    public function getSalt()
+    {
+    }
+
+    public function eraseCredentials()
+    {
+    }
+}

tests/fixtures/MakeRegistrationFormNoGuessing/src/Security/AuthenticatorFirst.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Security;
+
+class AuthenticatorFirst
+{
+}

tests/fixtures/MakeRegistrationFormNoGuessing/src/Security/AuthenticatorSecond.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Security;
+
+class AuthenticatorSecond
+{
+}