Fix bug in x-db-type feature + Add tests WIP

README.md

@@ -71,6 +71,8 @@ On console you can run the generator with `./yii gii/api --openApiPath=@app/open
 
 Run `./yii gii/api --help` for all options.
 
+See [Petstore example](https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.0/petstore.yaml) for example OpenAPI spec.
+
 
 ## OpenAPI extensions
 
@@ -115,9 +117,26 @@ Explicitly specify primary key name for table, if it is different from "id"
 
 ### `x-db-type`
 
-Explicitly specify the database type for a column. (MUST contains only db type! (json, jsonb, uuid, varchar etc))
-If x-db-type sets as false, property will be processed as virtual;
-It will be added in model as public property, but skipped for migrations generation
+Explicitly specify the database type for a column. (MUST contains only real DB type! (`json`, `jsonb`, `uuid`, `varchar` etc.)).
+If x-db-type sets as `false`, property will be processed as virtual;
+It will be added in model as public property, but skipped for migrations generation.
+
+Example values of `x-db-type` are:
+
+ - `false` (boolean false)
+ - as string and its value can be like:
+     - text
+     - text[]
+     - INTEGER PRIMARY KEY AUTO_INCREMENT
+     - decimal(12,4)
+     - decimal(12)
+     - decimal
+     - json
+     - varchar
+     - VARCHAR
+
+Such values are not allowed:
+   - `int null default null after low_price` (null and default will be handled by `nullable` and `default` keys respectively)
 
 ### `x-indexes`
 Specify table indexes

src/lib/items/Attribute.php

@@ -303,58 +303,54 @@ public function toColumnSchema():ColumnSchema
     // todo docs - it throw new NotSupportedException
     private function yiiAbstractTypeForDbSpecificType(string $type): string
     {
-        if (is_string($this->xDbType) && !empty($this->xDbType)) {
+        if (is_string($this->xDbType) && !empty($this->xDbType) && trim($this->xDbType)) {
             $xDbType = strtolower($this->xDbType);
 
-            list($isXDbTypeWithArray, $modifiedXDbType) = $this->isTypeWithArray($xDbType);
+            list(, $justYiiAbstractType) = $this->isTypeWithMoreInfo($xDbType);
 
             if ($this->isMysql()) {
                 $mysqlSchema = new MySqlSchema;
 
-                if (!array_key_exists($modifiedXDbType, $mysqlSchema->typeMap)) {
-                    throw new InvalidDefinitionException('"x-db-type: '.$modifiedXDbType.'" is incorrect for MySQL. "'.$modifiedXDbType.'" is not a real data type in MySQL.');
+                if (!array_key_exists($justYiiAbstractType, $mysqlSchema->typeMap)) {
+                    throw new InvalidDefinitionException('"x-db-type: '.$justYiiAbstractType.'" is incorrect for MySQL. "'.$justYiiAbstractType.'" is not a real data type in MySQL.');
                 }
 
-                return $mysqlSchema->typeMap[$modifiedXDbType] .
-                    ($isXDbTypeWithArray ? '[]' : '');
+                return $mysqlSchema->typeMap[$justYiiAbstractType];
             } elseif ($this->isMariaDb()) {
                 $mariadbSchema = new MariaDbSchema;
 
-                if (!array_key_exists($modifiedXDbType, $mariadbSchema->typeMap)) {
-                    throw new InvalidDefinitionException('"x-db-type: '.$modifiedXDbType.'" is incorrect for MariaDB. "'.$modifiedXDbType.'" is not a real data type in MariaDb.');
+                if (!array_key_exists($justYiiAbstractType, $mariadbSchema->typeMap)) {
+                    throw new InvalidDefinitionException('"x-db-type: '.$justYiiAbstractType.'" is incorrect for MariaDB. "'.$justYiiAbstractType.'" is not a real data type in MariaDb.');
                 }
-                return $mariadbSchema->typeMap[$modifiedXDbType] .
-                    ($isXDbTypeWithArray ? '[]' : '');
+                return $mariadbSchema->typeMap[$justYiiAbstractType];
             } elseif ($this->isPostgres()) {
                 $pgsqlSchema = new PgSqlSchema;
-                if (!array_key_exists($modifiedXDbType, $pgsqlSchema->typeMap)) {
-                    throw new InvalidDefinitionException('"x-db-type: '.$modifiedXDbType.'" is incorrect for PostgreSQL. "'.$modifiedXDbType.'" is not a real data type in PostgreSQL.');
+                if (!array_key_exists($justYiiAbstractType, $pgsqlSchema->typeMap)) {
+                    throw new InvalidDefinitionException('"x-db-type: '.$justYiiAbstractType.'" is incorrect for PostgreSQL. "'.$justYiiAbstractType.'" is not a real data type in PostgreSQL.');
                 }
-                return $pgsqlSchema->typeMap[$modifiedXDbType] .
-                    ($isXDbTypeWithArray ? '[]' : '');
+                return $pgsqlSchema->typeMap[$justYiiAbstractType];
             } else {
                 throw new NotSupportedException('"x-db-type" for database '.get_class(Yii::$app->db->schema).' is not implemented. It is only implemented for PostgreSQL, MySQL and MariaDB.');
             }
         } else {
-            list($isTypeWithArray, $modifiedType) = $this->isTypeWithArray($type);
             if (stripos($type, 'int') === 0) {
-                return $isTypeWithArray ? 'integer[]' : 'integer';
+                return 'integer';
             }
             if (stripos($type, 'string') === 0) {
-                return $isTypeWithArray ? 'string[]' : 'string';
+                return 'string';
             }
             if (stripos($type, 'varchar') === 0) {
-                return $isTypeWithArray ? 'string[]' : 'string';
+                return 'string';
             }
             if (stripos($type, 'tsvector') === 0) {
-                return $isTypeWithArray ? 'string[]' : 'string';
+                return 'string';
             }
             if (stripos($type, 'json') === 0) {
-                return $isTypeWithArray ? 'json[]' : 'json';
+                return 'json';
             }
             // TODO? behaviour in Pgsql should remain same but timestamp/datetime bug which is only reproduced in Mysql and Mariadb should be fixed
             if (stripos($type, 'datetime') === 0) {
-                return $isTypeWithArray ? 'timestamp[]' : 'timestamp';
+                return 'timestamp';
             }
         }
 
@@ -369,16 +365,54 @@ private function allowNull()
         return !$this->isRequired();
     }
 
-    private function isTypeWithArray(string $type): array
+    /**
+     * TODO docs + unit tests
+     * Value of `x-db-type` can be:
+     *    - `false` (boolean false)
+     *     - as string and its value can be like:
+     *         - text
+     *         - text[]
+     *         - INTEGER PRIMARY KEY AUTO_INCREMENT
+     *         - decimal(12,4)
+     *         - decimal(12)
+     *         - decimal
+     *         - json
+     *         - varchar
+     *         - VARCHAR
+     *
+     */
+    public function isTypeWithMoreInfo(string $type): array
     {
-        $modifiedType = $type;
-        $isDataTypeWithArray = false;
+        $justYiiAbstractType = $type;
+        $isTypeWithMoreInfo = false;
+
+        // 'text' => match `text`
+        // 'text[]' => match `text`
+        // 'INTEGER PRIMARY KEY AUTO_INCREMENT' => match `INTEGER`
+        // 'decimal(12,4)' => match `decimal`
+        // 'decimal(12)' => match `decimal`
+        preg_match('/(\w+)/', $type, $matches);
 
-        if (StringHelper::endsWith($type, '[]')) {
-            $isDataTypeWithArray = true;
-            $modifiedType = str_replace('[]', '', $type); // remove `[]` (array) e.g. 'text[]' -> 'text'
+        if (isset($matches[0])) {
+            $justYiiAbstractType = $matches[0];
+            $justYiiAbstractType = strtolower($justYiiAbstractType);
         }
-        return [$isDataTypeWithArray, $modifiedType];
+
+        // $isTypeWithMoreInfo = true for following:
+        // - text[]
+        // - INTEGER PRIMARY KEY AUTO_INCREMENT
+        // - decimal(12,4)
+        // - decimal(12)
+
+        // $isTypeWithMoreInfo = false for following:
+        // json
+        // text
+        // VARCHAR
+        if (strlen($justYiiAbstractType) < strlen($type)) {
+            $isTypeWithMoreInfo = true;
+        }
+
+        return [$isTypeWithMoreInfo, $justYiiAbstractType];
     }
 
     // TODO avoid duplication. also present in lib/ColumnToCode

tests/specs/petstore_x_db_type.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/petstore_x_db_type.yaml',
+    'generateUrls' => true,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => true,
+    'generateMigrations' => true,
+    'generateModelFaker' => true,
+];

tests/specs/petstore_x_db_type.yaml

@@ -0,0 +1,143 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            maximum: 100
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Checktypes:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+          format: int64
+        string_col:
+          type: string
+          x-db-type: string
+        varchar_col:
+          type: string
+          x-db-type: varchar
+        text_col:
+          type: string
+          x-db-type: text
+        varchar_4_col:
+          type: string
+          x-db-type: VARCHAR(4)
+        char_4_col:
+          type: string
+          x-db-type: CHAR(4)
+        # int_col:
+        #   type: integer
+        #   x-db-type: INT NULL DEFAULT NULL AFTER `Low_price`
+        decimal_col:
+          type: float
+          x-db-type: decimal(12,3)
+
+    Pets:
+      type: array
+      maxItems: 100
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string