Core user data and leaderboard commands.

Added flexibility to data `update_where`.
Added interactive utils, with improved pager.
Added user data table, with caching and transactional interface.
Added `topcoins` command to `Economy`
Added `top` command to `Study`

bot/modules/study/commands.py

@@ -0,0 +1,111 @@
+import datetime as dt
+
+from core import User
+from core.tables import users
+
+from utils import interactive  # noqa
+
+from .module import module
+
+
+first_emoji = "🥇"
+second_emoji = "🥈"
+third_emoji = "🥉"
+
+
+# TODO: in_guild ward
+@module.cmd(
+    "top",
+    short_help="View the Study Time leaderboard.",
+    aliases=('ttop', 'toptime')
+)
+async def cmd_top(ctx):
+    """
+    Usage``:
+        {prefix}top
+        {prefix}top 100
+    Description:
+        Display the study time leaderboard, or the top 100.
+
+        Use the paging reactions or send `p<n>` to switch pages (e.g. `p11` to switch to page 11).
+    """
+    # Handle args
+    if ctx.args and not ctx.args == "100":
+        return await ctx.error_reply(
+            "**Usage:**`{prefix}top` or `{prefix}top100`.".format(prefix=ctx.client.prefix)
+        )
+    top100 = ctx.args == "100"
+
+    # Flush any pending coin transactions
+    User.sync()
+
+    # Fetch the leaderboard
+    user_data = users.select_where(
+        select_columns=('userid', 'tracked_time'),
+        _extra="ORDER BY tracked_time DESC " + ("LIMIT 100" if top100 else "")
+    )
+
+    # Quit early if the leaderboard is empty
+    if not user_data:
+        return await ctx.reply("No leaderboard entries yet!")
+
+    # Extract entries
+    author_index = None
+    entries = []
+    for i, (userid, time) in enumerate(user_data):
+        member = ctx.guild.get_member(userid)
+        name = member.display_name if member else str(userid)
+        name = name.replace('*', ' ').replace('_', ' ')
+
+        num_str = "{}.".format(i+1)
+
+        hours = time // 3600
+        minutes = time // 60 % 60
+        seconds = time % 60
+
+        time_str = "{}:{:02}:{:02}".format(
+            hours,
+            minutes,
+            seconds
+        )
+
+        if ctx.author.id == userid:
+            author_index = i
+
+        entries.append((num_str, name, time_str))
+
+    # Extract blocks
+    blocks = [entries[i:i+20] for i in range(0, len(entries), 20)]
+    block_count = len(blocks)
+
+    # Build strings
+    header = "Study Time Top 100" if top100 else "Study Time Leaderboard"
+    if block_count > 1:
+        header += " (Page {{page}}/{})".format(block_count)
+
+    # Build pages
+    pages = []
+    for i, block in enumerate(blocks):
+        max_num_l, max_name_l, max_time_l = [max(len(e[i]) for e in block) for i in (0, 1, 2)]
+        body = '\n'.join(
+            "{:>{}} {:<{}} \t {:>{}} {} {}".format(
+                entry[0], max_num_l,
+                entry[1], max_name_l + 2,
+                entry[2], max_time_l + 1,
+                first_emoji if i == 0 and j == 0 else (
+                    second_emoji if i == 0 and j == 1 else (
+                        third_emoji if i == 0 and j == 2 else ''
+                    )
+                ),
+                "⮜" if author_index is not None and author_index == i * 20 + j else ""
+            )
+            for j, entry in enumerate(block)
+        )
+        title = header.format(page=i+1)
+        line = '='*len(title)
+        pages.append(
+            "```md\n{}\n{}\n{}```".format(title, line, body)
+        )
+
+    # Finally, page the results
+    await ctx.pager(pages, start_at=(author_index or 0)//20 if not top100 else 0)