Add ability to set custom config merge plan file path, config and ven…

…dor directories (#69)

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Enh #58: Support stream output headers (@xepozz)
 - Enh #64: Don't use buffered output in `SapiEmitter` when body size is less than buffer (@Gerych1984, @vjik)
 - Enh #65: Add support for `psr/http-message` version `^2.0` (@vjik)
+- New #69: Add ability to set custom config merge plan file path, config and vendor directories (@vjik)
 
 ## 2.2.0 December 25, 2023
 

composer.json

@@ -40,7 +40,7 @@
         "yiisoft/log": "^2.0",
         "yiisoft/log-target-file": "^3.0",
         "yiisoft/yii-http": "^1.0",
-        "yiisoft/yii-runner": "^2.1"
+        "yiisoft/yii-runner": "^2.2"
     },
     "require-dev": {
         "httpsoft/http-message": "^1.0",

src/HttpApplicationRunner.php

@@ -51,6 +51,9 @@ final class HttpApplicationRunner extends ApplicationRunner
      * @param array $nestedEventsGroups Configuration group names that are included into events' configuration group.
      * This is needed for reverse and recursive merge of events' configurations.
      * @param object[] $configModifiers Modifiers for {@see Config}.
+     * @param string $configDirectory The relative path from {@see $rootPath} to the configuration storage location.
+     * @param string $vendorDirectory The relative path from {@see $rootPath} to the vendor directory.
+     * @param string $configMergePlanFile The relative path from {@see $configDirectory} to merge plan.
      *
      * @psalm-param list<string> $nestedParamsGroups
      * @psalm-param list<string> $nestedEventsGroups
@@ -71,6 +74,9 @@ public function __construct(
         array $nestedParamsGroups = ['params'],
         array $nestedEventsGroups = ['events'],
         array $configModifiers = [],
+        string $configDirectory = 'config',
+        string $vendorDirectory = 'vendor',
+        string $configMergePlanFile = '.merge-plan.php',
     ) {
         parent::__construct(
             $rootPath,
@@ -87,6 +93,9 @@ public function __construct(
             $nestedParamsGroups,
             $nestedEventsGroups,
             $configModifiers,
+            $configDirectory,
+            $vendorDirectory,
+            $configMergePlanFile,
         );
     }
 

tests/HttpApplicationRunnerTest.php

@@ -118,6 +118,30 @@ public function testRunWithFailureDuringProcess(): void
         $runner->run();
     }
 
+    public function testConfigMergePlanFile(): void
+    {
+        $runner = new HttpApplicationRunner(
+            rootPath: __DIR__ . '/Support',
+            configMergePlanFile: 'test-merge-plan.php',
+        );
+
+        $params = $runner->getConfig()->get('params-web');
+
+        $this->assertSame(['a' => 42,], $params);
+    }
+
+    public function testConfigDirectory(): void
+    {
+        $runner = new HttpApplicationRunner(
+            rootPath: __DIR__ . '/Support',
+            configDirectory: 'custom-config',
+        );
+
+        $params = $runner->getConfig()->get('params-web');
+
+        $this->assertSame(['age' => 22], $params);
+    }
+
     public function testImmutability(): void
     {
         $this->assertNotSame($this->runner, $this->runner->withConfig($this->createConfig()));

tests/Support/config/test-merge-plan.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+// Do not edit. Content will be replaced.
+return [
+    '/' => [
+        'params-web' => [
+            '/' => [
+                'test-params.php',
+            ],
+        ],
+    ],
+];

tests/Support/config/test-params.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'a' => 42,
+];

tests/Support/custom-config/.merge-plan.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+// Do not edit. Content will be replaced.
+return [
+    '/' => [
+        'params-web' => [
+            '/' => [
+                'params.php',
+            ],
+        ],
+    ],
+];

tests/Support/custom-config/params.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'age' => 22,
+];