Merge pull request mpociot#700 from jantoniomartin/patch-array-params

fixes indentation problems in @lucianobargmann's PR for mpociot#637

Author: shalvah

.gitignore

@@ -13,3 +13,4 @@ docs/_build
 docs/make.bat
 tests/public/docs/
 tests/resources/**
+.phpunit.result.cache

.styleci.yml

@@ -1,10 +1,2 @@
-preset: laravel
+preset: psr12
 
-enabled:
-  - phpdoc_order
-  - phpdoc_separation
-  - unalign_double_arrow
-
-disabled:
-  - short_list_syntax
-  - simplified_null_return

resources/views/partials/example-requests/bash.blade.php

@@ -1,9 +1,6 @@
 ```bash
 curl -X {{$route['methods'][0]}} \
-    {{$route['methods'][0] == 'GET' ? '-G ' : ''}}"{{ rtrim($baseUrl, '/')}}/{{ ltrim($route['boundUri'], '/') }}@if(count($route['cleanQueryParameters']))?@foreach($route['cleanQueryParameters'] as $parameter => $value)
-{{ urlencode($parameter) }}={{ urlencode($value) }}@if(!$loop->last)&@endif
-@endforeach
-@endif" @if(count($route['headers']))\
+    {{$route['methods'][0] == 'GET' ? '-G ' : ''}}"{{ rtrim($baseUrl, '/')}}/{{ ltrim($route['boundUri'], '/') }}@if(count($route['cleanQueryParameters']))?{!! \Mpociot\ApiDoc\Tools\Utils::printQueryParamsAsString($route['cleanQueryParameters']) !!}@endif" @if(count($route['headers']))\
 @foreach($route['headers'] as $header => $value)
     -H "{{$header}}: {{ addslashes($value) }}"@if(! ($loop->last) || ($loop->last && count($route['bodyParameters']))) \
 @endif

resources/views/partials/example-requests/javascript.blade.php

@@ -4,11 +4,7 @@
 );
 @if(count($route['cleanQueryParameters']))
 
-let params = {
-@foreach($route['cleanQueryParameters'] as $parameter => $value)
-    "{{ $parameter }}": "{{ $value }}",
-@endforeach
-};
+let params = {!! \Mpociot\ApiDoc\Tools\Utils::printQueryParamsAsKeyValue($route['cleanQueryParameters'], "\"", ":", 4, "{}") !!};
 Object.keys(params)
     .forEach(key => url.searchParams.append(key, params[key]));
 @endif

resources/views/partials/example-requests/php.blade.php

@@ -9,11 +9,7 @@
         'headers' => {!! \Mpociot\ApiDoc\Tools\Utils::printPhpValue($route['headers'], 8) !!},
 @endif
 @if(!empty($route['cleanQueryParameters']))
-        'query' => [
-@foreach($route['cleanQueryParameters'] as $parameter => $value)
-            '{{$parameter}}' => '{{$value}}',
-@endforeach
-        ],
+        'query' => {!! \Mpociot\ApiDoc\Tools\Utils::printQueryParamsAsKeyValue($route['cleanQueryParameters'], "'", "=>", 12, "[]", 8) !!},
 @endif
 @if(!empty($route['cleanBodyParameters']))
         'json' => {!! \Mpociot\ApiDoc\Tools\Utils::printPhpValue($route['cleanBodyParameters'], 8) !!},

resources/views/partials/example-requests/python.blade.php

@@ -7,13 +7,7 @@
 payload = {!! json_encode($route['cleanBodyParameters'], JSON_PRETTY_PRINT) !!}
 @endif
 @if(count($route['cleanQueryParameters']))
-params = {
-@foreach($route['cleanQueryParameters'] as $parameter => $value)
-  '{{ $parameter }}': '{{ $value }}'@if(!($loop->last)),
-@endif
-@endforeach
-
-}
+params = {!! \Mpociot\ApiDoc\Tools\Utils::printQueryParamsAsKeyValue($route['cleanQueryParameters'], "'", ":", 2, "{}") !!}
 @endif
 @if(!empty($route['headers']))
 headers = {

src/Tools/Utils.php

@@ -54,7 +54,7 @@ public static function getRouteClassAndMethodNames($routeOrAction)
     public static function replaceUrlParameterPlaceholdersWithValues(string $uri, array $urlParameters)
     {
         $matches = preg_match_all('/{.+?}/i', $uri, $parameterPaths);
-        if (! $matches) {
+        if (!$matches) {
             return $uri;
         }
 
@@ -89,7 +89,8 @@ public static function dumpException(\Exception $e)
 
     public static function deleteDirectoryAndContents($dir)
     {
-        $adapter = new Local(realpath(__DIR__.'/../../'));
+        $dir = ltrim($dir, '/');
+        $adapter = new Local(realpath(__DIR__ . '/../../'));
         $fs = new Filesystem($adapter);
         $fs->deleteDir($dir);
     }
@@ -98,21 +99,76 @@ public static function deleteDirectoryAndContents($dir)
      * @param mixed $value
      * @param int $indentationLevel
      *
+     * @return string
      * @throws \Symfony\Component\VarExporter\Exception\ExceptionInterface
      *
-     * @return string
      */
