Use a constant to determine the collection name but do it better

HyacinthBots · Sep 5, 2023 · 86f09cd · 86f09cd
1 parent 472f1b2
commit 86f09cd
Show file tree

Hide file tree

Showing 46 changed files with 139 additions and 55 deletions.
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/Collection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/Collection.kt
@@ -0,0 +1,22 @@
+package org.hyacinthbots.lilybot.database
+
+/**
+ * This class stores the name of a collection, so it can be referenced easily, avoiding string duplication
+ *
+ * An example of how it should be used can be found below. The name property used in the get collection line comes from
+ * this class
+ * ```kt
+ * class MagicCollection : KordExKoinComponent {
+ * 	private val db: Database by inject()
+ *
+ * 	val collection = db.mainDatabase.getCollection<MagicCollectionData>(name)
+ *
+ * 	suspend fun get(): List<MagicCollectionData> = collection.find().toList()
+ *
+ * 	companion object : Collection("magicCollection")
+ * }
+ * ```
+ *
+ * @property name The name of the collection
+ */
+abstract class Collection(val name: String)
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/AutoThreadingCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/AutoThreadingCollection.kt
@@ -24,7 +24,7 @@ class AutoThreadingCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<AutoThreadingData>("autoThreadingData")
+	internal val collection = db.mainDatabase.getCollection<AutoThreadingData>(AutoThreadingData.name)
 
 	/**
 	 * Gets all auto threads for a given [inputGuildId].

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ConfigCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ConfigCollection.kt
@@ -23,7 +23,7 @@ class LoggingConfigCollection : KordExKoinComponent {
 	private val configDb: Database by inject()
 
 	@PublishedApi
-	internal val collection = configDb.configDatabase.getCollection<LoggingConfigData>("loggingConfigData")
+	internal val collection = configDb.configDatabase.getCollection<LoggingConfigData>(LoggingConfigData.name)
 
 	/**
 	 * Gets the logging config for the given guild using the [guildId][inputGuildId].
@@ -72,7 +72,7 @@ class ModerationConfigCollection : KordExKoinComponent {
 	private val configDb: Database by inject()
 
 	@PublishedApi
-	internal val collection = configDb.configDatabase.getCollection<ModerationConfigData>("moderationConfigData")
+	internal val collection = configDb.configDatabase.getCollection<ModerationConfigData>(ModerationConfigData.name)
 
 	/**
 	 * Gets the Moderation config for the given guild using the [guildId][inputGuildId].
@@ -121,7 +121,7 @@ class UtilityConfigCollection : KordExKoinComponent {
 	private val configDb: Database by inject()
 
 	@PublishedApi
-	internal val collection = configDb.configDatabase.getCollection<UtilityConfigData>("utilityConfigData")
+	internal val collection = configDb.configDatabase.getCollection<UtilityConfigData>(UtilityConfigData.name)
 
 	/**
 	 * Gets the Utility config for the given guild using the [guildId][inputGuildId].

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GalleryChannelCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GalleryChannelCollection.kt
@@ -23,7 +23,7 @@ class GalleryChannelCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<GalleryChannelData>("galleryChannelData")
+	internal val collection = db.mainDatabase.getCollection<GalleryChannelData>(GalleryChannelData.name)
 
 	/**
 	 * Collects every gallery channel in the database into a [List].

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GithubCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GithubCollection.kt
@@ -21,7 +21,7 @@ class GithubCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<GithubData>("githubData")
+	internal val collection = db.mainDatabase.getCollection<GithubData>(GithubData.name)
 
 	/**
 	 * Gets the default repo for GitHub commands.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GuildLeaveTimeCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/GuildLeaveTimeCollection.kt
@@ -20,7 +20,7 @@ class GuildLeaveTimeCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<GuildLeaveTimeData>("guildLeaveTimeData")
+	internal val collection = db.mainDatabase.getCollection<GuildLeaveTimeData>(GuildLeaveTimeData.name)
 
 	/**
 	 * Adds the time Lily bot left a guild with a config.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/MetaCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/MetaCollection.kt
@@ -21,7 +21,7 @@ class MainMetaCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<MainMetaData>("mainMetaData")
+	internal val collection = db.mainDatabase.getCollection<MainMetaData>(MainMetaData.name)
 
 	/**
 	 * Gets the main metadata from the database.
@@ -68,7 +68,7 @@ class ConfigMetaCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.configDatabase.getCollection<ConfigMetaData>("configMetaData")
+	internal val collection = db.configDatabase.getCollection<ConfigMetaData>(ConfigMetaData.name)
 
 	/**
 	 * Gets the config metadata from the database.

diff --git a/...n/kotlin/org/hyacinthbots/lilybot/database/collections/NewsChannelPublishingCollection.kt b/...n/kotlin/org/hyacinthbots/lilybot/database/collections/NewsChannelPublishingCollection.kt
@@ -25,7 +25,7 @@ class NewsChannelPublishingCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<NewsChannelPublishingData>("newsChannelPublishingData")
+	internal val collection = db.mainDatabase.getCollection<NewsChannelPublishingData>(NewsChannelPublishingData.name)
 
 	/**
 	 * Adds a channel for auto-publishing.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ReminderCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ReminderCollection.kt
@@ -30,7 +30,7 @@ class ReminderCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<ReminderData>("reminderData")
+	internal val collection = db.mainDatabase.getCollection<ReminderData>(ReminderData.name)
 
 	/**
 	 * Gets all the reminders currently in the database.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/RoleMenuCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/RoleMenuCollection.kt
@@ -22,7 +22,7 @@ class RoleMenuCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<RoleMenuData>("roleMenuData")
+	internal val collection = db.mainDatabase.getCollection<RoleMenuData>(RoleMenuData.name)
 
 	/**
 	 * Using the provided [inputMessageId] the associated [RoleMenuData] will be returned from the database.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/RoleSubscriptionCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/RoleSubscriptionCollection.kt
@@ -24,7 +24,7 @@ class RoleSubscriptionCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<RoleSubscriptionData>("roleSubscriptionData")
+	internal val collection = db.mainDatabase.getCollection<RoleSubscriptionData>(RoleSubscriptionData.name)
 
 	/**
 	 * Gets the roles that are subscribable for a given guild.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/StatusCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/StatusCollection.kt
@@ -19,7 +19,7 @@ class StatusCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<StatusData>("statusData")
+	internal val collection = db.mainDatabase.getCollection<StatusData>(StatusData.name)
 
 	/**
 	 * Gets Lily's status from the database.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/TagsCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/TagsCollection.kt
@@ -25,7 +25,7 @@ class TagsCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<TagsData>("tagsData")
+	internal val collection = db.mainDatabase.getCollection<TagsData>(TagsData.name)
 
 	/**
 	 * Gets the given tag using it's [name] and returns its [TagsData]. If the tag does not exist.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ThreadsCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ThreadsCollection.kt
@@ -25,7 +25,7 @@ class ThreadsCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<ThreadData>("threadsData")
+	internal val collection = db.mainDatabase.getCollection<ThreadData>(ThreadData.name)
 
 	/**
 	 * Using the provided [inputThreadId] the thread is returned.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/UptimeCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/UptimeCollection.kt
@@ -19,7 +19,7 @@ class UptimeCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<UptimeData>("uptimeData")
+	internal val collection = db.mainDatabase.getCollection<UptimeData>(UptimeData.name)
 
 	/**
 	 * Gets the uptime data from the database.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/WarnCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/WarnCollection.kt
@@ -22,7 +22,7 @@ class WarnCollection : KordExKoinComponent {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<WarnData>("warnData")
+	internal val collection = db.mainDatabase.getCollection<WarnData>(WarnData.name)
 
 	/**
 	 * Gets the number of points the provided [inputUserId] has in the provided [inputGuildId] from the database.

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/WelcomeChannelCollection.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/collections/WelcomeChannelCollection.kt
@@ -33,7 +33,7 @@ class WelcomeChannelCollection : KordExKoinComponent, CozyWelcomeChannelData {
 	private val db: Database by inject()
 
 	@PublishedApi
-	internal val collection = db.mainDatabase.getCollection<WelcomeChannelData>("welcomeChannelData")
+	internal val collection = db.mainDatabase.getCollection<WelcomeChannelData>(WelcomeChannelData.name)
 
 	override suspend fun getChannelURLs(): Map<Snowflake, String> =
 		collection.find()

diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/AutoThreadingData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/AutoThreadingData.kt
@@ -2,6 +2,7 @@ package org.hyacinthbots.lilybot.database.entities
 
 import dev.kord.common.entity.Snowflake
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for auto-threaded channels.
@@ -29,4 +30,6 @@ data class AutoThreadingData(
 	val mention: Boolean,
 	val creationMessage: String?,
 	val addModsAndRole: Boolean
-)
+) {
+	companion object : Collection("autoThreadingData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/Config.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/Config.kt
@@ -3,6 +3,7 @@ package org.hyacinthbots.lilybot.database.entities
 import dev.kord.common.entity.Snowflake
 import kotlinx.datetime.DateTimePeriod
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for moderation configuration. The logging config stores where logs are sent to, and whether to enable or
@@ -30,7 +31,9 @@ data class LoggingConfigData(
 	val enablePublicMemberLogs: Boolean,
 	val publicMemberLog: Snowflake?,
 	val publicMemberLogData: PublicMemberLogData?
-)
+) {
+	companion object : Collection("loggingConfigData")
+}
 
 /**
  * The data for moderation configuration. The moderation config is what stores the data for moderation actions. The
@@ -56,7 +59,9 @@ data class ModerationConfigData(
 	val autoPunishOnWarn: Boolean?,
 	val publicLogging: Boolean?,
 	val banDmMessage: String?,
-)
+) {
+	companion object : Collection("moderationConfigData")
+}
 
 /**
  * The data for miscellaneous configuration. The miscellaneous config stores the data for enabling or disabling log
@@ -70,4 +75,6 @@ data class ModerationConfigData(
 data class UtilityConfigData(
 	val guildId: Snowflake,
 	val utilityLogChannel: Snowflake?
-)
+) {
+	companion object : Collection("utilityConfigData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GalleryChannelData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GalleryChannelData.kt
@@ -2,6 +2,7 @@ package org.hyacinthbots.lilybot.database.entities
 
 import dev.kord.common.entity.Snowflake
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for image channels in a guild.
@@ -14,4 +15,6 @@ import kotlinx.serialization.Serializable
 data class GalleryChannelData(
 	val guildId: Snowflake,
 	val channelId: Snowflake
-)
+) {
+	companion object : Collection("galleryChannelData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GithubData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GithubData.kt
@@ -2,6 +2,7 @@ package org.hyacinthbots.lilybot.database.entities
 
 import dev.kord.common.entity.Snowflake
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for GitHub commands.
@@ -15,4 +16,6 @@ import kotlinx.serialization.Serializable
 data class GithubData(
 	val guildId: Snowflake,
 	val defaultRepo: String
-)
+) {
+	companion object : Collection("githubData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GuildLeaveTimeData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/GuildLeaveTimeData.kt
@@ -3,6 +3,7 @@ package org.hyacinthbots.lilybot.database.entities
 import dev.kord.common.entity.Snowflake
 import kotlinx.datetime.Instant
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for when Lily leaves a guild.
@@ -15,4 +16,6 @@ import kotlinx.serialization.Serializable
 data class GuildLeaveTimeData(
 	val guildId: Snowflake,
 	val guildLeaveTime: Instant
-)
+) {
+	companion object : Collection("guildLeaveTimeData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/MetaData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/MetaData.kt
@@ -1,6 +1,7 @@
 package org.hyacinthbots.lilybot.database.entities
 
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for the metadata of the main database.
@@ -14,7 +15,9 @@ import kotlinx.serialization.Serializable
 data class MainMetaData(
 	val version: Int,
 	val id: String = "mainMeta"
-)
+) {
+	companion object : Collection("mainMetaData")
+}
 
 /**
  * The data for the metadata of the config database.
@@ -28,4 +31,6 @@ data class MainMetaData(
 data class ConfigMetaData(
 	val version: Int,
 	val id: String = "configMeta"
-)
+) {
+	companion object : Collection("configMetaData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/NewsChannelPublishingData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/NewsChannelPublishingData.kt
@@ -2,6 +2,7 @@ package org.hyacinthbots.lilybot.database.entities
 
 import dev.kord.common.entity.Snowflake
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for the news channel publishing database.
@@ -15,4 +16,6 @@ import kotlinx.serialization.Serializable
 data class NewsChannelPublishingData(
 	val guildId: Snowflake,
 	val channelId: Snowflake
-)
+) {
+	companion object : Collection("newsChannelPublishingData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/PublicMemberLogData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/PublicMemberLogData.kt
@@ -1,6 +1,7 @@
 package org.hyacinthbots.lilybot.database.entities
 
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for public member logging.
@@ -14,4 +15,6 @@ data class PublicMemberLogData(
 	val pingNewUsers: Boolean,
 	val joinMessage: String?,
 	val leaveMessage: String?
-)
+) {
+	companion object : Collection("publicMemberLogData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/ReminderData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/ReminderData.kt
@@ -4,6 +4,7 @@ import dev.kord.common.entity.Snowflake
 import kotlinx.datetime.DateTimePeriod
 import kotlinx.datetime.Instant
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * THe data for reminders in a guild.
@@ -35,4 +36,6 @@ data class ReminderData(
 	val repeating: Boolean,
 	val repeatingInterval: DateTimePeriod?,
 	val id: Long
-)
+) {
+	companion object : Collection("reminderData")
+}
diff --git a/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/RoleMenuData.kt b/src/main/kotlin/org/hyacinthbots/lilybot/database/entities/RoleMenuData.kt
@@ -2,6 +2,7 @@ package org.hyacinthbots.lilybot.database.entities
 
 import dev.kord.common.entity.Snowflake
 import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.database.Collection
 
 /**
  * The data for role menus.
@@ -18,4 +19,6 @@ data class RoleMenuData(
 	val channelId: Snowflake,
 	val guildId: Snowflake,
 	val roles: MutableList<Snowflake>
-)
+) {
+	companion object : Collection("roleMenuData")
+}