test(json-crdt-extensions): 💍 add .findContained() and .findOverlapping() overlay tests

Author: streamich

src/json-crdt-extensions/peritext/overlay/MarkerOverlayPoint.ts

@@ -8,7 +8,7 @@ import type {MarkerSlice} from '../slice/MarkerSlice';
 
 export class MarkerOverlayPoint<T = string> extends OverlayPoint<T> {
   /**
-   * Hash value of the preceding text contents, up until the next marker.
+   * Hash value of the following text contents, up until the next marker.
    */
   public textHash: number = 0;
 

src/json-crdt-extensions/peritext/overlay/Overlay.ts

@@ -118,7 +118,8 @@ export class Overlay<T = string> implements Printable, Stateful {
     }
     return;
   }
-
+ 
+  /** @todo Rename to `chunks()`. */
   public chunkSlices0(
     chunk: Chunk<T> | undefined,
     p1: Point<T>,
@@ -245,6 +246,14 @@ export class Overlay<T = string> implements Printable, Stateful {
     return new UndefEndIter(this.tuples0(after));
   }
 
+  /**
+   * Finds all slices that are contained within the given range. A slice is
+   * considered contained if its start and end points are within the range,
+   * inclusive (uses {@link Range#contains} method to check containment).
+   *
+   * @param range The range to search for contained slices.
+   * @returns A set of slices that are contained within the given range.
+   */
   public findContained(range: Range<T>): Set<Slice<T>> {
     const result = new Set<Slice<T>>();
     let point = this.getOrNextLower(range.start);
@@ -265,6 +274,14 @@ export class Overlay<T = string> implements Printable, Stateful {
     return result;
   }
 
+  /**
+   * Finds all slices that overlap with the given range. A slice is considered
+   * overlapping if its start or end point is within the range, inclusive
+   * (uses {@link Range#containsPoint} method to check overlap).
+   *
+   * @param range The range to search for overlapping slices.
+   * @returns A set of slices that overlap with the given range.
+   */
   public findOverlapping(range: Range<T>): Set<Slice<T>> {
     const result = new Set<Slice<T>>();
     let point = this.getOrNextLower(range.start);

src/json-crdt-extensions/peritext/overlay/__tests__/Overlay.findX.spec.ts

@@ -0,0 +1,141 @@
+import {Kit, setupHelloWorldKit, setupHelloWorldWithFewEditsKit} from '../../__tests__/setup';
+
+const runFindContainedTests = (setup: () => Kit) => {
+  describe('.findContained()', () => {
+    test('returns empty set by default', () => {
+      const {peritext} = setup();
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findContained(peritext.rangeAt(3, 4));
+      expect(slices.size).toBe(0);
+    });
+
+    test('returns a single contained slice', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 2);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findContained(peritext.rangeAt(3, 4));
+      expect(slices.size).toBe(1);
+    });
+
+    test('returns two contained slice', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 1);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findContained(peritext.rangeAt(2, 8));
+      expect(slices.size).toBe(2);
+    });
+
+    test('does not return overlapping slice', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 4);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findContained(peritext.rangeAt(4, 8));
+      expect(slices.size).toBe(1);
+    });
+
+    test('returns split blocks', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 4);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(8);
+      editor.saved.insMarker('p');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findContained(peritext.rangeAt(4, 8));
+      expect(slices.size).toBe(2);
+    });
+  });
+};
+
+const runFindOverlappingTests = (setup: () => Kit) => {
+  describe('.findOverlapping()', () => {
+    test('returns empty set by default', () => {
+      const {peritext} = setup();
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(3, 4));
+      expect(slices.size).toBe(0);
+    });
+
+    test('returns a single contained slice', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 2);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(3, 4));
+      expect(slices.size).toBe(1);
+    });
+
+    test('returns two contained slice', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 1);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(2, 8));
+      expect(slices.size).toBe(2);
+    });
+
+    test('returns overlapping slices', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 4);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(4, 8));
+      expect(slices.size).toBe(2);
+    });
+
+    test('returns overlapping slices from both ends', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 2);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(8, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(4, 5));
+      expect(slices.size).toBe(2);
+    });
+
+    test('returns split blocks', () => {
+      const {peritext, editor} = setup();
+      editor.cursor.setAt(3, 4);
+      editor.saved.insStack('em');
+      editor.cursor.setAt(5, 2);
+      editor.saved.insStack('bold');
+      editor.cursor.setAt(8);
+      editor.saved.insMarker('p');
+      editor.cursor.setAt(0);
+      peritext.overlay.refresh();
+      const slices = peritext.overlay.findOverlapping(peritext.rangeAt(4, 8));
+      expect(slices.size).toBe(3);
+    });
+  });
+};
+
+describe('text "hello world", no edits', () => {
+  runFindContainedTests(setupHelloWorldKit);
+  runFindOverlappingTests(setupHelloWorldKit);
+});
+
+describe('text "hello world", with few edits', () => {
+  runFindContainedTests(setupHelloWorldWithFewEditsKit);
+  runFindOverlappingTests(setupHelloWorldWithFewEditsKit);
+});

src/json-crdt-extensions/peritext/overlay/__tests__/Overlay.tuples.spec.ts

@@ -152,10 +152,10 @@ const runPairsTests = (setup: () => Kit) => {
   });
 };
 
-describe('numbers "hello world", no edits', () => {
+describe('text "hello world", no edits', () => {
   runPairsTests(setupHelloWorldKit);
 });
 
-describe('numbers "hello world", with default schema and tombstones', () => {
+describe('text "hello world", with few edits', () => {
   runPairsTests(setupHelloWorldWithFewEditsKit);
 });