Skip to content

Commit

Permalink
Merge pull request #641 from streamich/peritext-blocks-testing
Browse files Browse the repository at this point in the history 
Peritext `Blocks` extensive testing
  • Loading branch information
@streamich
streamich authored Jun 12, 2024
2 parents 5c65d37 + 6e2ce3d commit 5059463
Show file tree
Hide file tree
Showing 7 changed files with 526 additions and 7 deletions.
280 changes: 280 additions & 0 deletions src/json-crdt-extensions/peritext/__tests__/Peritext.render-inline.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,280 @@
import {render} from './render';
import {
Kit,
setupNumbersKit,
setupNumbersWithMultipleChunksAndDeletesKit,
setupNumbersWithRgaSplitKit,
setupNumbersWithTombstonesKit,
setupNumbersWithTwoChunksKit,
} from './setup';

const runTests = (_setup: () => Kit) => {
const setup = () => {
const kit = _setup();
const view = () => {
kit.peritext.editor.delCursors();
kit.peritext.refresh();
return render(kit.peritext.blocks.root);
};
return {...kit, view};
};

test('renders plain text', () => {
const {view} = setup();
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0123456789" { }
"
`);
});

test('can annotate beginning of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(0, 3);
editor.saved.insOverwrite('BOLD');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"" { }
"012" { BOLD = [ 1, 3 ] }
"3456789" { }
"
`);
});

test('can annotate middle of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(3, 3);
editor.saved.insOverwrite('BOLD');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"012" { }
"345" { BOLD = [ 1, 3 ] }
"6789" { }
"
`);
});

test('can annotate end of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(7, 3);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0123456" { }
"789" { ITALIC = [ 1, 3 ] }
"" { }
"
`);
});

test('can annotate two regions', () => {
const {editor, view} = setup();
editor.cursor.setAt(1, 2);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(5, 3);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0" { }
"12" { BOLD = [ 1, 3 ] }
"34" { }
"567" { ITALIC = [ 1, 3 ] }
"89" { }
"
`);
});

test('can annotate two adjacent regions', () => {
const {editor, view} = setup();
editor.cursor.setAt(0, 2);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(2, 3);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"" { }
"01" { BOLD = [ 1, 3 ] }
"" { }
"234" { ITALIC = [ 1, 3 ] }
"56789" { }
"
`);
});

test('can annotate two adjacent regions at the end of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(5, 2);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(7, 3);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"01234" { }
"56" { BOLD = [ 1, 3 ] }
"" { }
"789" { ITALIC = [ 1, 3 ] }
"" { }
"
`);
});

test('can annotate overlapping regions at the beginning of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(0, 2);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(1, 2);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"" { }
"0" { BOLD = [ 1, 1 ] }
"1" { BOLD = [ 1, 2 ], ITALIC = [ 1, 1 ] }
"2" { ITALIC = [ 1, 2 ] }
"3456789" { }
"
`);
});

test('can annotate overlapping regions in the middle of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(4, 2);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(5, 2);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0123" { }
"4" { BOLD = [ 1, 1 ] }
"5" { BOLD = [ 1, 2 ], ITALIC = [ 1, 1 ] }
"6" { ITALIC = [ 1, 2 ] }
"789" { }
"
`);
});

test('can annotate a contained region at the beginning of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(0, 5);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(1, 2);
editor.saved.insOverwrite('ITALIC');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"" { }
"0" { BOLD = [ 1, 1 ] }
"12" { BOLD = [ 1, 0 ], ITALIC = [ 1, 3 ] }
"34" { BOLD = [ 1, 2 ] }
"56789" { }
"
`);
});

test('can annotate twice contained region in the middle of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(4, 5);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(5, 3);
editor.saved.insOverwrite('ITALIC');
editor.cursor.setAt(6, 1);
editor.saved.insOverwrite('UNDERLINE');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0123" { }
"4" { BOLD = [ 1, 1 ] }
"5" { BOLD = [ 1, 0 ], ITALIC = [ 1, 1 ] }
"6" { BOLD = [ 1, 0 ], ITALIC = [ 1, 0 ], UNDERLINE = [ 1, 3 ] }
"7" { BOLD = [ 1, 0 ], ITALIC = [ 1, 2 ] }
"8" { BOLD = [ 1, 2 ] }
"9" { }
"
`);
});

test('can annotate twice contained region at the end of text', () => {
const {editor, view} = setup();
editor.cursor.setAt(5, 5);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(6, 3);
editor.saved.insOverwrite('ITALIC');
editor.cursor.setAt(7, 1);
editor.saved.insOverwrite('UNDERLINE');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"01234" { }
"5" { BOLD = [ 1, 1 ] }
"6" { BOLD = [ 1, 0 ], ITALIC = [ 1, 1 ] }
"7" { BOLD = [ 1, 0 ], ITALIC = [ 1, 0 ], UNDERLINE = [ 1, 3 ] }
"8" { BOLD = [ 1, 0 ], ITALIC = [ 1, 2 ] }
"9" { BOLD = [ 1, 2 ] }
"" { }
"
`);
});

