@vived/core 1.2.2 → 1.2.4

package/src/AppObject/AppObject.test.ts

@@ -1,158 +0,0 @@
-import { AppObject, makeAppObject } from "./AppObject";
-import { AppObjectComponent } from "./AppObjectComponent";
-import { makeAppObjectRepo } from "./AppObjectRepo";
-
-export function makeTestRig() {
-  const repo = makeAppObjectRepo();
-  const appObj = makeAppObject("obj id", repo);
-  const observer = jest.fn();
-  appObj.addObserver(observer);
-
-  return { repo, appObj, observer };
-}
-
-describe("App Object", () => {
-  it("Adds itself to the repo", () => {
-    const { repo, appObj } = makeTestRig();
-
-    expect(repo.has(appObj.id)).toEqual(true);
-  });
-
-  it("Removes itself from the repo when disposed", () => {
-    const { repo, appObj } = makeTestRig();
-
-    appObj.dispose();
-    expect(repo.has(appObj.id)).toEqual(false);
-  });
-
-  it("Checks to see it has a component", () => {
-    const { appObj } = makeTestRig();
-
-    expect(appObj.hasComponent(MockComponent.type)).toEqual(false);
-
-    new MockComponent(appObj);
-
-    expect(appObj.hasComponent(MockComponent.type)).toEqual(true);
-  });
-
-  it("Notifies when an component is added", () => {
-    const { appObj, observer } = makeTestRig();
-
-    new MockComponent(appObj);
-
-    expect(observer).toBeCalled();
-  });
-
-  it("Gets a component", () => {
-    const { appObj } = makeTestRig();
-
-    expect(appObj.getComponent(MockComponent.type)).toEqual(undefined);
-
-    const mockComponent = new MockComponent(appObj);
-
-    expect(appObj.getComponent(MockComponent.type)).toEqual(mockComponent);
-  });
-
-  it("Warns if a component is replaced", () => {
-    const { appObj } = makeTestRig();
-
-    console.warn = jest.fn();
-
-    const mockComponent = new MockComponent(appObj);
-    appObj.addComponent(mockComponent);
-    appObj.addComponent(new MockComponent(appObj));
-
-    expect(console.warn).toBeCalled();
-  });
-
-  it("Returns the component list", () => {
-    const { appObj } = makeTestRig();
-
-    expect(appObj.allComponents()).toEqual([]);
-
-    const mockComponent = new MockComponent(appObj);
-    appObj.addComponent(mockComponent);
-
-    const anotherMockComponent = new AnotherMockComponent(appObj);
-    appObj.addComponent(anotherMockComponent)
-
-    expect(appObj.allComponents()).toEqual([mockComponent, anotherMockComponent]);
-  });
-
-  it("Removes a component", () => {
-    const { appObj } = makeTestRig();
-    const comp = new MockComponent(appObj);
-    appObj.addComponent(comp)
-
-    expect(appObj.hasComponent(MockComponent.type)).toEqual(true);
-
-    appObj.removeComponent(MockComponent.type);
-
-    expect(appObj.hasComponent(MockComponent.type)).toEqual(false);
-  });
-
-  it("Notifies when an component is removed", () => {
-    const { appObj, observer } = makeTestRig();
-    const comp = new MockComponent(appObj);
-    appObj.addComponent(comp)
-    observer.mockClear();
-
-    appObj.removeComponent(MockComponent.type);
-    appObj.removeComponent(MockComponent.type);
-    appObj.removeComponent(MockComponent.type);
-
-    expect(observer).toHaveBeenCalledTimes(1);
-  });
-
-  it("Disposes all components when the App Object is disposed", () => {
-    const { appObj } = makeTestRig();
-
-    const comp = new MockComponent(appObj);
-    appObj.addComponent(comp)
-
-    const spy = jest.spyOn(comp, "dispose");
-
-    appObj.dispose();
-
-    expect(spy).toBeCalled();
-  });
-
-  it("Clears the component list when disposed", () => {
-    const { appObj } = makeTestRig();
-
-    const comp = new MockComponent(appObj);
-    appObj.addComponent(comp)
-
-    expect(appObj.allComponents()).toHaveLength(1);
-
-    appObj.dispose();
-
-    expect(appObj.allComponents()).toHaveLength(0);
-  });
-
-  it("If an entity is replace, it disposes the original", () => {
-    const { appObj } = makeTestRig();
-
-    const comp = new MockComponent(appObj);
-    appObj.addComponent(comp)
-
-    const spy = jest.spyOn(comp, "dispose");
-    appObj.addComponent(new MockComponent(appObj))
-
-    expect(spy).toBeCalled();
-  });
-});
-
-class MockComponent extends AppObjectComponent {
-  static readonly type: string = "mockComponent";
-  constructor(appObject: AppObject) {
-    super(appObject, MockComponent.type)
-  }
-}
-
-class AnotherMockComponent extends AppObjectComponent {
-  static readonly type: string = "mockComponent2";
-  constructor(appObject: AppObject) {
-    super(appObject, AnotherMockComponent.type)
-  }
-}

