wip add scaffolding system

Author: kbond

src/Maker/MakeScaffold.php

@@ -0,0 +1,183 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Maker;
+
+use Composer\InstalledVersions;
+use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\Generator;
+use Symfony\Bundle\MakerBundle\InputConfiguration;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Process\Process;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class MakeScaffold extends AbstractMaker
+{
+    private $projectDir;
+    private $availableScaffolds;
+    private $installedScaffolds = [];
+    private $installedPackages = [];
+
+    public function __construct($projectDir)
+    {
+        $this->projectDir = $projectDir;
+    }
+
+    public static function getCommandName(): string
+    {
+        return 'make:scaffold';
+    }
+
+    public static function getCommandDescription(): string
+    {
+        return 'Create scaffold'; // todo
+    }
+
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
+    {
+        $command
+            ->addArgument('name', InputArgument::OPTIONAL|InputArgument::IS_ARRAY, 'Scaffold name(s) to create')
+        ;
+
+        $inputConfig->setArgumentAsNonInteractive('name');
+    }
+
+    public function configureDependencies(DependencyBuilder $dependencies): void
+    {
+        $dependencies->addClassDependency(Process::class, 'process');
+    }
+
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
+    {
+        $names = $input->getArgument('name');
+
+        if (!$names) {
+            throw new \InvalidArgumentException('You must select at least one scaffold.');
+        }
+
+        foreach ($names as $name) {
+            $this->generateScaffold($name, $io);
+        }
+    }
+
+    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
+    {
+        if ($input->getArgument('name')) {
+            return;
+        }
+
+        $availableScaffolds = array_combine(
+            array_keys($this->availableScaffolds()),
+            array_map(fn(array $scaffold) => $scaffold['description'], $this->availableScaffolds())
+        );
+
+        $input->setArgument('name', [$io->choice('Available scaffolds', $availableScaffolds)]);
+    }
+
+    private function generateScaffold(string $name, ConsoleStyle $io): void
+    {
+        if ($this->isScaffoldInstalled($name)) {
+            return;
+        }
+
+        if (!isset($this->availableScaffolds()[$name])) {
+            throw new \InvalidArgumentException("Scaffold \"{$name}\" does not exist for your version of Symfony.");
+        }
+
+        $scaffold = $this->availableScaffolds()[$name];
+
+        // install dependent scaffolds
+        foreach ($scaffold['dependents'] ?? [] as $dependent) {
+            $this->generateScaffold($dependent, $io);
+        }
+
+        $io->text("Generating <info>{$name}</info> Scaffold...");
+
+        // install required packages
+        foreach ($scaffold['packages'] ?? [] as $package => $env) {
+            if (!$this->isPackageInstalled($package)) {
+                $io->text("Installing <comment>{$package}</comment>...");
+
+                // todo composer bin detection
+                $command = ['composer', 'require', '--no-scripts', 'dev' === $env ? '--dev' : null, $package];
+                $process = new Process(array_filter($command), $this->projectDir);
+
+                $process->run();
+
+                if (!$process->isSuccessful()) {
+                    throw new \RuntimeException("Error installing \"{$package}\".");
+                }
+
+                $this->installedPackages[] = $package;
+            }
+        }
+
+        $io->text('Copying scaffold files...');
+
+        (new Filesystem())->mirror($scaffold['dir'], $this->projectDir, null, ['override' => true]);
+
+        $io->text("Successfully installed scaffold <info>{$name}</info>.");
+        $io->newLine();
+
+        $this->installedScaffolds[] = $name;
+    }
+
+    private function availableScaffolds(): array
+    {
+        if (is_array($this->availableScaffolds)) {
+            return $this->availableScaffolds;
+        }
+
+        $this->availableScaffolds = [];
+        $finder = Finder::create()
+            // todo, improve versioning system
+            ->in(\sprintf('%s/../Resources/scaffolds/%s.0', __DIR__, Kernel::MAJOR_VERSION))
+            ->name('*.json')
+        ;
+
+        foreach ($finder as $file) {
+            $name = $file->getFilenameWithoutExtension();
+
+            $this->availableScaffolds[$name] = array_merge(
+                json_decode(file_get_contents($file), true),
+                ['dir' => dirname($file->getRealPath()).'/'.$name]
+            );
+        }
+
+        return $this->availableScaffolds;
+    }
+
+    /**
+     * Detect if package already installed or installed in this process
+     * (when installing multiple scaffolds at once).
+     */
+    private function isPackageInstalled(string $package): bool
+    {
+        return InstalledVersions::isInstalled($package) || \in_array($package, $this->installedPackages, true);
+    }
+
+    /**
+     * Detect if package is installed in the same process (when installing
+     * multiple scaffolds at once).
+     */
+    private function isScaffoldInstalled(string $name): bool
+    {
+        return \in_array($name, $this->installedScaffolds, true);
+    }
+}