test('can annotate three intermingled regions', () => {
const {editor, view} = setup();
editor.cursor.setAt(2, 6);
editor.saved.insOverwrite('BOLD');
editor.cursor.setAt(1, 5);
editor.saved.insOverwrite('ITALIC');
editor.cursor.setAt(4, 5);
editor.saved.insOverwrite('UNDERLINE');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"0" { }
"1" { ITALIC = [ 1, 1 ] }
"23" { BOLD = [ 1, 1 ], ITALIC = [ 1, 0 ] }
"45" { BOLD = [ 1, 0 ], ITALIC = [ 1, 2 ], UNDERLINE = [ 1, 1 ] }
"67" { BOLD = [ 1, 2 ], UNDERLINE = [ 1, 0 ] }
"8" { UNDERLINE = [ 1, 2 ] }
"9" { }
"
`);
});

test('can insert zero length slice', () => {
const {editor, view} = setup();
editor.cursor.setAt(2, 0);
editor.saved.insOverwrite('CURSOR');
expect(view()).toMatchInlineSnapshot(`
"<>
<0>
"01" { }
"23456789" { CURSOR = [ 1, 4 ] }
"
`);
});
};

describe('numbers "0123456789", no edits', () => {
runTests(setupNumbersKit);
});

describe('numbers "0123456789", with default schema and tombstones', () => {
runTests(setupNumbersWithTombstonesKit);
});

describe('numbers "0123456789", two RGA chunks', () => {
runTests(setupNumbersWithTwoChunksKit);
});

describe('numbers "0123456789", with RGA split', () => {
runTests(setupNumbersWithRgaSplitKit);
});

describe('numbers "0123456789", with multiple deletes', () => {
runTests(setupNumbersWithMultipleChunksAndDeletesKit);
});
100 changes: 98 additions & 2 deletions src/json-crdt-extensions/peritext/__tests__/setup.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const setupNumbersKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, '0123456789');
if (str.view() !== '0123456789') throw new Error('Invalid text');
if (str.view() !== '0123456789') throw new Error('Invalid text: ' + str.view());
});
};

Expand Down Expand Up @@ -98,8 +98,104 @@ export const setupNumbersWithTombstonesKit = (sid?: number): Kit => {
str.ins(2, 'x234');
str.del(2, 1);
str.del(10, 3);
if (str.view() !== '0123456789') throw new Error('Invalid text');
if (str.view() !== '0123456789') throw new Error('Invalid text: ' + str.view());
},
sid,
);
};

/**
* Creates a Peritext instance with text "0123456789", two RGA chunks.
*/
export const setupNumbersWithTwoChunksKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, '56789');
str.ins(0, '01234');
if (str.view() !== '0123456789') throw new Error('Invalid text: ' + str.view());
});
};

/**
* Creates a Peritext instance with text "0123456789", with RGA chunks split.
*/
export const setupNumbersWithRgaSplitKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, '012389');
str.ins(4, '4567');
if (str.view() !== '0123456789') throw new Error('Invalid text: ' + str.view());
});
};

/**
* Creates a Peritext instance with text "0123456789", with multiple chunks and deletes.
*/
export const setupNumbersWithMultipleChunksAndDeletesKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, '0');
str.ins(1, '1');
str.ins(2, '2xyz3');
str.del(3, 3);
str.ins(4, '4589');
str.ins(6, '67');
str.ins(8, 'cool worlds');
str.del(8, 11);
if (str.view() !== '0123456789') throw new Error('Invalid text: ' + str.view());
});
};

/**
* Creates a Peritext instance with text "abcdefghijklmnopqrstuvwxyz", no edits.
*/
export const setupAlphabetKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, 'abcdefghijklmnopqrstuvwxyz');
if (str.view() !== 'abcdefghijklmnopqrstuvwxyz') throw new Error('Invalid text');
});
};

/**
* Creates a Peritext instance with text "abcdefghijklmnopqrstuvwxyz", two text chunks.
*/
export const setupAlphabetWithTwoChunksKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, 'lmnopqrstuvwxyz');
str.ins(0, 'abcdefghijk');
if (str.view() !== 'abcdefghijklmnopqrstuvwxyz') throw new Error('Invalid text');
});
};

/**
* Creates a Peritext instance with text "abcdefghijklmnopqrstuvwxyz", with RGA chunks split.
*/
export const setupAlphabetChunkSplitKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, 'lmnwxyz');
str.ins(3, 'opqrstuv');
str.ins(0, 'abcdefghijk');
if (str.view() !== 'abcdefghijklmnopqrstuvwxyz') throw new Error('Invalid text');
});
};

/**
* Creates a Peritext instance with text "abcdefghijklmnopqrstuvwxyz", with RGA deletes.
*/
export const setupAlphabetWithDeletesKit = (): Kit => {
return setupKit('', (model) => {
const str = model.s.text.toExt().text();
str.ins(0, 'lmXXXnwYxyz');
str.del(2, 3);
str.ins(3, 'opqrstuv');
str.del(12, 1);
str.ins(0, 'ab1c3defghijk4444');
str.del(2, 1);
str.del(3, 1);
str.del(11, 4);
if (str.view() !== 'abcdefghijklmnopqrstuvwxyz') throw new Error('Invalid text');
});
};
Loading

0 comments on commit 5059463

Please sign in to comment.