Feature allow configuration extension from a different base file (#373)

* feat: allow configuration extension from a different base file

* fix: typo

* fix: lint issues

* fix: static analyses issue

* fix: another lint issue

* feat: use array_replace_recursively and add more tests

* fix: lint issue

* Update ConfigurationJsonRepository.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: GuillaumeOnepilot

app/Repositories/ConfigurationJsonRepository.php

@@ -77,7 +77,13 @@ public function preset()
     protected function get()
     {
         if (! is_null($this->path) && $this->fileExists((string) $this->path)) {
-            return tap(json_decode(file_get_contents($this->path), true), function ($configuration) {
+            $baseConfig = json_decode(file_get_contents($this->path), true);
+
+            if (isset($baseConfig['extend'])) {
+                $baseConfig = $this->resolveExtend($baseConfig);
+            }
+
+            return tap($baseConfig, function ($configuration) {
                 if (! is_array($configuration)) {
                     abort(1, sprintf('The configuration file [%s] is not valid JSON.', $this->path));
                 }
@@ -99,4 +105,23 @@ protected function fileExists(string $path)
             default => file_exists($path)
         };
     }
+
+    /**
+     * Resolve the file to extend.
+     *
+     * @param  array<string, array<int, string>|string>  $configuration
+     * @return array<string, array<int, string>|string>
+     */
+    private function resolveExtend(array $configuration)
+    {
+        $path = realpath(dirname($this->path).DIRECTORY_SEPARATOR.$configuration['extend']);
+
+        $extended = json_decode(file_get_contents($path), true);
+
+        if (isset($extended['extend'])) {
+            throw new \LogicException('Pint configuration cannot extend from more than 1 file.');
+        }
+
+        return array_replace_recursive($extended, $configuration);
+    }
 }

tests/Fixtures/extend/base.json

@@ -0,0 +1,15 @@
+{
+    "preset": "psr12",
+    "rules": {
+        "array_push": true,
+        "backtick_to_shell_exec": true,
+        "date_time_immutable": true,
+        "final_internal_class": true,
+        "final_public_method_for_abstract_class": true,
+        "fully_qualified_strict_types": true,
+        "global_namespace_import": {
+            "import_classes": true,
+            "import_constants": true
+        }
+    }
+}

tests/Fixtures/extend/pint.json

@@ -0,0 +1,14 @@
+{
+    "extend": "./base.json",
+    "preset": "laravel",
+    "rules": {
+        "declare_strict_types": true,
+        "lowercase_keywords": true,
+        "lowercase_static_reference": true,
+        "final_class": true,
+        "fully_qualified_strict_types": false,
+        "global_namespace_import": {
+            "import_functions": true
+        }
+    }
+}

tests/Fixtures/extend_recursive/base.json

@@ -0,0 +1,3 @@
+{
+    "extend": "./config.json"
+}

tests/Fixtures/extend_recursive/config.json

@@ -0,0 +1,3 @@
+{
+    "preset": "laravel"
+}

tests/Fixtures/extend_recursive/pint.json

@@ -0,0 +1,3 @@
+{
+    "extend": "./base.json"
+}

tests/Unit/Repositories/ConfigurationJsonRepositoryTest.php

@@ -46,3 +46,32 @@
 
     expect($repository->preset())->toBe('laravel');
 });
+
+it('properly extend the base config file', function () {
+    $repository = new ConfigurationJsonRepository(dirname(__DIR__, 2).'/Fixtures/extend/pint.json', null);
+
+    expect($repository->preset())->toBe('laravel')
+        ->and($repository->rules())->toBe([
+            'array_push' => true,
+            'backtick_to_shell_exec' => true,
+            'date_time_immutable' => true,
+            'final_internal_class' => true,
+            'final_public_method_for_abstract_class' => true,
+            'fully_qualified_strict_types' => false,
+            'global_namespace_import' => [
+                'import_classes' => true,
+                'import_constants' => true,
+                'import_functions' => true,
+            ],
+            'declare_strict_types' => true,
+            'lowercase_keywords' => true,
+            'lowercase_static_reference' => true,
+            'final_class' => true,
+        ]);
+});
+
+it('throw an error if the extended configuration also has an extend', function () {
+    $repository = new ConfigurationJsonRepository(dirname(__DIR__, 2).'/Fixtures/extend_recursive/pint.json', null);
+
+    $repository->finder();
+})->throws(LogicException::class);