tests for rule objects and closures

mtrajano · Dec 6, 2019 · a204e3a · a204e3a
1 parent 5401f68
commit a204e3a
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 1 deletion.
diff --git a/src/Parameters/Concerns/GeneratesFromRules.php b/src/Parameters/Concerns/GeneratesFromRules.php
@@ -62,7 +62,7 @@ protected function getEnumValues(array $paramRules)
     private function getInParameter(array $paramRules)
     {
         foreach ($paramRules as $rule) {
-            if (is_string($rule) && Str::startsWith($rule, 'in:')) {
+            if ((is_string($rule) || method_exists($rule , '__toString')) && Str::startsWith($rule, 'in:')) {
                 return $rule;
             }
         }

diff --git a/tests/Parameters/BodyParameterGeneratorTest.php b/tests/Parameters/BodyParameterGeneratorTest.php
@@ -2,8 +2,10 @@
 
 namespace Mtrajano\LaravelSwagger\Tests\Parameters;
 
+use Illuminate\Validation\Rule;
 use Mtrajano\LaravelSwagger\Tests\TestCase;
 use Mtrajano\LaravelSwagger\Parameters\BodyParameterGenerator;
+use Mtrajano\LaravelSwagger\Tests\Stubs\Rules\Uppercase as UppercaseRule;
 
 class BodyParameterGeneratorTest extends TestCase
 {
@@ -153,6 +155,63 @@ public function testSingleObjectSyntax()
         ], $bodyParameters['schema']['properties']);
     }
 
+    public function testResolvesRuleEnum()
+    {
+
+        $bodyParameters = $this->getBodyParameters([
+            'type' => [
+                Rule::in(1,2,3),
+                'integer',
+            ]
+        ]);
+
+        $this->assertEquals([
+            'type' => [
+                'type' => 'integer',
+                'enum' => ['"1"','"2"','"3"'], //using Rule::in parameters are cast to string
+            ]
+        ], $bodyParameters['schema']['properties']);
+
+    }
+
+    public function testIgnoresRuleObject()
+    {
+
+        $bodyParameters = $this->getBodyParameters([
+            'name' => [
+                'string',
+                new UppercaseRule
+            ],
+        ]);
+
+        $this->assertEquals([
+            'name' => [
+                'type' => 'string',
+            ]
+        ], $bodyParameters['schema']['properties']);
+
+    }
+
+    public function testIgnoresClosureRules()
+    {
+        $bodyParameters = $this->getBodyParameters([
+            'name' => [
+                'string',
+                function ($attribute, $value, $fail) {
+                    if ($value === 'foo') {
+                        $fail($attribute.' is invalid.');
+                    }
+                },
+            ],
+        ]);
+
+        $this->assertEquals([
+            'name' => [
+                'type' => 'string',
+            ]
+        ], $bodyParameters['schema']['properties']);
+    }
+
     private function getBodyParameters(array $rules)
     {
         $bodyParameters = (new BodyParameterGenerator($rules))->getParameters();

diff --git a/tests/Stubs/Rules/Uppercase.php b/tests/Stubs/Rules/Uppercase.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Tests\Stubs\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+class Uppercase implements Rule
+{
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        return strtoupper($value) === $value;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return 'The :attribute must be uppercase.';
+    }
+}