Feat/conditional values refactoring 2

core/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.32.0
+
+### Added
+
+- [`Thing.observeLiterals`](https://pod-os.org/reference/core/classes/thing/#observeliterals) pushes changes to literals
+
 ## 0.31.0
 
 ### Breaking changes
@@ -33,7 +39,7 @@ and this project adheres to
 
 ## 0.28.0
 
-- [`addRelation`](https://pod-os.org/reference/core/classes/podos/#addrelation: A method to add a relation (link) between things
+- [`addRelation`](https://pod-os.org/reference/core/classes/podos/#addrelation): A method to add a relation (link) between things
 
 ## 0.27.0
 

core/src/Store.ts

@@ -45,6 +45,7 @@ import {
   Term,
 } from "rdflib/lib/tf-types";
 import { iana, internal } from "./namespaces";
+export { Quad } from "rdflib/lib/tf-types";
 
 /**
  * The Store contains all data that is known locally.

core/src/thing/Thing.literals.spec.ts

@@ -1,20 +1,21 @@
-import { beforeEach, describe, expect, it } from "vitest";
-import { blankNode, graph, IndexedFormula, sym } from "rdflib";
+import { afterEach, beforeEach, describe, expect, it, Mock, vi } from "vitest";
+import { blankNode, graph, IndexedFormula, literal, quad, sym } from "rdflib";
 import { PodOsSession } from "../authentication";
-import { Thing } from "./Thing";
+import { Literal, Thing } from "./Thing";
 import { Store } from "../Store";
+import { Observable } from "rxjs";
 
 describe("Thing", function () {
-  describe("literals", () => {
-    let internalStore: IndexedFormula;
-    const mockSession = {} as unknown as PodOsSession;
-    let store: Store;
+  let internalStore: IndexedFormula;
+  const mockSession = {} as unknown as PodOsSession;
+  let store: Store;
 
-    beforeEach(() => {
-      internalStore = graph();
-      store = new Store(mockSession, undefined, undefined, internalStore);
-    });
+  beforeEach(() => {
+    internalStore = graph();
+    store = new Store(mockSession, undefined, undefined, internalStore);
+  });
 
+  describe("literals", () => {
     it("are empty, if store is empty", () => {
       const it = new Thing(
         "https://jane.doe.example/container/file.ttl#fragment",
@@ -162,4 +163,195 @@ describe("Thing", function () {
       ]);
     });
   });
+
+  describe("observeLiterals", () => {
+    beforeEach(() => {
+      vi.useFakeTimers();
+    });
+
+    afterEach(() => {
+      vi.useRealTimers();
+    });
+
+    let uri: string,
+      subscriber: Mock,
+      thing: Thing,
+      literalsSpy: Mock,
+      observable: Observable<Literal[]>;
+
+    beforeEach(() => {
+      // Given a store with statements about a URI
+      uri = "https://jane.doe.example/container/file.ttl#fragment";
+      internalStore.add(
+        sym(uri),
+        sym("http://vocab.test/first"),
+        "value 1-1",
+        sym(uri),
+      );
+      internalStore.add(
+        sym(uri),
+        sym("http://vocab.test/second"),
+        "value 2-1",
+        sym(uri),
+      );
+      internalStore.add(
+        sym(uri),
+        sym("http://vocab.test/second"),
+        "value 2-2",
+        sym(uri),
+      );
+      internalStore.add(
+        sym(uri),
+        sym("http://vocab.test/third"),
+        "value 3-1",
+        sym(uri),
+      );
+
+      // and a Thing with a literals method
+      subscriber = vi.fn();
+      thing = new Thing(uri, store);
+      literalsSpy = vi.spyOn(thing, "literals");
+
+      // and a subscription to changes in relations
+      observable = thing.observeLiterals();
+      observable.subscribe(subscriber);
+    });
+
+    it("pushes existing literals immediately", () => {
+      expect(subscriber).toHaveBeenCalledTimes(1);
+      expect(literalsSpy).toHaveBeenCalledTimes(1);
+      expect(subscriber.mock.calls).toEqual([
+        [
+          [
+            {
+              predicate: "http://vocab.test/first",
+              label: "first",
+              values: ["value 1-1"],
+            },
+            {
+              predicate: "http://vocab.test/second",
+              label: "second",
+              values: ["value 2-1", "value 2-2"],
+            },
+            {
+              predicate: "http://vocab.test/third",
+              label: "third",
+              values: ["value 3-1"],
+            },
+          ],
+        ],
+      ]);
+    });
+
+    it("updates after removals", () => {
+      internalStore.removeStatement(
+        quad(
+          sym(uri),
+          sym("http://vocab.test/first"),
+          literal("value 1-1"),
+          sym(uri),
+        ),
+      );
+      vi.advanceTimersByTime(250);
+      expect(subscriber).toHaveBeenCalledTimes(2);
+      expect(literalsSpy).toHaveBeenCalledTimes(2);
+      expect(subscriber.mock.lastCall).toEqual([
+        [
+          {
+            predicate: "http://vocab.test/second",
+            label: "second",
+            values: ["value 2-1", "value 2-2"],
+          },
+          {
+            predicate: "http://vocab.test/third",
+            label: "third",
+            values: ["value 3-1"],
+          },
+        ],
+      ]);
+    });
+
+    it("updates after additions", () => {
+      internalStore.add(sym(uri), sym("http://vocab.test/first"), "value 1-2");
+      vi.advanceTimersByTime(250);
+      expect(subscriber).toHaveBeenCalledTimes(2);
+      expect(literalsSpy).toHaveBeenCalledTimes(2);
+      expect(subscriber.mock.lastCall).toEqual([
+        [
+          {
+            predicate: "http://vocab.test/first",
+            label: "first",
+            values: ["value 1-1", "value 1-2"],
+          },
+          {
+            predicate: "http://vocab.test/second",
+            label: "second",
+            values: ["value 2-1", "value 2-2"],
+          },
+          {
+            predicate: "http://vocab.test/third",
+            label: "third",
+            values: ["value 3-1"],
+          },
+        ],
+      ]);
+    });
+
+    it("pushes update in groups", () => {
+      internalStore.removeStatement(
+        quad(
+          sym(uri),
+          sym("http://vocab.test/first"),
+          literal("value 1-1"),
+          sym(uri),
+        ),
+      );
+      internalStore.add(sym(uri), sym("http://vocab.test/first"), "value 1-2");
+      internalStore.add(sym(uri), sym("http://vocab.test/third"), "value 3-2");
+      vi.advanceTimersByTime(250);
+      expect(subscriber).toHaveBeenCalledTimes(2);
+      expect(literalsSpy).toHaveBeenCalledTimes(2);
+      expect(subscriber.mock.lastCall).toEqual([
+        [
+          {
+            predicate: "http://vocab.test/second",
+            label: "second",
+            values: ["value 2-1", "value 2-2"],
+          },
+          {
+            predicate: "http://vocab.test/third",
+            label: "third",
+            values: ["value 3-1", "value 3-2"],
+          },
+          {
+            predicate: "http://vocab.test/first",
+            label: "first",
+            values: ["value 1-2"],
+          },
+        ],
+      ]);
+    });
+
+    it("ignores irrelevant statements about other resources", () => {
+      internalStore.add(
+        sym("https://other.uri/"),
+        sym("http://vocab.test/first"),
+        "value",
+      );
+      vi.advanceTimersByTime(250);
+      expect(subscriber).toHaveBeenCalledTimes(1);
+      expect(literalsSpy).toHaveBeenCalledTimes(1);
+    });
+
+    it("does not push if literals have not changed", () => {
+      internalStore.add(
+        sym(uri),
+        sym("http://vocab.test/first"),
+        sym("http://not.a.literal/"),
+      );
+      vi.advanceTimersByTime(250);
+      expect(literalsSpy).toHaveBeenCalledTimes(2);
+      expect(subscriber).toHaveBeenCalledTimes(1);
+    });
+  });
 });