chore: Add migration module and move generateMigrationScript functi…

…on to it

exposed-core/api/exposed-core.api

@@ -2026,8 +2026,6 @@ public final class org/jetbrains/exposed/sql/SchemaUtils {
 	public static synthetic fun dropSchema$default (Lorg/jetbrains/exposed/sql/SchemaUtils;[Lorg/jetbrains/exposed/sql/Schema;ZZILjava/lang/Object;)V
 	public final fun dropSequence ([Lorg/jetbrains/exposed/sql/Sequence;Z)V
 	public static synthetic fun dropSequence$default (Lorg/jetbrains/exposed/sql/SchemaUtils;[Lorg/jetbrains/exposed/sql/Sequence;ZILjava/lang/Object;)V
-	public final fun generateMigrationScript ([Lorg/jetbrains/exposed/sql/Table;Ljava/lang/String;Ljava/lang/String;Z)Ljava/io/File;
-	public static synthetic fun generateMigrationScript$default (Lorg/jetbrains/exposed/sql/SchemaUtils;[Lorg/jetbrains/exposed/sql/Table;Ljava/lang/String;Ljava/lang/String;ZILjava/lang/Object;)Ljava/io/File;
 	public final fun listDatabases ()Ljava/util/List;
 	public final fun listTables ()Ljava/util/List;
 	public final fun setSchema (Lorg/jetbrains/exposed/sql/Schema;Z)V

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/SchemaUtils.kt

@@ -4,7 +4,6 @@ import org.jetbrains.exposed.exceptions.ExposedSQLException
 import org.jetbrains.exposed.sql.SqlExpressionBuilder.asLiteral
 import org.jetbrains.exposed.sql.transactions.TransactionManager
 import org.jetbrains.exposed.sql.vendors.*
-import java.io.File
 import java.math.BigDecimal
 
 /** Utility functions that assist with creating, altering, and dropping database schema objects. */
@@ -849,44 +848,6 @@ object SchemaUtils {
         return toDrop.toList()
     }
 
-    /**
-     * @param tables The tables whose changes will be used to generate the migration script.
-     * @param scriptName The name to be used for the generated migration script.
-     * @param scriptDirectory The directory (path from repository root) in which to create the migration script.
-     * @param withLogs By default, a description for each intermediate step, as well as its execution time, is logged at
-     * the INFO level. This can be disabled by setting [withLogs] to `false`.
-     *
-     * @return The generated migration script.
-     *
-     * @throws IllegalArgumentException if no argument is passed for the [tables] parameter.
-     *
-     * This function simply generates the migration script without applying the migration. Its purpose is to show what
-     * the migration script will look like before applying the migration.
-     * If a migration script with the same name already exists, its content will be overwritten.
-     */
-    @ExperimentalDatabaseMigrationApi
-    fun generateMigrationScript(vararg tables: Table, scriptDirectory: String, scriptName: String, withLogs: Boolean = true): File {
-        require(tables.isNotEmpty()) { "Tables argument must not be empty" }
-
-        val allStatements = statementsRequiredForDatabaseMigration(*tables, withLogs = withLogs)
-
-        val migrationScript = File("$scriptDirectory/$scriptName.sql")
-        migrationScript.createNewFile()
-
-        // Clear existing content
-        migrationScript.writeText("")
-
-        // Append statements
-        allStatements.forEach { statement ->
-            // Add semicolon only if it's not already there
-            val conditionalSemicolon = if (statement.last() == ';') "" else ";"
-
-            migrationScript.appendText("$statement$conditionalSemicolon\n")
-        }
-
-        return migrationScript
-    }
-
     /**
      * Returns the SQL statements that need to be executed to make the existing database schema compatible with
      * the table objects defined using Exposed. Unlike [statementsRequiredToActualizeScheme], DROP/DELETE statements are

exposed-migration/api/exposed-migration.api

@@ -0,0 +1,6 @@
+public final class MigrationUtils {
+	public static final field INSTANCE LMigrationUtils;
+	public final fun generateMigrationScript ([Lorg/jetbrains/exposed/sql/Table;Ljava/lang/String;Ljava/lang/String;Z)Ljava/io/File;
+	public static synthetic fun generateMigrationScript$default (LMigrationUtils;[Lorg/jetbrains/exposed/sql/Table;Ljava/lang/String;Ljava/lang/String;ZILjava/lang/Object;)Ljava/io/File;
+}
+

exposed-migration/build.gradle.kts

@@ -0,0 +1,22 @@
+plugins {
+    id("java")
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    api(project(":exposed-core"))
+
+    testImplementation(platform("org.junit:junit-bom:5.10.0"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+kotlin {
+    jvmToolchain(8)
+}

exposed-migration/src/main/kotlin/MigrationUtils.kt

@@ -0,0 +1,44 @@
+import org.jetbrains.exposed.sql.ExperimentalDatabaseMigrationApi
+import org.jetbrains.exposed.sql.SchemaUtils.statementsRequiredForDatabaseMigration
+import org.jetbrains.exposed.sql.Table
+import java.io.File
+
+object MigrationUtils {
+    /**
+     * This function simply generates the migration script without applying the migration. Its purpose is to show what
+     * the migration script will look like before applying the migration. If a migration script with the same name
+     * already exists, its content will be overwritten.
+     *
+     * @param tables The tables whose changes will be used to generate the migration script.
+     * @param scriptName The name to be used for the generated migration script.
+     * @param scriptDirectory The directory (path from repository root) in which to create the migration script.
+     * @param withLogs By default, a description for each intermediate step, as well as its execution time, is logged at
+     * the INFO level. This can be disabled by setting [withLogs] to `false`.
+     *
+     * @return The generated migration script.
+     *
+     * @throws IllegalArgumentException if no argument is passed for the [tables] parameter.
+     */
+    @ExperimentalDatabaseMigrationApi
+    fun generateMigrationScript(vararg tables: Table, scriptDirectory: String, scriptName: String, withLogs: Boolean = true): File {
+        require(tables.isNotEmpty()) { "Tables argument must not be empty" }
+
+        val allStatements = statementsRequiredForDatabaseMigration(*tables, withLogs = withLogs)
+
+        val migrationScript = File("$scriptDirectory/$scriptName.sql")
+        migrationScript.createNewFile()
+
+        // Clear existing content
+        migrationScript.writeText("")
+
+        // Append statements
+        allStatements.forEach { statement ->
+            // Add semicolon only if it's not already there
+            val conditionalSemicolon = if (statement.last() == ';') "" else ";"
+
+            migrationScript.appendText("$statement$conditionalSemicolon\n")
+        }
+
+        return migrationScript
+    }
+}

exposed-tests/build.gradle.kts

@@ -23,6 +23,7 @@ dependencies {
     implementation(project(":exposed-jdbc"))
     implementation(project(":exposed-dao"))
     implementation(project(":exposed-kotlin-datetime"))
+    implementation(project(":exposed-migration"))
 
     implementation(libs.slf4j)
     implementation(libs.log4j.slf4j.impl)

exposed-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/ddl/DatabaseMigrationTests.kt

@@ -40,7 +40,7 @@ class DatabaseMigrationTests : DatabaseTestsBase() {
             try {
                 SchemaUtils.create(noPKTable)
 
-                val script = SchemaUtils.generateMigrationScript(singlePKTable, scriptDirectory = scriptDirectory, scriptName = scriptName)
+                val script = MigrationUtils.generateMigrationScript(singlePKTable, scriptDirectory = scriptDirectory, scriptName = scriptName)
                 assertTrue(script.exists())
                 assertEquals("src/test/resources/$scriptName.sql", script.path)
 
@@ -86,7 +86,7 @@ class DatabaseMigrationTests : DatabaseTestsBase() {
                 }
 
                 // Generate script with the same name of initial script
-                val newScript = SchemaUtils.generateMigrationScript(singlePKTable, scriptDirectory = directory, scriptName = name)
+                val newScript = MigrationUtils.generateMigrationScript(singlePKTable, scriptDirectory = directory, scriptName = name)
 
                 val expectedStatements: List<String> = SchemaUtils.statementsRequiredForDatabaseMigration(singlePKTable)
                 assertEquals(1, expectedStatements.size)
@@ -106,7 +106,7 @@ class DatabaseMigrationTests : DatabaseTestsBase() {
     fun testNoTablesPassedWhenGeneratingMigrationScript() {
         withDb {
             expectException<IllegalArgumentException> {
-                SchemaUtils.generateMigrationScript(scriptDirectory = "src/test/resources", scriptName = "V2__Test")
+                MigrationUtils.generateMigrationScript(scriptDirectory = "src/test/resources", scriptName = "V2__Test")
             }
         }
     }

settings.gradle.kts

@@ -12,6 +12,7 @@ include("exposed-bom")
 include("exposed-kotlin-datetime")
 include("exposed-crypt")
 include("exposed-json")
+include("exposed-migration")
 
 pluginManagement {
     repositories {