refactor(json-crdt-extensions): 💡 rename setCaret() to setAfter()

Author: streamich

src/json-crdt-extensions/peritext/editor/Editor.ts

@@ -54,8 +54,8 @@ export class Editor implements Printable {
       const api = model.api;
       api.builder.del(str.id, range);
       api.apply();
-      if (start.anchor === Anchor.After) cursor.setCaret(start.id);
-      else cursor.setCaret(start.prevId() || str.id);
+      if (start.anchor === Anchor.After) cursor.setAfter(start.id);
+      else cursor.setAfter(start.prevId() || str.id);
     }
     return cursor.start.id;
   }
@@ -68,7 +68,8 @@ export class Editor implements Printable {
     if (!text) return;
     const after = this.collapseSelection();
     const textId = this.txt.ins(after, text);
-    this.cursor.setCaret(textId, text.length - 1);
+    const shift = text.length - 1;
+    this.cursor.setAfter(shift ? tick(textId, shift) : textId);
   }
 
   /**

src/json-crdt-extensions/peritext/point/Point.ts

@@ -58,6 +58,8 @@ export class Point<T = string> implements Pick<Stateful, 'refresh'>, Printable {
    * @returns Returns 0 if the two points are equal, -1 if this point is less
    *          than the other point, and 1 if this point is greater than the other
    *          point.
+   * 
+   * @todo Rename to `cmp`.
    */
   public compare(other: Point<T>): -1 | 0 | 1 {
     const cmp = compare(this.id, other.id);
@@ -74,6 +76,8 @@ export class Point<T = string> implements Pick<Stateful, 'refresh'>, Printable {
    * @returns Returns 0 if the two points are equal, negative if this point is
    *          less than the other point, and positive if this point is greater
    *          than the other point.
+   * 
+   * @todo Rename to `cmpSpatial`.
    */
   public compareSpatial(other: Point<T>): number {
     const thisId = this.id;

src/json-crdt-extensions/peritext/slice/Range.ts

@@ -143,19 +143,17 @@ export class Range<T = string> implements Printable {
     this.setRange(range);
   }
 
-  /** @todo Can this be moved to Cursor? */
-  public setCaret(after: ITimestampStruct, shift: number = 0): void {
-    const id = shift ? tick(after, shift) : after;
-    const caretAfter = new Point(this.rga, id, Anchor.After);
-    this.set(caretAfter);
+  public setAfter(id: ITimestampStruct): void {
+    const point = new Point(this.rga, id, Anchor.After);
+    this.set(point);
   }
 
   public contains(range: Range<T>): boolean {
     return this.start.compareSpatial(range.start) <= 0 && this.end.compareSpatial(range.end) >= 0;
   }
 
-  public containsPoint(range: Point<T>): boolean {
-    return this.start.compareSpatial(range) <= 0 && this.end.compareSpatial(range) >= 0;
+  public containsPoint(point: Point<T>): boolean {
+    return this.start.compareSpatial(point) <= 0 && this.end.compareSpatial(point) >= 0;
   }
 
   /**
@@ -278,6 +276,8 @@ export class Range<T = string> implements Printable {
     const name = lite ? '' : `${this.constructor.name} `;
     const start = this.start.toString(tab, lite);
     const end = this.end.toString(tab, lite);
-    return `${name}${start} ↔ ${end}`;
+    let text = this.text();
+    if (text.length > 16) text = text.slice(0, 16) + '...';
+    return `${JSON.stringify(text)} ${name}${start} ↔ ${end}`;
   }
 }

src/json-crdt-extensions/peritext/slice/__tests__/Range.spec.ts

@@ -346,6 +346,21 @@ describe('.contains()', () => {
   });
 });
 
+describe('.containsPoint()', () => {
+  test('returns true if slice is contained', () => {
+    const {peritext} = setup();
+    const point = peritext.pointAt(2, Anchor.After);
+    const range1 = peritext.rangeAt(2, 2);
+    const range2 = peritext.rangeAt(3, 2);
+    expect(range1.containsPoint(point)).toBe(true);
+    expect(range2.containsPoint(point)).toBe(false);
+    range2.start.refAfter();
+    expect(range2.containsPoint(point)).toBe(true);
+    const range3 = peritext.rangeAt(1, 2);
+    expect(range3.containsPoint(point)).toBe(true);
+  });
+});
+
 describe('.isCollapsed()', () => {
   test('returns true when endpoints point to the same location', () => {
     const {peritext} = setup();