Merge pull request #13 from InsanusMokrassar/0.1.7

0.1.7

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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`

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

@@ -1,38 +1,21 @@
 package dev.inmo.plagubot
 
-import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
 import dev.inmo.plagubot.config.*
-import dev.inmo.plagubot.config.configJsonFormat
-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.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 {
+): Job = PlaguBot(config).start(scope)
-    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) }
-    }
-}
 
 /**
  * This method by default expects one argument in [args] field: path to config
@@ -43,6 +26,5 @@ suspend fun main(args: Array<String>) {
     val file = File(configPath)
     val config = configJsonFormat.decodeFromString(ConfigSerializer, file.readText())
 
-    val scope = CoroutineScope(Dispatchers.Default)
+    PlaguBot(config).start().join()
-    initPlaguBot(config, scope).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)
+    }
+}

gradle.properties

@@ -7,11 +7,11 @@ kotlin.incremental=true
 kotlin_version=1.4.32
 kotlin_coroutines_version=1.4.3
 kotlin_serialisation_runtime_version=1.1.0
-kotlin_exposed_version=0.29.1
+kotlin_exposed_version=0.30.1
 
 sdi_version=0.4.1
-tgbotapi_version=0.33.1
+tgbotapi_version=0.33.2
-microutils_version=0.4.31
+microutils_version=0.4.32
 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.6
+version=0.1.7