Merge pull request #12 from SOHELAHMED7/129-check-x-pk-when-generating-validation-rules

Resolve - Check x-pk when generating validation rules

Author: SOHELAHMED7

src/lib/ValidationRulesBuilder.php

@@ -64,7 +64,9 @@ public function build():array
         }
         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 ($attribute->columnName === 'id' || $attribute->propertyName === 'id') {
+            if (in_array($attribute->columnName, ['id', $this->model->pkName]) ||
+                in_array($attribute->propertyName, ['id', $this->model->pkName])
+            ) {
                 continue;
             }
             $this->resolveAttributeRules($attribute);
@@ -186,7 +188,9 @@ private function prepareTypeScope():void
                 continue;
             }
             // 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 ($attribute->columnName === 'id' || $attribute->propertyName === 'id') {
+            if (in_array($attribute->columnName, ['id', $this->model->pkName]) ||
+                in_array($attribute->propertyName, ['id', $this->model->pkName])
+            ) {
                 continue;
             }
             if ($attribute->defaultValue === null && $attribute->isRequired()) {

tests/specs/id_not_in_rules/app/models/Post.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace app\models;
+
+class Post extends \app\models\base\Post
+{
+
+
+}
+

tests/specs/id_not_in_rules/app/models/PostFaker.php

@@ -0,0 +1,41 @@
+<?php
+namespace app\models;
+
+use Faker\UniqueGenerator;
+
+/**
+ * Fake data generator for Post
+ * @method static Post makeOne($attributes = [], ?UniqueGenerator $uniqueFaker = null);
+ * @method static Post saveOne($attributes = [], ?UniqueGenerator $uniqueFaker = null);
+ * @method static Post[] make(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null)
+ * @method static Post[] save(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null)
+ */
+class PostFaker extends BaseModelFaker
+{
+
+    /**
+     * @param array|callable $attributes
+     * @return Post|\yii\db\ActiveRecord
+     * @example
+     *  $model = (new PostFaker())->generateModels(['author_id' => 1]);
+     *  $model = (new PostFaker())->generateModels(function($model, $faker, $uniqueFaker) {
+     *            $model->scenario = 'create';
+     *            $model->author_id = 1;
+     *            return $model;
+     *  });
+    **/
+    public function generateModel($attributes = [])
+    {
+        $faker = $this->faker;
+        $uniqueFaker = $this->uniqueFaker;
+        $model = new Post();
+        $model->uid = substr($uniqueFaker->sha256, 0, 255);
+        $model->title = $faker->sentence;
+        if (!is_callable($attributes)) {
+            $model->setAttributes($attributes, false);
+        } else {
+            $model = $attributes($model, $faker, $uniqueFaker);
+        }
+        return $model;
+    }
+}

tests/specs/id_not_in_rules/app/models/base/Post.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace app\models\base;
+
+/**
+ *
+ *
+ * @property string $uid
+ * @property string $title
+ *
+ */
+abstract class Post extends \yii\db\ActiveRecord
+{
+    public static function tableName()
+    {
+        return '{{%posts}}';
+    }
+
+    public function rules()
+    {
+        return [
+            'trim' => [['title'], 'trim'],
+            'title_string' => [['title'], 'string'],
+        ];
+    }
+}

tests/specs/id_not_in_rules/id_not_in_rules.yaml

@@ -24,3 +24,12 @@ components:
           type: integer
         name:
           type: string
+    Post:
+      x-table: posts
+      x-pk: uid
+      properties:
+        uid:
+           type: string
+        title:
+           type: string
+