support for enums

Author: mtrajano

src/Parameters/BodyParameterGenerator.php

@@ -20,14 +20,21 @@ public function getParameters()
 
         foreach  ($this->rules as $param => $rule) {
             $paramRules = $this->splitRules($rule);
+            $enums = $this->getEnumValues($paramRules);
 
             if ($this->isParamRequired($paramRules)) {
                 $required[] = $param;
             }
 
-            $properties[$param] = [
+            $propObj = [
                 'type' => $this->getParamType($paramRules)
             ];
+
+            if (!empty($enums)) {
+                $propObj['enum'] = $enums;
+            }
+
+            $properties[$param] = $propObj;
         }
 
         if (!empty($required)) {

src/Parameters/ParameterGenerator.php

@@ -50,4 +50,28 @@ protected function splitRules($rules)
             return $rules;
         }
     }
+
+    protected function getEnumValues(array $paramRules)
+    {
+        $in = $this->getInParameter($paramRules);
+
+        if (!$in) {
+            return [];
+        }
+
+        list($param, $vals) = explode(':', $in);
+
+        return explode(',', $vals);
+    }
+
+    private function getInParameter(array $paramRules)
+    {
+        foreach ($paramRules as $rule) {
+            if (starts_with($rule, 'in:')) {
+                return $rule;
+            }
+        }
+
+        return false;
+    }
 }

src/Parameters/QueryParameterGenerator.php

@@ -10,14 +10,21 @@ public function getParameters()
 
         foreach  ($this->rules as $param => $rule) {
             $paramRules = $this->splitRules($rule);
+            $enums = $this->getEnumValues($paramRules);
 
-            $params[] = [
+            $paramObj = [
                 'in' => $this->getParamLocation(),
                 'name' => $param,
                 'type' => $this->getParamType($paramRules),
                 'required' => $this->isParamRequired($paramRules),
                 'description' => '',
             ];
+
+            if (!empty($enums)) {
+                $paramObj['enum'] = $enums;
+            }
+
+            $params[] = $paramObj;
         }
 
         return $params;

tests/Parameters/BodyParameterGeneratorTest.php

@@ -62,6 +62,20 @@ public function testNoRequiredParameters()
         $this->assertArrayNotHasKey('required', $bodyParameters['schema']);
     }
 
+    public function testEnumInBody()
+    {
+        $bodyParameters = $this->getBodyParameters([
+            'account_type' => 'integer|in:1,2|in_array:foo',
+        ]);
+
+        $this->assertEquals([
+            'account_type' => [
+                'type' => 'integer',
+                'enum' => [1,2],
+            ]
+        ], $bodyParameters['schema']['properties']);
+    }
+
     private function getBodyParameters(array $rules)
     {
         $bodyParameters = (new BodyParameterGenerator('post', '/', $rules))->getParameters();

tests/Parameters/QueryParameterGeneratorTest.php

@@ -7,7 +7,6 @@
 
 class QueryParameterGeneratorTest extends TestCase
 {
-
     public function testRequiredParameter()
     {
         $queryParameters = $this->getQueryParameters([
@@ -49,6 +48,19 @@ public function testOptionalParameter()
         ], $queryParameters[0]);
     }
 
+    public function testEnumInQuery()
+    {
+        $queryParameters = $this->getQueryParameters([
+            'account_type' => 'integer|in:1,2|in_array:foo',
+        ]);
+
+        $this->assertArraySubset([
+            'name' => 'account_type',
+            'type' => 'integer',
+            'enum' => [1,2],
+        ], $queryParameters[0]);
+    }
+
     private function getQueryParameters(array $rules)
     {
         return (new QueryParameterGenerator('get', '/', $rules))->getParameters();