[make:*] interactivly install composer dependencies

phpunit.xml.dist

@@ -19,6 +19,7 @@
         <env name="SYMFONY_PHPUNIT_VERSION" value="9.6" />
         <env name="MAKER_SKIP_MERCURE_TEST" value="false"/>
         <env name="MAKER_SKIP_PANTHER_TEST" value="false" />
+        <env name="MAKER_INTERACTIVE_DEPENDENCIES" value="false" />
 <!--    Overrides process timeout when step debugging -->
 <!--    <env name="MAKER_PROCESS_TIMEOUT" value="null" /> -->
     </php>

src/Command/MakerCommand.php

@@ -13,6 +13,7 @@
 
 use Symfony\Bundle\MakerBundle\ApplicationAwareMakerInterface;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\Dependency\DependencyManager;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\FileManager;
@@ -62,6 +63,13 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
             $dependencies = new DependencyBuilder();
             $this->maker->configureDependencies($dependencies, $input);
 
+            // env is for tests - this way we don't have to add a `y` to every test when a dependency is needed.
+            $dependencyManager = new DependencyManager($this->io, getenv('MAKER_INTERACTIVE_DEPENDS') ?? true);
+
+            $this->maker->configureComposerDependencies($dependencyManager);
+
+            $dependencyManager->installRequiredDependencies();
+
             if ($missingPackagesMessage = $dependencies->getMissingPackagesMessage($this->getName())) {
                 throw new RuntimeCommandException($missingPackagesMessage);
             }

src/Dependency/DependencyManager.php

@@ -0,0 +1,118 @@
+<?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\Dependency;
+
+use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\Dependency\Model\OptionalClassDependency;
+use Symfony\Bundle\MakerBundle\Dependency\Model\RequiredClassDependency;
+use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Process\Process;
+
+/**
+ * @author Jesse Rushlow<[email protected]>
+ *
+ * @internal
+ */
+final class DependencyManager
+{
+    /** @var RequiredClassDependency[] */
+    private array $requiredClassDependencies = [];
+
+    /** @var OptionalClassDependency[] */
+    private array $optionalClassDependencies = [];
+
+    public function __construct(
+        private ConsoleStyle $io,
+        private bool $interactiveMode = true,
+    ) {
+    }
+
+    public function addDependency(RequiredClassDependency|OptionalClassDependency|array $dependency): self
+    {
+        $dependencies = [];
+
+        if (!\is_array($dependency)) {
+            $dependencies[] = $dependency;
+        }
+
+        foreach ($dependencies as $dependency) {
+            if ($dependency instanceof RequiredClassDependency) {
+                $this->requiredClassDependencies[] = $dependency;
+
+                continue;
+            }
+
+            $this->optionalClassDependencies[] = $dependency;
+        }
+
+        return $this;
+    }
+
+    public function installRequiredDependencies(): self
+    {
+        foreach ($this->requiredClassDependencies as $dependency) {
+            if (class_exists($dependency->className) || !$this->askToInstallDependency($dependency)) {
+                continue;
+            }
+
+            $dependency->preInstallMessage ?: $this->io->caution($dependency->preInstallMessage);
+
+            $this->runComposer($dependency);
+        }
+
+        return $this;
+    }
+
+    public function installOptionalDependencies(): self
+    {
+        foreach ($this->optionalClassDependencies as $dependency) {
+            if (class_exists($dependency->className) || !$this->askToInstallDependency($dependency)) {
+                continue;
+            }
+
+            $dependency->preInstallMessage ?: $this->io->caution($dependency->preInstallMessage);
+
+            $this->runComposer($dependency);
+        }
+
+        return $this;
+    }
+
+    public function installInteractively(): bool
+    {
+        return $this->interactiveMode;
+    }
+
+    private function askToInstallDependency(RequiredClassDependency|OptionalClassDependency $dependency): bool
+    {
+        return $this->io->confirm(
+            question: sprintf('Do you want us to run <fg=yellow>composer require %s</> for you?', $dependency->composerPackage),
+            default: true // @TODO - Should we default to yes or no on this...
+        );
+    }
+
+    private function runComposer(RequiredClassDependency|OptionalClassDependency $dependency): void
+    {
+        $process = Process::fromShellCommandline(
+            sprintf('composer require%s %s', $dependency->installAsRequireDev ?: ' --dev', $dependency->composerPackage)
+        );
+
+        if (Command::SUCCESS === $process->run()) {
+            return;
+        }
+
+        $this->io->block($process->getErrorOutput());
+
+        throw new RuntimeCommandException(sprintf('Oops! There was a problem installing "%s". You\'ll need to install the package manually.', $dependency->className));
+    }
+}

src/Dependency/Model/AbstractClassDependency.php

@@ -0,0 +1,28 @@
+<?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\Dependency\Model;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+abstract class AbstractClassDependency
+{
+    public function __construct(
+        public string $className,
+        public string $composerPackage,
+        public bool $installAsRequireDev = false,
+        public ?string $preInstallMessage = null,
+    ) {
+    }
+}

src/Dependency/Model/OptionalClassDependency.php

@@ -0,0 +1,21 @@
+<?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\Dependency\Model;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+final class OptionalClassDependency extends AbstractClassDependency
+{
+}

src/Dependency/Model/RequiredClassDependency.php

@@ -0,0 +1,21 @@
+<?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\Dependency\Model;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+final class RequiredClassDependency extends AbstractClassDependency
+{
+}

src/Maker/AbstractMaker.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\MakerBundle\Maker;
 
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\Dependency\DependencyManager;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Component\Console\Command\Command;
@@ -54,4 +55,15 @@ protected function addDependencies(array $dependencies, ?string $message = null)
             $message
         );
     }
+
+    public function configureComposerDependencies(DependencyManager $dependencyManager): void
+    {
+        // @TODO - method here in abstract prevents BC with signature added to `MakerInterface::class`
+    }
+
+    public function configureDependencies(DependencyBuilder $dependencies)
+    {
+        // @TODO - do we deprecate this method in favor of the one above. then remove in 2.x
+        // @TODO - still have plenty of work todo to determine if thats possible or a good idea...
+    }
 }

src/Maker/MakeTwigComponent.php

@@ -12,7 +12,9 @@
 namespace Symfony\Bundle\MakerBundle\Maker;
 
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
-use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\Dependency\DependencyManager;
+use Symfony\Bundle\MakerBundle\Dependency\Model\OptionalClassDependency;
+use Symfony\Bundle\MakerBundle\Dependency\Model\RequiredClassDependency;
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
@@ -28,6 +30,8 @@
  */
 final class MakeTwigComponent extends AbstractMaker
 {
+    private DependencyManager $dependencyManager;
+
     public static function getCommandName(): string
     {
         return 'make:twig-component';
@@ -47,20 +51,44 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
         ;
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies): void
+    public function configureComposerDependencies(DependencyManager $dependencyManager): void
     {
-        $dependencies->addClassDependency(AsTwigComponent::class, 'symfony/ux-twig-component');
+        // $this is a hack - we need the manager later in `interact()`
+        $this->dependencyManager = $dependencyManager;
+
+        $dependencyManager
+            ->addDependency(new RequiredClassDependency(
+                className: AsTwigComponent::class,
+                composerPackage: 'symfony/ux-twig-component',
+                preInstallMessage: 'This command requires the Symfony UX Twig Component Package.'
+            ))
+            ->addDependency(new OptionalClassDependency(
+                className: AsLiveComponent::class,
+                composerPackage: 'symfony/ux-live-component',
+                preInstallMessage: 'The Symfony UX Live Component is needed to make this a live component.'
+            ))
+        ;
+    }
+
+    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
+    {
+        if (!$input->getOption('live')) {
+            $input->setOption('live', $io->confirm('Make this a live component?', false));
+        }
+
+        if (!$input->getOption('live')) {
+            return;
+        }
+
+        // @TODO - with the dependencyManager in `Command` -> we can't use it outside of configure dependencies.....
+        $this->dependencyManager->installOptionalDependencies();
     }
 
     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
         $name = $input->getArgument('name');
         $live = $input->getOption('live');
 
-        if ($live && !class_exists(AsLiveComponent::class)) {
-            throw new \RuntimeException('You must install symfony/ux-live-component to create a live component (composer require symfony/ux-live-component)');
-        }
-
         $factory = $generator->createClassNameDetails(
             $name,
             'Twig\\Components',
@@ -87,11 +115,4 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         $io->writeln(" To render the component, use <fg=yellow><twig:{$shortName} /></>.");
         $io->newLine();
     }
-
-    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
-    {
-        if (!$input->getOption('live')) {
-            $input->setOption('live', $io->confirm('Make this a live component?', false));
-        }
-    }
 }

src/Maker/Security/MakeFormLogin.php

@@ -14,7 +14,8 @@
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
-use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\Dependency\DependencyManager;
+use Symfony\Bundle\MakerBundle\Dependency\Model\RequiredClassDependency;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\FileManager;
 use Symfony\Bundle\MakerBundle\Generator;
@@ -77,22 +78,15 @@ public static function getCommandDescription(): string
         return 'Generate the code needed for the form_login authenticator';
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies): void
+    public function configureComposerDependencies(DependencyManager $dependencyManager): void
     {
-        $dependencies->addClassDependency(
-            SecurityBundle::class,
-            'security'
-        );
-
-        $dependencies->addClassDependency(TwigBundle::class, 'twig');
-
-        // needed to update the YAML files
-        $dependencies->addClassDependency(
-            Yaml::class,
-            'yaml'
-        );
-
-        $dependencies->addClassDependency(DoctrineBundle::class, 'orm');
+        $dependencyManager
+            ->addDependency([
+                new RequiredClassDependency(SecurityBundle::class, 'security'),
+                new RequiredClassDependency(TwigBundle::class, 'twig'),
+                new RequiredClassDependency(Yaml::class, 'yaml'),
+                new RequiredClassDependency(DoctrineBundle::class, 'orm'),
+        ]);
     }
 
     public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void

src/MakerInterface.php

@@ -11,13 +11,15 @@
 
 namespace Symfony\Bundle\MakerBundle;
 
+use Symfony\Bundle\MakerBundle\Dependency\DependencyManager;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 
 /**
  * Interface that all maker commands must implement.
  *
  * @method static string getCommandDescription()
+ * @method        void   configureComposerDependencies(DependencyManager $dependencyManager)
  *
  * @author Ryan Weaver <[email protected]>
  */