lets stop abusing input arguments

Author: jrushlow

src/Maker/MakeResetPassword.php

@@ -29,7 +29,6 @@
 use Symfony\Bundle\MakerBundle\Util\YamlSourceManipulator;
 use Symfony\Bundle\MakerBundle\Validator;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Yaml\Yaml;
@@ -56,6 +55,14 @@ class MakeResetPassword extends AbstractMaker
     private $doctrineHelper;
     private $entityClassGenerator;
 
+    private $fromEmailAddress;
+    private $fromEmailName;
+    private $controllerResetSuccessRedirect;
+    private $userClass;
+    private $emailPropertyName;
+    private $emailGetterMethodName;
+    private $passwordSetterMethodName;
+
     public function __construct(FileManager $fileManager, DoctrineHelper $doctrineHelper, EntityClassGenerator $entityClassGenerator)
     {
         $this->fileManager = $fileManager;
@@ -73,14 +80,14 @@ public static function getCommandDescription(): string
         return 'Create controller, entity, and repositories for use with symfonycasts/reset-password-bundle';
     }
 
-    public function configureCommand(Command $command, InputConfiguration $inputConfig)
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $command
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeResetPassword.txt'))
         ;
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies)
+    public function configureDependencies(DependencyBuilder $dependencies): void
     {
         $dependencies->addClassDependency(SymfonyCastsResetPasswordBundle::class, 'symfonycasts/reset-password-bundle');
         $dependencies->addClassDependency(MailerInterface::class, 'symfony/mailer');
@@ -98,21 +105,10 @@ public function configureDependencies(DependencyBuilder $dependencies)
         }
     }
 
-    public function interact(InputInterface $input, ConsoleStyle $io, Command $command)
+    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
     {
         $io->title('Let\'s make a password reset feature!');
 
-        // initialize arguments & commands that are internal (i.e. meant only to be asked)
-        $command
-            ->addArgument('from-email-address', InputArgument::REQUIRED)
-            ->addArgument('from-email-name', InputArgument::REQUIRED)
-            ->addArgument('controller-reset-success-redirect', InputArgument::REQUIRED)
-            ->addArgument('user-class')
-            ->addArgument('email-property-name')
-            ->addArgument('email-getter')
-            ->addArgument('password-setter')
-        ;
-
         $interactiveSecurityHelper = new InteractiveSecurityHelper();
 
         if (!$this->fileManager->fileExists($path = 'config/packages/security.yaml')) {
@@ -123,62 +119,48 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
         $securityData = $manipulator->getData();
         $providersData = $securityData['security']['providers'] ?? [];
 
-        $input->setArgument(
-            'user-class',
-            $userClass = $interactiveSecurityHelper->guessUserClass(
-                $io,
-                $providersData,
-                'What is the User entity that should be used with the "forgotten password" feature? (e.g. <fg=yellow>App\\Entity\\User</>)'
-            )
+        $this->userClass = $interactiveSecurityHelper->guessUserClass(
+            $io,
+            $providersData,
+            'What is the User entity that should be used with the "forgotten password" feature? (e.g. <fg=yellow>App\\Entity\\User</>)'
         );
 
-        $input->setArgument(
-            'email-property-name',
-            $interactiveSecurityHelper->guessEmailField($io, $userClass)
-        );
-        $input->setArgument(
-            'email-getter',
-            $interactiveSecurityHelper->guessEmailGetter($io, $userClass, $input->getArgument('email-property-name'))
-        );
-        $input->setArgument(
-            'password-setter',
-            $interactiveSecurityHelper->guessPasswordSetter($io, $userClass)
-        );
+        $this->emailPropertyName = $interactiveSecurityHelper->guessEmailField($io, $this->userClass);
+        $this->emailGetterMethodName = $interactiveSecurityHelper->guessEmailGetter($io, $this->userClass, $this->emailPropertyName);
+        $this->passwordSetterMethodName = $interactiveSecurityHelper->guessPasswordSetter($io, $this->userClass);
 
-        $io->text(sprintf('Implementing reset password for <info>%s</info>', $userClass));
+        $io->text(sprintf('Implementing reset password for <info>%s</info>', $this->userClass));
 
         $io->section('- ResetPasswordController -');
         $io->text('A named route is used for redirecting after a successful reset. Even a route that does not exist yet can be used here.');
-        $input->setArgument('controller-reset-success-redirect', $io->ask(
+
+        $this->controllerResetSuccessRedirect = $io->ask(
             'What route should users be redirected to after their password has been successfully reset?',
             'app_home',
             [Validator::class, 'notBlank']
-        )
         );
 
         $io->section('- Email -');
         $emailText[] = 'These are used to generate the email code. Don\'t worry, you can change them in the code later!';
         $io->text($emailText);
 
-        $input->setArgument('from-email-address', $io->ask(
+        $this->fromEmailAddress = $io->ask(
             'What email address will be used to send reset confirmations? e.g. [email protected]',
             null,
             [Validator::class, 'validateEmailAddress']
-        ));
+        );
 
-        $input->setArgument('from-email-name', $io->ask(
+        $this->fromEmailName = $io->ask(
             'What "name" should be associated with that email address? e.g. "Acme Mail Bot"',
             null,
             [Validator::class, 'notBlank']
-        )
         );
     }
 
-    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
-        $userClass = $input->getArgument('user-class');
         $userClassNameDetails = $generator->createClassNameDetails(
-            '\\'.$userClass,
+            '\\'.$this->userClass,
             'Entity\\'
         );
 
@@ -217,24 +199,24 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 'request_form_type_class_name' => $requestFormTypeClassNameDetails->getShortName(),
                 'reset_form_type_full_class_name' => $changePasswordFormTypeClassNameDetails->getFullName(),
                 'reset_form_type_class_name' => $changePasswordFormTypeClassNameDetails->getShortName(),
-                'password_setter' => $input->getArgument('password-setter'),
-                'success_redirect_route' => $input->getArgument('controller-reset-success-redirect'),
-                'from_email' => $input->getArgument('from-email-address'),
-                'from_email_name' => $input->getArgument('from-email-name'),
-                'email_getter' => $input->getArgument('email-getter'),
-                'email_field' => $input->getArgument('email-property-name'),
+                'password_setter' => $this->passwordSetterMethodName,
+                'success_redirect_route' => $this->controllerResetSuccessRedirect,
+                'from_email' => $this->fromEmailAddress,
+                'from_email_name' => $this->fromEmailName,
+                'email_getter' => $this->emailGetterMethodName,
+                'email_field' => $this->emailPropertyName,
             ]
         );
 
-        $this->generateRequestEntity($generator, $requestClassNameDetails, $repositoryClassNameDetails, $userClass);
+        $this->generateRequestEntity($generator, $requestClassNameDetails, $repositoryClassNameDetails);
 
         $this->setBundleConfig($io, $generator, $repositoryClassNameDetails->getFullName());
 
         $generator->generateClass(
             $requestFormTypeClassNameDetails->getFullName(),
             'resetPassword/ResetPasswordRequestFormType.tpl.php',
             [
-                'email_field' => $input->getArgument('email-property-name'),
+                'email_field' => $this->emailPropertyName,
             ]
         );
 
@@ -257,7 +239,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             'reset_password/request.html.twig',
             'resetPassword/twig_request.tpl.php',
             [
-                'email_field' => $input->getArgument('email-property-name'),
+                'email_field' => $this->emailPropertyName,
             ]
         );
 
@@ -272,7 +254,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         $this->successMessage($input, $io, $requestClassNameDetails->getFullName());
     }
 
