Skip to content

Commit 7e3619d

Browse files
streamichstreamich
authored
Merge pull request #794 from streamich/fragment-converters
`Fragment` exports to other formats
2 parents 37aacc1 + 8f5be6c commit 7e3619d

18 files changed

+1253
-286
lines changed

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@
136136
"hyperdyperid": "^1.2.0",
137137
"sonic-forest": "^1.0.3",
138138
"thingies": "^2.1.1",
139-
"tree-dump": "^1.0.2"
139+
"tree-dump": "^1.0.2",
140+
"very-small-parser": "^1.8.0"
140141
},
141142
"devDependencies": {
142143
"@biomejs/biome": "^1.9.4",

‎src/json-crdt-extensions/peritext/__tests__/setup.ts

+37-15
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,28 @@ export const setupNumbersWithMultipleChunksAndDeletesKit = (): Kit => {
146146
});
147147
};
148148

149+
export const runNumbersKitTestSuite = (runTestSuite: (getKit: () => Kit) => void) => {
150+
describe('numbers "0123456789", no edits', () => {
151+
runTestSuite(setupNumbersKit);
152+
});
153+
154+
describe('numbers "0123456789", with default schema and tombstones', () => {
155+
runTestSuite(setupNumbersWithTombstonesKit);
156+
});
157+
158+
describe('numbers "0123456789", two RGA chunks', () => {
159+
runTestSuite(setupNumbersWithTwoChunksKit);
160+
});
161+
162+
describe('numbers "0123456789", with RGA split', () => {
163+
runTestSuite(setupNumbersWithRgaSplitKit);
164+
});
165+
166+
describe('numbers "0123456789", with multiple deletes', () => {
167+
runTestSuite(setupNumbersWithMultipleChunksAndDeletesKit);
168+
});
169+
};
170+
149171
/**
150172
* Creates a Peritext instance with text "abcdefghijklmnopqrstuvwxyz", no edits.
151173
*/
@@ -262,19 +284,19 @@ export const runAlphabetKitTestSuite = (runTestSuite: (getKit: () => Kit) => voi
262284
describe('basic alphabet', () => {
263285
runTestSuite(setupAlphabetKit);
264286
});
265-
// describe('alphabet with two chunks', () => {
266-
// runTestSuite(setupAlphabetWithTwoChunksKit);
267-
// });
268-
// describe('alphabet with chunk split', () => {
269-
// runTestSuite(setupAlphabetChunkSplitKit);
270-
// });
271-
// describe('alphabet with deletes', () => {
272-
// runTestSuite(setupAlphabetWithDeletesKit);
273-
// });
274-
// describe('alphabet written in reverse', () => {
275-
// runTestSuite(setupAlphabetWrittenInReverse);
276-
// });
277-
// describe('alphabet written in reverse with deletes', () => {
278-
// runTestSuite(setupAlphabetWrittenInReverseWithDeletes);
279-
// });
287+
describe('alphabet with two chunks', () => {
288+
runTestSuite(setupAlphabetWithTwoChunksKit);
289+
});
290+
describe('alphabet with chunk split', () => {
291+
runTestSuite(setupAlphabetChunkSplitKit);
292+
});
293+
describe('alphabet with deletes', () => {
294+
runTestSuite(setupAlphabetWithDeletesKit);
295+
});
296+
describe('alphabet written in reverse', () => {
297+
runTestSuite(setupAlphabetWrittenInReverse);
298+
});
299+
describe('alphabet written in reverse with deletes', () => {
300+
runTestSuite(setupAlphabetWrittenInReverseWithDeletes);
301+
});
280302
};

‎src/json-crdt-extensions/peritext/block/Block.ts

+35-50
Original file line numberDiff line numberDiff line change
@@ -52,33 +52,6 @@ export class Block<Attr = unknown> extends Range implements IBlock, Printable, S
5252
return length ? path[length - 1] : '';
5353
}
5454

55-
// public htmlTag(): string {
56-
// const tag = this.tag();
57-
// switch (typeof tag) {
58-
// case 'string': return tag.toLowerCase();
59-
// case 'number': return SliceTypeName[tag] || 'div';
60-
// default: return 'div';
61-
// }
62-
// }
63-
64-
// protected jsonMlNode(): JsonMlElement {
65-
// const props: Record<string, string> = {};
66-
// const node: JsonMlElement = ['div', props];
67-
// const tag = this.tag();
68-
// switch (typeof tag) {
69-
// case 'string':
70-
// node[0] = tag;
71-
// break;
72-
// case 'number':
73-
// const tag0 = SliceTypeName[tag];
74-
// if (tag0) node[0] = tag0; else props['data-tag'] = tag + '';
75-
// break;
76-
// }
77-
// const attr = this.attr();
78-
// if (attr !== undefined) props['data-attr'] = JSON.stringify(attr);
79-
// return node;
80-
// }
81-
8255
public attr(): Attr | undefined {
8356
return this.marker?.data() as Attr | undefined;
8457
}
@@ -112,59 +85,70 @@ export class Block<Attr = unknown> extends Range implements IBlock, Printable, S
11285
return new UndefEndIter(this.points0(withMarker));
11386
}
11487

