The possibility to specify a path to the settings file

src/Config/FileConfigManager.php

@@ -0,0 +1,175 @@
+<?php
+
+namespace Spatie\Ignition\Config;
+
+use Spatie\Ignition\Contracts\ConfigManager;
+use Throwable;
+
+class FileConfigManager implements ConfigManager
+{
+    private const SETTINGS_FILE_NAME = '.ignition.json';
+
+    private string $path;
+
+    private string $file;
+
+    public function __construct(string $path = '')
+    {
+        $this->path = $this->initPath($path);
+        $this->file = $this->createFile();
+    }
+
+    protected function initPath(string $path): string
+    {
+        if ($path !== '') {
+            return $this->initPathFromArgument($path);
+        }
+
+        return $this->initPathFromEnvironment();
+    }
+
+    private function initPathFromArgument(string $path): string
+    {
+        if ($this->isValidPath($path)) {
+            return $this->preparePath($path);
+        }
+
+        return '';
+    }
+
+    private function isValidPath(string $path): bool
+    {
+        return file_exists($path) && is_writable($path);
+    }
+
+    private function initPathFromEnvironment(): string
+    {
+        if ($this->isWindows()) {
+            if (empty($_SERVER['HOMEDRIVE']) || empty($_SERVER['HOMEPATH'])) {
+                return '';
+            }
+
+            $homeDirectory = $_SERVER['HOMEDRIVE'] . $_SERVER['HOMEPATH'];
+
+            return $this->preparePath($homeDirectory);
+        }
+
+        if ($homeDirectory = getenv('HOME')) {
+            return $this->preparePath($homeDirectory);
+        }
+
+        return '';
+    }
+
+    private function isWindows(): bool
+    {
+        return str_starts_with(strtoupper(PHP_OS), 'WIN');
+    }
+
+    private function preparePath(string $path): string
+    {
+        return rtrim($path, DIRECTORY_SEPARATOR);
+    }
+
+    protected function createFile(): string
+    {
+        if ($this->createPersistent()) {
+            return $this->generateFullFileName();
+        }
+
+        return '';
+    }
+
+    private function generateFullFileName(): string
+    {
+        return $this->path . DIRECTORY_SEPARATOR . self::SETTINGS_FILE_NAME;
+    }
+
+    /** {@inheritDoc} */
+    public function load(): array
+    {
+        return $this->readFromFile();
+    }
+
+    private function readFromFile()
+    {
+        if (! $this->isFileCreated()) {
+            return [];
+        }
+
+        if (! $this->isFileValid()) {
+            return [];
+        }
+
+        $content = (string)file_get_contents($this->file);
+        $settings = json_decode($content, true) ?? [];
+
+        return $settings;
+    }
+
+    /** {@inheritDoc} */
+    public function save(array $options): bool
+    {
+        return $this->saveToFile($options);
+    }
+
+    private function saveToFile(array $options): bool
+    {
+        if (! $this->isFileCreated()) {
+            return false;
+        }
+
+        if (! $this->isFileValid()) {
+            return false;
+        }
+
+        try {
+            file_put_contents($this->file, json_encode($options, JSON_THROW_ON_ERROR));
+        } catch (Throwable) {
+            return false;
+        }
+
+        return true;
+    }
+
+    protected function isFileCreated(): bool
+    {
+        return $this->file !== '';
+    }
+
+    protected function isFileValid(): bool
+    {
+        return file_exists($this->file) && @is_writable($this->file);
+    }
+
+    /** {@inheritDoc} */
+    public function createPersistent(): bool
+    {
+        if ($this->isEmptyPath()) {
+            return false;
+        }
+
+        $file = $this->generateFullFileName();
+
+        if (file_exists($file)) {
+            return true;
+        }
+
+        return (file_put_contents($file, '') !== false);
+    }
+
+    private function isEmptyPath(): bool
+    {
+        return trim($this->path) === '';
+    }
+
+    /** {@inheritDoc} */
+    public function getPersistentInfo(): array
+    {
+        return [
+            'name' => self::SETTINGS_FILE_NAME,
+            'path' => $this->path,
+            'file' => $this->file,
+        ];
+    }
+}

src/Config/IgnitionConfig.php

@@ -3,10 +3,13 @@
 namespace Spatie\Ignition\Config;
 
 use Illuminate\Contracts\Support\Arrayable;
+use Spatie\Ignition\Contracts\ConfigManager;
 use Throwable;
 
 class IgnitionConfig implements Arrayable
 {
+    private ConfigManager $manager;
+
     public static function loadFromConfigFile(): self
     {
         return (new self())->loadConfigFile();
@@ -20,6 +23,7 @@ public function __construct(protected array $options = [])
         $defaultOptions = $this->getDefaultOptions();
 
         $this->options = array_merge($defaultOptions, $options);
+        $this->manager = $this->initConfigManager();
     }
 
     public function setOption(string $name, string $value): self
@@ -29,6 +33,15 @@ public function setOption(string $name, string $value): self
         return $this;
     }
 
+    private function initConfigManager(): ConfigManager
+    {
+        try {
+            return app(ConfigManager::class);
+        } catch (Throwable) {
+            return new FileConfigManager();
+        }
+    }
+
     /** @param array<string, string> $options */
     public function merge(array $options): self
     {
@@ -47,39 +60,16 @@ public function loadConfigFile(): self
     /** @return array<string, mixed> */
     public function getConfigOptions(): array
     {
-        $configFilePath = (new DefaultConfigFinder())->getConfigFilePath();
-
-        $options = [];
-
-        if (file_exists($configFilePath)) {
-            $content = (string)file_get_contents($configFilePath);
-
-            $options = json_decode($content, true) ?? [];
-        }
-
-        return $options;
+        return $this->manager->load();
     }
 
     /**
      * @param array<string, mixed> $options
-     *
      * @return bool
      */
     public function saveValues(array $options): bool
     {
-        $configFilePath = (new DefaultConfigFinder())->getConfigFilePath();
-
-        if (! $configFilePath) {
-            return false;
-        }
-
-        try {
-            file_put_contents($configFilePath, json_encode($options));
-        } catch (Throwable) {
-            return false;
-        }
-
-        return true;
+        return $this->manager->save($options);
     }
 
     public function hideSolutions(): bool
@@ -148,7 +138,6 @@ public function toArray(): array
         ];
     }
 
-
     /**
      * @return array<string, mixed> $options
      */

src/Contracts/ConfigManager.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\Ignition\Contracts;
+
+interface ConfigManager
+{
+    /** @return array<string, mixed> */
+    public function load(): array;
+
+    /** @param array<string, mixed> $options */
+    public function save(array $options): bool;
+
+    public function createPersistent(): bool;
+
+    /** @return array<string, mixed> */
+    public function getPersistentInfo(): array;
+}