-    private function setBundleConfig(ConsoleStyle $io, Generator $generator, string $repositoryClassFullName)
+    private function setBundleConfig(ConsoleStyle $io, Generator $generator, string $repositoryClassFullName): void
     {
         $configFileExists = $this->fileManager->fileExists($path = 'config/packages/reset_password.yaml');
 
@@ -322,7 +304,7 @@ private function setBundleConfig(ConsoleStyle $io, Generator $generator, string
         $generator->dumpFile($path, $manipulator->getContents());
     }
 
-    private function successMessage(InputInterface $input, ConsoleStyle $io, string $requestClassName)
+    private function successMessage(InputInterface $input, ConsoleStyle $io, string $requestClassName): void
     {
         $closing[] = 'Next:';
         $closing[] = sprintf('  1) Run <fg=yellow>"php bin/console make:migration"</> to generate a migration for the new <fg=yellow>"%s"</> entity.', $requestClassName);
@@ -337,7 +319,7 @@ private function successMessage(InputInterface $input, ConsoleStyle $io, string
         $io->newLine();
     }
 
-    private function generateRequestEntity(Generator $generator, ClassNameDetails $requestClassNameDetails, ClassNameDetails $repositoryClassNameDetails, string $userClass): void
+    private function generateRequestEntity(Generator $generator, ClassNameDetails $requestClassNameDetails, ClassNameDetails $repositoryClassNameDetails): void
     {
         $requestEntityPath = $this->entityClassGenerator->generateEntityClass($requestClassNameDetails, false, false, false);
 
@@ -365,7 +347,7 @@ private function generateRequestEntity(Generator $generator, ClassNameDetails $r
 
         $manipulator->addManyToOneRelation((new RelationManyToOne())
             ->setPropertyName('user')
-            ->setTargetClassName($userClass)
+            ->setTargetClassName($this->userClass)
             ->setMapInverseRelation(false)
             ->setCustomReturnType('object', false)
             ->avoidSetter()