Merge pull request '1.2.0 release' (#2) from develop into main

Reviewed-on: Infendro/migration-ktor#2

.gitea/workflows/main.yaml

@@ -1,34 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-
-env:
-  GIT__TOKEN: ${{ secrets.TOKEN }}
-
-jobs:
-  publish:
-    runs-on: linux
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/cache/restore@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/
-
-      - uses: actions/setup-java@v4
-        with:
-          java-version: '24'
-          distribution: 'temurin'
-
-      - run: ./gradlew publish
-
-      - uses: actions/cache/save@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/

.gitea/workflows/publish.yaml

@@ -0,0 +1,30 @@
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  publish:
+    runs-on: linux
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: '24'
+          distribution: 'temurin'
+
+      - name: Cache Gradle
+        uses: actions/cache@v4
+        with:
+          key: gradle-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: gradle
+          path: |
+            ~/.gradle/caches/
+            ~/.gradle/wrapper/
+
+      - name: Publish
+        run: ./gradlew publish
+        env:
+          INFENDRO__TOKEN: ${{ secrets.TOKEN }}

README.md

@@ -0,0 +1,34 @@
+# migration-ktor
+
+`migration-ktor` is a Kotlin library that enables code-based migrations in Ktor.
+
+## Installation
+
+Add the following to your `build.gradle.kts`.
+
+```kotlin
+repositories {
+    maven("https://git.infendro.com/api/packages/Infendro/maven")
+}
+
+dependencies {
+    implementation("com.infendro:ktor-migration:1.2.0")
+}
+```
+
+## Usage
+
+```kotlin
+fun Application.configureDatabase() {
+    // connect to a database
+    Database.connect(/* parameters */)
+
+    // install the plugin
+    install(Migration) {
+        // create a migration
+        migration("initial") {
+            // execute code to migrate the database
+        }
+    }
+}
+```

build.gradle.kts

@@ -1,54 +1,37 @@
-group = "com.infendro"
-version = "1.0.0"
+import com.infendro.plugin.infendro
+import com.infendro.plugin.token
 
-repositories {
-    mavenCentral()
-}
+group = "com.infendro"
+version = "1.2.0"
 
 plugins {
+    alias(libs.plugins.infendro)
     alias(libs.plugins.kotlin)
     id("maven-publish")
 }
 
+repositories {
+    infendro()
+    mavenCentral()
+}
+
 dependencies {
     implementation(libs.ktor.server)
+    implementation(libs.migration)
     implementation(libs.exposed)
-    implementation(libs.exposed.dao)
+    implementation(libs.exposed.jdbc)
 }
 
 publishing {
     publications {
         create<MavenPublication>("JVM") {
             from(components["java"])
-            groupId = group as String
+            groupId = project.group as String
             artifactId = project.name
-            version = version
+            version = project.version as String
         }
     }
     repositories {
-        maven {
-            url = uri("https://git.infendro.com/api/packages/Infendro/maven")
-            authentication.create("header", HttpHeaderAuthentication::class)
-            credentials(HttpHeaderCredentials::class) {
-                val token = secret("git.token") ?: throw GradleException()
-
-                name = "Authorization"
-                value = "token $token"
-            }
-        }
+        infendro(token)
     }
 }
-
-fun secret(
-    key: String,
-): String? {
-    val property = key
-    val environment = key
-        .uppercase()
-        .replace(".", "__")
-
-    val prop = properties[property] as String?
-    val env = System.getenv(environment)
-
-    return prop ?: env
-}

gradle/libs.versions.toml

@@ -1,13 +1,16 @@
 [versions]
-kotlin = "2.2.10"
-ktor = "3.2.3"
-exposed = "0.60.0"
+infendro = "1.1.0"
+kotlin = "2.3.0"
+ktor = "3.4.0"
+migration = "1.2.0"
+exposed = "1.0.0"
 
 [plugins]
+infendro = { id = "com.infendro.plugin", version.ref = "infendro" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 
 [libraries]
 ktor-server = { module = "io.ktor:ktor-server-core-jvm", version.ref = "ktor" }
-
+migration = { module = "com.infendro:migration", version.ref = "migration" }
 exposed = { module = "org.jetbrains.exposed:exposed-core", version.ref = "exposed" }
-exposed-dao = { module = "org.jetbrains.exposed:exposed-dao", version.ref = "exposed" }
+exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "exposed" }

settings.gradle.kts

@@ -1 +1,6 @@
-rootProject.name = "ktor-migration"
+rootProject.name = "migration-ktor"
+
+pluginManagement.repositories {
+    maven("https://git.infendro.com/api/packages/Infendro/maven")
+    mavenCentral()
+}

src/main/kotlin/com/infendro/ktor/migration/Plugin.kt

@@ -0,0 +1,19 @@
+package com.infendro.ktor.migration
+
+import com.infendro.migration.migrate
+import io.ktor.server.application.*
+import org.jetbrains.exposed.v1.jdbc.JdbcTransaction
+
+val Migration = createApplicationPlugin("Migration", MigrationConfig::new) {
+    migrate(pluginConfig.config)
+}
+
+class MigrationConfig {
+    internal val config = com.infendro.migration.MigrationConfig()
+
+    fun migration(name: String, migrate: JdbcTransaction.() -> Unit) = config.migration(name, migrate)
+
+    companion object {
+        fun new() = MigrationConfig()
+    }
+}

src/main/kotlin/com/infendro/migration/Plugin.kt

@@ -1,55 +0,0 @@
-package com.infendro.migration
-
-import com.infendro.migration.model.MigrationRepository
-import com.infendro.migration.model.MigrationTable
-import io.ktor.server.application.*
-import org.jetbrains.exposed.sql.SchemaUtils
-import org.jetbrains.exposed.sql.Transaction
-import org.jetbrains.exposed.sql.transactions.transaction
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
-
-internal val logger: Logger = LoggerFactory.getLogger("Database")
-
-val Migration = createApplicationPlugin(
-    name = "Migration",
-    createConfiguration = { MigrationConfig() },
-) {
-    transaction {
-        SchemaUtils.create(MigrationTable)
-    }
-
-    val (migrations) = pluginConfig
-    for ((name, body) in migrations) {
-        if (MigrationRepository.exists(name))
-            continue
-
-        transaction {
-            try {
-                body()
-                logger.info("""Migration "$name" successful""")
-            } catch (e: Exception) {
-                logger.error("""Migration "$name" failed""")
-                throw e
-            }
-        }
-
-        MigrationRepository.insert(name)
-    }
-}
-
-data class MigrationConfig(
-    internal val migrations: MutableList<Migration> = mutableListOf()
-) {
-    fun migration(
-        name: String,
-        block: Transaction.() -> Unit,
-    ) {
-        migrations += Migration(name, block)
-    }
-
-    data class Migration(
-        val name: String,
-        val body: Transaction.() -> Unit
-    )
-}

src/main/kotlin/com/infendro/migration/model/Migration.kt

@@ -1,16 +0,0 @@
-package com.infendro.migration.model
-
-import org.jetbrains.exposed.dao.LongEntity
-import org.jetbrains.exposed.dao.LongEntityClass
-import org.jetbrains.exposed.dao.id.EntityID
-import org.jetbrains.exposed.dao.id.LongIdTable
-
-object MigrationTable : LongIdTable("migration", "id") {
-    val name = text("name")
-}
-
-class MigrationEntity(id: EntityID<Long>) : LongEntity(id) {
-    companion object : LongEntityClass<MigrationEntity>(MigrationTable)
-
-    var name by MigrationTable.name
-}

src/main/kotlin/com/infendro/migration/model/MigrationRepository.kt

@@ -1,22 +0,0 @@
-package com.infendro.migration.model
-
-import org.jetbrains.exposed.sql.transactions.transaction
-
-object MigrationRepository {
-    fun exists(
-        name: String,
-    ): Boolean = transaction {
-        MigrationEntity
-            .find { MigrationTable.name eq name }
-            .any()
-    }
-
-    fun insert(
-        name: String,
-    ): Unit = transaction {
-        MigrationEntity
-            .new {
-                this.name = name
-            }
-    }
-}