Refactor Player from generic class to inheritance hierarchy

packages/kol.js/src/Client.ts

@@ -13,7 +13,7 @@ import {
   isValidMessage,
   parseKmailMessage,
 } from "./utils/kmail.js";
-import { PlayerCache } from "./Cache.js";
+import { Players } from "./domains/Players.js";
 import { CookieJar } from "tough-cookie";
 import got, {
   type OptionsOfJSONResponseBody,
@@ -79,7 +79,7 @@ export class Client extends (EventEmitter as unknown as new () => TypedEmitter<E
       },
     ],
   });
-  players = new PlayerCache(this);
+  players = new Players(this);
 
   #username: string;
   #password: string;

packages/kol.js/src/Player.test.ts

@@ -17,104 +17,108 @@ vi.mock("./Client.js", async (importOriginal) => {
 
 const client = new Client("", "");
 
-describe("Player searching", () => {
-  test("Can search for a player by name", async () => {
-    vi.mocked(text).mockResolvedValueOnce(
-      await loadFixture(__dirname, "searchplayer_mad_carew.html"),
-    );
-
-    const player = await Player.fromName(client, "mad carew");
-
-    expectNotNull(player);
-
-    expect(player.id).toBe(263717);
-    // Learns correct capitalisation
-    expect(player.name).toBe("Mad Carew");
+describe("Player.parseSearch", () => {
+  test("Can parse a player search result", async () => {
+    const html = await loadFixture(__dirname, "searchplayer_mad_carew.html");
+    const result = Player.parseSearch(html);
+
+    expectNotNull(result);
+    expect(result.id).toBe(263717);
+    expect(result.name).toBe("Mad Carew");
   });
 
-  test("Can search for a player in Valhalla by name ", async () => {
-    vi.mocked(text).mockResolvedValueOnce(
-      await loadFixture(__dirname, "searchplayer_beldur.html"),
-    );
-
-    const player = await Player.fromName(client, "Beldur");
-
-    expectNotNull(player);
+  test("Can parse a player in Valhalla", async () => {
+    const html = await loadFixture(__dirname, "searchplayer_beldur.html");
+    const result = Player.parseSearch(html);
 
-    expect(player.id).toBe(1046951);
-    // Learns correct capitalisation
-    expect(player.name).toBe("Beldur");
-    expect(player.level).toBe(0);
-    // We display Astral Spirit even though the search page says Seal Clubber.
-    expect(player.kolClass).toBe("Astral Spirit");
+    expectNotNull(result);
+    expect(result.id).toBe(1046951);
+    expect(result.name).toBe("Beldur");
+    expect(result.level).toBe(0);
+    expect(result.kolClass).toBe("Astral Spirit");
   });
 });
 
-describe("Profile parsing", () => {
+describe("Player.Profiled.parseProfile", () => {
   test("Can parse a profile picture", async () => {
-    vi.mocked(text).mockResolvedValueOnce(
-      await loadFixture(__dirname, "showplayer_regular.html"),
-    );
-
-    const player = await new Player(
-      client,
-      2264486,
-      "SSBBHax",
-      1,
-      "Sauceror",
-    ).full();
+    const html = await loadFixture(__dirname, "showplayer_regular.html");
+    const result = await Player.Profiled.parseProfile(html);
 
-    expectNotNull(player);
-    expect(player.avatar).toContain("<svg");
+    expectNotNull(result);
+    expect(result.avatar).toContain("<svg");
   });
 
   test("Can parse a profile picture on dependence day", async () => {
-    vi.mocked(text).mockResolvedValueOnce(
-      await loadFixture(__dirname, "showplayer_dependence_day.html"),
+    const html = await loadFixture(
+      __dirname,
+      "showplayer_dependence_day.html",
     );
+    const result = await Player.Profiled.parseProfile(html);
 
-    const player = await new Player(
-      client,
-      3019702,
-      "Name Guy Man",
-      1,
-      "Sauceror",
-    ).full();
-
-    expectNotNull(player);
-    expect(player.avatar).toContain("<svg");
+    expectNotNull(result);
+    expect(result.avatar).toContain("<svg");
   });
 
   test("Can parse an avatar when the player has been painted gold", async () => {
-    vi.mocked(text).mockResolvedValueOnce(
-      await loadFixture(__dirname, "showplayer_golden_gun.html"),
-    );
+    const html = await loadFixture(__dirname, "showplayer_golden_gun.html");
+    const result = await Player.Profiled.parseProfile(html);
 
-    const player = await new Player(
-      client,
-      1197090,
-      "gAUSIE",
-      15,
-      "Sauceror",
-    ).full();
+    expectNotNull(result);
+    expect(result.avatar).toContain("<svg");
+  });
+});
 
-    expectNotNull(player);
-    expect(player.avatar).toContain("<svg");
+describe("Player class", () => {
+  test("toString returns formatted string", () => {
+    const player = new Player(client, 1197090, "gausie");
+    expect(player.toString()).toBe("gausie (#1197090)");
   });
 
-  test("Can resolve KoL images", () => {
-    expect(resolveKoLImage("/iii/otherimages/classav31_f.gif")).toBe(
-      "https://s3.amazonaws.com/images.kingdomofloathing.com/otherimages/classav31_f.gif",
-    );
-    expect(resolveKoLImage("/itemimages/oaf.gif")).toBe(
-      "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
-    );
-    expect(
-      resolveKoLImage(
-        "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
-      ),
-    ).toBe(
-      "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
-    );
+  test("matches by id", () => {
+    const player = new Player(client, 1197090, "gausie");
+    expect(player.matches(1197090)).toBe(true);
+    expect(player.matches(999)).toBe(false);
+  });
+
+  test("matches by name case-insensitively", () => {
+    const player = new Player(client, 1197090, "gausie");
+    expect(player.matches("gausie")).toBe(true);
+    expect(player.matches("GAUSIE")).toBe(true);
+    expect(player.matches("other")).toBe(false);
+  });
+
+  test("Profiled.fetch() returns itself", async () => {
+    const profiled = new Player.Profiled(client, {
+      id: 1,
+      name: "test",
+      level: 15,
+      kolClass: "Sauceror",
+      avatar: "test.gif",
+      ascensions: 100,
+      trophies: 5,
+      tattoos: 3,
+      favoriteFood: null,
+      favoriteBooze: null,
+      createdDate: new Date(),
+      lastLogin: new Date(),
+      hasDisplayCase: false,
+    });
+    expect(await profiled.fetch()).toBe(profiled);
   });
 });
+
+test("Can resolve KoL images", () => {
+  expect(resolveKoLImage("/iii/otherimages/classav31_f.gif")).toBe(
+    "https://s3.amazonaws.com/images.kingdomofloathing.com/otherimages/classav31_f.gif",
+  );
+  expect(resolveKoLImage("/itemimages/oaf.gif")).toBe(
+    "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
+  );
+  expect(
+    resolveKoLImage(
+      "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
+    ),
+  ).toBe(
+    "https://s3.amazonaws.com/images.kingdomofloathing.com/itemimages/oaf.gif",
+  );
+});