src/Resources/config/makers.xml

@@ -25,6 +25,11 @@
                 <tag name="maker.command" />
             </service>
 
+            <service id="maker.maker.make_scaffold" class="Symfony\Bundle\MakerBundle\Maker\MakeScaffold">
+                <argument>%kernel.project_dir%</argument>
+                <tag name="maker.command" />
+            </service>
+
             <service id="maker.maker.make_crud" class="Symfony\Bundle\MakerBundle\Maker\MakeCrud">
                 <argument type="service" id="maker.doctrine_helper" />
                 <argument type="service" id="maker.renderer.form_type_renderer" />

src/Resources/scaffolds/6.0/auth.json

@@ -0,0 +1,10 @@
+{
+    "description": "Create login form and tests.",
+    "dependents": [
+        "homepage",
+        "user"
+    ],
+    "packages": {
+        "profiler": "dev"
+    }
+}

src/Resources/scaffolds/6.0/auth/config/packages/security.yaml

@@ -0,0 +1,58 @@
+security:
+    enable_authenticator_manager: true
+    # https://symfony.com/doc/current/security.html#registering-the-user-hashing-passwords
+    password_hashers:
+        Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface: 'auto'
+    # https://symfony.com/doc/current/security.html#loading-the-user-the-user-provider
+    providers:
+        # used to reload user from session & other features (e.g. switch_user)
+        app_user_provider:
+            entity:
+                class: App\Entity\User
+                property: email
+    firewalls:
+        dev:
+            pattern: ^/(_(profiler|wdt)|css|images|js)/
+            security: false
+        main:
+            lazy: true
+            provider: app_user_provider
+            form_login:
+                login_path: login
+                check_path: login
+                username_parameter: email
+                password_parameter: password
+                enable_csrf: true
+            logout:
+                path: logout
+                # where to redirect after logout
+                target: homepage
+            remember_me:
+                secret: '%kernel.secret%'
+                secure: auto
+                samesite: lax
+
+            # activate different ways to authenticate
+            # https://symfony.com/doc/current/security.html#the-firewall
+
+            # https://symfony.com/doc/current/security/impersonating_user.html
+            # switch_user: true
+
+    # Easy way to control access for large sections of your site
+    # Note: Only the *first* access control that matches will be used
+    access_control:
+        # - { path: ^/admin, roles: ROLE_ADMIN }
+        # - { path: ^/profile, roles: ROLE_USER }
+
+when@test:
+    security:
+        password_hashers:
+            # By default, password hashers are resource intensive and take time. This is
+            # important to generate secure password hashes. In tests however, secure hashes
+            # are not important, waste resources and increase test times. The following
+            # reduces the work factor to the lowest possible values.
+            Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface:
+                algorithm: auto
+                cost: 4 # Lowest possible value for bcrypt
+                time_cost: 3 # Lowest possible value for argon
+                memory_cost: 10 # Lowest possible value for argon

src/Resources/scaffolds/6.0/auth/config/services.yaml

