@vived/core 1.2.2 → 1.2.3

package/src/AppObject/AppObjectRepo.test.ts

@@ -1,317 +0,0 @@
-import { AppObject, makeAppObject } from "./AppObject";
-import { AppObjectComponent } from "./AppObjectComponent";
-import { makeAppObjectRepo } from "./AppObjectRepo";
-
-function makeTestRig() {
-  const repo = makeAppObjectRepo();
-
-  const observer = jest.fn();
-  repo.addObserver(observer);
-
-  return { repo, observer };
-}
-
-describe("Observable appObject Repo", () => {
-  it("Allows an App Object to be added", () => {
-    const { repo } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    expect(repo.has(appObject.id)).toEqual(true);
-  });
-
-  it("Notifies when an appObject is added", () => {
-    const { repo, observer } = makeTestRig();
-    makeAppObject("appObj", repo);
-
-    expect(observer).toBeCalled();
-  });
-
-  it("Forwards notification from an added App Object", () => {
-    const { repo, observer } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    observer.mockClear();
-
-    appObject.notify();
-
-    expect(observer).toBeCalled();
-  });
-
-  it("Stops notifying if adding an App Object replaces and existing appObject", () => {
-    const { repo, observer } = makeTestRig();
-
-    const original = makeAppObject("appObj", repo);
-    makeAppObject("appObj", repo);
-    observer.mockClear();
-
-    original.notify();
-
-    expect(observer).not.toBeCalled();
-  });
-
-  it("Removes an App Object", () => {
-    const { repo } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    expect(repo.has(appObject.id)).toEqual(true);
-
-    repo.remove(appObject.id);
-
-    expect(repo.has(appObject.id)).toEqual(false);
-  });
-
-  it("Notifies if an App Object is removed", () => {
-    const { repo, observer } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-    observer.mockClear();
-
-    repo.remove(appObject.id);
-
-    expect(observer).toBeCalled();
-  });
-
-  it("Does not notify if the App Object to be removed cannot be found", () => {
-    const { repo, observer } = makeTestRig();
-
-    repo.remove("someId");
-
-    expect(observer).not.toBeCalled();
-  });
-
-  it("Stops observing a removed App Object", () => {
-    const { repo, observer } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    repo.remove(appObject.id);
-
-    observer.mockClear();
-
-    appObject.notify();
-
-    expect(observer).not.toBeCalled();
-  });
-
-  it("Gets an App Object", () => {
-    const { repo } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    expect(repo.get("appObj")).toEqual(appObject);
-  });
-
-  it("Gets all App Objects", () => {
-    const { repo } = makeTestRig();
-    const appObject = makeAppObject("appObj", repo);
-
-    expect(repo.getAll()).toEqual([appObject]);
-  });
-
-  it("Returns undefined for an unknown App Object", () => {
-    const { repo } = makeTestRig();
-
-    expect(repo.get("unknownID")).toBeUndefined();
-  });
-
-  it("Supports notifying an observer when an App Object is added", () => {
-    const { repo } = makeTestRig();
-
-    const addEntityObserver = jest.fn();
-    repo.addAppObjectAddedObserver(addEntityObserver);
-
-    const ent = makeAppObject("appObj", repo);
-
-    expect(addEntityObserver).toBeCalledWith(ent);
-  });
-
-  it("Add App Object observer can be removed", () => {
-    const { repo } = makeTestRig();
-
-    const addEntityObserver = jest.fn();
-    repo.addAppObjectAddedObserver(addEntityObserver);
-    repo.removeAppObjectAddedObserver(addEntityObserver);
-
-    makeAppObject("appObj", repo);
-
-    expect(addEntityObserver).not.toBeCalled();
-  });
-
-  it("Supports notifying an observer when an App Object is removed", () => {
-    const { repo } = makeTestRig();
-
-    const removeEntityObserver = jest.fn();
-    repo.addAppObjectRemovedObserver(removeEntityObserver);
-
-    const ent = makeAppObject("appObj", repo);
-
-    repo.remove("appObj");
-
-    expect(removeEntityObserver).toBeCalledWith(ent);
-  });
-
-  it("Remove App Object observer can be removed", () => {
-    const { repo } = makeTestRig();
-
-    const removeEntityObserver = jest.fn();
-    repo.addAppObjectRemovedObserver(removeEntityObserver);
-    repo.removedAppObjectRemovedObserver(removeEntityObserver);
-
-    makeAppObject("appObj", repo);
-    repo.remove("appObj");
-
-    expect(removeEntityObserver).not.toBeCalled();
-  });
-
-  it("Creats a new App Object when getOrCreate is called but the AO does not exist", () => {
-    const { repo } = makeTestRig();
-
-    expect(repo.has("ao1")).toEqual(false);
-
-    const ao = repo.getOrCreate("ao1");
-
-    expect(ao.id).toEqual("ao1");
-    expect(repo.has("ao1")).toEqual(true);
-  });
-
-  it("Gets the existing App Object when getOrCreate is called and the AO exists", () => {
-    const { repo } = makeTestRig();
-
-    const appObject = makeAppObject("appObj", repo);
-    const ao = repo.getOrCreate("appObj");
-
-    expect(ao).toEqual(appObject);
-  });
-
-  it("Get all App Objects with component type", () => {
-    const { repo } = makeTestRig();
-
-    expect(repo.getAllAppObjectsWithComponent(MockComponent.type)).toEqual([]);
-
-    makeAppObject("appObj1", repo);
-    const appObj2 = makeAppObject("appObj2", repo);
-    const appObj3 = makeAppObject("appObj3", repo);
-
-    new MockComponent(appObj2);
-    new MockComponent(appObj3);
-
-    expect(repo.getAllAppObjectsWithComponent(MockComponent.type)).toEqual([
-      appObj2,
-      appObj3,
-    ]);
-  });
-
-  it("Get a component on an object", () => {
-    const { repo } = makeTestRig();
-
-    const appObj = repo.getOrCreate("appObj");
-
-    const comp = new MockComponent(appObj);
-
-    expect(repo.getAppObjectComponent("appObj", MockComponent.type)).toEqual(
-      comp
-    );
-  });
-
-  it("Returns undefined if the App Object does not have an entity when calling get entity on object", () => {
-    const { repo } = makeTestRig();
-
-    repo.getOrCreate("appObj");
-
-    expect(repo.getAppObjectComponent("appObj", MockComponent.type)).toEqual(
-      undefined
-    );
-  });
-
-  it("Returns undefined if the App Object does not exist when calling get entity on object", () => {
-    const { repo } = makeTestRig();
-    expect(repo.getAppObjectComponent("appObj", MockComponent.type)).toEqual(
-      undefined
-    );
-  });
-
-  it("Get all Components", () => {
-    const { repo } = makeTestRig();
-
-    expect(repo.getAllComponents<MockComponent>(MockComponent.type)).toEqual(
-      []
-    );
-
-    const appObj1 = makeAppObject("appObj2", repo);
-    const comp1 = new MockComponent(appObj1);
-
-    const appObj2 = makeAppObject("appObj3", repo);
-    const comp2 = new MockComponent(appObj2);
-
-    expect(repo.getAllComponents<MockComponent>(MockComponent.type)).toEqual([
-      comp1,
-      comp2,
-    ]);
-  });
-
-  it("Registers a singleton", () => {
-    const { repo } = makeTestRig();
-    const appObj1 = makeAppObject("appObj2", repo);
-    const comp1 = new MockComponent(appObj1);
-
-    repo.registerSingleton(comp1);
-
-    expect(repo.getSingleton(MockComponent.type)).toEqual(comp1);
-  });
-
-  it("Warns and replaces if multiple singleton are registered", () => {
-    const { repo } = makeTestRig();
-    const appObj1 = makeAppObject("appObj1", repo);
-    const comp1 = new MockComponent(appObj1);
-
-    repo.registerSingleton(comp1);
-
-    const appObj2 = makeAppObject("appObj2", repo);
-    const comp2 = new MockComponent(appObj2);
-
-    repo.submitWarning = jest.fn();
-
-    repo.registerSingleton(comp2);
-    expect(repo.getSingleton(MockComponent.type)).toEqual(comp2);
-    expect(repo.submitWarning).toBeCalled();
-  });
-
-  it("Searches for a singleton that has not been registered", () => {
-    const { repo } = makeTestRig();
-    const appObj1 = makeAppObject("appObj2", repo);
-    const comp1 = new MockComponent(appObj1);
-
-    repo.registerSingleton(comp1);
-
-    expect(repo.getSingleton(MockComponent.type)).toEqual(comp1);
-  });
-
-  it("Warns if it cannot find a singleton", () => {
-    const { repo } = makeTestRig();
-
-    repo.submitWarning = jest.fn();
-
-    repo.getSingleton(MockComponent.type);
-
-    expect(repo.submitWarning).toBeCalled();
-  });
-
-  
-  it("Warns if it finds multiple singletons and returns the first one", () => {
-    const { repo } = makeTestRig();
-    const appObj1 = makeAppObject("appObj1", repo);
-    const comp1 = new MockComponent(appObj1);
-    
-    const appObj2 = makeAppObject("appObj2", repo);
-    new MockComponent(appObj2);
-
-    repo.submitWarning = jest.fn();
-
-    expect(repo.getSingleton(MockComponent.type)).toEqual(comp1);
-    expect(repo.submitWarning).toBeCalled();
-  });
-});
-
-class MockComponent extends AppObjectComponent {
-  static readonly type: string = "mockComponent";
-  constructor(appObject: AppObject) {
-    super(appObject, MockComponent.type);
-  }
-}

package/src/AppObject/AppObjectRepo.ts

@@ -1,203 +0,0 @@
-import { ObservableEntity, ObserverList } from "../Entities";
-import { AppObject, makeAppObject } from "./AppObject";
-import { AppObjectComponent } from "./AppObjectComponent";
-
-export abstract class AppObjectRepo extends ObservableEntity {
-  abstract has(appObjectID: string): boolean;
-  abstract add(appObject: AppObject): void;
-  abstract remove(appObjectID: string): void;
-  abstract get(appObjectID: string): AppObject | undefined;
-  abstract getOrCreate(appObjectID: string): AppObject;
-  abstract getAll(): AppObject[];
-
-  abstract submitLog(sender: string, message: string): void;
-  abstract submitWarning(sender: string, message: string): void;
-  abstract submitError(sender: string, message: string): void;
-  abstract submitFatal(sender: string, message: string): void;
-
-  abstract registerSingleton(component: AppObjectComponent): void;
-  abstract getSingleton<T extends AppObjectComponent>(
-    type: string
-  ): T | undefined;
-
-  abstract getAppObjectComponent<T extends AppObjectComponent>(
-    appObjectID: string,
-    type: string
-  ): T | undefined;
-  abstract getAllAppObjectsWithComponent(componentType: string): AppObject[];
-  abstract getAllComponents<T extends AppObjectComponent>(type: string): T[];
-
-  abstract addAppObjectAddedObserver: (
-    observer: (addedEntity: AppObject) => void
-  ) => void;
-  abstract removeAppObjectAddedObserver: (
-    observer: (addedEntity: AppObject) => void
-  ) => void;
-
-  abstract addAppObjectRemovedObserver: (
-    observer: (addedEntity: AppObject) => void
-  ) => void;
-  abstract removedAppObjectRemovedObserver: (
-    observer: (addedEntity: AppObject) => void
-  ) => void;
-}
-
-export function makeAppObjectRepo(): AppObjectRepo {
-  return new AppObjectRepoImp();
-}
-
-class AppObjectRepoImp extends AppObjectRepo {
-  private appObjectLookup = new Map<string, AppObject>();
-  private singletons = new Map<string, AppObjectComponent>();
-
-  private onAppObjectAddedObserver = new ObserverList<AppObject>();
-  addAppObjectAddedObserver = (observer: (addedEntity: AppObject) => void) => {
-    this.onAppObjectAddedObserver.add(observer);
-  };
-  removeAppObjectAddedObserver = (
-    observer: (addedEntity: AppObject) => void
-  ): void => {
-    this.onAppObjectAddedObserver.remove(observer);
-  };
-
-  private onAppObjectRemovedObservers = new ObserverList<AppObject>();
-  addAppObjectRemovedObserver = (
-    observer: (removedEntity: AppObject) => void
-  ) => {
-    this.onAppObjectRemovedObservers.add(observer);
-  };
-  removedAppObjectRemovedObserver = (
-    observer: (removedEntity: AppObject) => void
-  ): void => {
-    this.onAppObjectRemovedObservers.remove(observer);
-  };
-
-  has = (id: string): boolean => {
-    return this.appObjectLookup.has(id);
-  };
-
-  add = (appObject: AppObject) => {
-    const existing = this.appObjectLookup.get(appObject.id);
-    if (existing) {
-      existing.removeObserver(this.notify);
-    }
-
-    this.appObjectLookup.set(appObject.id, appObject);
-    appObject.addObserver(this.notify);
-    this.notify();
-    this.onAppObjectAddedObserver.notify(appObject);
-  };
-
-  remove = (id: string) => {
-    const existing = this.appObjectLookup.get(id);
-    if (!existing) return;
-
-    this.appObjectLookup.delete(id);
-    existing.removeObserver(this.notify);
-    this.notify();
-    this.onAppObjectRemovedObservers.notify(existing);
-  };
-
-  get = (id: string): AppObject | undefined => {
-    return this.appObjectLookup.get(id);
-  };
-
-  getOrCreate = (id: string): AppObject => {
-    const existing = this.appObjectLookup.get(id);
-
-    if (!existing) {
-      return makeAppObject(id, this);
-    } else {
-      return existing;
-    }
-  };
-
-  getAll = (): AppObject[] => {
-    return Array.from(this.appObjectLookup.values());
-  };
-
-  getAllAppObjectsWithComponent(componentType: string): AppObject[] {
-    const rArray: AppObject[] = [];
-
-    this.appObjectLookup.forEach((appObj) => {
-      if (appObj.hasComponent(componentType)) {
-        rArray.push(appObj);
-      }
-    });
-
-    return rArray;
-  }
-
-  getAllComponents<T extends AppObjectComponent>(type: string): T[] {
-    const rArray: T[] = [];
-
-    this.appObjectLookup.forEach((appObj) => {
-      const aoEntity = appObj.getComponent(type);
-      if (aoEntity) {
-        rArray.push(aoEntity as T);
-      }
-    });
-
-    return rArray;
-  }
-
-  getAppObjectComponent<T extends AppObjectComponent>(
-    id: string,
-    entityType: string
-  ): T | undefined {
-    const ao = this.appObjectLookup.get(id);
-    if (!ao) {
-      return undefined;
-    }
-
-    return ao.getComponent(entityType) as T;
-  }
-
-  submitLog(sender: string, message: string): void {
-    console.log(`[${sender}]: ${message}`);
-  }
-  submitWarning(sender: string, message: string): void {
-    console.warn(`[${sender}]: ${message}`);
-  }
-  submitError(sender: string, message: string): void {
-    console.error(`[${sender}]: ${message}`);
-  }
-  submitFatal(sender: string, message: string): void {
-    console.error(`FATAL ERROR - [${sender}]: ${message}`);
-  }
-
-  registerSingleton(component: AppObjectComponent): void {
-    if (this.singletons.has(component.type)) {
-      this.submitWarning(
-        "AppObjectRepo",
-        `Singleton for type ${component.type} already exists. Relpacing`
-      );
-    }
-
-    this.singletons.set(component.type, component);
-  }
-
-  getSingleton<T extends AppObjectComponent>(type: string): T | undefined {
-    if (this.singletons.has(type)) {
-      return this.singletons.get(type) as T;
-    }
-
-    const components = this.getAllComponents<AppObjectComponent>(type);
-    if (components.length === 1) {
-      this.singletons.set(components[0].type, components[0]);
-      return components[0] as T;
-    } else if (components.length === 0) {
-      this.submitWarning(
-        "AppObjectRepo",
-        `Unable to find a singleton for ${type}`
-      );
-      return undefined;
-    } else if (components.length > 1) {
-      this.submitWarning(
-        "AppObjectRepo",
-        `Multiple ${type} found. There should only be one if it truly a singleton. Using the first one`
-      );
-      return components[0] as T;
-    }
-  }
-}

package/src/AppObject/AppObjectUC.ts

@@ -1,5 +0,0 @@
-import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
-
-export class AppObjectUC extends AppObjectComponent {
-	readonly componentType = AppObjectComponentType.UC;
-}

package/src/AppObject/AppObjectView.ts

@@ -1,5 +0,0 @@
-import { AppObjectComponent, AppObjectComponentType } from "./AppObjectComponent";
-
-export class AppObjectView extends AppObjectComponent {
-	readonly componentType = AppObjectComponentType.VIEW;
-}

package/src/AppObject/getSingletonComponent.test.ts

@@ -1,17 +0,0 @@
-import { makeAppObjectRepo } from "./AppObjectRepo";
-import { getSingletonComponent } from "./getSingletonComponent";
-
-describe("Get Singleton Component", () => {
-  it("Calls the get singleton on the app object repo", () => {
-    const appObjects = makeAppObjectRepo();
-
-    appObjects.getSingleton = jest.fn();
-
-    getSingletonComponent(
-      "Mock Component",
-      appObjects
-    );
-
-    expect(appObjects.getSingleton).toBeCalledWith("Mock Component")
-  });
-});

package/src/AppObject/getSingletonComponent.ts

@@ -1,9 +0,0 @@
-import { AppObjectComponent } from "./AppObjectComponent";
-import { AppObjectRepo } from "./AppObjectRepo";
-
-export function getSingletonComponent<T extends AppObjectComponent>(
-  type: string,
-  appObjects: AppObjectRepo
-): T | undefined {
-  return appObjects.getSingleton<T>(type);
-}

package/src/AppObject/index.ts

@@ -1,10 +0,0 @@
-export * from "./AppObject"
-export * from "./AppObjectEntity"
-export * from "./AppObjectEntityRepo"
-export * from "./AppObjectPM"
-export * from "./AppObjectRepo"
-export * from "./AppObjectUC"
-export * from "./AppObjectController"
-export * from "./AppObjectView"
-export * from "./getSingletonComponent";
-export * from "./printAppObjectDetails";

package/src/AppObject/printAppObjectDetails.ts

@@ -1,17 +0,0 @@
-import { AppObjectRepo } from "./AppObjectRepo";
-
-export function printAppObjectDetails(id: string, appObjects: AppObjectRepo) {
-  const appObject = appObjects.get(id);
-  if (!appObject) {
-    console.warn("[printAppObjectDetails] Unable to find App Object by ID");
-    return;
-  }
-
-  console.log("[printAppObjectDetails] Start App Object Details ---");
-  console.log(`id: ${appObject.id}`);
-  const components = appObject.allComponents();
-  components.forEach((component) => {
-    console.log(`Has Component: ${component.type}`);
-  });
-  console.log("[printAppObjectDetails] End App Object Details ---");
-}

package/src/Entities/MemoizedAngle.test.ts

@@ -1,38 +0,0 @@
-import { Angle } from "../ValueObjects";
-import { MemoizedAngle } from "./MemoizedAngle";
-
-test("Initial value is stored", () => {
-  const memoizedNumber = new MemoizedAngle(Angle.FromDegrees(55), jest.fn());
-  expect(memoizedNumber.val.degrees).toEqual(55);
-});
-
-test("Callback is called when something changes", () => {
-  const cb = jest.fn();
-  const memoizedNumber = new MemoizedAngle(Angle.FromDegrees(33), cb);
-
-  expect(cb).not.toBeCalled();
-
-  memoizedNumber.val = Angle.FromDegrees(55);
-
-  expect(cb).toBeCalled();
-});
-
-test("CB is only called when something has changed", () => {
-  const cb = jest.fn();
-  const memoizedNumber = new MemoizedAngle(Angle.FromDegrees(33), cb);
-
-  memoizedNumber.val = Angle.FromDegrees(33);
-  memoizedNumber.val = Angle.FromDegrees(33);
-  memoizedNumber.val = Angle.FromDegrees(33);
-
-  expect(cb).not.toBeCalled();
-});
-
-test("Setting the value quietly should not notify", () => {
-  const cb = jest.fn();
-  const memoizedBoolean = new MemoizedAngle(Angle.FromDegrees(33), cb);
-
-  memoizedBoolean.setValQuietly(Angle.FromDegrees(55));
-
-  expect(cb).not.toBeCalled();
-});

package/src/Entities/MemoizedAngle.ts

@@ -1,25 +0,0 @@
-import { Angle } from "../ValueObjects";
-
-export class MemoizedAngle {
-  private _val: Angle;
-  get val(): Angle {
-    return this._val;
-  }
-  set val(b: Angle) {
-    if (this._val.degrees === b.degrees) return;
-
-    this._val = b;
-    this.onChangeCallback();
-  }
-
-  public setValQuietly(val: Angle) {
-    this._val = val;
-  }
-
-  private onChangeCallback: () => void;
-
-  constructor(initialValue: Angle, onChangeCallback: () => void) {
-    this._val = initialValue;
-    this.onChangeCallback = onChangeCallback;
-  }
-}

package/src/Entities/MemoizedBoolean.test.ts

@@ -1,45 +0,0 @@
-import { MemoizedBoolean } from "./MemoizedBoolean";
-
-test("Initial value is stored", ()=>{
-  const memoizedTrue = new MemoizedBoolean(true, jest.fn());
-  expect(memoizedTrue.val).toEqual(true);
-
-  const memoizedFalse = new MemoizedBoolean(false, jest.fn());
-  expect(memoizedFalse.val).toEqual(false);
-})
-
-test("Callback is called when something changes", ()=>{
-  const cb = jest.fn();
-  const memoizedBoolean = new MemoizedBoolean(true, cb);
-
-  expect(cb).not.toBeCalled();
-
-  memoizedBoolean.val = false;
-
-  expect(cb).toBeCalled();
-  cb.mockClear();
-
-  memoizedBoolean.val = true;
-
-  expect(cb).toBeCalled();
-})
-
-test("CB is only called when something has changed", ()=>{
-  const cb = jest.fn();
-  const memoizedBoolean = new MemoizedBoolean(true, cb);
-
-  memoizedBoolean.val = true;
-  memoizedBoolean.val = true;
-  memoizedBoolean.val = true;
-
-  expect(cb).not.toBeCalled();
-})
-
-test("Setting the value quietly should not notify", ()=>{
-  const cb = jest.fn();
-  const memoizedBoolean = new MemoizedBoolean(true, cb);
-
-  memoizedBoolean.setValQuietly(false);
-
-  expect(cb).not.toBeCalled();
-})