Config Object

bin/slim

@@ -9,13 +9,18 @@
 
 declare(strict_types=1);
 
-use Slim\Console\Application;
+use Slim\Console\App;
+use Slim\Console\Config\ConfigResolver;
+
+$cwd = getcwd();
 
 if (file_exists(__DIR__ . '/../../../autoload.php')) {
     require __DIR__ . '/../../../autoload.php';
 } else {
     require __DIR__ . '/../vendor/autoload.php';
 }
 
-$app = new Application();
+$config = (new ConfigResolver())->resolve($cwd);
+
+$app = new App($config);
 $app->run();

composer.json

@@ -13,14 +13,14 @@
         }
     ],
     "require": {
+        "ext-json": "*",
         "php": "^7.2",
-        "symfony/console": "^5.0",
-        "symfony/config": "^5.0"
+        "symfony/console": "^5.0"
     },
     "require-dev": {
         "adriansuter/php-autoload-override": "^1.0",
         "phpspec/prophecy": "^1.10",
-        "phpstan/phpstan": "^0.12.19",
+        "phpstan/phpstan": "^0.12.23",
         "phpunit/phpunit": "^8.5",
         "squizlabs/php_codesniffer": "^3.5"
     },

src/Application.php → src/App.php

@@ -10,18 +10,31 @@
 
 namespace Slim\Console;
 
+use Slim\Console\Config\Config;
 use Symfony\Component\Console\Application as SymfonyApplication;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
 
-class Application extends SymfonyApplication
+class App extends SymfonyApplication
 {
-    private const VERSION = '0.1';
+    protected const NAME = 'Slim Console';
 
-    public function __construct()
+    protected const VERSION = '0.1';
+
+    /**
+     * @var Config
+     */
+    protected $config;
+
+    /**
+     * @param Config $config
+     */
+    public function __construct(Config $config)
     {
-        parent::__construct('Slim Console', self::VERSION);
+        parent::__construct(static::NAME, static::VERSION);
+
+        $this->config = $config;
     }
 
     /**
@@ -48,4 +61,12 @@ public function doRun(InputInterface $input, OutputInterface $output): int
 
         return parent::doRun($input, $output);
     }
+
+    /**
+     * @return Config
+     */
+    public function getConfig(): Config
+    {
+        return $this->config;
+    }
 }

src/Command/AbstractCommand.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Slim Framework (https://slimframework.com)
+ *
+ * @license https://github.com/slimphp/Slim-Console/blob/0.x/LICENSE.md (MIT License)
+ */
+
+declare(strict_types=1);
+
+namespace Slim\Console\Command;
+
+use RuntimeException;
+use Slim\Console\App;
+use Slim\Console\Config\Config;
+use Symfony\Component\Console\Command\Command;
+
+abstract class AbstractCommand extends Command
+{
+    /**
+     * @return Config|null
+     *
+     * @throws RuntimeException
+     */
+    public function getConfig(): ?Config
+    {
+        $app = $this->getApplication();
+
+        if ($app instanceof App === false) {
+            throw new RuntimeException(
+                'Usage of the method `getConfig()` requires the parent application to be a Slim Console Application.'
+            );
+        }
+
+        return $app->getConfig();
+    }
+}

src/Config/Config.php

@@ -0,0 +1,213 @@
+<?php
+
+/**
+ * Slim Framework (https://slimframework.com)
+ *
+ * @license https://github.com/slimphp/Slim-Console/blob/0.x/LICENSE.md (MIT License)
+ */
+
+declare(strict_types=1);
+
+namespace Slim\Console\Config;
+
+use InvalidArgumentException;
+
+class Config
+{
+    public const SLIM_CONSOLE_BOOTSTRAP_DIR = 'SLIM_CONSOLE_BOOTSTRAP_DIR';
+    public const SLIM_CONSOLE_INDEX_DIR = 'SLIM_CONSOLE_INDEX_DIR';
+    public const SLIM_CONSOLE_INDEX_FILE = 'SLIM_CONSOLE_INDEX_FILE';
+    public const SLIM_CONSOLE_SOURCE_DIR = 'SLIM_CONSOLE_SOURCE_DIR';
+    public const SLIM_CONSOLE_COMMANDS_DIR = 'SLIM_CONSOLE_COMMANDS_DIR';
+
+    /**
+     * @var array<string, string>
+     */
+    protected static $defaults = [
+        'bootstrapDir' => 'app',
+        'indexDir' => 'public',
+        'indexFile' => 'index.php',
+        'sourceDir' => 'src',
+        'commandsDir' => 'src'
+            . DIRECTORY_SEPARATOR
+            . 'Application'
+            . DIRECTORY_SEPARATOR
+            . 'Console'
+            . DIRECTORY_SEPARATOR
+            . 'Commands',
+    ];
+
+    /**
+     * @var string
+     */
+    protected $bootstrapDir;
+
+    /**
+     * @var string
+     */
+    protected $indexDir;
+
+    /**
+     * @var string
+     */
+    protected $indexFile;
+
+    /**
+     * @var string
+     */
+    protected $sourceDir;
+
+    /**
+     * @var string|null
+     */
+    protected $commandsDir;
+
+    /**
+     * @param string      $bootstrapDir
+     * @param string      $indexDir
+     * @param string      $indexFile
+     * @param string      $sourceDir
+     * @param string|null $commandsDir
+     */
+    protected function __construct(
+        string $bootstrapDir,
+        string $indexDir,
+        string $indexFile,
+        string $sourceDir,
+        ?string $commandsDir = null
+    ) {
+        $this->bootstrapDir = $bootstrapDir;
+        $this->indexDir = $indexDir;
+        $this->indexFile = $indexFile;
+        $this->sourceDir = $sourceDir;
+        $this->commandsDir = $commandsDir;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBootstrapDir(): string
+    {
+        return $this->bootstrapDir;
+    }
+
+    /**
+     * @return string
+     */
+    public function getIndexDir(): string
+    {
+        return $this->indexDir;
+    }
+
+    /**
+     * @return string
+     */
+    public function getIndexFile(): string
+    {
+        return $this->indexFile;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSourceDir(): string
+    {
+        return $this->sourceDir;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCommandsDir(): ?string
+    {
+        return $this->commandsDir;
+    }
+
+    /**
+     * @param array<string, string> $params
+     *
+     * @throws InvalidArgumentException
+     */
+    protected static function validate(array $params): void
+    {
+        [
+            'bootstrapDir' => $bootstrapDir,
+            'indexDir' => $indexDir,
+            'indexFile' => $indexFile,
+            'sourceDir' => $sourceDir,
+            'commandsDir' => $commandsDir,
+        ] = $params;
+
+        if (!is_string($bootstrapDir) || empty($bootstrapDir) || ctype_space($bootstrapDir)) {
+            throw new InvalidArgumentException('`bootstrapDir` must be a string.');
+        }
+
+        if (!is_string($indexDir) || empty($indexDir) || ctype_space($indexDir)) {
+            throw new InvalidArgumentException('`indexDir` must be a string.');
+        }
+
+        if (!is_string($indexFile) || empty($indexFile) || ctype_space($indexFile)) {
+            throw new InvalidArgumentException('`indexFile` must be a string.');
+        }
+
+        if (!is_string($sourceDir) || empty($sourceDir) || ctype_space($sourceDir)) {
+            throw new InvalidArgumentException('`sourceDir` must be a string.');
+        }
+
+        if (!empty($commandsDir) && (!is_string($commandsDir) || ctype_space($commandsDir))) {
+            throw new InvalidArgumentException('`commandsDir` must be a string.');
+        }
+    }
+
+    /**
+     * @param array<string, string> $params
+     *
+     * @return Config
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function fromArray(array $params): Config
+    {
+        $params = array_merge(self::$defaults, $params);
+
+        self::validate($params);
+
+        return new self(
+            $params['bootstrapDir'],
+            $params['indexDir'],
+            $params['indexFile'],
+            $params['sourceDir'],
+            $params['commandsDir']
+        );
+    }
+
+    /**
+     * @return Config
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function fromEnvironment(): Config
+    {
+        return self::fromArray([
+            'bootstrapDir' => (string) getenv(self::SLIM_CONSOLE_BOOTSTRAP_DIR),
+            'indexDir' => (string) getenv(self::SLIM_CONSOLE_INDEX_DIR),
+            'indexFile' => (string) getenv(self::SLIM_CONSOLE_INDEX_FILE),
+            'sourceDir' => (string) getenv(self::SLIM_CONSOLE_SOURCE_DIR),
+            'commandsDir' => (string) getenv(self::SLIM_CONSOLE_COMMANDS_DIR),
+        ]);
+    }
+
+    /**
+     * @return Config
+     */
+    public static function fromDefaults(): Config
+    {
+        return new self(
+            self::$defaults['bootstrapDir'],
+            self::$defaults['indexDir'],
+            self::$defaults['indexFile'],
+            self::$defaults['sourceDir'],
+            self::$defaults['commandsDir']
+        );
+    }
+}