package/src/AppObject/AppObject.ts

@@ -1,83 +0,0 @@
-import { ObservableEntity } from "../Entities";
-import { AppObjectComponent } from "./AppObjectComponent";
-import { AppObjectRepo } from "./AppObjectRepo";
-
-export abstract class AppObject extends ObservableEntity {
-  abstract readonly id: string;
-  abstract readonly appObjectRepo: AppObjectRepo;
-
-  abstract hasComponent(type: string): boolean;
-  abstract addComponent(component: AppObjectComponent): void;
-  abstract getComponent<T extends AppObjectComponent>(type: string): T | undefined;
-  abstract removeComponent(type: string): void;
-  abstract allComponents(): AppObjectComponent[];
-
-  abstract dispose(): void;
-}
-
-export function makeAppObject(id: string, repo: AppObjectRepo): AppObject {
-  return new AppObjectImp(id, repo);
-}
-
-class AppObjectImp extends AppObject {
-  readonly id: string;
-  readonly appObjectRepo: AppObjectRepo;
-
-  private componentLookup = new Map<string, AppObjectComponent>();
-
-  hasComponent(type: string): boolean {
-    return this.componentLookup.has(type);
-  }
-
-  addComponent(component: AppObjectComponent): void {
-    const currentComponent = this.componentLookup.get(component.type);
-    if (currentComponent) {
-      console.warn(
-        `[AppObject] Component ${component.type} is being replaced on ${this.id}`
-      );
-      currentComponent.dispose();
-    }
-
-    this.componentLookup.set(component.type, component);
-    this.notify();
-  }
-
-  getComponent<T extends AppObjectComponent>(type: string): T | undefined {
-    if (this.componentLookup.has(type)) {
-      return this.componentLookup.get(type) as T;
-    } else {
-      return undefined;
-    }
-  }
-
-  removeComponent(type: string): void {
-    const component = this.componentLookup.get(type);
-
-    if (!component) return;
-
-    this.componentLookup.delete(type);
-    this.notify();
-  }
-
-  allComponents(): AppObjectComponent[] {
-    return Array.from(this.componentLookup.values());
-  }
-
-
-  dispose = (): void => {
-    const components = Array.from(this.componentLookup.values());
-    this.componentLookup.clear();
-    components.forEach(c => c.dispose());
-
-    if (this.appObjectRepo.has(this.id)) {
-      this.appObjectRepo.remove(this.id);
-    }
-  };
-
-  constructor(id: string, repo: AppObjectRepo) {
-    super();
-    this.id = id;
-    this.appObjectRepo = repo;
-    this.appObjectRepo.add(this);
-  }
-}

package/src/AppObject/AppObjectComponent.test.ts

