Make this feature optional - WIP - #61 (comment)

Author: SOHELAHMED7

src/lib/CustomSpecAttr.php

@@ -56,4 +56,8 @@ class CustomSpecAttr
      * Custom route (controller ID/action ID) instead of auto-generated. See README for usage docs. https://github.com/cebe/yii2-openapi/issues/144
      */
     public const ROUTE = 'x-route';
+
+
+    // TODO docs here + in README.md
+    public const DESC_IS_COMMENT = 'x-description-is-comment';
 }

src/lib/generators/MigrationsGenerator.php

@@ -142,7 +142,7 @@ protected function createBuilder(DbModel $model):BaseMigrationBuilder
         if ($this->db->getDriverName() === 'pgsql') {
             return Yii::createObject(PostgresMigrationBuilder::class, [$this->db, $model]);
         }
-        return Yii::createObject(MysqlMigrationBuilder::class, [$this->db, $model]);
+        return Yii::createObject(MysqlMigrationBuilder::class, [$this->db, $model, $this->config]);
     }
 
     /**

src/lib/migrations/BaseMigrationBuilder.php

@@ -9,6 +9,7 @@
 
 use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
+use cebe\yii2openapi\lib\Config;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\ManyToManyRelation;
 use cebe\yii2openapi\lib\items\MigrationModel;
@@ -53,19 +54,22 @@ abstract class BaseMigrationBuilder
      */
     protected $recordBuilder;
 
+    public ?Config $config = null;
+
     /**
      * MigrationBuilder constructor.
      * @param \yii\db\Connection                  $db
      * @param \cebe\yii2openapi\lib\items\DbModel $model
      * @throws \yii\base\InvalidConfigException
      * @throws \yii\base\NotSupportedException
      */
-    public function __construct(Connection $db, DbModel $model)
+    public function __construct(Connection $db, DbModel $model, ?Config $config = null)
     {
         $this->db = $db;
         $this->model = $model;
         $this->tableSchema = $db->getTableSchema($model->getTableAlias(), true);
         $this->recordBuilder = Yii::createObject(MigrationRecordBuilder::class, [$db->getSchema()]);
+        $this->config = $config;
     }
 
     /**

src/lib/migrations/MysqlMigrationBuilder.php

@@ -9,6 +9,7 @@
 
 use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
+use cebe\yii2openapi\lib\CustomSpecAttr;
 use cebe\yii2openapi\lib\items\DbIndex;
 use yii\base\NotSupportedException;
 use yii\db\ColumnSchema;
@@ -59,10 +60,14 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
         $this->modifyDesiredInContextOfCurrent($current, $desiredFromDb);
         $this->modifyDesiredFromDbInContextOfDesired($desired, $desiredFromDb);
 
-        foreach (['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
-                    , 'dbType', 'phpType'
-                     , 'precision', 'scale', 'unsigned', 'comment'
-        ] as $attr) {
+        $properties = ['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
+            , 'dbType', 'phpType'
+            , 'precision', 'scale', 'unsigned'#, 'comment'
+        ];
+        if (!empty($this->config->getOpenApi()->{CustomSpecAttr::DESC_IS_COMMENT})) {
+            $properties[] = 'comment';
+        }
+        foreach ($properties as $attr) {
             if ($attr === 'defaultValue') {
                 if ($this->isDefaultValueChanged($current, $desiredFromDb)) {
                     $changedAttributes[] = $attr;

tests/specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/index.yml

@@ -1,5 +1,5 @@
 openapi: 3.0.3
-
+x-description-is-comment: true
 info:
   title: 'Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60'
   version: 1.0.0