Merge pull request #22 from CommanderBot-Dev/invite_descriptions

Added descriptions to `invite`

Author: lolgeny

commanderbot_ext/ext/invite/invite_cog.py

@@ -155,6 +155,15 @@ async def cmd_invites_modify_tags(
     ):
         await self.state[ctx.guild].modify_invite_tags(ctx, invite_key, tags)
 
+    @cmd_invites_modify.command(
+        name="description",
+        brief="Modify an invite's description"
+    )
+    async def cmd_invites_modify_description(
+        self, ctx: GuildContext, invite_key: str, *, description: str
+    ):
+        await self.state[ctx.guild].modify_invite_description(ctx, invite_key, description)
+
     # @@ invites configure
 
     @cmd_invites.group(

commanderbot_ext/ext/invite/invite_data.py

@@ -32,6 +32,7 @@ class InviteDataInviteEntry:
     hits: int
     link: str
     tags: Set[str]
+    description: str
 
     @staticmethod
     def deserialize(data: JsonObject, key: str) -> "InviteDataInviteEntry":
@@ -42,6 +43,7 @@ def deserialize(data: JsonObject, key: str) -> "InviteDataInviteEntry":
             hits=data["hits"],
             link=data["link"],
             tags=set(data["tags"]),
+            description=data["description"]
         )
 
     def serialize(self) -> JsonObject:
@@ -51,6 +53,7 @@ def serialize(self) -> JsonObject:
             "hits": self.hits,
             "link": self.link,
             "tags": list(self.tags),
+            "description": self.description
         }
 
     # @implements InviteEntry
@@ -142,6 +145,7 @@ def add_invite(self, invite_key: str, link: str) -> InviteDataInviteEntry:
             hits=0,
             link=link,
             tags=set(),
+            description=""
         )
         self.invite_entries[invite_key] = invite_entry
         # Return the newly-created invite entry.
@@ -159,29 +163,33 @@ def remove_invite(self, invite_key: str) -> InviteDataInviteEntry:
         raise NoSuchInvite(invite_key)
 
     def modify_invite_link(self, invite_key: str, link: str) -> InviteDataInviteEntry:
-        if invite_entry := self.require_invite_entry(invite_key):
-            invite_entry.update_modified_on()
-            invite_entry.link = link
-            return invite_entry
-        raise NoSuchInvite(invite_key)
-
+        invite_entry = self.require_invite_entry(invite_key):
+        invite_entry.update_modified_on()
+        invite_entry.link = link
+        return invite_entry
+        
     def modify_invite_tags(
         self, invite_key: str, tags: Tuple[str, ...]
     ) -> InviteDataInviteEntry:
-        if invite_entry := self.require_invite_entry(invite_key):
-            invite_entry.tags = set(tags)
-            return invite_entry
-        raise NoSuchInvite(invite_key)
-
+        invite_entry = self.require_invite_entry(invite_key):
+        invite_entry.tags = set(tags)
+        return invite_entry
+        
+    def modify_invite_description(
+        self, invite_key: str, description: str
+    ) -> InviteDataInviteEntry:
+        invite_entry = self.require_invite_entry(invite_key):
+        invite_entry.description = description
+        return invite_entry
+        
     def configure_guild_key(self, invite_key: Optional[str]) -> Optional[InviteEntry]:
         if not invite_key:
             self.guild_key = None
             return
-        if invite_entry := self.require_invite_entry(invite_key):
-            self.guild_key = invite_key
-            return invite_entry
-        raise NoSuchInvite(invite_key)
-
+        invite_entry = self.require_invite_entry(invite_key):
+        self.guild_key = invite_key
+        return invite_entry
+        
 
 def _guilds_defaultdict_factory() -> DefaultDict[GuildID, InviteDataGuild]:
     return defaultdict(lambda: InviteDataGuild())
@@ -266,6 +274,12 @@ async def modify_invite_tags(
     ) -> InviteEntry:
         return self.guilds[guild.id].modify_invite_tags(invite_key, tags)
 
