update dependencies

0.1.7

CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.1.8
+
+* `Versions`
+  * `tgbotapi`: `0.33.2` -> `0.33.3`
+  * `microutils`: `0.4.32` -> `0.4.33`
+
+## 0.1.7
+
+* `Versions`
+  * `exposed`: `0.29.1` -> `0.30.1`
+  * `tgbotapi`: `0.33.1` -> `0.33.2`
+  * `microutils`: `0.4.31` -> `0.4.32`
+* `PlaguBot`
+  * New class `PlaguBot` (😊)
+  * `initPlaguBot` is deprecated
+  * New shortcut for params - `plagubot`. `PlaguBot` class can be put inside other plagubot
+  for additional opportunities
+
+## 0.1.6
+
+* `Versions`
+  * `kotlin`: `1.4.31` -> `1.4.32`
+  * `tgbotapi`: `0.33.0` -> `0.33.1`
+  * `microutils`: `0.4.29` -> `0.4.31`
+
+## 0.1.5
+
+* `Versions`
+  * `kotlin`: `1.4.30` -> `1.4.31`
+  * `serialization`: `1.1.0-RC` -> `1.1.0`
+  * `coroutines`: `1.4.2` -> `1.4.3`
+  * `tgbotapi`: `0.32.8` -> `0.33.0`
+  * `microutils`: `0.4.26` -> `0.4.29`
+
+## 0.1.4
+
+* `Versions`
+  * `sdi`: `0.4.0-rc2` -> `0.4.1`
+  * `tgbotapi`: `0.32.7` -> `0.32.8`
+  * `microutils`: `0.4.25` -> `0.4.26`
+* `Bot`
+  * Fix of [#9](https://github.com/InsanusMokrassar/PlaguBot/issues/9)
+
 ## 0.1.3
 
 * `Versions`

bot/build.gradle

@@ -25,6 +25,8 @@ dependencies {
     kapt "com.github.matfax.klassindex:processor:$klassindex_version"
     api "org.xerial:sqlite-jdbc:$sqlite_version"
 
+    testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
+
     api project(":plagubot.plugin")
 }
 

bot/src/main/kotlin/dev/inmo/plagubot/App.kt

@@ -1,39 +1,21 @@
 package dev.inmo.plagubot
 
-import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
 import dev.inmo.plagubot.config.*
-import dev.inmo.plagubot.config.configSerialFormat
-import dev.inmo.tgbotapi.bot.Ktor.telegramBot
-import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
-import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
-import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.longPolling
-import dev.inmo.tgbotapi.types.botCommandsLimit
 import kotlinx.coroutines.*
 import kotlinx.serialization.InternalSerializationApi
 import java.io.File
 
+@Deprecated(
+    "This method is redundant due to new class PlaguBot",
+    ReplaceWith(
+        "PlaguBot(config).start(scope)",
+        "dev.inmo.plagubot.PlaguBot"
+    )
+)
 suspend inline fun initPlaguBot(
     config: Config,
     scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
-): Job {
-    val bot = telegramBot(config.botToken)
-
-    val paramsMap = config.params ?.toMap() ?: emptyMap()
-    val database = config.params ?.database ?: config.database.database
-    return bot.buildBehaviour(scope) {
-        val commands = config.plugins.flatMap {
-            it.apply { invoke(database, paramsMap) }
-            it.getCommands()
-        }.let {
-            val futureUnavailable = it.drop(botCommandsLimit.last)
-            if (futureUnavailable.isNotEmpty()) {
-                println("Next commands are out of range in setting command request and will be unavailable from autocompleting: ${futureUnavailable}")
-            }
-            it.take(botCommandsLimit.last)
-        }
-        safelyWithoutExceptions { setMyCommands(commands) }
-    }
-}
+): Job = PlaguBot(config).start(scope)
 
 /**
  * This method by default expects one argument in [args] field: path to config
@@ -42,8 +24,7 @@ suspend inline fun initPlaguBot(
 suspend fun main(args: Array<String>) {
     val (configPath) = args
     val file = File(configPath)
-    val config = configSerialFormat.decodeFromString(Config.serializer(), file.readText())
+    val config = configJsonFormat.decodeFromString(ConfigSerializer, file.readText())
 
-    val scope = CoroutineScope(Dispatchers.Default)
-    initPlaguBot(config, scope).join()
+    PlaguBot(config).start().join()
 }

bot/src/main/kotlin/dev/inmo/plagubot/PlaguBot.kt

@@ -0,0 +1,56 @@
+package dev.inmo.plagubot
+
+import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
+import dev.inmo.plagubot.config.Config
+import dev.inmo.plagubot.config.database
+import dev.inmo.tgbotapi.bot.Ktor.telegramBot
+import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
+import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
+import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
+import dev.inmo.tgbotapi.types.BotCommand
+import dev.inmo.tgbotapi.types.botCommandsLimit
+import kotlinx.coroutines.*
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
+import org.jetbrains.exposed.sql.Database
+
+const val DefaultPlaguBotParamsKey = "plagubot"
+val Map<String, Any>.plagubot
+    get() = get(DefaultPlaguBotParamsKey) as? PlaguBot
+
+@Serializable
+data class PlaguBot(
+    private val config: Config
+) : Plugin {
+    @Transient
+    private val bot = telegramBot(config.botToken)
+    @Transient
+    private val paramsMap = config.params ?.toMap() ?: emptyMap()
+    @Transient
+    private val database = config.params ?.database ?: config.database.database
+
+    override suspend fun getCommands(): List<BotCommand> = config.plugins.flatMap {
+        it.getCommands()
+    }
+
+    override suspend fun BehaviourContext.invoke(database: Database, params: Map<String, Any>) {
+        config.plugins.forEach {
+            it.apply { invoke(database, params) }
+        }
+        val commands = getCommands()
+        val futureUnavailable = commands.drop(botCommandsLimit.last)
+        if (futureUnavailable.isNotEmpty()) {
+            println("Next commands are out of range in setting command request and will be unavailable from autocompleting: $futureUnavailable")
+        }
+        safelyWithoutExceptions { setMyCommands(commands.take(botCommandsLimit.last)) }
+    }
+
+    /**
+     * This method will create an [Job] which will be the main [Job] of ran instance
+     */
+    suspend fun start(
+        scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
+    ): Job = bot.buildBehaviour(scope) {
+        invoke(database, paramsMap)
+    }
+}