-    public static function printPhpValue($value, $indentationLevel = 0)
+    public static function printPhpValue($value, int $indentationLevel = 0): string
     {
         $output = VarExporter::export($value);
         // Padding with x spaces so they align
         $split = explode("\n", $output);
         $result = '';
         $padWith = str_repeat(' ', $indentationLevel);
         foreach ($split as $index => $line) {
-            $result .= ($index == 0 ? '' : "\n$padWith").$line;
+            $result .= ($index == 0 ? '' : "\n$padWith") . $line;
         }
 
         return $result;
     }
+
+    public static function printQueryParamsAsString(array $cleanQueryParams): string
+    {
+        $qs = '';
+        foreach ($cleanQueryParams as $parameter => $value) {
+            $paramName = urlencode($parameter);
+
+            if (!is_array($value)) {
+                $qs .= "$paramName=" . urlencode($value) . "&";
+            } else {
+                if (array_keys($value)[0] === 0) {
+                    // List query param (eg filter[]=haha should become "filter[]": "haha")
+                    $qs .= "$paramName" . '[]=' . urlencode($value[0]) . '&';
+                } else {
+                    // Hash query param (eg filter[name]=john should become "filter[name]": "john")
+                    foreach ($value as $item => $itemValue) {
+                        $qs .= "$paramName" . '[' . urlencode($item) . ']=' . urlencode($itemValue) . '&';
+                    }
+                }
+            }
+        }
+
+        return rtrim($qs, '&');
+    }
+
+    public static function printQueryParamsAsKeyValue(
+        array $cleanQueryParams,
+        string $quote = "\"",
+        string $delimiter = ":",
+        int $spacesIndentation = 4,
+        string $braces = "{}",
+        int $closingBraceIndentation = 0
+    ): string {
+        $output = "{$braces[0]}\n";
+        foreach ($cleanQueryParams as $parameter => $value) {
+            if (!is_array($value)) {
+                $output .= str_repeat(" ", $spacesIndentation);
+                $output .= "$quote$parameter$quote$delimiter $quote$value$quote,\n";
+            } else {
+                if (array_keys($value)[0] === 0) {
+                    // List query param (eg filter[]=haha should become "filter[]": "haha")
+                    $output .= str_repeat(" ", $spacesIndentation);
+                    $output .= "$quote$parameter" . "[]$quote$delimiter $quote$value[0]$quote,\n";
+                } else {
+                    // Hash query param (eg filter[name]=john should become "filter[name]": "john")
+                    foreach ($value as $item => $itemValue) {
+                        $output .= str_repeat(" ", $spacesIndentation);
+                        $output .= "$quote$parameter" . "[$item]$quote$delimiter $quote$itemValue$quote,\n";
+                    }
+                }
+            }
+        }
+
+        return $output . str_repeat(" ", $closingBraceIndentation) . "{$braces[1]}";
+    }
 }

tests/Fixtures/index.md

@@ -233,7 +233,7 @@ let params = {
     "user_id": "me",
     "page": "4",
     "filters": "consequatur",
-    "url_encoded": "+ []&=",
+    "url_encoded": "+ []&=",
 };
 Object.keys(params)
     .forEach(key => url.searchParams.append(key, params[key]));