@@ -0,0 +1,28 @@
+# This file is the entry point to configure your own services.
+# Files in the packages/ subdirectory configure your dependencies.
+
+# Put parameters here that don't need to change on each machine where the app is deployed
+# https://symfony.com/doc/current/best_practices.html#use-parameters-for-application-configuration
+parameters:
+
+services:
+    # default configuration for services in *this* file
+    _defaults:
+        autowire: true      # Automatically injects dependencies in your services.
+        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
+
+    # makes classes in src/ available to be used as services
+    # this creates a service per class whose id is the fully-qualified class name
+    App\:
+        resource: '../src/'
+        exclude:
+            - '../src/DependencyInjection/'
+            - '../src/Entity/'
+            - '../src/Kernel.php'
+
+    # add more service definitions when explicit configuration is needed
+    # please note that last definitions always *replace* previous ones
+
+    # programmatic user login service
+    App\Security\LoginUser:
+        $authenticator: '@security.authenticator.form_login.main'

src/Resources/scaffolds/6.0/auth/src/Controller/SecurityController.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
+
+class SecurityController extends AbstractController
+{
+    #[Route(path: '/login', name: 'login')]
+    public function login(AuthenticationUtils $authenticationUtils, Request $request): Response
+    {
+        if ($this->isGranted('IS_AUTHENTICATED_FULLY')) {
+            return new RedirectResponse($request->query->get('target', $this->generateUrl('homepage')));
+        }
+
+        // get the login error if there is one
+        $error = $authenticationUtils->getLastAuthenticationError();
+
+        // current user's username (if already logged in) or last username entered by the user
+        $lastUsername = $this->getUser()?->getUserIdentifier() ?? $authenticationUtils->getLastUsername();
+
+        return $this->render('login.html.twig', ['last_username' => $lastUsername, 'error' => $error]);
+    }
+
+    #[Route(path: '/logout', name: 'logout')]
+    public function logout(): void
+    {
+        throw new \LogicException('This method can be blank - it will be intercepted by the logout key on your firewall.');
+    }
+}

src/Resources/scaffolds/6.0/auth/src/Security/LoginUser.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Security;
+
+use App\Entity\User;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Security\Http\Authentication\UserAuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+
+class LoginUser
+{
+    public function __construct(
+        private UserAuthenticatorInterface $userAuthenticator,
+        private AuthenticatorInterface $authenticator,
+    ) {
+    }
+
+    public function __invoke(User $user, Request $request): void
+    {
+        $this->userAuthenticator->authenticateUser($user, $this->authenticator, $request);
+    }
+}

src/Resources/scaffolds/6.0/auth/templates/login.html.twig

@@ -0,0 +1,31 @@
+{% extends 'base.html.twig' %}
+
+{% block title %}Log in!{% endblock %}
+
+{% block body %}
+<form method="post">
+    {% if error %}
+        <div class="alert alert-danger">{{ error.messageKey|trans(error.messageData, 'security') }}</div>
+    {% endif %}
+
+    <h1 class="h3 mb-3 font-weight-normal">Please sign in</h1>
+    <label for="inputEmail">Email</label>
+    <input type="email" value="{{ last_username }}" name="email" id="inputEmail" class="form-control" autocomplete="email" required autofocus>
+    <label for="inputPassword">Password</label>
+    <input type="password" name="password" id="inputPassword" class="form-control" autocomplete="current-password" required>
+    <input type="hidden" name="_csrf_token" value="{{ csrf_token('authenticate') }}">
+    <div class="checkbox mb-3">
+        <label>
+            <input type="checkbox" checked name="_remember_me"> Remember me
+        </label>
+    </div>
+
+    {% if app.request.query.has('target') %}
+        <input type="hidden" name="_target_path" value="{{ app.request.query.get('target') }}"/>
+    {% endif %}
+
+    <button class="btn btn-lg btn-primary" type="submit">
+        Sign in
+    </button>
+</form>
+{% endblock %}