bot/src/main/kotlin/dev/inmo/plagubot/config/Config.kt

@@ -2,9 +2,13 @@ package dev.inmo.plagubot.config
 
 import com.github.matfax.klassindex.KlassIndex
 import dev.inmo.plagubot.Plugin
-import dev.inmo.sdi.Module
+import dev.inmo.plagubot.PluginSerializer
+import dev.inmo.sdi.*
 import kotlinx.serialization.*
-import kotlinx.serialization.json.Json
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import kotlinx.serialization.json.*
 import kotlinx.serialization.modules.*
 import kotlin.reflect.KClass
 
@@ -12,7 +16,7 @@ import kotlin.reflect.KClass
 internal inline fun <T : Plugin> KClass<T>.includeIn(builder: PolymorphicModuleBuilder<Plugin>) = builder.subclass(this, serializer())
 
 @InternalSerializationApi
-internal val configSerialFormat: StringFormat
+internal val configJsonFormat: Json
     get() = Json {
         ignoreUnknownKeys = true
         serializersModule = SerializersModule {
@@ -37,8 +41,126 @@ internal val configSerialFormat: StringFormat
 
 @Serializable
 data class Config(
-    val plugins: List<Plugin>,
+    val plugins: List<@Contextual Plugin>,
     val database: DatabaseConfig = DatabaseConfig(),
     val botToken: String,
+    @Contextual
     val params: Module? = null
 )
+
+@Serializer(Plugin::class)
+private class InternalPluginSerializer(
+    private val params: Module
+) : KSerializer<Plugin> {
+    override val descriptor: SerialDescriptor = PluginSerializer.descriptor
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): Plugin {
+        val asJson = JsonElement.serializer().deserialize(decoder)
+
+        return if (asJson is JsonPrimitive) {
+            params[asJson.jsonPrimitive.content] as Plugin
+        } else {
+            val jsonFormat = ((decoder as? JsonDecoder)?.json ?: configJsonFormat)
+            jsonFormat.decodeFromJsonElement(PluginSerializer, asJson)
+        }
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: Plugin) {
+        params.keys.firstOrNull { params[it] === value } ?.also {
+            encoder.encodeString(it)
+        } ?: PluginSerializer.serialize(encoder, value)
+    }
+}
+
+private val DefaultModuleSerializer = ModuleSerializer(emptyList()) {
+
+}
+
+@Serializer(Module::class)
+private class InternalModuleSerializer(
+    private val original: JsonElement?,
+    private val params: Module
+) : KSerializer<Module> {
+    override val descriptor: SerialDescriptor = PluginSerializer.descriptor
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): Module {
+        val asJson = JsonElement.serializer().deserialize(decoder)
+
+        return if (asJson == original) {
+            params
+        } else {
+            configJsonFormat.decodeFromJsonElement(DefaultModuleSerializer, asJson)
+        }
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: Module) = DefaultModuleSerializer.serialize(encoder, value)
+}
+
+private fun internalPluginSerializerSerializersModule(
+    internalPluginSerializer: InternalPluginSerializer,
+    internalModuleSerializer: InternalModuleSerializer?
+) = SerializersModule {
+    contextual(internalPluginSerializer)
+    contextual(internalModuleSerializer ?: return@SerializersModule)
+}
+
+@Serializer(Config::class)
+internal object ConfigSerializer : KSerializer<Config> {
+    private val jsonSerializer = JsonObject.serializer()
+    private val moduleSerializer = ModuleSerializer()
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): Config {
+        val json = jsonSerializer.deserialize(decoder)
+        val jsonFormat = (decoder as? JsonDecoder) ?.json ?: configJsonFormat
+        val paramsRow = json["params"]
+
+        val resultJsonFormat = if (paramsRow != null && paramsRow != JsonNull) {
+            val params = jsonFormat.decodeFromJsonElement(
+                moduleSerializer,
+                paramsRow
+            )
+
+            val pluginsSerializer = InternalPluginSerializer(params)
+            val moduleSerializer = InternalModuleSerializer(paramsRow, params)
+            Json(jsonFormat) {
+                serializersModule = decoder.serializersModule.overwriteWith(
+                    internalPluginSerializerSerializersModule(pluginsSerializer, moduleSerializer)
+                )
+            }
+        } else {
+            jsonFormat
+        }
+        return resultJsonFormat.decodeFromJsonElement(
+            Config.serializer(),
+            json
+        )
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: Config) {
+        if (value.params != null) {
+            val pluginsSerializer = InternalPluginSerializer(value.params)
+
+            val jsonFormat = Json(configJsonFormat) {
+                serializersModule = encoder.serializersModule.overwriteWith(
+                    internalPluginSerializerSerializersModule(pluginsSerializer, null)
+                )
+            }
+
+            jsonSerializer.serialize(
+                encoder,
+                jsonFormat.encodeToJsonElement(
+                    Config.serializer(),
+                    value
+                ) as JsonObject
+            )
+        } else {
+            Config.serializer().serialize(encoder, value)
+        }
+    }
+}

