feat: add --ymir-file option so you can select a configuration file

carlalexander · carlalexander · commit 01f7b65026ae · 2022-09-22T12:24:46.000-04:00
diff --git a/config/services.yml b/config/services.yml
@@ -4,7 +4,6 @@ parameters:
   build_artifact_path: '%hidden_directory%/build.zip'
   cli_configuration_filepath: '%home_directory%/.ymir/config.json'
   hidden_directory: '%working_directory%/.ymir'
-  project_configuration_filepath: '%working_directory%/ymir.yml'
   stub_directory: '%application_directory%/stubs'
   uploads_directory: '%hidden_directory%/uploads'
   version: '1.32.4'
@@ -57,14 +56,6 @@ services:
     arguments:
       $configurationFilePath: '%cli_configuration_filepath%'
 
-  Ymir\Cli\EventDispatcher\AutowiredEventDispatcher:
-    arguments:
-      - !tagged subscriber
-
-  Ymir\Cli\ProjectConfiguration\ProjectConfiguration:
-    arguments:
-      $configurationFilePath: '%project_configuration_filepath%'
-
   Ymir\Cli\Command\Project\BuildProjectCommand:
     arguments:
       $buildSteps:
@@ -99,3 +90,7 @@ services:
     arguments:
       $deploymentSteps:
         - '@Ymir\Cli\Deployment\StartAndMonitorDeploymentStep'
+
+  Ymir\Cli\EventDispatcher\AutowiredEventDispatcher:
+    arguments:
+      - !tagged subscriber
diff --git a/src/Application.php b/src/Application.php
@@ -14,6 +14,8 @@
 namespace Ymir\Cli;
 
 use Symfony\Component\Console\Application as BaseApplication;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Ymir\Cli\Exception\CommandCancelledException;
 
@@ -42,4 +44,16 @@ public function renderThrowable(\Throwable $exception, OutputInterface $output):
 
         parent::renderThrowable($exception, $output);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getDefaultInputDefinition(): InputDefinition
+    {
+        $definition = parent::getDefaultInputDefinition();
+
+        $definition->addOption(new InputOption('ymir-file', null, InputOption::VALUE_OPTIONAL, 'Path to Ymir project configuration file', 'ymir.yml'));
+
+        return $definition;
+    }
 }
diff --git a/src/EventListener/LoadProjectConfigurationSubscriber.php b/src/EventListener/LoadProjectConfigurationSubscriber.php
@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir command-line tool.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Cli\EventListener;
+
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Ymir\Cli\ProjectConfiguration\ProjectConfiguration;
+
+class LoadProjectConfigurationSubscriber implements EventSubscriberInterface
+{
+    /**
+     * The Ymir project configuration.
+     *
+     * @var ProjectConfiguration
+     */
+    private $projectConfiguration;
+
+    /**
+     * Constructor.
+     */
+    public function __construct(ProjectConfiguration $projectConfiguration)
+    {
+        $this->projectConfiguration = $projectConfiguration;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            ConsoleEvents::COMMAND => 'onConsoleCommand',
+        ];
+    }
+
+    /**
+     * Load the Ymir project configuration.
+     */
+    public function onConsoleCommand(ConsoleCommandEvent $event)
+    {
+        $configurationFilePath = $event->getInput()->getOption('ymir-file');
+
+        if (!is_string($configurationFilePath)) {
+            throw new RuntimeException('The "--ymir-file" option must be a string value');
+        }
+
+        $this->projectConfiguration->loadConfiguration($configurationFilePath);
+    }
+}
diff --git a/src/ProjectConfiguration/ProjectConfiguration.php b/src/ProjectConfiguration/ProjectConfiguration.php
@@ -31,7 +31,7 @@ class ProjectConfiguration implements Arrayable
     private $configuration;
 
     /**
-     * The path to the configuration file.
+     * The path to the Ymir project configuration file.
      *
      * @var string
      */
@@ -47,11 +47,11 @@ class ProjectConfiguration implements Arrayable
     /**
      * Constructor.
      */
-    public function __construct(string $configurationFilePath, Filesystem $filesystem)
+    public function __construct(Filesystem $filesystem, string $configurationFilePath = '')
     {
-        $this->configurationFilePath = $configurationFilePath;
         $this->filesystem = $filesystem;
-        $this->configuration = $this->load($configurationFilePath);
+
+        $this->loadConfiguration($configurationFilePath);
     }
 
     /**
@@ -115,8 +115,12 @@ public function createNew(Collection $project, array $environments, string $type
      */
     public function delete()
     {
+        if ($this->exists()) {
+            $this->filesystem->remove($this->configurationFilePath);
+        }
+
         $this->configuration = [];
-        $this->filesystem->remove($this->configurationFilePath);
+        $this->configurationFilePath = '';
     }
 
     /**
@@ -130,11 +134,11 @@ public function deleteEnvironment(string $environment)
     }
 
     /**
-     * Checks if the project configuration file exists.
+     * Checks if the Ymir project configuration file exists.
      */
     public function exists(): bool
     {
-        return $this->filesystem->exists($this->configurationFilePath);
+        return !empty($this->configurationFilePath) && $this->filesystem->exists($this->configurationFilePath);
     }
 
     /**
@@ -143,7 +147,7 @@ public function exists(): bool
     public function getEnvironment(string $environment): array
     {
         if (!$this->hasEnvironment($environment)) {
-            throw new InvalidArgumentException(sprintf('Environment "%s" not found in ymir.yml file', $environment));
+            throw new InvalidArgumentException(sprintf('Environment "%s" not found in Ymir project configuration file', $environment));
         }
 
         return (array) $this->configuration['environments'][$environment];
@@ -163,7 +167,7 @@ public function getEnvironments(): array
     public function getProjectId(): int
     {
         if (empty($this->configuration['id'])) {
-            throw new RuntimeException('No "id" found in ymir.yml file');
+            throw new RuntimeException('No "id" found in Ymir project configuration file');
         }
 
         return (int) $this->configuration['id'];
@@ -175,7 +179,7 @@ public function getProjectId(): int
     public function getProjectName(): string
     {
         if (empty($this->configuration['name'])) {
-            throw new RuntimeException('No "name" found in ymir.yml file');
+            throw new RuntimeException('No "name" found in Ymir project configuration file');
         }
 
         return (string) $this->configuration['name'];
@@ -187,7 +191,7 @@ public function getProjectName(): string
     public function getProjectType(): string
     {
         if (empty($this->configuration['type'])) {
-            throw new RuntimeException('No "type" found in ymir.yml file');
+            throw new RuntimeException('No "type" found in Ymir project configuration file');
         }
 
         return (string) $this->configuration['type'];
@@ -201,6 +205,25 @@ public function hasEnvironment(string $environment): bool
         return array_key_exists($environment, $this->configuration['environments']);
     }
 
+    /**
+     * Load the given Ymir project configuration file.
+     */
+    public function loadConfiguration(string $configurationFilePath)
+    {
+        $configuration = [];
+
+        if ($this->filesystem->exists($configurationFilePath)) {
+            $configuration = Yaml::parse((string) file_get_contents($configurationFilePath));
+        }
+
+        if (!empty($configuration) && !is_array($configuration)) {
+            throw new RuntimeException('Error parsing Ymir project configuration file');
+        }
+
+        $this->configuration = $configuration;
+        $this->configurationFilePath = $configurationFilePath;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -215,41 +238,27 @@ public function toArray()
     public function validate()
     {
         if (!$this->exists()) {
-            throw new RuntimeException(sprintf('No Ymir project found in the current directory. You can initialize one with the "%s" command.', InitializeProjectCommand::ALIAS));
+            throw new RuntimeException(sprintf('No Ymir project configuration file found. You can create one by initializing a project with the "%s" command.', InitializeProjectCommand::ALIAS));
         } elseif (empty($this->configuration['id'])) {
-            throw new RuntimeException('The ymir.yml file must have an "id"');
+            throw new RuntimeException('The Ymir project configuration file must have an "id"');
         } elseif (empty($this->configuration['environments'])) {
-            throw new RuntimeException('The ymir.yml file must have at least one environment');
+            throw new RuntimeException('The Ymir project configuration file must have at least one environment');
         } elseif (empty($this->configuration['type'])) {
-            throw new RuntimeException('The ymir.yml file must have a "type"');
+            throw new RuntimeException('The Ymir project configuration file must have a "type"');
         } elseif (!in_array($this->configuration['type'], ['bedrock', 'wordpress'])) {
             throw new RuntimeException('The allowed project "type" are "bedrock" or "wordpress"');
         }
     }
 
-    /**
-     * Load the options from the configuration file.
-     */
-    private function load(string $configurationFilePath): array
-    {
-        $configuration = [];
-
-        if ($this->filesystem->exists($configurationFilePath)) {
-            $configuration = Yaml::parse((string) file_get_contents($configurationFilePath));
-        }
-
-        if (!empty($configuration) && !is_array($configuration)) {
-            throw new RuntimeException('Error parsing ymir.yml file');
-        }
-
-        return $configuration;
-    }
-
     /**
      * Save the configuration options to the configuration file.
      */
     private function save()
     {
+        if (empty($this->configurationFilePath)) {
+            throw new RuntimeException('No Ymir project configuration file path set');
+        }
+
         $this->filesystem->dumpFile($this->configurationFilePath, str_replace('!!float 8', '8.0', Yaml::dump($this->configuration, 20, 2, Yaml::DUMP_NULL_AS_TILDE)));
     }
 }
