test(json-crdt-extensions): 💍 add Inline .str() and .pos() tests

Author: streamich

src/json-crdt-extensions/peritext/block/Inline.ts

@@ -11,7 +11,7 @@ import type {PathStep} from '../../../json-pointer';
 import type {Slice} from '../slice/types';
 import type {Peritext} from '../Peritext';
 
-export type Marks = Record<string | number, unknown>;
+export type InlineAttributes = Record<string | number, unknown>;
 
 /**
  * The `Inline` class represents a range of inline text within a block, which
@@ -60,14 +60,29 @@ export class Inline extends Range implements Printable {
     return updateNum(this.start.refresh(), this.end.refresh());
   }
 
+  /**
+   * @returns The full text content of the inline, which is the concatenation
+   *     of all the underlying {@link ChunkSlice}s.
+   */
   public str(): string {
     let str = '';
     for (const slice of this.texts) str += slice.view();
     return str;
   }
 
-  public marks(): Marks {
-    const marks: Marks = {};
+  /**
+   * @returns The position of the inline withing the text.
+   */
+  public pos(): number {
+    const chunkSlice = this.texts[0];
+    if (!chunkSlice) return -1;
+    const chunk = chunkSlice.chunk;
+    const pos = this.rga.pos(chunk);
+    return pos + chunkSlice.off;
+  }
+
+  public attr(): InlineAttributes {
+    const attr: InlineAttributes = {};
     const point = this.start as OverlayPoint;
     const slices: Slice[] = this.texts.length ? point.layers : point.markers;
     const length = slices.length;
@@ -76,8 +91,8 @@ export class Inline extends Range implements Printable {
       const type = slice.type as PathStep;
       switch (slice.behavior) {
         case SliceBehavior.Stack: {
-          let dataList: unknown[] = (marks[type] as unknown[]) || (marks[type] = []);
-          if (!Array.isArray(dataList)) dataList = marks[type] = [dataList];
+          let dataList: unknown[] = (attr[type] as unknown[]) || (attr[type] = []);
+          if (!Array.isArray(dataList)) dataList = attr[type] = [dataList];
           let data = slice.data();
           if (data === undefined) data = 1;
           dataList.push(data);
@@ -86,24 +101,16 @@ export class Inline extends Range implements Printable {
         case SliceBehavior.Overwrite: {
           let data = slice.data();
           if (data === undefined) data = 1;
-          marks[type] = data;
+          attr[type] = data;
           break;
         }
         case SliceBehavior.Erase: {
-          delete marks[type];
+          delete attr[type];
           break;
         }
       }
     }
-    return marks;
-  }
-
-  public pos(): number {
-    const chunkSlice = this.texts[0];
-    if (!chunkSlice) return -1;
-    const chunk = chunkSlice.chunk;
-    const pos = this.rga.pos(chunk);
-    return pos + chunkSlice.off;
+    return attr;
   }
 
   // ---------------------------------------------------------------- Printable
@@ -116,7 +123,7 @@ export class Inline extends Range implements Printable {
     const range =
       this.start.cmp(this.end) === 0 ? startFormatted : `${startFormatted} ↔ ${this.end.toString(tab, true)}`;
     const header = `${this.constructor.name} ${range} ${text}`;
-    const marks = this.marks();
+    const marks = this.attr();
     const markKeys = Object.keys(marks);
     return (
       header +

src/json-crdt-extensions/peritext/block/__tests__/Inline.hash.spec.ts renamed to src/json-crdt-extensions/peritext/block/__tests__/Inline.key.spec.ts

@@ -40,7 +40,6 @@ describe('range hash', () => {
   });
 
   test('computes unique hash - 4', () => {
-    const {peritext} = setupKit();
     const hash1 = updateNum(
       updateId(0, new Timestamp(2, 7)),
       updateId(1, new Timestamp(2, 7)),
@@ -53,7 +52,7 @@ describe('range hash', () => {
   });
 });
 
-const runPairsTests = (setup: () => Kit) => {
+const runKeyTests = (setup: () => Kit) => {
   describe('.key()', () => {
     test('construct unique keys for all ranges', () => {
       const {peritext} = setup();
@@ -88,18 +87,18 @@ const runPairsTests = (setup: () => Kit) => {
 
 describe('Inline', () => {
   describe('lorem ipsum', () => {
-    runPairsTests(() => setupKit('lorem ipsum dolor sit amet consectetur adipiscing elit'));
+    runKeyTests(() => setupKit('lorem ipsum dolor sit amet consectetur adipiscing elit'));
   });
 
   describe('numbers "0123456789", no edits', () => {
-    runPairsTests(setupNumbersKit);
+    runKeyTests(setupNumbersKit);
   });
 
   describe('numbers "0123456789", with default schema and tombstones', () => {
-    runPairsTests(setupNumbersWithTombstonesKit);
+    runKeyTests(setupNumbersWithTombstonesKit);
   });
 
   describe('numbers "0123456789", with default schema and tombstones and constant sid', () => {
-    runPairsTests(() => setupNumbersWithTombstonesKit(12313123));
+    runKeyTests(() => setupNumbersWithTombstonesKit(12313123));
   });
 });

src/json-crdt-extensions/peritext/block/__tests__/Inline.str.spec.ts

@@ -0,0 +1,58 @@
+import {Kit,  setupKit, setupNumbersKit, setupNumbersWithTombstonesKit} from '../../__tests__/setup';
+import {Inline} from '../Inline';
+
+const runStrTests = (setup: () => Kit) => {
+  describe('.str()', () => {
+    test('concatenates parts of Inline correctly', () => {
+      const {peritext} = setup();
+      const overlay = peritext.overlay;
+      const length = peritext.strApi().length();
+      for (let i = 0; i < length; i++) {
+        for (let j = 1; j <= length - i; j++) {
+          peritext.editor.cursor.setAt(i, j);
+          overlay.refresh();
+          const [start, end] = [...overlay.points()];
+          const inline = Inline.create(peritext, start, end);
+          const str = inline.str();
+          expect(str).toBe(peritext.strApi().view().slice(i, i + j));
+        }
+      }
+    });
+  });
+
+  describe('.pos()', () => {
+    test('returns correct offset in text', () => {
+      const {peritext} = setup();
+      const overlay = peritext.overlay;
+      const length = peritext.strApi().length();
+      for (let i = 0; i < length; i++) {
+        for (let j = 1; j <= length - i; j++) {
+          peritext.editor.cursor.setAt(i, j);
+          overlay.refresh();
+          const [start, end] = [...overlay.points()];
+          const inline = Inline.create(peritext, start, end);
+          const pos = inline.pos();
+          expect(pos).toBe(i);
+        }
+      }
+    });
+  });
+};
+
+describe('Inline', () => {
+  describe('lorem ipsum', () => {
+    runStrTests(() => setupKit('lorem ipsum dolor sit amet'));
+  });
+
+  describe('numbers "0123456789", no edits', () => {
+    runStrTests(setupNumbersKit);
+  });
+
+  describe('numbers "0123456789", with default schema and tombstones', () => {
+    runStrTests(setupNumbersWithTombstonesKit);
+  });
+
+  describe('numbers "0123456789", with default schema and tombstones and constant sid', () => {
+    runStrTests(() => setupNumbersWithTombstonesKit(12313123));
+  });
+});