bot/src/test/kotlin/dev/inmo/plagubot/config/ConfigTest.kt

@@ -0,0 +1,37 @@
+package dev.inmo.plagubot.config
+
+import dev.inmo.plagubot.HelloPlugin
+import kotlinx.serialization.InternalSerializationApi
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class ConfigTest {
+    @InternalSerializationApi
+    @Test
+    fun testThatPluginPassedToParamsWillBeCorrectlyUsedInPlugins() {
+        val rawConfig = """
+            {
+              "database": {
+              },
+              "botToken": "",
+              "plugins": [
+                "helloPlugin"
+              ],
+              "params": {
+                "helloPlugin": {"type": "dev.inmo.plagubot.HelloPlugin", "parameter": "Example"}
+              }
+            }
+        """.trimIndent()
+        val config = configJsonFormat.decodeFromString(ConfigSerializer, rawConfig)
+
+        assert(config.plugins.size == 1)
+        assert(config.plugins.first() is HelloPlugin)
+        assert((config.plugins.first() as HelloPlugin).parameter == "Example")
+
+        val redecoded = configJsonFormat.decodeFromString(ConfigSerializer, configJsonFormat.encodeToString(ConfigSerializer, config))
+        assertEquals(config.database, redecoded.database)
+        assertEquals(config.plugins, redecoded.plugins)
+        assertEquals(config.botToken, redecoded.botToken)
+        assertEquals(config.params ?.toMap(), redecoded.params ?.toMap())
+    }
+}

gradle.properties

@@ -4,14 +4,14 @@ org.gradle.parallel=true
 kotlin.js.generate.externals=true
 kotlin.incremental=true
 
-kotlin_version=1.4.30
-kotlin_coroutines_version=1.4.2
-kotlin_serialisation_runtime_version=1.1.0-RC
-kotlin_exposed_version=0.29.1
+kotlin_version=1.4.32
+kotlin_coroutines_version=1.4.3
+kotlin_serialisation_runtime_version=1.1.0
+kotlin_exposed_version=0.30.1
 
-sdi_version=0.4.0-rc2
-tgbotapi_version=0.32.7
-microutils_version=0.4.25
+sdi_version=0.4.1
+tgbotapi_version=0.33.3
+microutils_version=0.4.33
 klassindex_version=4.1.0-rc.1
 
 sqlite_version=3.30.1
@@ -19,4 +19,4 @@ sqlite_version=3.30.1
 github_release_plugin_version=2.2.12
 
 group=dev.inmo
-version=0.1.3
+version=0.1.8

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists