From c44f16dd8f822f46e5ed6ec759bed3105b2ee8d2 Mon Sep 17 00:00:00 2001
From: Marc Di Luzio <marc.diluzio@gmail.com>
Date: Sat, 10 Aug 2024 10:45:44 +0100
Subject: [PATCH] Pull out the config and history classes

---
 config.py  | 33 +++++++++++++++++++++++++----
 history.py | 56 ++++++++++++++++++++++++++++++++++++++++++++++++
 matchy.py  | 62 ++++++++++--------------------------------------------
 3 files changed, 96 insertions(+), 55 deletions(-)
 create mode 100644 history.py

diff --git a/config.py b/config.py
index d9ffe28..99487df 100644
--- a/config.py
+++ b/config.py
@@ -1,9 +1,34 @@
 """Very simple config loading library"""
-import json
+from schema import Schema, And, Use
+import matching
 
 CONFIG = "config.json"
 
 
-def load() -> dict:
-    with open(CONFIG) as f:
-        return json.load(f)
+class Config():
+    def __init__(self, data: dict):
+        self.__dict__ = data
+
+    @property
+    def token(self) -> str:
+        return self.__dict__["token"]
+
+    @property
+    def owners(self) -> list[int]:
+        return self.__dict__["owners"]
+
+
+def load() -> Config:
+    """Load the config and validate it"""
+    config = matching.load(CONFIG)
+    Schema(
+        {
+            # Discord bot token
+            "token": And(Use(str)),
+
+            # ids of owners authorised to use owner-only commands
+            "owners": And(Use(list[int])),
+        }
+    ).validate(config)
+
+    return Config(config)
diff --git a/history.py b/history.py
new file mode 100644
index 0000000..3144ce3
--- /dev/null
+++ b/history.py
@@ -0,0 +1,56 @@
+"""Store matching history"""
+import os
+from schema import Schema, And, Use, Optional
+import matching
+
+FILE = "history.json"
+
+
+class History():
+    def __init__(self, data: dict):
+        self.__dict__ = data
+
+    @property
+    def groups(self) -> list[dict]:
+        return self.__dict__["groups"]
+
+    @property
+    def matchees(self) -> dict:
+        return self.__dict__["matchees"]
+
+    def save(self) -> None:
+        """Save out the history"""
+        matching.save(FILE, self.__dict__)
+
+
+def load() -> History:
+    """Load the history and validate it"""
+    history = matching.load(FILE) if os.path.isfile(FILE) else {
+        "groups": [],
+        "matchees": {}
+    }
+    Schema(
+        {
+            Optional("groups"): [
+                {
+                    "ts": And(Use(str)),
+                    "matchees": [
+                        And(Use(int))
+                    ]
+                }
+            ],
+            Optional("matchees"): {
+                Optional(str): {
+                    "matches": [
+                        {
+                            "ts": And(Use(str)),
+                            "id": And(Use(int)),
+                        }
+                    ]
+                }
+
+            }
+        }
+    ).validate(history)
+
+    return History(history)
diff --git a/matchy.py b/matchy.py
index 52e54d4..5412b78 100755
--- a/matchy.py
+++ b/matchy.py
@@ -2,56 +2,17 @@
     matchy.py - Discord bot that matches people into groups
 """
 import logging
-import os.path
 import time
 import discord
 from discord import app_commands
 from discord.ext import commands
-from schema import Schema, And, Use, Optional
 import matching
+import history
+import config
 
 
-CONFIG = "config.json"
-config = matching.load(CONFIG)
-Schema(
-    {
-        # Discord bot token
-        "token": And(Use(str)),
-
-        # ids of owners authorised to use owner-only commands
-        "owners": And(Use(list[int])),
-    }
-).validate(config)
-
-# History format:
-HISTORY = "history.json"
-history = matching.load(HISTORY) if os.path.isfile(HISTORY) else {
-    "groups": [],
-    "matchees": {}
-}
-Schema(
-    {
-        Optional("groups"): [
-            {
-                "ts": And(Use(str)),
-                "matchees": [
-                    And(Use(int))
-                ]
-            }
-        ],
-        Optional("matchees"): {
-            Optional(str): {
-                "matches": [
-                    {
-                        "ts": And(Use(str)),
-                        "id": And(Use(int)),
-                    }
-                ]
-            }
-
-        }
-    }
-).validate(history)
+Config = config.load()
+History = history.load()
 
 logger = logging.getLogger("matchy")
 logger.setLevel(logging.INFO)
@@ -73,7 +34,7 @@ async def on_ready():
 
 def owner_only(ctx: commands.Context) -> bool:
     """Checks the author is an owner"""
-    return ctx.message.author.id in config["owners"]
+    return ctx.message.author.id in Config.owners
 
 
 @bot.command()
@@ -83,7 +44,7 @@ async def sync(ctx: commands.Context):
     """Handle sync command"""
     msg = await ctx.reply("Reloading config...", ephemeral=True)
     global config
-    config = matching.load(CONFIG)
+    config = matching.load(Config)
     logger.info("Reloaded config")
 
     await msg.edit(content="Syncing commands...")
@@ -167,21 +128,20 @@ def save_groups_to_history(groups: list[list[discord.Member]]) -> None:
     ts = time.time()
     for group in groups:
         # Add the group
-        history["groups"].append({
+        History.groups.append({
             "ts": ts,
             "matchees": list(m.id for m in group)
         })
         # Add the matches to the matchee's daya
         for m in group:
-            matchee = history["matchees"].get(str(m.id), {"matches": []})
+            matchee = History.matchees.get(str(m.id), {"matches": []})
             for o in (o for o in group if o.id != m.id):
                 matchee["matches"].append({"ts": ts, "id": o.id})
-            history["matchees"][m.id] = matchee
+            History.matchees[m.id] = matchee
 
-    matching.save(HISTORY, history)
+    History.save()
 
 
 if __name__ == "__main__":
     handler = logging.StreamHandler()
-    bot.run(config["token"], log_handler=handler, root_logger=True)
-    matching.save(HISTORY, history)
+    bot.run(Config.token, log_handler=handler, root_logger=True)