add publish command

Author: michalsn

src/Commands/PublishSettings.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter Queue.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Settings\Commands;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use CodeIgniter\Publisher\Publisher;
+use Throwable;
+
+class PublishSettings extends BaseCommand
+{
+    protected $group       = 'Settings';
+    protected $name        = 'settings:publish';
+    protected $description = 'Publish Settings config file into the current application.';
+
+    public function run(array $params): void
+    {
+        $source = service('autoloader')->getNamespace('CodeIgniter\\Settings')[0];
+
+        $publisher = new Publisher($source, APPPATH);
+
+        try {
+            $publisher->addPaths([
+                'Config/Settings.php',
+            ])->merge(false);
+        } catch (Throwable $e) {
+            $this->showError($e);
+
+            return;
+        }
+
+        foreach ($publisher->getPublished() as $file) {
+            $contents = file_get_contents($file);
+            $contents = str_replace('namespace CodeIgniter\\Settings\\Config', 'namespace Config', $contents);
+            $contents = str_replace('use CodeIgniter\\Config\\BaseConfig', 'use CodeIgniter\\Settings\\Config\\Settings as BaseSettings', $contents);
+            $contents = str_replace('class Settings extends BaseConfig', 'class Settings extends BaseSettings', $contents);
+            file_put_contents($file, $contents);
+        }
+
+        CLI::write(CLI::color('  Published! ', 'green') . 'You can customize the configuration by editing the "app/Config/Settings.php" file.');
+    }
+}

tests/Commands/PublishSettingsTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter Queue.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Tests\Commands;
+
+use CodeIgniter\Test\Filters\CITestStreamFilter;
+use Tests\Support\TestCase;
+
+/**
+ * @internal
+ */
+final class PublishSettingsTest extends TestCase
+{
+    public function testRun(): void
+    {
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
+
+        $this->assertNotFalse(command('settings:publish'));
+        $output = $this->parseOutput(CITestStreamFilter::$buffer);
+
+        CITestStreamFilter::removeOutputFilter();
+
+        $this->assertSame('  Published! You can customize the configuration by editing the "app/Config/Settings.php" file.', $output);
+    }
+}

tests/_support/TestCase.php

@@ -2,13 +2,18 @@
 
 namespace Tests\Support;
 
-use CodeIgniter\Settings\Handlers\ArrayHandler;
+use CodeIgniter\CLI\CLI;
 use CodeIgniter\Settings\Settings;
 use CodeIgniter\Test\CIUnitTestCase;
+use CodeIgniter\Test\ReflectionHelper;
 use Config\Services;
 
 abstract class TestCase extends CIUnitTestCase
 {
+    use ReflectionHelper;
+
+    private array $lines = [];
+
     /**
      * @var Settings
      */
@@ -34,4 +39,38 @@ protected function tearDown(): void
 
         $this->resetServices();
     }
+
+    protected function parseOutput(string $output): string
+    {
+        $this->lines = [];
+        $output      = $this->removeColorCodes($output);
+        $this->lines = explode("\n", $output);
+
+        return $output;
+    }
+
+    protected function getLine(int $line = 0): ?string
+    {
+        return $this->lines[$line] ?? null;
+    }
+
+    protected function getLines(): string
+    {
+        return implode('', $this->lines);
+    }
+
+    protected function removeColorCodes(string $output): string
+    {
+        $colors = $this->getPrivateProperty(CLI::class, 'foreground_colors');
+        $colors = array_values(array_map(static fn ($color) => "\033[" . $color . 'm', $colors));
+        $colors = array_merge(["\033[0m"], $colors);
+
+        $output = str_replace($colors, '', trim($output));
+
+        if (is_windows()) {
+            $output = str_replace("\r\n", "\n", $output);
+        }
+
+        return $output;
+    }
 }