Added min/max rules support for strings (#433)

dedoc · Jun 28, 2024 · 34bfad5 · 34bfad5
1 parent 90f7661
commit 34bfad5
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 7 deletions.
diff --git a/src/Support/Generator/Types/ArrayType.php b/src/Support/Generator/Types/ArrayType.php
@@ -12,11 +12,11 @@ class ArrayType extends Type
     /** @var Type|Schema */
     public $prefixItems = [];
 
-    private $minItems = null;
+    public $minItems = null;
 
-    private $maxItems = null;
+    public $maxItems = null;
 
-    private $additionalItems = null;
+    public $additionalItems = null;
 
     public function __construct()
     {

diff --git a/src/Support/Generator/Types/NumberType.php b/src/Support/Generator/Types/NumberType.php
@@ -4,9 +4,9 @@
 
 class NumberType extends Type
 {
-    private $min = null;
+    public $min = null;
 
-    private $max = null;
+    public $max = null;
 
     public function __construct($type = 'number')
     {

diff --git a/src/Support/Generator/Types/StringType.php b/src/Support/Generator/Types/StringType.php
@@ -4,8 +4,34 @@
 
 class StringType extends Type
 {
+    public $min = null;
+
+    public $max = null;
+
     public function __construct()
     {
         parent::__construct('string');
     }
+
+    public function setMin($min)
+    {
+        $this->min = $min;
+
+        return $this;
+    }
+
+    public function setMax($max)
+    {
+        $this->max = $max;
+
+        return $this;
+    }
+
+    public function toArray()
+    {
+        return array_merge(parent::toArray(), array_filter([
+            'minLength' => $this->min,
+            'maxLength' => $this->max,
+        ], fn ($v) => $v !== null));
+    }
 }
diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesMapper.php b/src/Support/OperationExtensions/RulesExtractor/RulesMapper.php
@@ -115,7 +115,11 @@ public function required(Type $type)
 
     public function min(Type $type, $params)
     {
-        if ($type instanceof NumberType || $type instanceof ArrayType) {
+        if (
+            $type instanceof NumberType
+            || $type instanceof ArrayType
+            || $type instanceof StringType
+        ) {
             $type->setMin((float) $params[0]);
         }
 
@@ -124,7 +128,11 @@ public function min(Type $type, $params)
 
     public function max(Type $type, $params)
     {
-        if ($type instanceof NumberType || $type instanceof ArrayType) {
+        if (
+            $type instanceof NumberType
+            || $type instanceof ArrayType
+            || $type instanceof StringType
+        ) {
             $type->setMax((float) $params[0]);
         }
 

diff --git a/tests/ValidationRulesDocumentingTest.php b/tests/ValidationRulesDocumentingTest.php
@@ -184,6 +184,34 @@
         ->toHaveKey('maximum', 8);
 });
 
+it('converts min rule into "minLength" for string fields', function () {
+    $rules = [
+        'str' => ['string', 'min:8'],
+    ];
+
+    $params = app()->make(RulesToParameters::class, ['rules' => $rules])->handle();
+
+    expect($params = collect($params)->all())
+        ->toHaveCount(1)
+        ->and($params[0]->schema->type)
+        ->toBeInstanceOf(\Dedoc\Scramble\Support\Generator\Types\StringType::class)
+        ->toHaveKey('minLength', 8);
+});
+
+it('converts max rule into "maxLength" for string fields', function () {
+    $rules = [
+        'str' => ['string', 'max:8'],
+    ];
+
+    $params = app()->make(RulesToParameters::class, ['rules' => $rules])->handle();
+
+    expect($params = collect($params)->all())
+        ->toHaveCount(1)
+        ->and($params[0]->schema->type)
+        ->toBeInstanceOf(\Dedoc\Scramble\Support\Generator\Types\StringType::class)
+        ->toHaveKey('maxLength', 8);
+});
+
 it('converts min rule into "minItems" for array fields', function () {
     $rules = [
         'num' => ['array', 'min:8'],