Merge pull request #24 from php-openapi/22-bug-rules-required-is-generated-before-_default

Bug: rules() "required" is generated before "*_default" #22

Author: cebe

src/lib/ValidationRulesBuilder.php

@@ -53,30 +53,38 @@ public function build():array
             $this->rules['trim'] = new ValidationRule($this->typeScope['trim'], 'trim');
         }
 
+        foreach ($this->model->attributes as $attribute) {
+            if ($this->isIdColumn($attribute)) {
+                continue;
+            }
+            $this->defaultRule($attribute);
+        }
+
         if (!empty($this->typeScope['required'])) {
             $this->rules['required'] = new ValidationRule($this->typeScope['required'], 'required');
         }
-        if (!empty($this->typeScope['ref'])) {
-            $this->addExistRules($this->typeScope['ref']);
+
+        foreach ($this->model->attributes as $attribute) {
+            if ($this->isIdColumn($attribute)) {
+                continue;
+            }
+            $this->resolveAttributeRules($attribute);
         }
+
         foreach ($this->model->indexes as $index) {
             if ($index->isUnique) {
                 $this->addUniqueRule($index->columns);
             }
         }
-        foreach ($this->model->attributes as $attribute) {
-            // column/field/property with name `id` is considered as Primary Key by this library, and it is automatically handled by DB/Yii; so remove it from validation `rules()`
-            if (in_array($attribute->columnName, ['id', $this->model->pkName]) ||
-                in_array($attribute->propertyName, ['id', $this->model->pkName])
-            ) {
-                continue;
-            }
-            $this->resolveAttributeRules($attribute);
+
+        if (!empty($this->typeScope['ref'])) {
+            $this->addExistRules($this->typeScope['ref']);
         }
 
         if (!empty($this->typeScope['safe'])) {
             $this->rules['safe'] = new ValidationRule($this->typeScope['safe'], 'safe');
         }
+
         return $this->rules;
     }
 
@@ -93,7 +101,6 @@ private function resolveAttributeRules(Attribute $attribute):void
         }
         if ($attribute->phpType === 'bool' || $attribute->phpType === 'boolean') {
             $this->rules[$attribute->columnName . '_boolean'] = new ValidationRule([$attribute->columnName], 'boolean');
-            $this->defaultRule($attribute);
             return;
         }
 
@@ -111,13 +118,11 @@ private function resolveAttributeRules(Attribute $attribute):void
             }
 
             $this->rules[$key] = new ValidationRule([$attribute->columnName], $attribute->dbType, $params);
-            $this->defaultRule($attribute);
             return;
         }
 
         if (in_array($attribute->phpType, ['int', 'integer', 'double', 'float']) && !$attribute->isReference()) {
             $this->addNumericRule($attribute);
-            $this->defaultRule($attribute);
             return;
         }
         if ($attribute->phpType === 'string' && !$attribute->isReference()) {
@@ -127,10 +132,8 @@ private function resolveAttributeRules(Attribute $attribute):void
             $key = $attribute->columnName . '_in';
             $this->rules[$key] =
                 new ValidationRule([$attribute->columnName], 'in', ['range' => $attribute->enumValues]);
-            $this->defaultRule($attribute);
             return;
         }
-        $this->defaultRule($attribute);
         $this->addRulesByAttributeName($attribute);
     }
 
@@ -278,4 +281,15 @@ public function __toString()
             }
         };
     }
+
+    private function isIdColumn(Attribute $attribute): bool
+    {
+        // column/field/property with name `id` is considered as Primary Key by this library, and it is automatically handled by DB/Yii; so remove it from validation `rules()`
+        if (in_array($attribute->columnName, ['id', $this->model->pkName]) ||
+            in_array($attribute->propertyName, ['id', $this->model->pkName])
+        ) {
+            return true;
+        }
+        return false;
+    }
 }

tests/DbTestCase.php

@@ -3,13 +3,13 @@
 namespace tests;
 
 use cebe\yii2openapi\generator\ApiGenerator;
+use SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
 use Yii;
 use yii\db\IndexConstraint;
-use yii\di\Container;
 use yii\db\mysql\Schema as MySqlSchema;
 use yii\db\pgsql\Schema as PgSqlSchema;
-use \SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
-use yii\helpers\{ArrayHelper, VarDumper, StringHelper, Console};
+use yii\di\Container;
+use yii\helpers\{ArrayHelper, StringHelper};
 use yii\helpers\FileHelper;
 
 class DbTestCase extends \PHPUnit\Framework\TestCase
@@ -102,7 +102,6 @@ protected function compareFiles(array $actual, string $testFile)
         foreach ($actual as $file) {
             $expectedFile = str_replace('@app', substr($testFile, 0, -4), $file);
             $actualFile = str_replace('@app', Yii::getAlias('@app'), $file);
-            // exec('cp '.$actualFile.' '.$expectedFile);
             $this->checkFiles([$actualFile], [$expectedFile]);
         }
     }
@@ -128,6 +127,7 @@ protected function checkFiles(array $actual, array $expected)
                 );
             }
 
+            // exec('cp '.$file.' '.$expectedFilePath);
             $this->assertFileEquals($expectedFilePath, $file, "Failed asserting that file contents of\n$file\nare equal to file contents of\n$expectedFilePath \n\n cp $file $expectedFilePath \n\n ");
         }
     }