[Toolkit] Add StimulusController support, extract logic to KitSynchronizer, rewrite installation system, create dedicated Installer/Pool system, make classes not readonly (PHP 8.1 comptability)

Author: Kocal

src/Toolkit/bin/ux-toolkit-kit-debug

@@ -20,7 +20,7 @@ use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Contracts\Service\ServiceLocatorTrait;
 use Symfony\Contracts\Service\ServiceProviderInterface;
 use Symfony\UX\Toolkit\Command\DebugKitCommand;
-use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
+use Symfony\UX\Toolkit\Kit\KitSynchronizer;
 use Symfony\UX\Toolkit\Kit\KitFactory;
 use Symfony\UX\Toolkit\Registry\GitHubRegistry;
 use Symfony\UX\Toolkit\Registry\LocalRegistry;
@@ -46,7 +46,7 @@ if (!class_exists(Application::class)) {
 }
 
 $filesystem = new Filesystem();
-$kitFactory = new KitFactory($filesystem, new DependenciesResolver($filesystem));
+$kitFactory = new KitFactory($filesystem, new KitSynchronizer($filesystem));
 $registryFactory = new RegistryFactory(new class([
     Type::Local->value => fn () => new LocalRegistry($kitFactory, $filesystem, getcwd() ?? throw new \RuntimeException('The current working directory could not be determined.')),
     Type::GitHub->value => fn () => new GitHubRegistry($kitFactory, $filesystem, class_exists(HttpClient::class) ? HttpClient::create() : null),

src/Toolkit/bin/ux-toolkit-kit-lint

@@ -20,7 +20,7 @@ use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Contracts\Service\ServiceLocatorTrait;
 use Symfony\Contracts\Service\ServiceProviderInterface;
 use Symfony\UX\Toolkit\Command\LintKitCommand;
-use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
+use Symfony\UX\Toolkit\Kit\KitSynchronizer;
 use Symfony\UX\Toolkit\Kit\KitFactory;
 use Symfony\UX\Toolkit\Registry\GitHubRegistry;
 use Symfony\UX\Toolkit\Registry\LocalRegistry;
@@ -46,7 +46,7 @@ if (!class_exists(Application::class)) {
 }
 
 $filesystem = new Filesystem();
-$kitFactory = new KitFactory($filesystem, new DependenciesResolver($filesystem));
+$kitFactory = new KitFactory($filesystem, new KitSynchronizer($filesystem));
 $registryFactory = new RegistryFactory(new class([
     Type::Local->value => fn () => new LocalRegistry($kitFactory, $filesystem, getcwd() ?? throw new \RuntimeException('The current working directory could not be determined.')),
     Type::GitHub->value => fn () => new GitHubRegistry($kitFactory, $filesystem, class_exists(HttpClient::class) ? HttpClient::create() : null),

src/Toolkit/config/services.php

@@ -13,11 +13,9 @@
 
 use Symfony\UX\Toolkit\Command\DebugKitCommand;
 use Symfony\UX\Toolkit\Command\InstallComponentCommand;
-use Symfony\UX\Toolkit\Command\InstallKitCommand;
 use Symfony\UX\Toolkit\Command\LintKitCommand;
-use Symfony\UX\Toolkit\Component\ComponentInstaller;
-use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
 use Symfony\UX\Toolkit\Kit\KitFactory;
+use Symfony\UX\Toolkit\Kit\KitSynchronizer;
 use Symfony\UX\Toolkit\Registry\GitHubRegistry;
 use Symfony\UX\Toolkit\Registry\LocalRegistry;
 use Symfony\UX\Toolkit\Registry\RegistryFactory;
@@ -40,15 +38,7 @@
             ->args([
                 param('ux_toolkit.kit'),
                 service('.ux_toolkit.registry.factory'),
-                service('.ux_toolkit.component.component_installer'),
-            ])
-            ->tag('console.command')
-
-        ->set('.ux_toolkit.command.install_kit', InstallKitCommand::class)
-            ->args([
-                param('ux_toolkit.kit'),
-                service('.ux_toolkit.registry.factory'),
-                service('.ux_toolkit.component.component_installer'),
+                service('filesystem'),
             ])
             ->tag('console.command')
 
@@ -84,30 +74,15 @@
 
         // Kit
 
-        ->set('.ux_toolkit.kit.factory', KitFactory::class)
-            ->args([
-                service('filesystem'),
-                service('.ux_toolkit.dependency.dependencies_resolver'),
-            ])
-
         ->set('.ux_toolkit.kit.kit_factory', KitFactory::class)
             ->args([
                 service('filesystem'),
-                service('.ux_toolkit.dependency.dependencies_resolver'),
-            ])
-
-        // Component
-        ->set('.ux_toolkit.component.component_installer', ComponentInstaller::class)
-            ->args([
-                service('filesystem'),
+                service('.ux_toolkit.kit.kit_synchronizer'),
             ])
 
-        // Dependency
-
-        ->set('.ux_toolkit.dependency.dependencies_resolver', DependenciesResolver::class)
+        ->set('.ux_toolkit.kit.kit_synchronizer', KitSynchronizer::class)
             ->args([
                 service('filesystem'),
             ])
-
     ;
 };

src/Toolkit/src/Assert.php

@@ -11,7 +11,7 @@
 
 namespace Symfony\UX\Toolkit;
 
-final readonly class Assert
+final class Assert
 {
     /**
      * Assert that the kit name is valid (ex: "Shadcn", "Tailwind", "Bootstrap", etc.).
@@ -52,7 +52,14 @@ public static function phpPackageName(string $name): void
     {
         // Taken from https://github.com/composer/composer/blob/main/res/composer-schema.json
         if (1 !== preg_match('/^[a-z0-9]([_.-]?[a-z0-9]+)*\/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$/', $name)) {
-            throw new \InvalidArgumentException(\sprintf('Invalid package name "%s".', $name));
+            throw new \InvalidArgumentException(\sprintf('Invalid PHP package name "%s".', $name));
+        }
+    }
+
+    public static function stimulusControllerName(string $name): void
+    {
+        if (1 !== preg_match('/^[a-z][a-z0-9-]*[a-z0-9]$/', $name)) {
+            throw new \InvalidArgumentException(\sprintf('Invalid Stimulus controller name "%s".', $name));
         }
     }
 }

src/Toolkit/src/Component/Component.php renamed to src/Toolkit/src/Asset/Component.php

@@ -9,12 +9,13 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\UX\Toolkit\Component;
+namespace Symfony\UX\Toolkit\Asset;
 
 use Symfony\UX\Toolkit\Assert;
 use Symfony\UX\Toolkit\Dependency\ComponentDependency;
 use Symfony\UX\Toolkit\Dependency\Dependency;
 use Symfony\UX\Toolkit\Dependency\PhpPackageDependency;
+use Symfony\UX\Toolkit\Dependency\StimulusControllerDependency;
 use Symfony\UX\Toolkit\File\Doc;
 use Symfony\UX\Toolkit\File\File;
 
@@ -58,6 +59,10 @@ public function addDependency(Dependency $dependency): void
             if ($existingDependency instanceof ComponentDependency && $existingDependency->name === $dependency->name) {
                 return;
             }
+
+            if ($existingDependency instanceof StimulusControllerDependency && $existingDependency->name === $dependency->name) {
+                return;
+            }
         }
 
         $this->dependencies[] = $dependency;

src/Toolkit/src/Asset/StimulusController.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony 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\UX\Toolkit\Asset;
+
+use Symfony\UX\Toolkit\Assert;
+use Symfony\UX\Toolkit\File\File;
+
+/**
+ * @internal
+ *
+ * @author Hugo Alliaume <[email protected]>
+ */
+class StimulusController
+{
+    /**
+     * @param non-empty-string $name
+     * @param list<File>       $files
+     */
+    public function __construct(
+        public readonly string $name,
+        public readonly array $files,
+    ) {
+        Assert::stimulusControllerName($this->name);
+
+        if ([] === $files) {
+            throw new \InvalidArgumentException(\sprintf('Stimulus controller "%s" has no files.', $name));
+        }
+    }
+}

src/Toolkit/src/Command/InstallComponentCommand.php

@@ -11,20 +11,18 @@
 
 namespace Symfony\UX\Toolkit\Command;
 
-use Composer\InstalledVersions;
 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\Style\SymfonyStyle;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Filesystem\Path;
-use Symfony\UX\Toolkit\Component\Component;
-use Symfony\UX\Toolkit\Component\ComponentInstaller;
-use Symfony\UX\Toolkit\Dependency\ComponentDependency;
-use Symfony\UX\Toolkit\Dependency\PhpPackageDependency;
-use Symfony\UX\Toolkit\Exception\ComponentAlreadyExistsException;
+use Symfony\UX\Toolkit\Asset\Component;
+use Symfony\UX\Toolkit\File\File;
+use Symfony\UX\Toolkit\Installer\Installer;
 use Symfony\UX\Toolkit\Kit\Kit;
 use Symfony\UX\Toolkit\Registry\RegistryFactory;
 
@@ -46,7 +44,7 @@ class InstallComponentCommand extends Command
     public function __construct(
         private readonly string $kitName,
         private readonly RegistryFactory $registryFactory,
-        private readonly ComponentInstaller $componentInstaller,
+        private readonly Filesystem $filesystem,
     ) {
         parent::__construct();
     }
@@ -87,7 +85,6 @@ protected function configure(): void
     protected function initialize(InputInterface $input, OutputInterface $output): void
     {
         $this->io = new SymfonyStyle($input, $output);
-        $this->isInteractive = $input->isInteractive();
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -123,29 +120,23 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-        // Install the component and dependencies
-        $destination = $input->getOption('destination');
+        $this->io->text(\sprintf('Installing component <info>%s</>...', $component->name));
 
-        if (!$this->installComponent($kit, $component, $destination)) {
-            return Command::FAILURE;
-        }
+        $installer = new Installer($this->filesystem, fn (string $question) => $this->io->confirm($question, $input->isInteractive()));
+        $installationReport = $installer->installComponent($kit, $component, $destinationPath = $input->getOption('destination'), $input->getOption('force'));
 
-        // Iterate over the component's dependencies
-        $phpDependenciesToInstall = [];
-        foreach ($component->getDependencies() as $dependency) {
-            if ($dependency instanceof ComponentDependency) {
-                if (!$this->installComponent($kit, $kit->getComponent($dependency->name), $destination)) {
-                    return Command::FAILURE;
-                }
-            } elseif ($dependency instanceof PhpPackageDependency && !InstalledVersions::isInstalled($dependency->name)) {
-                $phpDependenciesToInstall[] = $dependency;
-            }
+        if ([] === $installationReport->newFiles) {
+            $this->io->warning('The component has not been installed.');
+
+            return Command::SUCCESS;
         }
 
-        $this->io->success(\sprintf('The component "%s" has been installed.', $component->name));
+        $this->io->success('The component has been installed.');
+        $this->io->writeln('The following file(s) have been added to your project:');
+        $this->io->listing(array_map(fn (File $file) => Path::join($destinationPath, $file->relativePathName), $installationReport->newFiles));
 
-        if ([] !== $phpDependenciesToInstall) {
-            $this->io->writeln(\sprintf('Run <info>composer require %s</info> to install the required PHP dependencies.', implode(' ', $phpDependenciesToInstall)));
+        if ([] !== $installationReport->suggestedPhpPackages) {
+            $this->io->writeln(\sprintf('Run <info>composer require %s</> to install the required PHP dependencies.', implode(' ', $installationReport->suggestedPhpPackages)));
             $this->io->newLine();
         }
 
@@ -168,33 +159,4 @@ private function getAlternativeComponents(Kit $kit, string $componentName): arra
 
         return $alternative;
     }
-
-    private function installComponent(Kit $kit, Component $component, string $destination, bool $force = false): bool
-    {
-        try {
-            $this->io->text(\sprintf('<info>Installing component "%s"...</>', $component->name));
-
-            $this->componentInstaller->install($kit, $component, $destination);
-        } catch (ComponentAlreadyExistsException) {
-            if ($force) {
-                $this->componentInstaller->install($kit, $component, $destination, true);
-
-                return true;
-            }
-
-            $this->io->warning(\sprintf('The component "%s" already exists.', $component->name));
-
-            if ($this->isInteractive) {
-                if ($this->io->confirm('Do you want to overwrite it?')) {
-                    $this->componentInstaller->install($kit, $component, $destination, true);
-
-                    return true;
-                }
-            } else {
-                return false;
-            }
-        }
-
-        return true;
-    }
 }