feat(json-crdt-extensions): 🎸 make Overlay an iterable

Author: streamich

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

@@ -19,10 +19,10 @@ const setup = () => {
 test('can insert markers', () => {
   const {peritext} = setup();
   const {editor} = peritext;
-  expect(peritext.overlay.all().length).toBe(0);
+  expect([...peritext.overlay].length).toBe(0);
   editor.cursor.setAt(0);
   peritext.refresh();
-  expect(peritext.overlay.all().length).toBe(1);
+  expect([...peritext.overlay].length).toBe(1);
   editor.insMarker(['p'], '<p>');
   peritext.refresh();
   expect(size(peritext.overlay.root)).toBe(2);

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

@@ -11,6 +11,7 @@ import {compare, ITimestampStruct, tick} from '../../../json-crdt-patch/clock';
 import {CONST, updateNum} from '../../../json-hash';
 import {MarkerSlice} from '../slice/MarkerSlice';
 import {Range} from '../rga/Range';
+import {UndefEndIter} from '../../../util/iterator';
 import type {Chunk} from '../../../json-crdt/nodes/rga';
 import type {Peritext} from '../Peritext';
 import type {Stateful} from '../types';
@@ -58,12 +59,12 @@ export class Overlay<T = string> implements Printable, Stateful {
     };
   }
 
-  public all(): OverlayPoint<T>[] {
-    const iterator = this.iterator();
-    let point: OverlayPoint<T> | undefined;
-    const points: OverlayPoint<T>[] = [];
-    while ((point = iterator())) points.push(point);
-    return points;
+  public entries(): IterableIterator<OverlayPoint<T>> {
+    return new UndefEndIter(this.iterator());
+  }
+
+  [Symbol.iterator]() {
+    return this.entries();
   }
 
   public splitIterator(): () => MarkerOverlayPoint | undefined {

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

@@ -30,7 +30,7 @@ describe('Overlay.refresh()', () => {
     editor.cursor.setRange(range);
     peritext.refresh();
     expect(editor.cursor.text()).toBe('0123456789');
-    const overlayPoints = overlay.all();
+    const overlayPoints = [...overlay];
     expect(overlayPoints.length).toBe(2);
     expect(overlayPoints[0].id.time).toBe(editor.cursor.start.id.time);
     expect(overlayPoints[1].id.time).toBe(editor.cursor.end.id.time);
@@ -43,7 +43,7 @@ describe('Overlay.refresh()', () => {
     editor.cursor.setRange(range);
     peritext.refresh();
     expect(editor.cursor.text()).toBe('0123456789');
-    const overlayPoints = overlay.all();
+    const overlayPoints = [...overlay];
     expect(overlayPoints.length).toBe(2);
     expect(overlayPoints[0].id.time).toBe(editor.cursor.start.id.time);
     expect(overlayPoints[1].id.time).toBe(editor.cursor.end.id.time);

src/util/iterator.ts

@@ -0,0 +1,16 @@
+export class UndefEndIter<T> implements IterableIterator<T> {
+  constructor(private readonly i: () => T | undefined) {}
+
+  public next(): IteratorResult<T> {
+    const value = this.i();
+    return new IterRes(value, value === undefined) as IteratorResult<T>;
+  }
+
+  [Symbol.iterator]() {
+    return this;
+  }
+}
+
+export class IterRes<T> {
+  constructor(public readonly value: T, public readonly done: boolean) {}
+}