@@ -1,219 +0,0 @@
-import { AppObject, makeAppObject } from "./AppObject";
-import { AppObjectComponent } from "./AppObjectComponent";
-import { makeAppObjectRepo } from "./AppObjectRepo";
-
-function makeTestRig() {
-  const appObjectRepo = makeAppObjectRepo();
-  const appObj = makeAppObject("appObj", appObjectRepo);
-  const appObjectComponent = new AppObjectComponent(appObj, "aComponent");
-
-  return { appObjectComponent, appObj, appObjectRepo };
-}
-
-describe("App Object Component", () => {
-  it("Sets the type", () => {
-    const { appObjectComponent } = makeTestRig();
-    expect(appObjectComponent.type).toEqual("aComponent");
-  });
-
-  it("Stores the app object", () => {
-    const { appObjectComponent, appObj } = makeTestRig();
-    expect(appObjectComponent.appObject).toEqual(appObj);
-  });
-
-  it("Adds itself to the app object", () => {
-    const { appObjectComponent, appObj } = makeTestRig();
-
-    expect(appObj.hasComponent(appObjectComponent.type)).toEqual(true);
-  });
-
-  it("Removes itself from the app object when disposed", () => {
-    const { appObjectComponent, appObj } = makeTestRig();
-
-    appObjectComponent.dispose();
-
-    expect(appObj.hasComponent(appObjectComponent.type)).toEqual(false);
-  });
-
-  it("Returns the repo", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    expect(appObjectComponent.appObjects).toEqual(appObjectRepo);
-  });
-
-  it("Forwards a warn to the App Object Repo warn", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.warn("Some warning");
-
-    expect(appObjectRepo.submitWarning).toBeCalledWith(
-      `appObj/aComponent`,
-      "Some warning"
-    );
-  });
-
-  it("Forwards a log to the App Object Repo log", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    appObjectRepo.submitLog = jest.fn();
-
-    appObjectComponent.log("Some log");
-
-    expect(appObjectRepo.submitLog).toBeCalledWith(
-      `appObj/aComponent`,
-      "Some log"
-    );
-  });
-
-  it("Forwards an error to the App Object Repo error", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    appObjectRepo.submitError = jest.fn();
-
-    appObjectComponent.error("Some error");
-
-    expect(appObjectRepo.submitError).toBeCalledWith(
-      `appObj/aComponent`,
-      "Some error"
-    );
-  });
-
-  it("Gets a singleton", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    const mockSingleton = new MockComponent(
-      appObjectRepo.getOrCreate("Some other")
-    );
-
-    const returned = appObjectComponent.getSingleton<MockComponent>(
-      MockComponent.type
-    );
-
-    expect(returned).toEqual(mockSingleton);
-  });
-
-  it("Warns by default if the singleton cannot be found", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    appObjectComponent.warn = jest.fn();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.getSingleton<MockComponent>(MockComponent.type);
-
-    expect(appObjectComponent.warn).toBeCalled();
-  });
-
-  it("Errors if the singleton cannot be found", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    appObjectComponent.error = jest.fn();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.getSingleton<MockComponent>(MockComponent.type, "ERROR");
-
-    expect(appObjectComponent.error).toBeCalled();
-  });
-
-  it("Logs if the singleton cannot be found", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    appObjectComponent.log = jest.fn();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.getSingleton<MockComponent>(MockComponent.type, "LOG");
-
-    expect(appObjectComponent.log).toBeCalled();
-  });
-
-  it("Warns if the singleton cannot be found", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    appObjectComponent.warn = jest.fn();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.getSingleton<MockComponent>(MockComponent.type, "WARN");
-
-    expect(appObjectComponent.warn).toBeCalled();
-  });
-
-  it("Gets a cached singleton", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-    const mockSingleton = new MockComponent(
-      appObjectRepo.getOrCreate("Some other")
-    );
-
-    const returned = appObjectComponent.getCachedSingleton<MockComponent>(
-      MockComponent.type
-    );
-
-    expect(returned).toEqual(mockSingleton);
-  });
-
-  it("Gets a cached singleton from the local cache", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    const spy = jest.spyOn(appObjectRepo, "getSingleton");
-
-    new MockComponent(appObjectRepo.getOrCreate("Some other"));
-
-    appObjectComponent.getCachedSingleton<MockComponent>(MockComponent.type);
-    appObjectComponent.getCachedSingleton<MockComponent>(MockComponent.type);
-    appObjectComponent.getCachedSingleton<MockComponent>(MockComponent.type);
-    appObjectComponent.getCachedSingleton<MockComponent>(MockComponent.type);
-
-    expect(spy).toBeCalledTimes(1);
-  });
-
-  it("Warns if the cached singleton cannot be found", () => {
-    const { appObjectComponent, appObjectRepo } = makeTestRig();
-
-    appObjectComponent.warn = jest.fn();
-    appObjectRepo.submitWarning = jest.fn();
-
-    appObjectComponent.getCachedSingleton<MockComponent>(MockComponent.type);
-
-    expect(appObjectComponent.warn).toBeCalled();
-  });
-
-  it("Gets a local component", () => {
-    const { appObjectComponent, appObjectRepo, appObj } = makeTestRig();
-
-    const b1 = new MockComponent(appObj);
-
-    new MockComponent(appObjectRepo.getOrCreate("otherAO"));
-
-    expect(
-      appObjectComponent.getCachedLocalComponent<MockComponent>(
-        MockComponent.type
-      )
-    ).toEqual(b1);
-  });
-
-  it("Caches the local component", () => {
-    const { appObjectComponent, appObj } = makeTestRig();
-
-    const spy = jest.spyOn(appObj, "getComponent");
-
-    new MockComponent(appObj);
-
-    appObjectComponent.getCachedLocalComponent<MockComponent>(
-      MockComponent.type
-    );
-    appObjectComponent.getCachedLocalComponent<MockComponent>(
-      MockComponent.type
-    );
-    appObjectComponent.getCachedLocalComponent<MockComponent>(
-      MockComponent.type
-    );
-    appObjectComponent.getCachedLocalComponent<MockComponent>(
-      MockComponent.type
-    );
-
-    expect(spy).toBeCalledTimes(1);
-  });
-});
-
-class MockComponent extends AppObjectComponent {
-  static type = "MockComponent";
-
-  constructor(appObject: AppObject) {
-    super(appObject, MockComponent.type);
-  }
-}

package/src/AppObject/AppObjectComponent.ts

@@ -1,100 +0,0 @@
-import { AppObject } from "./AppObject";
-import { AppObjectRepo } from "./AppObjectRepo";
-
-export enum AppObjectComponentType {
-  ENTITY = "Entity",
-  PM = "Presentation Manager",
-  UC = "Use Case",
-  CONTROLLER = "Controller",
-  VIEW = "View",
-  UNKNOWN = "Unknown",
-}
-
-export class AppObjectComponent {
-  readonly componentType: AppObjectComponentType = AppObjectComponentType.UNKNOWN;
-  readonly type: string;
-  readonly appObject: AppObject;
-  get appObjects(): AppObjectRepo {
-    return this.appObject.appObjectRepo;
-  }
-
-  private cachedComponents = new Map<string, AppObjectComponent>();
-  getCachedSingleton<T extends AppObjectComponent>(
-    type: string
-  ): T | undefined {
-    if (!this.cachedComponents.has(type)) {
-      const component = this.appObjects.getSingleton(type);
-      if (!component) {
-        this.warn("Unable to get cached singleton type " + type);
-      } else {
-        this.cachedComponents.set(type, component);
-      }
-    }
-
-    return this.cachedComponents.get(type) as T;
-  }
-
-  getCachedLocalComponent<T extends AppObjectComponent>(
-    type: string
-  ): T | undefined {
-    if (!this.cachedComponents.has(type)) {
-      const component = this.appObject.getComponent(type);
-
-      if (!component) {
-        this.warn("Unable to get local component of type " + type);
-      } else {
-        this.cachedComponents.set(type, component);
-      }
-    }
-
-    return this.cachedComponents.get(type) as T;
-  }
-
-  getSingleton<T extends AppObjectComponent>(
-    type: string,
-    logType: "LOG" | "WARN" | "ERROR" = "WARN"
-  ): T | undefined {
-    const comp = this.appObjects.getSingleton<T>(type);
-
-    if (!comp) {
-      const msg = "Unable to get singleton type " + type;
-      switch (logType) {
-        case "ERROR":
-          this.error(msg);
-          break;
-        case "LOG":
-          this.log(msg);
-          break;
-        case "WARN":
-          this.warn(msg);
-          break;
-      }
-    }
-
-    return comp;
-  }
-
-  dispose() {
-    if (this.appObject.getComponent(this.type) === this) {
-      this.appObject.removeComponent(this.type);
-    }
-  }
-
-  log(message: string) {
-    this.appObjects.submitLog(`${this.appObject.id}/${this.type}`, message);
-  }
-
-  warn(message: string) {
-    this.appObjects.submitWarning(`${this.appObject.id}/${this.type}`, message);
-  }
-
-  error(message: string) {
-    this.appObjects.submitError(`${this.appObject.id}/${this.type}`, message);
-  }
-
-  constructor(appObject: AppObject, type: string) {
-    this.appObject = appObject;
-    this.type = type;
-    appObject.addComponent(this);
-  }
-}

package/src/AppObject/AppObjectController.ts

@@ -1,8 +0,0 @@
-import {
-  AppObjectComponent,
-  AppObjectComponentType,
-} from "./AppObjectComponent";
-
-export class AppObjectController extends AppObjectComponent {
-  readonly componentType = AppObjectComponentType.CONTROLLER;
-}