Rework configuration helper (#661)

fixtures/Console/Command/TestConfigurableCommand.php

@@ -18,9 +18,6 @@
 
 class TestConfigurableCommand extends ConfigurableBaseCommand
 {
- /**
- * {@inheritdoc}
- */
  protected function executeCommand(IO $io): int
  {
  return 0;

src/Console/ConfigurationHelper.php → src/Configuration/ConfigurationLoader.php

@@ -12,49 +12,25 @@
  * with this source code in the file LICENSE.
  */
 
-namespace KevinGH\Box\Console;
+namespace KevinGH\Box\Configuration;
 
-use function file_exists;
-use KevinGH\Box\Configuration\Configuration;
-use KevinGH\Box\Configuration\NoConfigurationFound;
 use KevinGH\Box\Json\Json;
-use function realpath;
 use stdClass;
-use Symfony\Component\Console\Helper\Helper;
 
 /**
  * @private
  */
-final class ConfigurationHelper extends Helper
+final class ConfigurationLoader
 {
- private const FILE_NAME = 'box.json';
  private const SCHEMA_FILE = __DIR__.'/../../res/schema.json';
 
- private $json;
-
- public function __construct()
- {
- $this->json = new Json();
- }
-
- public function getName(): string
- {
- return 'config';
- }
-
- public function findDefaultPath(): string
+ public function __construct(private readonly Json $json = new Json())
  {
- if (false === file_exists(self::FILE_NAME)) {
- if (false === file_exists(self::FILE_NAME.'.dist')) {
- throw new NoConfigurationFound();
- }
-
- return realpath(self::FILE_NAME.'.dist');
- }
-
- return realpath(self::FILE_NAME);
  }
 
+ /**
+ * @param null|non-empty-string $file
+ */
  public function loadFile(?string $file): Configuration
  {
  if (null === $file) {

src/Console/Application.php

@@ -17,7 +17,6 @@
 use function KevinGH\Box\get_box_version;
 use function sprintf;
 use Symfony\Component\Console\Application as SymfonyApplication;
-use Symfony\Component\Console\Helper\HelperSet;
 use function trim;
 
 /**
@@ -82,12 +81,4 @@ protected function getDefaultCommands(): array
 
  return $commands;
  }
-
- protected function getDefaultHelperSet(): HelperSet
- {
- $helperSet = parent::getDefaultHelperSet();
- $helperSet->set(new ConfigurationHelper());
-
- return $helperSet;
- }
 }

src/Console/Command/BaseCommand.php

@@ -15,7 +15,6 @@
 namespace KevinGH\Box\Console\Command;
 
 use KevinGH\Box\Console\Application;
-use KevinGH\Box\Console\ConfigurationHelper;
 use KevinGH\Box\Console\IO\IO;
 use KevinGH\Box\Console\OutputFormatterConfigurator;
 use Symfony\Component\Console\Command\Command as SymfonyCommand;
@@ -38,9 +37,4 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
  return $this->executeCommand(new IO($input, $output));
  }
-
- final protected function getConfigurationHelper(): ConfigurationHelper
- {
- return $this->getHelper('config');
- }
 }

src/Console/Command/ConfigurableBaseCommand.php

@@ -18,7 +18,6 @@
 use KevinGH\Box\Console\ConfigurationLoader;
 use KevinGH\Box\Console\IO\IO;
 use KevinGH\Box\Json\JsonValidationException;
-use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 
 /**
@@ -51,14 +50,8 @@ final protected function getConfig(IO $io, bool $allowNoFile = false): Configura
  {
  return ConfigurationLoader::getConfig(
  $io->getInput()->getOption(self::CONFIG_PARAM),
- $this->getConfigurationHelper(),
  $io,
  $allowNoFile,
  );
  }
-
- final protected function getConfigPath(InputInterface $input): string
- {
- return $input->getOption(self::CONFIG_PARAM) ?? $this->getConfigurationHelper()->findDefaultPath();
- }
 }

src/Console/Command/Validate.php

@@ -16,6 +16,7 @@
 
 use Exception;
 use KevinGH\Box\Console\ConfigurationLoader;
+use KevinGH\Box\Console\ConfigurationLocator;
 use KevinGH\Box\Console\IO\IO;
 use KevinGH\Box\Console\MessageRenderer;
 use KevinGH\Box\Json\JsonValidationException;
@@ -70,8 +71,7 @@ protected function executeCommand(IO $io): int
 
  try {
  $config = ConfigurationLoader::getConfig(
- $input->getArgument(self::FILE_ARGUMENT) ?? $this->getConfigurationHelper()->findDefaultPath(),
- $this->getConfigurationHelper(),
+ $input->getArgument(self::FILE_ARGUMENT) ?? ConfigurationLocator::findDefaultPath(),
  $io,
  false,
  );

src/Console/ConfigurationLoader.php

@@ -16,6 +16,7 @@
 
 use InvalidArgumentException;
 use KevinGH\Box\Configuration\Configuration;
+use KevinGH\Box\Configuration\ConfigurationLoader as ConfigLoader;
 use KevinGH\Box\Configuration\NoConfigurationFound;
 use KevinGH\Box\Console\IO\IO;
 use KevinGH\Box\Json\JsonValidationException;
@@ -36,18 +37,18 @@ final class ConfigurationLoader
  *
  * @param bool $allowNoFile Load the config nonetheless if not file is found when true
  *
- * @throws JsonValidationException
+ * @throws JsonValidationException|NoConfigurationFound
  */
  public static function getConfig(
  ?string $configPath,
- ConfigurationHelper $helper,
  IO $io,
  bool $allowNoFile,
  ): Configuration {
- $configPath = self::getConfigPath($configPath, $helper, $io, $allowNoFile);
+ $configPath = self::getConfigPath($configPath, $io, $allowNoFile);
+ $configLoader = new ConfigLoader();
 
  try {
- return $helper->loadFile($configPath);
+ return $configLoader->loadFile($configPath);
  } catch (InvalidArgumentException $invalidConfig) {
  $io->error('The configuration file is invalid.');
 
@@ -57,12 +58,11 @@ public static function getConfig(
 
  private static function getConfigPath(
  ?string $configPath,
- ConfigurationHelper $helper,
  IO $io,
  bool $allowNoFile,
  ): ?string {
  try {
- $configPath ??= $helper->findDefaultPath();
+ $configPath ??= ConfigurationLocator::findDefaultPath();
  } catch (NoConfigurationFound $noConfigurationFound) {
  if (false === $allowNoFile) {
  throw $noConfigurationFound;

src/Console/ConfigurationLocator.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the box project.
+ *
+ * (c) Kevin Herrera <kevin@herrera.io>
+ * Théo Fidry <theo.fidry@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace KevinGH\Box\Console;
+
+use function file_exists;
+use KevinGH\Box\Configuration\NoConfigurationFound;
+use KevinGH\Box\NotInstantiable;
+use function realpath;
+
+/**
+ * @private
+ */
+final class ConfigurationLocator
+{
+ use NotInstantiable;
+
+ private const FILE_NAME = 'box.json';
+
+ /**
+ * @var list<non-empty-string>
+ */
+ private static array $candidates;
+
+ public static function findDefaultPath(): string
+ {
+ if (!isset(self::$candidates)) {
+ self::$candidates = [
+ self::FILE_NAME,
+ self::FILE_NAME.'.dist',
+ ];
+ }
+
+ foreach (self::$candidates as $candidate) {
+ if (file_exists($candidate)) {
+ return realpath($candidate);
+ }
+ }
+
+ throw new NoConfigurationFound();
+ }
+}

tests/Composer/ComposerOrchestratorTest.php

@@ -528,7 +528,7 @@ public static function composerAutoloadProvider(): iterable
  echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
  exit(1);
  }
- 
+
  require_once __DIR__ . '/composer/autoload_real.php';
 
  \$loader = ${composerAutoloaderName}::getLoader();
@@ -568,7 +568,7 @@ function foo() {
  echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
  exit(1);
  }
- 
+
  require_once __DIR__ . '/composer/autoload_real.php';
 
  \$loader = ${composerAutoloaderName}::getLoader();
@@ -624,7 +624,7 @@ function foo() {
  echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
  exit(1);
  }
- 
+
  require_once __DIR__ . '/composer/autoload_real.php';
 
  \$loader = ${composerAutoloaderName}::getLoader();
@@ -684,7 +684,7 @@ function foo() {
  echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
  exit(1);
  }
- 
+
  require_once __DIR__ . '/composer/autoload_real.php';
 
  return ComposerAutoloaderInit80c62b20a4a44fb21e8e102ccb92ff05::getLoader();

tests/Configuration/ConfigurationLoaderTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the box project.
+ *
+ * (c) Kevin Herrera <kevin@herrera.io>
+ * Théo Fidry <theo.fidry@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace KevinGH\Box\Configuration;
+
+use function KevinGH\Box\FileSystem\dump_file;
+use function KevinGH\Box\FileSystem\touch;
+use KevinGH\Box\Test\FileSystemTestCase;
+
+/**
+ * @covers \KevinGH\Box\Configuration\ConfigurationLoader
+ */
+class ConfigurationLoaderTest extends FileSystemTestCase
+{
+ private ConfigurationLoader $loader;
+
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->loader = new ConfigurationLoader();
+ }
+
+ public function test_it_can_load_a_configuration(): void
+ {
+ touch('index.php');
+ dump_file('box.json.dist', '{}');
+
+ $this->assertInstanceOf(
+ Configuration::class,
+ $this->loader->loadFile('box.json.dist'),
+ );
+ }
+
+ public function test_it_can_load_a_configuration_without_a_file(): void
+ {
+ touch('index.php');
+
+ $this->assertInstanceOf(
+ Configuration::class,
+ $this->loader->loadFile(null),
+ );
+ }
+}

tests/Configuration/ConfigurationTestCase.php

@@ -16,7 +16,6 @@
 
 use function json_encode;
 use const JSON_PRETTY_PRINT;
-use KevinGH\Box\Console\ConfigurationHelper;
 use function KevinGH\Box\FileSystem\dump_file;
 use function KevinGH\Box\FileSystem\make_path_absolute;
 use function KevinGH\Box\FileSystem\touch;
@@ -56,7 +55,7 @@ final protected function setConfig(array $config): void
 
  final protected function reloadConfig(): void
  {
- $this->config = (new ConfigurationHelper())->loadFile($this->file);
+ $this->config = (new ConfigurationLoader())->loadFile($this->file);
  }
 
  final protected function isWindows(): bool