Contains implementation

Author: SOHELAHMED7

TODO.taskpaper

@@ -1,9 +1,9 @@
 TODO.taskpaper
 
 ### Add validation rules by attribute name or pattern #30
- ☐ create failing test
- ☐ implement the solution
- ☐ fix failing tests if any
- ☐ resolve TODOs if any
+ ✔ create failing test @done (24-08-26 18:13)
+ ✔ implement the solution @done (24-08-26 18:13)
+ ✔ fix failing tests if any @done (24-08-26 18:13)
+ ✔ resolve TODOs if any @done (24-08-26 18:13)
  ☐ review PR
  ☐ delete this file and submit PR

src/lib/ValidationRulesBuilder.php

@@ -10,8 +10,6 @@
 use cebe\yii2openapi\lib\items\Attribute;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\ValidationRule;
-use yii\helpers\VarDumper;
-use yii\validators\DateValidator;
 use function count;
 use function implode;
 use function in_array;
@@ -65,7 +63,7 @@ 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()`
+            // 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])
             ) {
@@ -140,12 +138,30 @@ private function addRulesByAttributeName(Attribute $attribute):void
         $patterns = [
             '~e?mail~i' => 'email',
             '~(url|site|website|href|link)~i' => 'url',
+
+            # below patters will only work if `format: binary` (file) is present in OpenAPI spec
+            # also `string` validation rule will be removed
+            '~(image|photo|picture)~i' => 'image',
+            '~(file|pdf|audio|video|document|json|yml|yaml|zip|tar|7z)~i' => 'file',
         ];
+        $addRule = function (Attribute $attribute, string $validator): void {
+            $key = $attribute->columnName . '_' . $validator;
+            $this->rules[$key] = new ValidationRule([$attribute->columnName], $validator);
+        };
         foreach ($patterns as $pattern => $validator) {
             if (empty($attribute->reference) # ignore column name based rules in case of reference/relation # https://github.com/cebe/yii2-openapi/issues/159
                 && preg_match($pattern, strtolower($attribute->columnName))) {
-                $key = $attribute->columnName . '_' . $validator;
-                $this->rules[$key] = new ValidationRule([$attribute->columnName], $validator);
+
+                if (in_array($validator, ['image', 'file'], true)) {
+                    if ($attribute->dbType === 'binary') {
+                        $addRule($attribute, $validator);
+                        // for files, we don't need `string` validation
+                        $key = $attribute->columnName . '_string';
+                        unset($this->rules[$key]);
+                    }
+                } else {
+                    $addRule($attribute, $validator);
+                }
                 return;
             }
         }
@@ -223,7 +239,7 @@ private function prepareTypeScope():void
             if ($attribute->isReadOnly()) {
                 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()`
+            // 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])
             ) {

tests/specs/issue_fix/30_add_validation_rules_by_attribute_name_or_pattern/index.php

@@ -0,0 +1,14 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/30_add_validation_rules_by_attribute_name_or_pattern/index.yaml',
+    'generateUrls' => false,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => false,
+    'generateMigrations' => false,
+    'generateModelFaker' => true, // `generateModels` must be `true` in order to use `generateModelFaker` as `true`
+];
+

tests/specs/issue_fix/30_add_validation_rules_by_attribute_name_or_pattern/index.yaml

@@ -0,0 +1,45 @@
+
+openapi: 3.0.3
+
+info:
+  title: Add validation rules by attribute name or pattern \#30
+  version: 1.0.0
+
+components:
+  schemas:
+    User:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          description: name
+          type: string
+          maxLength: 128
+        photo:
+          type: string
+          format: binary
+        profile_photo:
+          type: string
+          format: binary
+        pdf:
+          type: string
+          format: binary
+        a_file:
+          type: string
+          format: binary
+        profile:
+          type: string
+
+paths:
+  '/':
+    get:
+      operationId: opId
+      summary: summary
+      responses:
+        '200':
+          description: OK

tests/unit/IssueFixTest.php

@@ -360,4 +360,18 @@ public function test158BugGiiapiGeneratedRulesEnumWithTrim()
         ]);
         $this->checkFiles($actualFiles, $expectedFiles);
     }
+
+    // https://github.com/php-openapi/yii2-openapi/issues/30
+    public function test30AddValidationRulesByAttributeNameOrPattern()
+    {
+        $testFile = Yii::getAlias("@specs/issue_fix/30_add_validation_rules_by_attribute_name_or_pattern/index.php");
+        $this->runGenerator($testFile);
+//        $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
+//            'recursive' => true,
+//        ]);
+//        $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/30_add_validation_rules_by_attribute_name_or_pattern/mysql"), [
+//            'recursive' => true,
+//        ]);
+//        $this->checkFiles($actualFiles, $expectedFiles);
+    }
 }