Added component groups.

Author: serbanghita

src/ComponentRegistry.ts

@@ -1,5 +1,6 @@
 // create a singleton class
 import Component from "./Component.ts";
+import { addBit } from "@serbanghita-gamedev/bitmask";
 
 type ComponentConstructor<TProps extends NonNullable<object>, TComp extends Component<TProps>> = new (properties: TProps) => TComp;
 
@@ -8,6 +9,8 @@ export default class ComponentRegistry {
 
   private bitmask: bigint = 1n;
   private components: Map<string, typeof Component> = new Map();
+  private componentGroups: Map<string, { components: (typeof Component)[]; bitmask: bigint }> = new Map();
+  private componentToGroupMap: Map<bigint, string> = new Map();
 
   private constructor() {}
 
@@ -46,7 +49,28 @@ export default class ComponentRegistry {
     return component;
   }
 
+  public registerComponentGroup<T extends Array<ComponentConstructor<any, any>>>(groupName: string, components: [...T]) {
+    let groupBitmask = 0n;
+    for (const component of components) {
+      groupBitmask = addBit(groupBitmask, component.prototype.bitmask);
+      this.componentToGroupMap.set(component.prototype.bitmask, groupName);
+    }
+    this.componentGroups.set(groupName, { components, bitmask: groupBitmask });
+  }
+
+  public getComponentGroup(groupName: string): { components: (typeof Component)[]; bitmask: bigint } | undefined {
+    return this.componentGroups.get(groupName);
+  }
+
+  public getComponentGroupName(componentBitmask: bigint): string | undefined {
+    return this.componentToGroupMap.get(componentBitmask);
+  }
+
   public getLastBitmask() {
     return this.bitmask;
   }
+
+  public reset() {
+    ComponentRegistry.instance = new ComponentRegistry();
+  }
 }

src/tests/ComponentRegistry.test.ts

@@ -1,71 +1,117 @@
 import ComponentRegistry from "../ComponentRegistry.ts";
-import { Body, PositionOnScreen } from "../fixtures.ts";
+import { Body, Keyboard, PositionOnScreen } from "../fixtures.ts";
+import { afterAll, afterEach, describe } from "vitest";
 
 describe("ComponentRegistry", () => {
-  it("constructor", () => {
-    const reg = ComponentRegistry.getInstance();
-    expect(reg).toBeInstanceOf(ComponentRegistry);
+  afterEach(() => {
+    ComponentRegistry.getInstance().reset();
   });
 
-  it("registerComponent", () => {
-    const reg = ComponentRegistry.getInstance();
-    expect(reg).toBeInstanceOf(ComponentRegistry);
+  describe("components", () => {
+    it("constructor", () => {
+      const reg = ComponentRegistry.getInstance();
+      expect(reg).toBeInstanceOf(ComponentRegistry);
+    });
 
-    reg.registerComponent(Body);
-    reg.registerComponent(PositionOnScreen);
+    it("registerComponent", () => {
+      const reg = ComponentRegistry.getInstance();
+      expect(reg).toBeInstanceOf(ComponentRegistry);
 
-    expect(reg.getLastBitmask()).toBe(4n);
+      reg.registerComponent(Body);
+      reg.registerComponent(PositionOnScreen);
 
-    const body1 = new Body({ width: 10, height: 20 });
-    const body2 = new Body({ width: 30, height: 40 });
-    const body3 = new Body({ width: 50, height: 60 });
+      expect(reg.getLastBitmask()).toBe(4n);
 
-    const position1 = new PositionOnScreen({ x: 1, y: 2 });
-    const position2 = new PositionOnScreen({ x: 3, y: 4 });
-    const position3 = new PositionOnScreen({ x: 5, y: 6 });
+      const body1 = new Body({ width: 10, height: 20 });
+      const body2 = new Body({ width: 30, height: 40 });
+      const body3 = new Body({ width: 50, height: 60 });
 
-    expect(body1.bitmask).toBe(2n);
-    expect(body2.bitmask).toBe(2n);
-    expect(body3.bitmask).toBe(2n);
+      const position1 = new PositionOnScreen({ x: 1, y: 2 });
+      const position2 = new PositionOnScreen({ x: 3, y: 4 });
+      const position3 = new PositionOnScreen({ x: 5, y: 6 });
 
-    expect(position1.bitmask).toBe(4n);
-    expect(position2.bitmask).toBe(4n);
-    expect(position3.bitmask).toBe(4n);
+      expect(body1.bitmask).toBe(2n);
+      expect(body2.bitmask).toBe(2n);
+      expect(body3.bitmask).toBe(2n);
 
-    // Extra safety check that the properties of the class were successfully set.
-    expect(body1.properties.width).toBe(10);
-    expect(body1.properties.height).toBe(20);
+      expect(position1.bitmask).toBe(4n);
+      expect(position2.bitmask).toBe(4n);
+      expect(position3.bitmask).toBe(4n);
 
-    expect(body2.properties.width).toBe(30);
-    expect(body2.properties.height).toBe(40);
+      // Extra safety check that the properties of the class were successfully set.
+      expect(body1.properties.width).toBe(10);
+      expect(body1.properties.height).toBe(20);
 
-    expect(body3.properties.width).toBe(50);
-    expect(body3.properties.height).toBe(60);
+      expect(body2.properties.width).toBe(30);
+      expect(body2.properties.height).toBe(40);
 
-    expect(position1.properties.x).toBe(1);
-    expect(position1.properties.y).toBe(2);
+      expect(body3.properties.width).toBe(50);
+      expect(body3.properties.height).toBe(60);
 
-    expect(position2.properties.x).toBe(3);
-    expect(position2.properties.y).toBe(4);
+      expect(position1.properties.x).toBe(1);
+      expect(position1.properties.y).toBe(2);
 
-    expect(position3.properties.x).toBe(5);
-    expect(position3.properties.y).toBe(6);
-  });
+      expect(position2.properties.x).toBe(3);
+      expect(position2.properties.y).toBe(4);
 
-  it("registerComponents", () => {
-    const reg = ComponentRegistry.getInstance();
-    reg.registerComponents([Body, PositionOnScreen]);
+      expect(position3.properties.x).toBe(5);
+      expect(position3.properties.y).toBe(6);
+    });
 
-    expect(reg.getComponent("Body")).toBe(Body);
-    expect(reg.getComponent("PositionOnScreen")).toBe(PositionOnScreen);
-  });
+    it("registerComponents", () => {
+      const reg = ComponentRegistry.getInstance();
+      reg.registerComponents([Body, PositionOnScreen]);
+
+      expect(reg.getComponent("Body")).toBe(Body);
+      expect(reg.getComponent("PositionOnScreen")).toBe(PositionOnScreen);
+    });
 
-  it("getComponent", () => {
-    const reg = ComponentRegistry.getInstance();
-    reg.registerComponent(Body);
-    reg.registerComponent(PositionOnScreen);
+    it("getComponent", () => {
+      const reg = ComponentRegistry.getInstance();
+      reg.registerComponent(Body);
+      reg.registerComponent(PositionOnScreen);
+
+      expect(reg.getComponent("Body")).toBe(Body);
+      expect(reg.getComponent("PositionOnScreen")).toBe(PositionOnScreen);
+    });
+  });
 
-    expect(reg.getComponent("Body")).toBe(Body);
-    expect(reg.getComponent("PositionOnScreen")).toBe(PositionOnScreen);
+  describe("component groups", () => {
+    it("getComponentGroup", () => {
+      const reg = ComponentRegistry.getInstance();
+
+      reg.registerComponent(Body);
+      reg.registerComponent(PositionOnScreen);
+      reg.registerComponent(Keyboard);
+
+      reg.registerComponentGroup("group1", [Body, PositionOnScreen]);
+      reg.registerComponentGroup("group2", [Keyboard]);
+
+      expect(reg.getComponentGroup("group0")).toBeUndefined();
+      expect(reg.getComponentGroup("group1")).toEqual(
+        expect.objectContaining({
+          bitmask: 6n,
+          components: [Body, PositionOnScreen],
+        }),
+      );
+      expect(reg.getComponentGroup("group2")).toEqual(
+        expect.objectContaining({
+          bitmask: 8n,
+          components: [Keyboard],
+        }),
+      );
+    });
+
+    it("getComponentGroupName", () => {
+      const reg = ComponentRegistry.getInstance();
+
+      reg.registerComponent(Body);
+      reg.registerComponentGroup("group1", [Body]);
+
+      const a = reg.getComponentGroup("group1");
+
+      expect(reg.getComponentGroupName(1n)).toBeUndefined();
+      expect(reg.getComponentGroupName(2n)).toEqual("group1");
+    });
   });
 });