Merge pull request #4 from SOHELAHMED7/master

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

Author: cebe

README.md

@@ -319,6 +319,23 @@ 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
+```
+
 ### `x-no-relation`
 
 To differentiate a component schema property from one-to-many or many-to-many relation in favour of array(json) of
@@ -443,7 +460,7 @@ paths:
 Generated URL rules config for above is (in `urls.rest.php` or pertinent file):
 ```php
     'GET a1/b1' => 'abc/xyz',
-    'POST a1/b1' => 'abc/xyz',    
+    'POST a1/b1' => 'abc/xyz',
     'a1/b1' => 'abc/options',
 ```
 `x-route` does not support [Yii Modules](https://www.yiiframework.com/doc/guide/2.0/en/structure-modules).

composer.json

@@ -23,11 +23,11 @@
 		"yiisoft/yii2": "~2.0.48",
 		"yiisoft/yii2-gii": "~2.0.0 | ~2.1.0 | ~2.2.0| ~2.3.0",
 		"laminas/laminas-code": ">=3.4 <=4.13",
-		"php-openapi/yii2-fractal": "^1.0.0",
+		"php-openapi/yii2-fractal": "^1.4",
 		"fakerphp/faker": "^1.9",
 		"sam-it/yii2-mariadb": "^2.0",
 		"symfony/var-exporter": "^5.4",
-		"symfony/polyfill-php80": "^1.30"
+		"symfony/polyfill-php80": "^1.31"
 	},
 	"require-dev": {
 		"cebe/indent": "*",

src/generator/ApiGenerator.php

@@ -7,6 +7,9 @@
 
 namespace cebe\yii2openapi\generator;
 
+use cebe\openapi\exceptions\IOException;
+use cebe\openapi\exceptions\TypeErrorException;
+use cebe\openapi\exceptions\UnresolvableReferenceException;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\openapi\Reader;
 use cebe\openapi\spec\OpenApi;
@@ -22,6 +25,7 @@
 use cebe\yii2openapi\lib\items\RestAction;
 use cebe\yii2openapi\lib\PathAutoCompletion;
 use cebe\yii2openapi\lib\SchemaToDatabase;
+use Exception;
 use Yii;
 use yii\db\mysql\Schema as MySqlSchema;
 use SamIT\Yii2\MariaDb\Schema as MariaDbSchema;
@@ -190,7 +194,7 @@ class ApiGenerator extends Generator
     private $_openApiWithoutRef;
 
     /**
-     * @var \cebe\yii2openapi\lib\Config $config
+     * @var Config $config
      **/
     private $config;
 
@@ -297,11 +301,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;
@@ -313,7 +317,7 @@ public function validateSpec($attribute):void
         }
     }
 
-    public function validateUrlPrefixes($attribute):void
+    public function validateUrlPrefixes($attribute): void
     {
         if (empty($this->urlPrefixes)) {
             return;
@@ -441,7 +445,7 @@ public function stickyAttributes()
         );
     }
 
-    public function makeConfig():Config
+    public function makeConfig(): Config
     {
         if (!$this->config) {
             $props = get_object_vars($this);
@@ -471,11 +475,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]);
@@ -504,12 +509,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);
@@ -522,17 +527,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;
     }

src/lib/AttributeResolver.php

@@ -139,7 +139,8 @@ protected function resolveJunctionTableProperty(PropertySchema $property, bool $
                 ->asReference($junkAttribute['relatedClassName'])
                 ->setPhpType($junkAttribute['phpType'])
                 ->setDbType($junkAttribute['dbType'])
-                ->setForeignKeyColumnName($property->fkColName);
+                ->setForeignKeyColumnName($property->fkColName)
+                ->setTableName($this->componentSchema->resolveTableName($this->schemaName));
             $relation = Yii::createObject(AttributeRelation::class, [
                 $property->getName(),
                 $junkAttribute['relatedTableName'],
@@ -205,7 +206,7 @@ protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bo
      */
     protected function resolveProperty(
         PropertySchema $property,
-        bool $isRequired,
+        bool           $isRequired,
         $nullableValue = 'ARG_ABSENT'
     ): void {
         if ($nullableValue === 'ARG_ABSENT') {
@@ -227,7 +228,8 @@ protected function resolveProperty(
                   ->setNullable($nullableValue)
                   ->setIsPrimary($property->isPrimaryKey())
                   ->setForeignKeyColumnName($property->fkColName)
-                  ->setFakerStub($this->guessFakerStub($attribute, $property));
+                  ->setFakerStub($this->guessFakerStub($attribute, $property))
+                  ->setTableName($this->componentSchema->resolveTableName($this->schemaName));
         if ($property->isReference()) {
             if ($property->isVirtual()) {
                 throw new InvalidDefinitionException('References not supported for virtual attributes');
@@ -374,9 +376,9 @@ protected function resolveProperty(
      * @throws InvalidConfigException|InvalidDefinitionException
      */
     protected function catchManyToMany(
-        string $propertyName,
-        string $relatedSchemaName,
-        string $relatedTableName,
+        string          $propertyName,
+        string          $relatedSchemaName,
+        string          $relatedTableName,
         ComponentSchema $refSchema
     ): bool {
         if (strtolower(Inflector::id2camel($propertyName, '_'))

src/lib/ColumnToCode.php

@@ -399,8 +399,9 @@ private function getIsBuiltinType($type, $dbType)
     private function resolveEnumType():void
     {
         if (ApiGenerator::isPostgres()) {
-            $rawTableName = $this->dbSchema->getRawTableName($this->tableAlias);
-            $this->rawParts['type'] = '"enum_'.$rawTableName.'_' . $this->column->name.'"';
+            // $rawTableName = $this->dbSchema->getRawTableName($this->tableAlias);
+            // $this->rawParts['type'] = '"enum_'.$rawTableName.'_' . $this->column->name.'"';
+            $this->rawParts['type'] = '"'.$this->column->dbType.'"';
             return;
         }
         $this->rawParts['type'] = 'enum(' . self::mysqlEnumToString($this->column->enumValues) . ')';

src/lib/CustomSpecAttr.php

@@ -41,6 +41,12 @@ class CustomSpecAttr
      */
     public const FK_COLUMN_NAME = 'x-fk-column-name';
 
+    /**
+     * Drop table Migrations to be generated from removed component schemas
+     * See README for docs
+     */
+    public const DELETED_SCHEMAS = 'x-deleted-schemas';
+
     /**
      * Foreign key column name. See README for usage docs
      */