+    # @implements InviteStore
+    async def modify_invite_description(
+        self, guild: Guild, invite_key: str, description: str
+    ) -> InviteEntry:
+        return self.guilds[guild.id].modify_invite_description(invite_key, description)
+
     # @implements InviteStore
     async def configure_guild_key(
         self, guild: Guild, invite_key: Optional[str]

commanderbot_ext/ext/invite/invite_guild_state.py

@@ -27,7 +27,7 @@ class InviteGuildState(CogGuildState):
 
     async def _show_invite_entry(self, ctx: GuildContext, invite_entry: InviteEntry):
         await self.store.increment_invite_hits(invite_entry)
-        await ctx.send(invite_entry.link)
+        await ctx.send(f"{invite_entry.description} - {invite_entry.link}")
 
     async def show_invite(self, ctx: GuildContext, invite_query: str):
         if invite_entries := await async_expand(
@@ -61,6 +61,7 @@ async def show_invite_details(self, ctx: GuildContext, invite_query: str):
                     "```",
                     f"Key:         {invite_entry.key}",
                     f"Tags:        {tags_str}",
+                    f"Description: {invite_entry.description}",
                     f"Added on:    {added_on_str}",
                     f"Modified on: {modified_on_str}",
                     f"Hits:        {invite_entry.hits}",
@@ -78,11 +79,11 @@ async def list_invites(self, ctx: GuildContext):
                 invite_entries, key=lambda invite_entry: invite_entry.key
             )
             count = len(sorted_invite_entries)
-            invite_keys = (invite_entry.key for invite_entry in sorted_invite_entries)
+            invites = (f"{invite_entry.key} - {invite_entry.description}" for invite_entry in sorted_invite_entries)
             text = (
-                f"There are {count} invites available: `"
-                + "` `".join(invite_keys)
-                + "`"
+                f"There are {count} invites available: ```"
+                + "` `".join(invites)
+                + "```"
             )
             await ctx.send(text)
         else:
@@ -148,6 +149,17 @@ async def modify_invite_tags(
         except InviteException as ex:
             await ex.respond(ctx)
 
+    async def modify_invite_description(
+        self, ctx: GuildContext, invite_key: str, description: str
+    ):
+        try:
+            invite_entry = await self.store.modify_invite_description(self.guild, invite_key, description)
+            await ctx.send(
+                f"Set description for invite `{invite_entry.key}` to `{description}`"
+            )
+        except InviteException as ex:
+            await ex.respond(ctx)
+
     async def configure_guild_key(self, ctx: GuildContext, invite_key: Optional[str]):
         try:
             if invite_entry := await self.store.configure_guild_key(

commanderbot_ext/ext/invite/invite_json_store.py

@@ -78,6 +78,14 @@ async def modify_invite_tags(
         await self.db.dirty()
         return invite_entry
 
+    async def modify_invite_description(
+        self, guild: Guild, invite_key: str, description: str
+    ) -> InviteEntry:
+        cache = await self.db.get_cache()
+        invite_entry = await cache.modify_invite_description(guild, invite_key, description)
+        await self.db.dirty()
+        return invite_entry
+
     # @implements InviteStore
     async def configure_guild_key(
         self, guild: Guild, invite_key: Optional[str]

commanderbot_ext/ext/invite/invite_store.py

@@ -29,6 +29,7 @@ class InviteEntry(Protocol):
     hits: int
     link: str
     tags: Set[str]
+    description: str
 
     @property
     def sorted_tags(self) -> List[str]:
@@ -73,6 +74,11 @@ async def modify_invite_tags(
     ) -> InviteEntry:
         ...
 
+    async def modify_invite_description(
+        self, guild: Guild, invite_key: str, description: str
+    ) -> InviteEntry:
+        ...
+
     async def configure_guild_key(
         self, guild: Guild, invite_key: Optional[str]
     ) -> Optional[InviteEntry]: