feat: add command settings:publish

phpstan.neon.dist

@@ -1,22 +1,22 @@
-parameters:
-	tmpDir: build/phpstan
-	level: 5
-	paths:
-		- src/
-		- tests/
-	bootstrapFiles:
-		- vendor/codeigniter4/framework/system/Test/bootstrap.php
-	excludePaths:
-		- src/Config/Routes.php
-		- src/Views/*
-	ignoreErrors:
-	universalObjectCratesClasses:
-		- CodeIgniter\Entity
-		- CodeIgniter\Entity\Entity
-		- Faker\Generator
-	scanDirectories:
-		- vendor/codeigniter4/framework/system/Helpers
-	dynamicConstantNames:
-		- APP_NAMESPACE
-		- CI_DEBUG
-		- ENVIRONMENT
+parameters:
+	tmpDir: build/phpstan
+	level: 5
+	paths:
+		- src/
+		- tests/
+	bootstrapFiles:
+		- vendor/codeigniter4/framework/system/Test/bootstrap.php
+	excludePaths:
+		- src/Config/Routes.php
+		- src/Views/*
+	ignoreErrors:
+	universalObjectCratesClasses:
+		- CodeIgniter\Entity
+		- CodeIgniter\Entity\Entity
+		- Faker\Generator
+	scanDirectories:
+		- vendor/codeigniter4/framework/system/Helpers
+	dynamicConstantNames:
+		- APP_NAMESPACE
+		- CI_DEBUG
+		- ENVIRONMENT

src/Commands/SettingsPublisher.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace CodeIgniter\Settings\Commands;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+use CodeIgniter\Publisher\Publisher;
+use Throwable;
+
+/**
+ * Publish Settings config file into the current application.
+ */
+class SettingsPublisher extends BaseCommand
+{
+    /**
+     * The group the command is lumped under
+     * when listing commands.
+     *
+     * @var string
+     */
+    protected $group = 'Settings';
+
+    /**
+     * The Command's name
+     *
+     * @var string
+     */
+    protected $name = 'settings:publish';
+
+    /**
+     * the Command's usage
+     *
+     * @var string
+     */
+    protected $usage = <<<'EOL'
+        settings:publish [options]
+
+          Examples:
+            settings:publish -f
+        EOL;
+
+    /**
+     * the Command's short description
+     *
+     * @var string
+     */
+    protected $description = 'Publish Settings config file into the current application.';
+
+    /**
+     * The Command's options
+     *
+     * @var array<string, string>
+     */
+    protected $options = [
+        '-f' => 'Set to enable overwrites.',
+    ];
+
+    /**
+     * @var bool `true` to enable overwrites file
+     */
+    private bool $overwrites = false;
+
+    public function run(array $params): void
+    {
+        if (array_key_exists('f', $params)) {
+            $this->overwrites = true;
+        }
+
+        // Use the Autoloader to figure out the module path
+        $source    = service('autoloader')->getNamespace('CodeIgniter\\Settings')[0];
+        $publisher = new Publisher($source, APPPATH);
+
+        try {
+            $publisher->addPath('Config/Settings.php')
+                ->merge($this->overwrites);
+        } catch (Throwable $e) {
+            $this->showError($e);
+        }
+
+        // If publication succeeded then update file
+        foreach ($publisher->getPublished() as $file) {
+            // Replace data in 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 SettingsConfig', $contents);
+            $contents = str_replace('class Settings extends BaseConfig', 'class Settings extends SettingsConfig', $contents);
+            file_put_contents($file, $contents);
+            CLI::write(CLI::color('  Published! ', 'green') . "You can customize the configuration by editing the \"{$file}\" file.");
+        }
+    }
+}

tests/Commands/SettingsPublisherTest.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Commands;
+
+use CodeIgniter\Test\CIUnitTestCase;
+use CodeIgniter\Test\Filters\CITestStreamFilter;
+
+/**
+ * @internal
+ */
+final class SettingsPublisherTest extends CIUnitTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        CITestStreamFilter::registration();
+        CITestStreamFilter::addOutputFilter();
+        CITestStreamFilter::addErrorFilter();
+
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        CITestStreamFilter::removeOutputFilter();
+        CITestStreamFilter::removeErrorFilter();
+
+    }
+
+    public function testPublishConfigFile(): void
+    {
+        command('settings:publish');
+
+        $filepath = APPPATH . 'Config/Settings.php';
+        $this->assertFileExists($filepath);
+        $this->assertStringContainsString('  Published! ', CITestStreamFilter::$buffer);
+
+        $contents = $this->getFileContents($filepath);
+        $this->assertStringContainsString('namespace Config;', $contents);
+        $this->assertStringContainsString('use CodeIgniter\\Settings\\Config\\Settings as SettingsConfig;', $contents);
+        $this->assertStringContainsString('class Settings extends SettingsConfig', $contents);
+
+        if (is_file($filepath)) {
+            copy($filepath, APPPATH . 'Config/Settings.php.bak');
+        }
+    }
+
+    /**
+     * @depends testPublishConfigFile
+     */
+    public function testPublishConfigFileWithForce(): void
+    {
+
+        $filepath = APPPATH . 'Config/Settings.php';
+
+        helper('filesystem');
+        write_file($filepath, 'fake text.');
+        $contents = $this->getFileContents($filepath);
+
+        $this->assertFileExists($filepath);
+        $this->assertStringContainsString('fake text.', $contents);
+
+        command('settings:publish -f');
+
+        $expectedConfigFile = APPPATH . 'Config/Settings.php.bak';
+        $this->assertFileEquals($expectedConfigFile, $filepath);
+
+        clearstatcache(true, $expectedConfigFile);
+        if (is_file($expectedConfigFile)) {
+            unlink($expectedConfigFile);
+        }
+
+    }
+
+    private function getFileContents(string $filepath): string
+    {
+        return (string) @file_get_contents($filepath);
+    }
+}