Merge branch 'v0.1.2'

Release v0.1.2 with a leaderboard command patch

Author: m1kql

README.md

@@ -129,6 +129,7 @@ Prefix: `=`
 | `=fetch` | Yes | `contest_name year [contest id, optional] problem_number` | Fetches a problem from the specified path |
 | `=last5` | Yes | `contest_name` | Returns the last 5 questions from a specified contest |
 | `=random` | No |  | Returns a random problem |
+| `=leaderboard` | Yes | `amount of users` | Shows the leaderboard for the server with a specified amount of users. If it is not given, the default is 10. |
 
 <u>Miscellaneous</u>
 <br>

bot/src/cogs/math/leaderboard.py

@@ -1,16 +1,16 @@
 import discord
 from discord.ext import commands
 from ..utility.db import (
-    get_user_db,
+    get_guild_db,
 )
 
 # leaderboard help
 leaderboard_help = {
     "name": "=leaderboard help info",
     "description_name": "Description",
-    "description": "View your server's leaderboard and see who has the most points. Retrieves the top 10 users.",
+    "description": "View your server's leaderboard and see who has the most points. Retrieves the top 10 users by default.",
     "usage_name": "Usage",
-    "usage_description": "`=leaderboard`",
+    "usage_description": "`=leaderboard <number of users>`",
     "alias_name": "Aliases",
     "alias_description": "`rank`, `lb`",
     "usage_syntax_name": "Usage syntax",
@@ -29,51 +29,56 @@ async def on_ready(self):
         print("Leaderboard cog has been loaded sucessfully")
 
     @commands.command(aliases=["rank", "lb"])
-    async def leaderboard(self, ctx):
+    async def leaderboard(self, ctx, top_users=None):
+
+        if top_users is None:
+            top_users = 10
+        else:
+            pass
 
         user_guild_id = ctx.guild.id
+        users = await get_guild_db(user_guild_id)
 
-        leaderboard = []
+        leaderboard_total = []
+        leaderboard = {}
 
-        for user in ctx.guild.members:
-            score = await get_user_db(user_guild_id, user.id)
-            points = score.get("total_weighted_points")
-            if points is None:
-                points = 0
-                leaderboard.append((user.name, points))
-            else:
-                leaderboard.append((user.name, points))
+        for user in users:
+            user_dict = user.to_dict()
+            user_name_id = user.id
+            total = user_dict.get("total_weighted_points")
+            if total is None or total == 0:
+                total = 0
+            leaderboard[total] = user_name_id
+            print(leaderboard[total])
+            leaderboard_total.append(total)
 
-        sorted_leaderboard = sorted(
-            leaderboard, key=lambda x: (x[1], x[1]), reverse=True
-        )
+        leaderboard_total = sorted(leaderboard_total, reverse=True)
+        print("LEADERBOARD USERS:" + str(leaderboard_total))
 
-        sorted_names = [i[0] for i in sorted_leaderboard]
-        sorted_scores = [i[1] for i in sorted_leaderboard]
-        sorted_amount = len([i[1] for i in sorted_leaderboard])
-
-        description_string = ""
-        if sorted_amount > 10:
-            for i in range(10):
-                description_string += (
-                    f"**{sorted_names[i]}** - `{sorted_scores[i]}` points\n"
-                )
-        elif sorted_amount <= 10:
-            for i in range(sorted_amount):
-                description_string += (
-                    f"**{sorted_names[i]}** - `{sorted_scores[i]}` points\n"
-                )
-
-        # embed
         leaderboard_embed = discord.Embed(
             title=f"Leaderboard for guild: `{ctx.guild.name}`",
+            description=f"Showing the top {top_users} users",
             color=0xA4D0DA,
-            description=description_string,
-        )
-        leaderboard_embed.set_footer(
-            text="Such scores are not indicative of a user's skill level or aptitude in mathematics or logical reasoning."
         )
-        leaderboard_embed.set_thumbnail(url=ctx.guild.icon_url)
+
+        index = 1
+
+        for score in leaderboard_total:
+            name_id = leaderboard[score]
+            print("USER ID:" + str(name_id))
+            user_object = await self.bot.fetch_user(name_id)
+            user_name = user_object.name
+            print(user_name)
+            if score == 0:
+                break
+            leaderboard_embed.add_field(
+                name=f"{index}. {user_name}", value=f"`{score}` points", inline=False
+            )
+            if index == top_users:
+                break
+            else:
+                index += 1
+
         await ctx.send(embed=leaderboard_embed)
 
 

bot/src/cogs/math/stats.py

@@ -2,7 +2,6 @@
 
 import discord
 from discord.ext import commands
-from firebase_admin import firestore
 
 from ..math.contest_problems import amc10_weight, amc12_weight
 from ..utility.db import (
@@ -72,7 +71,7 @@ def parse_user(raw_user):
         user_collection_ref = db.collection(str(user_guild_id)).document(str(user_id))
 
         user_collection_ref.update(
-            {total_weighted_points_string: firestore.Increment(total_weighted_points)}
+            {total_weighted_points_string: total_weighted_points}
         )
 
         user_object = self.bot.get_user(user_id)

bot/src/cogs/utility/db.py

@@ -131,3 +131,12 @@ async def get_user_db(guild_id, user_id):
             (db.collection(str(guild_id)).document(str(user_id))).get()
         ).to_dict()
         return new_user_db_dict
+
+
+async def get_guild_db(guild_id):
+    guild_collection = ""
+    try:
+        guild_collection = db.collection(str(guild_id)).get()
+        return guild_collection
+    except Exception:
+        pass

bot/src/main.py

@@ -1,6 +1,7 @@
 import os
 import discord
 from discord.ext import commands
+from discord.ext.commands.core import command
 from dotenv import load_dotenv
 
 intents = discord.Intents.default()
@@ -75,5 +76,13 @@ async def unloadcog(ctx, cogname=None):
 async def hello(ctx):
     await ctx.send("Hello, World!")
 
+@bot.command()
+@commands.is_owner()
+async def announcement(ctx, *, announcement_message):
+    for guild in bot.guilds:
+        for channel in guild.channels:
+            if isinstance(channel, discord.TextChannel):
+                await channel.send(announcement_message)
+                await ctx.send("It was successful.")
 
 bot.run(token)