Config Object

bin/slim

@@ -20,7 +20,7 @@ if (file_exists(__DIR__ . '/../../../autoload.php')) {
     require __DIR__ . '/../vendor/autoload.php';
 }
 
-$config = (new ConfigResolver($cwd))->resolve();
+$config = (new ConfigResolver())->resolve($cwd);
 
 $app = new App($config);
 $app->run();

composer.json

@@ -15,8 +15,7 @@
     "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",

phpstan.neon.dist

@@ -1,4 +1,3 @@
 parameters:
   level: max
-  checkMissingIterableValueType: false
   inferPrivatePropertyTypeFromConstructor: true

src/Command/AbstractCommand.php

@@ -27,7 +27,9 @@ public function getConfig(): ?Config
         $app = $this->getApplication();
 
         if ($app instanceof App === false) {
-            throw new RuntimeException('Method method `getConfig()` does not exist on this type of application.');
+            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

@@ -21,14 +21,20 @@ class Config
     public const SLIM_CONSOLE_COMMANDS_DIR = 'SLIM_CONSOLE_COMMANDS_DIR';
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     protected static $defaults = [
         'bootstrapDir' => 'app',
         'indexDir' => 'public',
         'indexFile' => 'index.php',
         'sourceDir' => 'src',
-        'commandsDir' => 'src/Application/Console/Commands',
+        'commandsDir' => 'src'
+            . DIRECTORY_SEPARATOR
+            . 'Application'
+            . DIRECTORY_SEPARATOR
+            . 'Console'
+            . DIRECTORY_SEPARATOR
+            . 'Commands',
     ];
 
     /**
@@ -118,7 +124,7 @@ public function getCommandsDir(): ?string
     }
 
     /**
-     * @param array $params
+     * @param array<string, string> $params
      *
      * @throws InvalidArgumentException
      */
@@ -154,7 +160,7 @@ protected static function validate(array $params): void
     }
 
     /**
-     * @param array<mixed> $params
+     * @param array<string, string> $params
      *
      * @return Config
      *
@@ -183,11 +189,11 @@ public static function fromArray(array $params): Config
     public static function fromEnvironment(): Config
     {
         return self::fromArray([
-            'bootstrapDir' => getenv(self::SLIM_CONSOLE_BOOTSTRAP_DIR),
-            'indexDir' => getenv(self::SLIM_CONSOLE_INDEX_DIR),
-            'indexFile' => getenv(self::SLIM_CONSOLE_INDEX_FILE),
-            'sourceDir' => getenv(self::SLIM_CONSOLE_SOURCE_DIR),
-            'commandsDir' => getenv(self::SLIM_CONSOLE_COMMANDS_DIR),
+            '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),
         ]);
     }
 

src/Config/ConfigResolver.php

@@ -10,10 +10,10 @@
 
 namespace Slim\Console\Config;
 
-use InvalidArgumentException;
 use RuntimeException;
 use Slim\Console\Config\Parser\JSONConfigParser;
 use Slim\Console\Config\Parser\PHPConfigParser;
+use Slim\Console\Exception\CannotParseConfigException;
 use Slim\Console\Exception\CannotResolveConfigException;
 
 class ConfigResolver
@@ -32,34 +32,23 @@ class ConfigResolver
         self::FORMAT_JSON,
     ];
 
-    /**
-     * @var string
-     */
-    protected $cwd;
-
-    /**
-     * @param string $cwd
-     */
-    public function __construct(string $cwd)
-    {
-        $this->cwd = $cwd;
-    }
-
     /**
      * Resolve configuration. Environment takes precedence over configuration file.
      *
+     * @param string|null $dir
+     *
      * @return Config
      *
-     * @throws InvalidArgumentException
+     * @throws CannotParseConfigException
      * @throws RuntimeException
      */
-    public function resolve(): Config
+    public function resolve(string $dir = null): Config
     {
         try {
             return $this->attemptResolvingConfigFromEnvironment();
         } catch (CannotResolveConfigException $e) {
             try {
-                return $this->attemptResolvingConfigFromSupportedFormats();
+                return $this->attemptResolvingConfigFromSupportedFormats($dir);
             } catch (CannotResolveConfigException $e) {
                 return Config::fromDefaults();
             }
@@ -73,12 +62,18 @@ public function resolve(): Config
      */
     protected function attemptResolvingConfigFromEnvironment(): Config
     {
+        $bootstrapDir = getenv(Config::SLIM_CONSOLE_BOOTSTRAP_DIR);
+        $commandsDir = getenv(Config::SLIM_CONSOLE_COMMANDS_DIR);
+        $indexDir = getenv(Config::SLIM_CONSOLE_INDEX_DIR);
+        $indexFile = getenv(Config::SLIM_CONSOLE_INDEX_FILE);
+        $sourceDir = getenv(Config::SLIM_CONSOLE_SOURCE_DIR);
+
         if (
-            getenv(Config::SLIM_CONSOLE_BOOTSTRAP_DIR)
-            || getenv(Config::SLIM_CONSOLE_COMMANDS_DIR)
-            || getenv(Config::SLIM_CONSOLE_INDEX_DIR)
-            || getenv(Config::SLIM_CONSOLE_INDEX_FILE)
-            || getenv(Config::SLIM_CONSOLE_SOURCE_DIR)
+            (is_string($bootstrapDir) && !empty($bootstrapDir) && !ctype_space($bootstrapDir))
+            || (is_string($commandsDir) && !empty($commandsDir) && !ctype_space($commandsDir))
+            || (is_string($indexDir) && !empty($indexDir) && !ctype_space($indexDir))
+            || (is_string($indexFile) && !empty($indexFile) && !ctype_space($indexFile))
+            || (is_string($sourceDir) && !empty($sourceDir) && !ctype_space($sourceDir))
         ) {
             return Config::fromEnvironment();
         }
@@ -87,19 +82,22 @@ protected function attemptResolvingConfigFromEnvironment(): Config
     }
 
     /**
+     * @param string|null $dir
+     *
      * @return Config
      *
      * @throws CannotResolveConfigException
-     * @throws InvalidArgumentException
+     * @throws CannotParseConfigException
      * @throws RuntimeException
      */
-    protected function attemptResolvingConfigFromSupportedFormats(): Config
+    protected function attemptResolvingConfigFromSupportedFormats(string $dir = null): Config
     {
-        $basePath = $this->cwd . DIRECTORY_SEPARATOR . self::CONFIG_FILENAME;
+        $dir = $dir ?? getcwd();
+        $basePath = $dir . DIRECTORY_SEPARATOR . self::CONFIG_FILENAME;
 
         foreach ($this->supportedFormats as $format) {
             $path = $basePath . ".{$format}";
-            if (file_exists($path) && is_readable($path)) {
+            if (is_file($path) && is_readable($path)) {
                 return $this->attemptParsingConfigFromFile($path, $format);
             }
         }
@@ -113,7 +111,7 @@ protected function attemptResolvingConfigFromSupportedFormats(): Config
      *
      * @return Config
      *
-     * @throws InvalidArgumentException
+     * @throws CannotParseConfigException
      * @throws RuntimeException
      */
     protected function attemptParsingConfigFromFile(string $path, string $format): Config

src/Config/Parser/ConfigParserInterface.php

@@ -10,8 +10,8 @@
 
 namespace Slim\Console\Config\Parser;
 
-use InvalidArgumentException;
 use Slim\Console\Config\Config;
+use Slim\Console\Exception\CannotParseConfigException;
 
 interface ConfigParserInterface
 {
@@ -20,7 +20,7 @@ interface ConfigParserInterface
      *
      * @return Config
      *
-     * @throws InvalidArgumentException
+     * @throws CannotParseConfigException
      */
     public static function parse(string $path): Config;
 }

src/Config/Parser/JSONConfigParser.php

@@ -16,9 +16,7 @@
 class JSONConfigParser implements ConfigParserInterface
 {
     /**
-     * @param string $path
-     *
-     * @return Config
+     * {@inheritdoc}
      */
     public static function parse(string $path): Config
     {

src/Config/Parser/PHPConfigParser.php

@@ -10,22 +10,20 @@
 
 namespace Slim\Console\Config\Parser;
 
-use InvalidArgumentException;
 use Slim\Console\Config\Config;
+use Slim\Console\Exception\CannotParseConfigException;
 
 class PHPConfigParser implements ConfigParserInterface
 {
     /**
-     * @param string $path
-     *
-     * @return Config
+     * {@inheritdoc}
      */
     public static function parse(string $path): Config
     {
         $parsed = require $path;
 
         if (!is_array($parsed)) {
-            throw new InvalidArgumentException('Slim Console configuration should be an array.');
+            throw new CannotParseConfigException('Slim Console configuration should be an array.');
         }
 
         return Config::fromArray($parsed);

src/Exception/CannotParseConfigException.php

@@ -0,0 +1,17 @@
+<?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\Exception;
+
+use Exception;
+
+class CannotParseConfigException extends Exception
+{
+}

tests/Command/AbstractCommandTest.php

@@ -35,7 +35,9 @@ public function testGetConfigThrowsRuntimeExceptionWithIncompatibleApp(): void
         $mockCommand = new MockCommand();
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Method method `getConfig()` does not exist on this type of application.');
+        $this->expectExceptionMessage(
+            'Usage of the method `getConfig()` requires the parent application to be a Slim Console Application.'
+        );
 
         $mockCommand->getConfig();
     }

tests/Config/ConfigResolverTest.php

@@ -37,9 +37,9 @@ public function testResolvePrioritizesEnvironment(): void
         $this->setupEnvConfig();
 
         $exampleJsonConfigPath = $this->getExampleConfigPath(ConfigResolver::FORMAT_JSON);
-        $configResolver = new ConfigResolver($exampleJsonConfigPath);
+        $configResolver = new ConfigResolver();
 
-        $config = $configResolver->resolve();
+        $config = $configResolver->resolve($exampleJsonConfigPath);
 
         $this->assertSame($this->envParams['bootstrapDir'], $config->getBootstrapDir());
         $this->assertSame($this->envParams['commandsDir'], $config->getCommandsDir());
@@ -62,9 +62,9 @@ public function testAttemptResolvingConfigFromSupportedFormats(string $format, C
         $example = $parser($configPath);
 
         $exampleConfigPath = $this->getExampleConfigPath($format);
-        $configResolver = new ConfigResolver($exampleConfigPath);
+        $configResolver = new ConfigResolver();
 
-        $config = $configResolver->resolve();
+        $config = $configResolver->resolve($exampleConfigPath);
 
         $this->assertSame($example['bootstrapDir'], $config->getBootstrapDir());
         $this->assertSame($example['commandsDir'], $config->getCommandsDir());
@@ -86,7 +86,7 @@ public function testAttemptParsingConfigFromFileThrowsRuntimeException(): void
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage("Invalid configuration format `{$invalidFormat}`.");
 
-        $configResolver = new ConfigResolver($this->examplesConfigBasePath);
+        $configResolver = new ConfigResolver();
 
         $attemptParsingConfigFromFileMethod->invoke($configResolver, $this->examplesConfigBasePath, $invalidFormat);
     }
@@ -98,8 +98,8 @@ public function testResolveFallbackOnDefaults(): void
 
         $defaults = $defaultsReflection->getValue();
 
-        $configResolver = new ConfigResolver($this->examplesConfigBasePath);
-        $config = $configResolver->resolve();
+        $configResolver = new ConfigResolver();
+        $config = $configResolver->resolve($this->examplesConfigBasePath);
 
         $this->assertSame($defaults['bootstrapDir'], $config->getBootstrapDir());
         $this->assertSame($defaults['commandsDir'], $config->getCommandsDir());

tests/Config/Parser/PHPConfigParserTest.php

@@ -10,9 +10,9 @@
 
 namespace Slim\Tests\Console\Config\Parser;
 
-use InvalidArgumentException;
 use Slim\Console\Config\ConfigResolver;
 use Slim\Console\Config\Parser\PHPConfigParser;
+use Slim\Console\Exception\CannotParseConfigException;
 use Slim\Tests\Console\TestCase;
 
 class PHPConfigParserTest extends TestCase
@@ -34,13 +34,13 @@ public function testParse(): void
         $this->assertSame($phpConfig['sourceDir'], $config->getSourceDir());
     }
 
-    public function testParseThrowsInvalidArgumentException(): void
+    public function testParseThrowsExceptionWithInvalidConfigFormat(): void
     {
         $invalidJsonConfigPath = $this->examplesConfigBasePath
             . DIRECTORY_SEPARATOR . 'invalid-php'
             . DIRECTORY_SEPARATOR . 'invalid-format.php';
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(CannotParseConfigException::class);
         $this->expectExceptionMessage('Slim Console configuration should be an array.');
 
         PHPConfigParser::parse($invalidJsonConfigPath);

tests/Mocks/MockCommand.php

@@ -44,14 +44,4 @@ public function getMockOutput(): string
     {
         return $this->output;
     }
-
-    /**
-     * @param string $output
-     * @return self
-     */
-    public function setMockOutput(string $output): self
-    {
-        $this->output = $output;
-        return $this;
-    }
 }

tests/examples/invalid-php/invalid-format.php

@@ -1,3 +1,11 @@
 <?php
 
+/**
+ * Slim Framework (https://slimframework.com)
+ *
+ * @license https://github.com/slimphp/Slim-Console/blob/0.x/LICENSE.md (MIT License)
+ */
+
+declare(strict_types=1);
+
 return "invalid";