feat: add option to flatten response (#11)

Author: marcoraddatz

README.md

@@ -43,6 +43,37 @@ For security reasons, it only returns the array from your config and doesn't rea
 Route::get('/locales', ListLocalesController::class);
 ```
 
+By adding `?flatten=true` to the URL, you can get a flat array of all available locales.
+You can also change the default behavior in the config file.
+
+#### Non-flattened response
+```json
+{
+    "data": {
+        "api": {
+            "error": {
+                "401": "Unauthenticated.",
+                "403": "Forbidden.",
+                "404": "Not Found.",
+                "422": "Unprocessable Entity."
+            }
+        }
+    }
+}
+```
+
+#### Flattened response
+```json
+{
+    "data": {
+        "api.error.401": "Unauthenticated.",
+        "api.error.403": "Forbidden.",
+        "api.error.404": "Not Found.",
+        "api.error.422": "Unprocessable Entity."
+    }
+}
+```
+
 ### `Empuxa\LocaleViaApi\Http\Controllers\GetLocaleController`
 This controller returns the contents of a locale directory as JSON.
 If the directory does not exist, it will return an error 404.

config/locale-via-api.php

@@ -34,6 +34,13 @@
      */
     'load_vendor_files' => true,
 
+    /**
+     * Should the output be flattened?
+     * This will return keys as "api.error.401" instead of "api => error => 401".
+     * DEFAULT: false
+     */
+    'flatten'           => false,
+
     /**
      * Add your supported locales here.
      */

src/Controllers/GetLocaleController.php

@@ -3,6 +3,7 @@
 namespace Empuxa\LocaleViaApi\Controllers;
 
 use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\File;
@@ -12,13 +13,17 @@ class GetLocaleController extends Controller
 {
     private const LOCALE_NOT_FOUND = 'Locale not found.';
 
+    private bool $flatten;
+
     /**
      * Handle the incoming request.
      *
      * @throws \Throwable
      */
-    public function __invoke(string $locale): JsonResponse
+    public function __invoke(Request $request, string $locale): JsonResponse
     {
+        $this->flatten = $request->query('flatten', config('locale-via-api.flatten', false));
+
         // Ensure locale is valid and exists
         $this->ensureLocaleIsValid($locale);
         $this->ensureLocaleExists($locale);
@@ -133,12 +138,39 @@ protected function loadLocaleFiles(string $directory, string $prefix = ''): arra
                 $key = sprintf('%s.%s', $prefix, $key);
             }
 
-            $data[$key] = File::getRequire($file);
+            $fileData = File::getRequire($file);
+
+            if ($this->flatten) {
+                $flattenedData = $this->flattenArray($fileData, $key);
+                $data = array_merge($data, $flattenedData);
+            } else {
+                $data[$key] = $fileData;
+            }
         }
 
         return $data;
     }
 
+    /**
+     * Flatten a multi-dimensional associative array with dot notation keys.
+     */
+    protected function flattenArray(array $array, string $prefix = ''): array
+    {
+        $result = [];
+
+        foreach ($array as $key => $value) {
+            $newKey = $prefix ? $prefix . '.' . $key : $key;
+
+            if (is_array($value)) {
+                $result = array_merge($result, $this->flattenArray($value, $newKey));
+            } else {
+                $result[$newKey] = $value;
+            }
+        }
+
+        return $result;
+    }
+
     /**
      * Create a JSON response.
      */

tests/Feature/GetLocaleTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Empuxa\LocaleViaApi\Controllers\GetLocaleController;
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\File;
 
@@ -33,12 +34,14 @@
         ->andReturn([]);
 
     $controller = new GetLocaleController;
-    $controller($locale);
+    $request = new Request;
+    $controller($request, $locale);
 });
 
 it('returns a json response with correct structure', function () {
     $controller = new GetLocaleController;
-    $response = $controller('en');
+    $request = new Request;
+    $response = $controller($request, 'en');
 
     expect($response)->toBeInstanceOf(Illuminate\Http\JsonResponse::class);
 
@@ -59,7 +62,8 @@
     File::put(lang_path('vendor/test-plugin/en/vendor-test.php'), "<?php return ['title' => 'Vendor Test'];");
 
     $controller = new GetLocaleController;
-    $response = $controller('en');
+    $request = new Request;
+    $response = $controller($request, 'en');
 
     expect($response)->toBeInstanceOf(Illuminate\Http\JsonResponse::class);
 
@@ -86,7 +90,8 @@
     File::put(lang_path('vendor/test-plugin/en/vendor-test.php'), "<?php return ['title' => 'Vendor Test'];");
 
     $controller = new GetLocaleController;
-    $response = $controller('en');
+    $request = new Request;
+    $response = $controller($request, 'en');
 
     expect($response)->toBeInstanceOf(Illuminate\Http\JsonResponse::class);
 
@@ -104,3 +109,67 @@
 
     expect($responseData['meta']['hash'])->toEqual($expectedHash);
 });
+
+it('returns a flattened json response with correct structure', function () {
+    File::put(lang_path('en/test.php'), "<?php return ['api' => ['error' => ['401' => 'Unauthenticated.', '403' => 'Forbidden.', '404' => 'Not Found.', '422' => 'Unprocessable Entity.']]];");
+
+    $request = new Request(['flatten' => true]);
+
+    $controller = new GetLocaleController;
+    $response = $controller($request, 'en');
+
+    expect($response)->toBeInstanceOf(Illuminate\Http\JsonResponse::class);
+
+    $responseData = $response->getData(true);
+
+    expect($responseData)->toHaveKeys(['data', 'meta'])
+        ->and($responseData['data'])->toBeArray()
+        ->and($responseData['data'])->toBe([
+            'test.api.error.401' => 'Unauthenticated.',
+            'test.api.error.403' => 'Forbidden.',
+            'test.api.error.404' => 'Not Found.',
+            'test.api.error.422' => 'Unprocessable Entity.',
+        ]);
+
+    $expectedHash = md5(json_encode([
+        'test.api.error.401' => 'Unauthenticated.',
+        'test.api.error.403' => 'Forbidden.',
+        'test.api.error.404' => 'Not Found.',
+        'test.api.error.422' => 'Unprocessable Entity.',
+    ]));
+
+    expect($responseData['meta']['hash'])->toEqual($expectedHash);
+});
+
+it('returns a flattened json response with correct structure with vendor', function () {
+    config(['locale-via-api.load_vendor_files' => true]);
+
+    File::put(lang_path('en/test.php'), "<?php return ['api' => ['error' => ['401' => 'Unauthenticated.', '403' => 'Forbidden.', '404' => 'Not Found.', '422' => 'Unprocessable Entity.']]];");
+    File::put(lang_path('vendor/test-plugin/en/vendor-test.php'), "<?php return ['title' => 'Vendor Test'];");
+
+    $request = new Request(['flatten' => true]);
+
+    $controller = new GetLocaleController;
+    $response = $controller($request, 'en');
+
+    expect($response)->toBeInstanceOf(Illuminate\Http\JsonResponse::class);
+
+    $responseData = $response->getData(true);
+
+    expect($responseData)->toHaveKeys(['data', 'meta'])
+        ->and($responseData['data'])->toBeArray()
+        ->and($responseData['data'])->toHaveKey('test.api.error.401')
+        ->and($responseData['data'])->toHaveKey('vendor.test-plugin.vendor-test.title')
+        ->and($responseData['data']['test.api.error.401'])->toBe('Unauthenticated.')
+        ->and($responseData['data']['vendor.test-plugin.vendor-test.title'])->toBe('Vendor Test');
+
+    $expectedHash = md5(json_encode([
+        'test.api.error.401'                   => 'Unauthenticated.',
+        'test.api.error.403'                   => 'Forbidden.',
+        'test.api.error.404'                   => 'Not Found.',
+        'test.api.error.422'                   => 'Unprocessable Entity.',
+        'vendor.test-plugin.vendor-test.title' => 'Vendor Test',
+    ]));
+
+    expect($responseData['meta']['hash'])->toEqual($expectedHash);
+});