fixed array.* syntax in query param

Author: mtrajano

src/FormatterManager.php

@@ -26,7 +26,7 @@ public function setFormat($format)
 
     protected function getFormatter($format)
     {
-        switch($format) {
+        switch ($format) {
             case 'json':
                 return new Formatters\JsonFormatter($this->docs);
             case 'yaml':

src/Generator.php

@@ -150,7 +150,7 @@ protected function getFormRules()
 
     protected function getParameterGenerator($rules)
     {
-        switch($this->method) {
+        switch ($this->method) {
             case 'post':
             case 'put':
             case 'patch':

src/Parameters/BodyParameterGenerator.php

@@ -27,7 +27,7 @@ public function getParameters()
             ],
         ];
 
-        foreach  ($this->rules as $param => $rule) {
+        foreach ($this->rules as $param => $rule) {
             $paramRules = $this->splitRules($rule);
             $enums = $this->getEnumValues($paramRules);
 

src/Parameters/Concerns/GeneratesFromRules.php

@@ -34,6 +34,16 @@ protected function isParamRequired(array $paramRules)
         return in_array('required', $paramRules);
     }
 
+    protected function isArrayParameter($param)
+    {
+        return str_contains($param, '*');
+    }
+
+    protected function getArrayKey($param)
+    {
+        return current(explode('.', $param));
+    }
+
     protected function getEnumValues(array $paramRules)
     {
         $in = $this->getInParameter($paramRules);

src/Parameters/QueryParameterGenerator.php

@@ -16,15 +16,23 @@ public function __construct($rules)
     public function getParameters()
     {
         $params = [];
+        $arrayTypes = [];
 
         foreach  ($this->rules as $param => $rule) {
             $paramRules = $this->splitRules($rule);
             $enums = $this->getEnumValues($paramRules);
+            $type = $this->getParamType($paramRules);
+
+            if ($this->isArrayParameter($param)) {
+                $arrayKey = $this->getArrayKey($param);
+                $arrayTypes[$arrayKey] = $type;
+                continue;
+            }
 
             $paramObj = [
                 'in' => $this->getParamLocation(),
                 'name' => $param,
-                'type' => $this->getParamType($paramRules),
+                'type' => $type,
                 'required' => $this->isParamRequired($paramRules),
                 'description' => '',
             ];
@@ -33,7 +41,36 @@ public function getParameters()
                 $paramObj['enum'] = $enums;
             }
 
-            $params[] = $paramObj;
+            if ($type === 'array') {
+                $paramObj['items'] = ['type' => 'string'];
+            }
+
+            $params[$param] = $paramObj;
+        }
+
+        $params = $this->addArrayTypes($params, $arrayTypes);
+
+        return array_values($params);
+    }
+
+    protected function addArrayTypes($params, $arrayTypes)
+    {
+        foreach ($arrayTypes as $arrayKey => $type) {
+            if (!isset($params[$arrayKey])) {
+                $params[$arrayKey] = [
+                    'in' => $this->getParamLocation(),
+                    'name' => $arrayKey,
+                    'type' => 'array',
+                    'required' => false,
+                    'description' => '',
+                    'items' => [
+                        'type' => $type,
+                    ],
+                ];
+            } else {
+                $params[$arrayKey]['type'] = 'array';
+                $params[$arrayKey]['items']['type'] = $type;
+            }
         }
 
         return $params;

tests/Parameters/QueryParameterGeneratorTest.php

@@ -79,6 +79,55 @@ public function testEnumRuleObjet()
         ], $queryParameters[0]);
     }
 
+    public function testArrayTypeDefaultsToString()
+    {
+        $queryParameters = $this->getQueryParameters([
+            'values' => 'array',
+        ]);
+
+        $this->assertArraySubset([
+            'name' => 'values',
+            'type' => 'array',
+            'required' => false,
+            'items' => [
+                'type' => 'string',
+            ],
+        ], $queryParameters[0]);
+    }
+
+    public function testArrayValidationSyntax()
+    {
+        $queryParameters = $this->getQueryParameters([
+            'values.*' => 'integer',
+        ]);
+
+        $this->assertArraySubset([
+            'name' => 'values',
+            'type' => 'array',
+            'required' => false,
+            'items' => [
+                'type' => 'integer',
+            ],
+        ], $queryParameters[0]);
+    }
+
+    public function testArrayValidationSyntaxWithRequiredArray()
+    {
+        $queryParameters = $this->getQueryParameters([
+            'values.*' => 'integer',
+            'values' => 'required',
+        ]);
+
+        $this->assertArraySubset([
+            'name' => 'values',
+            'type' => 'array',
+            'required' => true,
+            'items' => [
+                'type' => 'integer',
+            ],
+        ], $queryParameters[0]);
+    }
+
     private function getQueryParameters(array $rules)
     {
         return (new QueryParameterGenerator($rules))->getParameters();