add scaffold configuration system to manipulate files

Author: kbond

src/Maker/MakeScaffold.php

@@ -14,6 +14,7 @@
 use Composer\InstalledVersions;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\FileManager;
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Component\Console\Command\Command;
@@ -29,14 +30,14 @@
  */
 final class MakeScaffold extends AbstractMaker
 {
-    private $projectDir;
+    private $files;
     private $availableScaffolds;
     private $installedScaffolds = [];
     private $installedPackages = [];
 
-    public function __construct($projectDir)
+    public function __construct(FileManager $files)
     {
-        $this->projectDir = $projectDir;
+        $this->files = $files;
     }
 
     public static function getCommandName(): string
@@ -116,7 +117,7 @@ private function generateScaffold(string $name, ConsoleStyle $io): void
 
                 // todo composer bin detection
                 $command = ['composer', 'require', '--no-scripts', 'dev' === $env ? '--dev' : null, $package];
-                $process = new Process(array_filter($command), $this->projectDir);
+                $process = new Process(array_filter($command), $this->files->getRootDirectory());
 
                 $process->run();
 
@@ -130,7 +131,13 @@ private function generateScaffold(string $name, ConsoleStyle $io): void
 
         $io->text('Copying scaffold files...');
 
-        (new Filesystem())->mirror($scaffold['dir'], $this->projectDir, null, ['override' => true]);
+        (new Filesystem())->mirror($scaffold['dir'], $this->files->getRootDirectory());
+
+        if (isset($scaffold['configure'])) {
+            $io->text('Executing configuration...');
+
+            $scaffold['configure']($this->files);
+        }
 
         $io->text("Successfully installed scaffold <info>{$name}</info>.");
         $io->newLine();

src/Resources/config/makers.xml

@@ -26,7 +26,7 @@
             </service>
 
             <service id="maker.maker.make_scaffold" class="Symfony\Bundle\MakerBundle\Maker\MakeScaffold">
-                <argument>%kernel.project_dir%</argument>
+                <argument type="service" id="maker.file_manager" />
                 <tag name="maker.command" />
             </service>
 

src/Resources/scaffolds/6.0/auth.php

@@ -1,5 +1,8 @@
 <?php
 
+use Symfony\Bundle\MakerBundle\FileManager;
+use Symfony\Bundle\MakerBundle\Util\YamlSourceManipulator;
+
 return [
     'description' => 'Create login form and tests.',
     'dependents' => [
@@ -8,5 +11,45 @@
     ],
     'packages' => [
         'profiler' => 'dev',
-    ]
+    ],
+    'configure' => function(FileManager $files) {
+        $services = new YamlSourceManipulator($files->getFileContents('config/services.yaml'));
+        $data = $services->getData();
+        $data['services']['App\Security\LoginUser']['$authenticator'] ='@security.authenticator.form_login.main';
+        $services->setData($data);
+        $files->dumpFile('config/services.yaml', $services->getContents());
+
+        $security = new YamlSourceManipulator($files->getFileContents('config/packages/security.yaml'));
+        $data = $security->getData();
+        $data['security']['providers'] = [
+            'app_user_provider' => [
+                'entity' => [
+                    'class' => 'App\Entity\User',
+                    'property' => 'email',
+                ],
+            ],
+        ];
+        $data['security']['firewalls']['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',
+                'target' => 'homepage',
+            ],
+            'remember_me' => [
+                'secret' => '%kernel.secret%',
+                'secure' => 'auto',
+                'samesite' => 'lax',
+            ],
+        ];
+        $security->setData($data);
+        $files->dumpFile('config/packages/security.yaml', $security->getContents());
+    },
 ];

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

@@ -1,5 +1,7 @@
 <?php
 
+use Symfony\Bundle\MakerBundle\FileManager;
+
 return [
     'description' => 'Create registration form and tests.',
     'dependents' => [
@@ -8,5 +10,26 @@
     'packages' => [
         'form' => 'all',
         'validator' => 'all',
-    ]
+    ],
+    'configure' => function(FileManager $files) {
+        $userEntity = $files->getFileContents('src/Entity/User.php');
+
+        if (str_contains($userEntity, $attribute = "#[UniqueEntity(fields: ['email'], message: 'There is already an account with this email')]")) {
+            // unique constraint already there
+            return;
+        }
+
+        $userEntity = str_replace(
+            [
+                '#[ORM\Entity(repositoryClass: UserRepository::class)]',
+                'use Doctrine\ORM\Mapping as ORM;'
+            ],
+            [
+                "#[ORM\Entity(repositoryClass: UserRepository::class)]\n{$attribute}",
+                "use Doctrine\ORM\Mapping as ORM;\nuse Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;",
+            ],
+            $userEntity
+        );
+        $files->dumpFile('src/Entity/User.php', $userEntity);
+    },
 ];

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

@@ -1,5 +1,7 @@
 <?php
 
+use Symfony\Bundle\MakerBundle\FileManager;
+
 return [
     'description' => 'Reset password system using symfonycasts/reset-password-bundle with tests.',
     'dependents' => [
@@ -11,5 +13,11 @@
         'mailer' => 'all',
         'symfonycasts/reset-password-bundle' => 'all',
         'zenstruck/mailer-test' => 'dev',
-    ]
+    ],
+    'configure' => function(FileManager $files) {
+        $files->dumpFile(
+            'config/packages/reset_password.yaml',
+            file_get_contents(__DIR__.'/reset-password/config/packages/reset_password.yaml')
+        );
+    },
 ];