Import changes from cebe/yii2-openapi

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
+        php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3']
 
     # TODO use cache
     steps:

README.md

@@ -182,6 +182,8 @@ Such values are not allowed:
    - `int null default null after low_price` (null and default will be handled by `nullable` and `default` keys respectively)
    - MEDIUMINT(10) UNSIGNED ZEROFILL NULL DEFAULT '7' COMMENT 'comment' AFTER `seti`, ADD INDEX `t` (`w`)
 
+If `enum` and `x-db-type` both are provided then for database column schema (migrations), only `x-db-type` will be considered ignoring `enum`.
+
 ### `x-indexes`
 
 Specify table indexes
@@ -446,6 +448,8 @@ It works on all 3 DB: MySQL, MariaDb and PgSQL.
 
 Note: Changes in enum values are not very simple. For Mysql and Mariadb, migrations will be generated but in many cases custom modification in it are required. For Pgsql migrations for change in enum values will not be generated. It should be handled manually.
 
+It will be ignored for database column schema (migrations) if `x-db-type` is provided.
+
 ## Handling of `numeric` (#numeric, #MariaDb)
 
 precision-default = 10

src/lib/ValidationRulesBuilder.php

@@ -142,7 +142,8 @@ private function addRulesByAttributeName(Attribute $attribute):void
             '~(url|site|website|href|link)~i' => 'url',
         ];
         foreach ($patterns as $pattern => $validator) {
-            if (preg_match($pattern, strtolower($attribute->columnName))) {
+            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);
                 return;
@@ -232,7 +233,9 @@ private function prepareTypeScope():void
                 $this->typeScope['required'][$attribute->columnName] = $attribute->columnName;
             }
 
-            if ($attribute->phpType === 'string') {
+            if ($attribute->phpType === 'string' &&
+                empty($attribute->enumValues) # don't apply trim on enum columns # https://github.com/cebe/yii2-openapi/issues/158
+            ) {
                 $this->typeScope['trim'][$attribute->columnName] = $attribute->columnName;
             }
 

src/lib/openapi/ResponseSchema.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib\openapi;
 
+use cebe\openapi\exceptions\UnresolvableReferenceException;
 use cebe\openapi\spec\MediaType;
 use cebe\openapi\spec\Operation;
 use cebe\openapi\spec\Reference;
@@ -36,10 +37,10 @@ protected static function isObjectSchema($schema): bool
     protected static function isArraySchemaWithRefItems($schema): bool
     {
         return isset($schema->items) && $schema->items instanceof Reference &&
-            (isset($schema->type) &&  $schema->type === 'array');
+            (isset($schema->type) && $schema->type === 'array');
     }
 
-    protected static function hasAttributesReference($schema):bool
+    protected static function hasAttributesReference($schema): bool
     {
         return isset($schema->properties['attributes']) && $schema->properties['attributes'] instanceof Reference;
     }
@@ -49,17 +50,20 @@ protected static function schemaNameByRef($schemaOrReference): ?string
 //        if($schemaOrReference instanceof Reference){
 //            $schemaOrReference->resolve();
 //        }
+        if (!$schemaOrReference instanceof Reference) { # https://github.com/cebe/yii2-openapi/issues/175
+            return null;
+        }
         $ref = $schemaOrReference->getJsonReference()->getJsonPointer()->getPointer();
         $name = strpos($ref, '/components/schemas/') === 0 ? substr($ref, 20) : null;
         return str_replace(JunctionSchemas::PREFIX, '', $name);
     }
 
     /**
-     * @param \cebe\openapi\spec\Operation $operation
+     * @param Operation $operation
      * @return array
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws UnresolvableReferenceException
      */
-    public static function guessResponseRelations(Operation $operation):array
+    public static function guessResponseRelations(Operation $operation): array
     {
         if (!isset($operation->responses)) {
             return [];
@@ -109,12 +113,12 @@ public static function guessResponseRelations(Operation $operation):array
     }
 
     /**
-     * @param \cebe\openapi\spec\Operation $operation
+     * @param Operation $operation
      * @param                              $actionType
      * @return string|null
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws UnresolvableReferenceException
      */
-    public static function guessModelClass(Operation $operation, $actionType):?string
+    public static function guessModelClass(Operation $operation, $actionType): ?string
     {
         // first, check request body
         $requestBody = $operation->requestBody;
@@ -159,20 +163,26 @@ public static function guessModelClass(Operation $operation, $actionType):?strin
     }
 
     /**
-     * @param \cebe\openapi\SpecObjectInterface $property
+     * @param SpecObjectInterface $property
      * @return array|null[]
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws UnresolvableReferenceException
      */
     public static function guessModelClassFromJsonResource(SpecObjectInterface $property): array
     {
-        $schema = $property instanceof Reference? $property->resolve() : $property;
-
-        if (self::isObjectSchema($schema) && self::hasAttributesReference($schema)) {
-            $name = self::schemaNameByRef($schema->properties['attributes']);
-            if ($name !== null) {
-                return [$name, '', '', 'object'];
+        $schema = $property instanceof Reference ? $property->resolve() : $property;
+        if (self::isObjectSchema($schema)) {
+            if (self::hasAttributesReference($schema)) {
+                $name = self::schemaNameByRef($schema->properties['attributes']);
+                if ($name !== null) {
+                    return [$name, '', '', 'object'];
+                }
+                return [null, null, null, null];
+            } else { # https://github.com/cebe/yii2-openapi/issues/172
+                $name = self::schemaNameByRef($property);
+                if ($name !== null) {
+                    return [$name, '', '', 'object'];
+                }
             }
-            return [null, null, null, null];
         }
         if (self::isArraySchemaWithRefItems($property)) {
             $ref = $property->items->resolve();
@@ -188,11 +198,11 @@ public static function guessModelClassFromJsonResource(SpecObjectInterface $prop
     }
 
     /**
-     * @param \cebe\openapi\spec\MediaType $content
+     * @param MediaType $content
      * @return array|null[]
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws UnresolvableReferenceException
      */
-    public static function guessModelClassFromContent(MediaType $content):array
+    public static function guessModelClassFromContent(MediaType $content): array
     {
         /** @var $referencedSchema Schema */
         if ($content->schema instanceof Reference) {
@@ -255,9 +265,9 @@ public static function guessModelClassFromContent(MediaType $content):array
      * @param Operation $operation
      * @param           $modelClass
      * @return null|array
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws UnresolvableReferenceException
      */
-    public static function findResponseWrapper(Operation $operation, $modelClass):?array
+    public static function findResponseWrapper(Operation $operation, $modelClass): ?array
     {
         if (!isset($operation->responses)) {
             return null;

tests/specs/blog_v2/models/base/Post.php

@@ -29,7 +29,7 @@ public static function tableName()
     public function rules()
     {
         return [
-            'trim' => [['title', 'slug', 'lang', 'created_at'], 'trim'],
+            'trim' => [['title', 'slug', 'created_at'], 'trim'],
             'required' => [['title', 'category_id', 'active'], 'required'],
             'category_id_integer' => [['category_id'], 'integer'],
             'category_id_exist' => [['category_id'], 'exist', 'targetRelation' => 'Category'],

tests/specs/blog_v2/models/base/Tag.php

@@ -21,7 +21,7 @@ public static function tableName()
     public function rules()
     {
         return [
-            'trim' => [['name', 'lang'], 'trim'],
+            'trim' => [['name'], 'trim'],
             'required' => [['name', 'lang'], 'required'],
             'name_unique' => [['name'], 'unique'],
             'name_string' => [['name'], 'string', 'max' => 100],

tests/specs/blog_v2/models/base/User.php

@@ -24,7 +24,7 @@ public static function tableName()
     public function rules()
     {
         return [
-            'trim' => [['login', 'email', 'password', 'role', 'created_at'], 'trim'],
+            'trim' => [['login', 'email', 'password', 'created_at'], 'trim'],
             'required' => [['login', 'email', 'password'], 'required'],
             'login_unique' => [['login'], 'unique'],
             'email_unique' => [['email'], 'unique'],

tests/specs/issue_fix/158_bug_giiapi_generated_rules_enum_with_trim/index.php

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

tests/specs/issue_fix/158_bug_giiapi_generated_rules_enum_with_trim/index.yaml

@@ -0,0 +1,40 @@
+
+openapi: 3.0.3
+
+info:
+  title: 'Proxy-Service'
+  version: 1.0.0
+
+components:
+
+  schemas:
+
+    Mailing:
+      description: Mailing
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          description: name
+          type: string
+          maxLength: 128
+        paymentMethodName:
+          type: string
+          enum:
+            - card
+            - cash
+            - ewallet
+
+paths:
+  '/':
+    get:
+      operationId: opId
+      summary: summary
+      responses:
+        '200':
+          description: OK

tests/specs/issue_fix/158_bug_giiapi_generated_rules_enum_with_trim/maria/models/BaseModelFaker.php

@@ -0,0 +1,144 @@
+<?php
+
+namespace app\models;
+
+use Faker\Factory as FakerFactory;
+use Faker\Generator;
+use Faker\UniqueGenerator;
+
+/**
+ * Base fake data generator
+ */
+abstract class BaseModelFaker
+{
+    /**
+     * @var Generator
+    */
+    protected $faker;
+    /**
+     * @var UniqueGenerator
+    */
+    protected $uniqueFaker;
+
+    public function __construct()
+    {
+        $this->faker = FakerFactory::create(str_replace('-', '_', \Yii::$app->language));
+        $this->uniqueFaker = new UniqueGenerator($this->faker);
+    }
+
+    abstract public function generateModel($attributes = []);
+
+    public function getFaker():Generator
+    {
+        return $this->faker;
+    }
+
+    public function getUniqueFaker():UniqueGenerator
+    {
+        return $this->uniqueFaker;
+    }
+
+    public function setFaker(Generator $faker):void
+    {
+        $this->faker = $faker;
+    }
+
+    public function setUniqueFaker(UniqueGenerator $faker):void
+    {
+        $this->uniqueFaker = $faker;
+    }
+
+    /**
+     * Generate and return model
+     * @param array|callable $attributes
+     * @param UniqueGenerator|null $uniqueFaker
+     * @return \yii\db\ActiveRecord
+     * @example MyFaker::makeOne(['user_id' => 1, 'title' => 'foo']);
+     * @example MyFaker::makeOne( function($model, $faker) {
+     *        $model->scenario = 'create';
+     *        $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
+     *        return $model;
+     *  });
+     */
+    public static function makeOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
+    {
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        $model = $fakeBuilder->generateModel($attributes);
+        return $model;
+    }
+
+    /**
+     * Generate, save and return model
+     * @param array|callable $attributes
+     * @param UniqueGenerator|null $uniqueFaker
+     * @return \yii\db\ActiveRecord
+     * @example MyFaker::saveOne(['user_id' => 1, 'title' => 'foo']);
+     * @example MyFaker::saveOne( function($model, $faker) {
+     *        $model->scenario = 'create';
+     *        $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
+     *        return $model;
+     *  });
+     */
+    public static function saveOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
+    {
+        $model = static::makeOne($attributes, $uniqueFaker);
+        $model->save();
+        return $model;
+    }
+
+    /**
+     * Generate and return multiple models
+     * @param int $number
+     * @param array|callable $commonAttributes
+     * @return \yii\db\ActiveRecord[]|array
+     * @example TaskFaker::make(5, ['project_id'=>1, 'user_id' => 2]);
+     * @example TaskFaker::make(5, function($model, $faker, $uniqueFaker) {
+     *       $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
+     *       return $model;
+     * });
+     */
+    public static function make(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
+    {
+        if ($number < 1) {
+            return [];
+        }
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        return array_map(function () use ($commonAttributes, $fakeBuilder) {
+            $model = $fakeBuilder->generateModel($commonAttributes);
+            return $model;
+        }, range(0, $number -1));
+    }
+
+    /**
+     * Generate, save and return multiple models
+     * @param int $number
+     * @param array|callable $commonAttributes
+     * @return \yii\db\ActiveRecord[]|array
+     * @example TaskFaker::save(5, ['project_id'=>1, 'user_id' => 2]);
+     * @example TaskFaker::save(5, function($model, $faker, $uniqueFaker) {
+     *       $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
+     *       return $model;
+     * });
+     */
+    public static function save(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
+    {
+        if ($number < 1) {
+            return [];
+        }
+        $fakeBuilder = new static();
+        if ($uniqueFaker !== null) {
+            $fakeBuilder->setUniqueFaker($uniqueFaker);
+        }
+        return array_map(function () use ($commonAttributes, $fakeBuilder) {
+            $model = $fakeBuilder->generateModel($commonAttributes);
+            $model->save();
+            return $model;
+        }, range(0, $number -1));
+    }
+}