Merge pull request #29 from SOHELAHMED7/132-create-migration-for-drop-table-if-a-entire-schema-is-deleted-from-open-api-spec

Resolve - Create migration for drop table if a entire schema is deleted from OpenAPI spec

Author: SOHELAHMED7

README.md

@@ -309,6 +309,24 @@ Provide custom database table column name in case of relationship column. This w
               - x-fk-column-name: redelivery_of # this will create `redelivery_of` column instead of `redelivery_of_id`
 ```
 
+
+### `x-deleted-schemas`
+
+This is root level key used to generate "drop table" migration for the deleted component schema. If a component schema (DB model) is removed from OpenAPI spec then its following entities should be also deleted from the code:
+
+ - DB table (migrations)
+ - model
+ - faker
+
+So to generate appropriate migration for the removed schema, explicitly setting schema name or schema name + custom table name is required in this key. Only then the migrations will be generated. It should be set as:
+
+```yaml
+x-deleted-schemas:
+  - Fruit # Example: table name is evaluated to `itt_fruits`, if `itt_` is prefix set in DB config
+  - Mango: the_mango_table_name # custom table name; see `x-table` in README.md
+```
+
+
 ## Many-to-Many relation definition
 
 There are two ways for define many-to-many relations:

src/generator/ApiGenerator.php

@@ -7,9 +7,9 @@
 
 namespace cebe\yii2openapi\generator;
 
-use yii\db\mysql\Schema as MySqlSchema;
-use SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
-use yii\db\pgsql\Schema as PgSqlSchema;
+use cebe\openapi\exceptions\IOException;
+use cebe\openapi\exceptions\TypeErrorException;
+use cebe\openapi\exceptions\UnresolvableReferenceException;
 use cebe\openapi\Reader;
 use cebe\openapi\spec\OpenApi;
 use cebe\yii2openapi\lib\Config;
@@ -22,7 +22,10 @@
 use cebe\yii2openapi\lib\generators\UrlRulesGenerator;
 use cebe\yii2openapi\lib\PathAutoCompletion;
 use cebe\yii2openapi\lib\SchemaToDatabase;
+use Exception;
 use Yii;
+use yii\db\mysql\Schema as MySqlSchema;
+use yii\db\pgsql\Schema as PgSqlSchema;
 use yii\gii\CodeFile;
 use yii\gii\Generator;
 use yii\helpers\Html;
@@ -176,7 +179,7 @@ class ApiGenerator extends Generator
     private $_openApiWithoutRef;
 
     /**
-     * @var \cebe\yii2openapi\lib\Config $config
+     * @var Config $config
      **/
     private $config;
 
@@ -283,11 +286,11 @@ public function rules()
 
     /**
      * @param $attribute
-     * @throws \cebe\openapi\exceptions\IOException
-     * @throws \cebe\openapi\exceptions\TypeErrorException
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @throws IOException
+     * @throws TypeErrorException
+     * @throws UnresolvableReferenceException
      */
-    public function validateSpec($attribute):void
+    public function validateSpec($attribute): void
     {
         if ($this->ignoreSpecErrors) {
             return;
@@ -299,7 +302,7 @@ public function validateSpec($attribute):void
         }
     }
 
-    public function validateUrlPrefixes($attribute):void
+    public function validateUrlPrefixes($attribute): void
     {
         if (empty($this->urlPrefixes)) {
             return;
@@ -427,7 +430,7 @@ public function stickyAttributes()
         );
     }
 
-    public function makeConfig():Config
+    public function makeConfig(): Config
     {
         if (!$this->config) {
             $props = get_object_vars($this);
@@ -457,11 +460,12 @@ public function makeConfig():Config
      * Please refer to [[\yii\gii\generators\controller\Generator::generate()]] as an example
      * on how to implement this method.
      * @return CodeFile[] a list of code files to be created.
-     * @throws \Exception
+     * @throws Exception
      */
-    public function generate():array
+    public function generate(): array
     {
         $config = $this->makeConfig();
+
         $actionsGenerator = $this->useJsonApi
             ? Yii::createObject(JsonActionGenerator::class, [$config])
             : Yii::createObject(RestActionGenerator::class, [$config]);
@@ -489,12 +493,12 @@ public function generate():array
     }
 
     /**
-     * @return \cebe\openapi\spec\OpenApi
-     * @throws \cebe\openapi\exceptions\IOException
-     * @throws \cebe\openapi\exceptions\TypeErrorException
-     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     * @return OpenApi
+     * @throws IOException
+     * @throws TypeErrorException
+     * @throws UnresolvableReferenceException
      */
-    protected function getOpenApiWithoutReferences():OpenApi
+    protected function getOpenApiWithoutReferences(): OpenApi
     {
         if ($this->_openApiWithoutRef === null) {
             $file = Yii::getAlias($this->openApiPath);
@@ -507,17 +511,17 @@ protected function getOpenApiWithoutReferences():OpenApi
         return $this->_openApiWithoutRef;
     }
 
-    public static function isPostgres():bool
+    public static function isPostgres(): bool
     {
         return Yii::$app->db->schema instanceof PgSqlSchema;
     }
 
-    public static function isMysql():bool
+    public static function isMysql(): bool
     {
         return (Yii::$app->db->schema instanceof MySqlSchema && !static::isMariaDb());
     }
 
-    public static function isMariaDb():bool
+    public static function isMariaDb(): bool
     {
         return strpos(Yii::$app->db->schema->getServerVersion(), 'MariaDB') !== false;
     }