components-web-app/api-components-bundle

View on GitHub
src/Command/UserCreateCommand.php

Summary

Maintainability
A
1 hr
Test Coverage
<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <daniel@silverback.is>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\Command;

use Silverback\ApiComponentsBundle\Factory\User\UserFactory;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

/**
 * Based on FOSUserBundle: https://github.com/FriendsOfSymfony/FOSUserBundle/blob/master/Command/CreateUserCommand.php.
 */
#[AsCommand(name: 'silverback:api-components:user:create')]
class UserCreateCommand extends Command
{
    private UserFactory $userFactory;
    private array $questions = [];

    public function __construct(UserFactory $userFactory)
    {
        parent::__construct();
        $this->userFactory = $userFactory;
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Create a user.')
            ->setDefinition(
                [
                    new InputArgument('username', InputArgument::REQUIRED, 'The username'),
                    new InputArgument('email', InputArgument::REQUIRED, 'The email'),
                    new InputArgument('password', InputArgument::REQUIRED, 'The password'),
                    new InputOption('admin', null, InputOption::VALUE_NONE, 'Set the user as super admin'),
                    new InputOption('super-admin', null, InputOption::VALUE_NONE, 'Set the user as super admin'),
                    new InputOption('inactive', null, InputOption::VALUE_NONE, 'Set the user as inactive'),
                    new InputOption('overwrite', null, InputOption::VALUE_NONE, 'Overwrite the user if they already exist'),
                ]
            )
            ->setHelp(
                <<<EOT
                    The <info>silverback:api-components:user:create</info> command creates a user:
                      <info>php %command.full_name% daniel</info>
                    This interactive shell will ask you for an email and then a password.
                    You can alternatively specify the email and password as the second and third arguments:
                      <info>php %command.full_name% daniel daniel@example.com mypassword</info>
                    You can create an admin via the admin flag:
                      <info>php %command.full_name% admin --admin</info>
                    You can create a super admin via the super-admin flag:
                      <info>php %command.full_name% admin --super-admin</info>
                    You can create an inactive user (will not be able to log in):
                      <info>php %command.full_name% disabled_user --inactive</info>
                    You can overwrite a user if they already exist:
                      <info>php %command.full_name% existing_username --overwrite</info>
                    EOT
            );
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $username = (string) $input->getArgument('username');
        $email = (string) $input->getArgument('email');
        $password = (string) $input->getArgument('password');
        $inactive = $input->getOption('inactive');
        $superAdmin = $input->getOption('super-admin');
        $admin = $input->getOption('admin');
        $overwrite = $input->getOption('overwrite');

        $this->userFactory->create($username, $password, $email, $inactive, $superAdmin, $admin, $overwrite);

        $output->writeln(sprintf('Created user: <comment>%s</comment>', $username));

        return 0;
    }

    /**
     * {@inheritdoc}
     */
    protected function interact(InputInterface $input, OutputInterface $output): void
    {
        $this->checkUsernameQuestion($input);
        $this->checkEmailQuestion($input);
        $this->checkPasswordQuestion($input);

        foreach ($this->questions as $name => $question) {
            $answer = $this->getHelper('question')->ask($input, $output, $question);
            $input->setArgument($name, $answer);
        }
    }

    private function checkUsernameQuestion(InputInterface $input): void
    {
        if (!$input->getArgument('username')) {
            $question = new Question('Please choose a username:');
            $question->setValidator(self::getNotEmptyValidator('Username'));
            $this->questions['username'] = $question;
        }
    }

    private function checkPasswordQuestion(InputInterface $input): void
    {
        if (!$input->getArgument('password')) {
            $question = new Question('Please choose a password:');
            $question
                ->setValidator(self::getNotEmptyValidator('Password'))
                ->setHidden(true);
            $this->questions['password'] = $question;
        }
    }

    private function checkEmailQuestion(InputInterface $input): void
    {
        if (!$input->getArgument('email')) {
            $question = new Question('Please choose an email (leave blank to use same as username):');
            $this->questions['email'] = $question;
        }
    }

    private static function getNotEmptyValidator(string $label): callable
    {
        return static function (string $string) use ($label) {
            if (empty($string)) {
                throw new \Exception($label . ' can not be empty');
            }

            return $string;
        };
    }
}