115-
public tuples0(): UndefIterator<OverlayTuple<T>> {
88+
protected tuples0(): UndefIterator<OverlayTuple<T>> {
11689
const overlay = this.txt.overlay;
117-
const iterator = overlay.tuples0(this.marker);
90+
const marker = this.marker;
91+
const iterator = overlay.tuples0(marker);
11892
let closed = false;
11993
return () => {
12094
if (closed) return;
121-
const pair = iterator();
122-
if (!pair) return;
95+
let pair = iterator();
96+
while (!marker && pair && pair[1] && pair[1].cmpSpatial(this.start) < 0) pair = iterator();
97+
if (!pair) return (closed = true), void 0;
12398
if (!pair[1] || pair[1] instanceof MarkerOverlayPoint) closed = true;
12499
return pair;
125100
};
126101
}
127102

128-
public tuples(): IterableIterator<OverlayTuple<T>> {
129-
return new UndefEndIter(this.tuples0());
130-
}
131-
103+
/**
104+
* @todo Consider moving inline-related methods to {@link LeafBlock}.
105+
*/
132106
public texts0(): UndefIterator<Inline> {
133107
const txt = this.txt;
134108
const iterator = this.tuples0();
135-
const blockStart = this.start;
136-
const blockEnd = this.end;
109+
const start = this.start;
110+
const end = this.end;
111+
const startIsMarker = txt.overlay.isMarker(start.id);
112+
const endIsMarker = txt.overlay.isMarker(end.id);
137113
let isFirst = true;
138114
let next = iterator();
115+
let closed = false;
139116
return () => {
117+
if (closed) return;
140118
const pair = next;
141119
next = iterator();
142120
if (!pair) return;
143-
const [p1, p2] = pair;
144-
let start: Point = p1;
145-
let end: Point = p2;
121+
const [overlayPoint1, overlayPoint2] = pair;
122+
let point1: Point = overlayPoint1;
123+
let point2: Point = overlayPoint2;
146124
if (isFirst) {
147125
isFirst = false;
148-
if (blockStart.cmpSpatial(p1) > 0) start = blockStart;
126+
if (start.cmpSpatial(overlayPoint1) > 0) point1 = start;
127+
if (startIsMarker) {
128+
point1 = point1.clone();
129+
point1.step(1);
130+
}
149131
}
150-
const isLast = !next;
151-
if (isLast) if (blockEnd.cmpSpatial(p2) < 0) end = blockEnd;
152-
return new Inline(txt, p1, p2, start, end);
132+
if (!endIsMarker && end.cmpSpatial(overlayPoint2) < 0) {
133+
closed = true;
134+
point2 = end;
135+
}
136+
return new Inline(txt, overlayPoint1, overlayPoint2, point1, point2);
153137
};
154138
}
155139

140+
/**
141+
* @todo Consider moving inline-related methods to {@link LeafBlock}.
142+
*/
156143
public texts(): IterableIterator<Inline> {
157144
return new UndefEndIter(this.texts0());
158145
}
159146

160147
public text(): string {
161148
let str = '';
162-
const iterator = this.texts0();
163-
let inline = iterator();
164-
while (inline) {
165-
str += inline.text();
166-
inline = iterator();
167-
}
149+
const children = this.children;
150+
const length = children.length;
151+
for (let i = 0; i < length; i++) str += children[i].text();
168152
return str;
169153
}
170154

@@ -204,6 +188,7 @@ export class Block<Attr = unknown> extends Range implements IBlock, Printable, S
204188
public toStringName(): string {
205189
return 'Block';
206190
}
191+
207192
protected toStringHeader(): string {
208193
const hash = `#${this.hash.toString(36).slice(-4)}`;
209194
const tag = this.path.map((step) => formatType(step)).join('.');

‎src/json-crdt-extensions/peritext/block/Fragment.ts

+2-10
Original file line numberDiff line numberDiff line change
@@ -71,24 +71,16 @@ export class Fragment extends Range implements Printable, Stateful {
7171
}
7272

7373
protected build(): void {
74-
const {end, root} = this;
74+
const {root} = this;
7575
root.children = [];
7676
let parent = this.root;
7777
const txt = this.txt;
7878
const overlay = txt.overlay;
79-
/**
80-
* @todo This line always inserts a markerless block at the beginning of
81-
* the fragment. But what happens if one actually exists?
82-
*/
83-
this.insertBlock(parent, [CommonSliceType.p], void 0, void 0);
8479
const iterator = overlay.markerPairs0(this.start, this.end);
85-
const checkEnd = !end.isAbsEnd();
8680
let pair: ReturnType<typeof iterator>;
8781
while ((pair = iterator())) {
8882
const [p1, p2] = pair;
89-
if (!p1) break;
90-
if (checkEnd && p1.cmpSpatial(end) > 0) break;
91-
const type = p1.type();
83+
const type = p1 ? p1.type() : CommonSliceType.p;
9284
const path = type instanceof Array ? type : [type];
9385
const block = this.insertBlock(parent, path, p1, p2);
9486
if (block.parent) parent = block.parent;

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

+1-11
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,6 @@ export class Inline extends Range implements Printable {
238238
return texts;
239239
}
240240

241-
public text(): string {
242-
const str = super.text();
243-
return this.p1 instanceof MarkerOverlayPoint ? str.slice(1) : str;
244-
}
245-
246241
// ------------------------------------------------------------------- export
247242

248243
public toJson(): PeritextMlNode {
@@ -273,12 +268,7 @@ export class Inline extends Range implements Printable {
273268
}
274269

275270
public toString(tab: string = ''): string {
276-
const str = this.text();
277-
const truncate = str.length > 32;
278-
const text = JSON.stringify(truncate ? str.slice(0, 32) : str) + (truncate ? ' …' : '');
279-
const startFormatted = this.p1.toString(tab, true);
280-
const range = this.p1.cmp(this.end) === 0 ? startFormatted : `${startFormatted} ↔ ${this.end.toString(tab, true)}`;
281-
const header = `Inline ${range} ${text}`;
271+
const header = `${super.toString(tab)}`;
282272
const attr = this.attr();
283273
const attrKeys = Object.keys(attr);
284274
const texts = this.texts();

‎src/json-crdt-extensions/peritext/block/LeafBlock.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import {printTree} from 'tree-dump/lib/printTree';
22
import {Block} from './Block';
33
import type {Path} from '@jsonjoy.com/json-pointer';
4-
import type {PeritextMlAttributes, PeritextMlElement, PeritextMlNode} from './types';
4+
import type {PeritextMlAttributes, PeritextMlElement} from './types';
55

66
export interface IBlock<Attr = unknown> {
77
readonly path: Path;
@@ -10,6 +10,12 @@ export interface IBlock<Attr = unknown> {
1010
}
1111

1212
export class LeafBlock<Attr = unknown> extends Block<Attr> {
13+
public text(): string {
14+
let str = '';
15+
for (let iterator = this.texts0(), inline = iterator(); inline; inline = iterator()) str += inline.text();
16+
return str;
17+
}
18+
1319
// ------------------------------------------------------------------- export
1420

1521
public toJson(): PeritextMlElement {

‎src/json-crdt-extensions/peritext/block/__tests__/Block.iteration.spec.ts

-26
Original file line numberDiff line numberDiff line change
@@ -93,32 +93,6 @@ describe('points', () => {
9393
});
9494
});
9595

96-
describe('tuples', () => {
97-
test('in markup-less document, returns a single pair', () => {
98-
const {peritext} = setupHelloWorldKit();
99-
peritext.refresh();
100-
const blocks = peritext.blocks;
101-
const block = blocks.root.children[0]!;
102-
const pairs = [...block.tuples()];
103-
expect(pairs.length).toBe(1);
104-
expect(pairs[0]).toEqual([peritext.overlay.START, peritext.overlay.END]);
105-
});
106-
107-
test('can iterate through all text chunks in two-block documents', () => {
108-
const {peritext} = setupTwoBlockDocument();
109-
expect(peritext.blocks.root.children.length).toBe(2);
110-
const block1 = peritext.blocks.root.children[0]!;
111-
const block2 = peritext.blocks.root.children[1]!;
112-
const tuples1 = [...block1.tuples()];
113-
const tuples2 = [...block2.tuples()];
114-
expect(tuples1.length).toBe(3);
115-
const text1 = tuples1.map(([p1, p2]) => new Inline(peritext, p1, p2, p1, p2).text()).join('');
116-
const text2 = tuples2.map(([p1, p2]) => new Inline(peritext, p1, p2, p1, p2).text()).join('');
117-
expect(text1).toBe('hello ');
118-
expect(text2).toBe('world');
119-
});
120-
});
121-
12296
describe('texts', () => {
12397
test('in markup-less document', () => {
12498
const {peritext} = setupHelloWorldKit();

0 commit comments

Comments
 (0)