proskomma-core 0.9.12 → 0.9.13

package/test/code/main/serialize.cjs

@@ -1,104 +0,0 @@
-const test = require('tape');
-const { Validator } = require('proskomma-json-tools');
-
-const { Proskomma, utils } = require('../../../src/index.cjs');
-const { unpackEnum } = utils.succinct;
-
-const { pkWithDoc } = require('../../lib/load.js');
-
-const testGroup = 'Serialize';
-
-const pk = pkWithDoc('../test_data/usx/web_rut.usx', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-
-const pk3 = pkWithDoc('../test_data/usfm/78-GALspavbl.usfm', {
-  lang: 'spa',
-  abbr: 'vbl',
-})[0];
-
-test(
-  `Serialize WEB RUT (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(4);
-      const query = '{ docSets { id } }';
-      const result = await pk.gqlQuery(query);
-      const docSetId = result.data.docSets[0].id;
-      const serialized = pk.serializeSuccinct(docSetId);
-      t.ok(serialized);
-      const validationReport = new Validator().validate('proskomma',
-        'succinct',
-        '0.2.0',
-        serialized
-      );
-      t.ok(validationReport.isValid);
-      t.equal(validationReport.errors, null);
-      const wordLikes = unpackEnum(pk.docSets[docSetId].enums['wordLike']);
-      t.ok(wordLikes.includes('Ruth'));
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Load WEB RUT (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(11);
-      let query = '{ docSets { id } }';
-      let result = await pk.gqlQuery(query);
-      const docSetId = result.data.docSets[0].id;
-      const serialized = pk.serializeSuccinct(docSetId);
-      // console.log(JSON.stringify(serialized, null, 2));
-      const pk2 = new (Proskomma);
-      pk2.loadSuccinctDocSet(serialized);
-      t.equal(pk2.nDocSets(), 1);
-      t.equal(pk2.nDocuments(), 1);
-      const wordLikes = unpackEnum(pk2.docSets[docSetId].enums['wordLike']);
-      t.ok(wordLikes.includes('Ruth'));
-      query = '{ docSets { id documents { id } } documents { cv(chapter:"1") { text } cv2: cv(chapter:"1" verses:"1") { text } mainSequence { id blocks { text items { type } } } } }';
-      result = await pk2.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSets.length, 1);
-      t.equal(result.data.docSets[0].documents.length, 1);
-      t.equal(result.data.documents.length, 1);
-      t.ok(result.data.documents[0].cv[0].text.startsWith('In the days'));
-      t.ok(result.data.documents[0].cv2[0].text.startsWith('In the days'));
-      const firstBlock = result.data.documents[0].mainSequence.blocks[0];
-      t.ok(firstBlock.text.startsWith('In the days when the judges judged'));
-      t.throws(() => pk2.loadSuccinctDocSet(serialized), /already loaded/);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Load Text with Accents (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(7);
-      let query = '{ docSets { id } }';
-      let result = await pk3.gqlQuery(query);
-      const docSetId = result.data.docSets[0].id;
-      const serialized = pk3.serializeSuccinct(docSetId);
-      const pk2 = new (Proskomma);
-      pk2.loadSuccinctDocSet(serialized);
-      t.equal(pk2.nDocSets(), 1);
-      t.equal(pk2.nDocuments(), 1);
-      const wordLikes = unpackEnum(pk2.docSets[docSetId].enums['wordLike']);
-      t.ok(wordLikes.includes('Gálatas'));
-      query = '{ documents { header(id:"h") headers {key value} } }';
-      result = await pk2.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents.length, 1);
-      t.ok(result.data.documents[0].header === 'Gálatas');
-      t.ok(result.data.documents[0].headers.filter(h => h.key === 'h')[0].value === 'Gálatas');
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/spans.cjs

@@ -1,51 +0,0 @@
-const test = require('tape');
-
-const { pkWithDoc } = require('../../lib/load.js');
-
-const testGroup = 'Spans';
-
-const pk = pkWithDoc('../test_data/usfm/spans.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-
-test(
-  `Spans via Dump (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(4);
-      const query =
-        '{ documents { mainSequence { blocks { dump } } } }';
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const block = result.data.documents[0].mainSequence.blocks[0];
-      t.ok(block.dump.includes('+span/nd+|Lord-span/nd-'));
-      t.ok(block.dump.includes('+span/it++span/bd+|Joel-span/bd-'));
-      t.ok(block.dump.includes('Pethuel-span/it-'));
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Spans via items with context (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(8);
-      const query =
-        `{ documents { mainSequence { blocks { tokens(includeContext:true) { subType payload position scopes } } } } }`;
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const joel = result.data.documents[0].mainSequence.blocks[0].tokens.filter(t => t.payload === 'Joel')[0];
-      t.ok('position' in joel);
-      t.ok('scopes' in joel);
-
-      for (const scope of ['chapter/1', 'verse/1', 'verses/1', 'span/it', 'span/bd']) {
-        t.ok(joel.scopes.includes(scope));
-      }
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/split_long_tokens.cjs

@@ -1,30 +0,0 @@
-const test = require('tape');
-
-const { pkWithDoc } = require('../../lib/load.js');
-
-const testGroup = 'Split Long Tokens';
-
-const pk = pkWithDoc('../test_data/usfm/split_long_tokens.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-
-test(
-  `300-Char Word (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(6);
-      const query = `{ documents { mainSequence { blocks { items {type subType payload} } } } }`;
-      const result = await pk.gqlQuery(query);
-      t.ok('data' in result);
-      const words = result.data.documents[0].mainSequence.blocks[0].items.filter(i => i.subType === 'wordLike');
-      t.equal(words.length, 4);
-      t.equal(words[0].payload.length, 127);
-      t.equal(words[1].payload.length, 127);
-      t.equal(words[2].payload.length, 46);
-      t.equal(words[3].payload.length, 3);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/standard_vrs.cjs

@@ -1,76 +0,0 @@
-const test = require('tape');
-
-const testGroup = 'Standard VRS';
-
-const { Proskomma } = require('../../../src/index.cjs');
-
-const pk = new Proskomma();
-
-test(
-  `versifications (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(3);
-      let query = '{versifications { id } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const versifications = result.data.versifications;
-      t.equal(versifications.length, 6);
-      t.equal(versifications.filter(v => v.id === 'eng').length, 1);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `raw vrs (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(3);
-      let query = '{versification(id: "eng") { id vrs } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const versification = result.data.versification;
-      t.equal(versification.id, 'eng');
-      t.ok(versification.vrs.includes('English'));
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `cvBooks (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(2);
-      let query = '{versification(id: "eng") { cvBooks { bookCode } } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const cvBooks = result.data.versification.cvBooks;
-      t.equal(cvBooks.filter(b => b.bookCode === 'TIT').length, 1);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `cvBook details (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(5);
-      let query = '{versification(id: "eng") { cvBook(bookCode: "TIT") { bookCode chapters { chapter maxVerse } } } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const cvBook = result.data.versification.cvBook;
-      t.equal(cvBook.bookCode, 'TIT');
-      t.equal(cvBook.chapters.length, 3);
-      t.equal(cvBook.chapters[0].chapter, 1);
-      t.equal(cvBook.chapters[0].maxVerse, 16);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/subclass.cjs

@@ -1,25 +0,0 @@
-const test = require('tape');
-const { Proskomma } = require('../../../src/index.cjs');
-
-const testGroup = 'Subclass test';
-
-test(
-  `Creating a subclass from lib (${testGroup})`,
-  function (t) {
-    try {
-      t.plan(1);
-      t.doesNotThrow(() => {
-        class SubClassProskomma extends Proskomma {
-          constructor() {
-            super();
-            this.test = 'test';
-          }
-        }
-        const sbClass = new SubClassProskomma();
-        sbClass.test = 'othertest';
-      });
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/table.cjs

@@ -1,119 +0,0 @@
-const test = require('tape');
-
-const { pkWithDoc } = require('../../lib/load.js');
-
-const testGroup = 'Tables';
-
-const pk = pkWithDoc('../test_data/usx/table.usx', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-const pk2 = pkWithDoc('../test_data/usfm/table.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-const pk3 = pkWithDoc('../test_data/usfm/table_at_end.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-const pk4 = pkWithDoc('../test_data/usfm/table_no_end_cells.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-
-const pk5 = pkWithDoc('../test_data/usfm/table_in_intro.usfm', {
-  lang: 'fra',
-  abbr: 'hello',
-})[0];
-
-const checkResult = (t, result) => {
-  const blocks = result.data.documents[0].mainSequence.blocks;
-  t.equal(blocks.length, 6);
-  t.equal(blocks[0].bs.payload, 'blockTag/p');
-  t.false(blocks[0].scopeLabels.includes('table'));
-  t.equal(blocks[1].bs.payload, 'blockTag/tr');
-  t.ok(blocks[1].scopeLabels.includes('cell/body/left/2'));
-  t.ok(blocks[1].scopeLabels.includes('table'));
-  t.ok(blocks[2].scopeLabels.includes('cell/body/left/1'));
-  t.ok(blocks[2].scopeLabels.includes('cell/body/right/1'));
-  t.equal(blocks[5].bs.payload, 'blockTag/p');
-  t.false(blocks[5].scopeLabels.includes('table'));
-};
-
-const query = `{ documents { sequences { id nBlocks } mainSequence { blocks { scopeLabels bs { payload } bg { subType payload } text items { type subType payload } } } } }`;
-
-test(
-  `USX (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(11);
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      checkResult(t, result);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `USFM (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(11);
-      const result = await pk2.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      checkResult(t, result);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `USFM in intro (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(4);
-      const result = await pk5.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const mainSequence = result.data.documents[0].mainSequence;
-      t.equal(mainSequence.blocks.length, 1);
-      const firstMainBlock = mainSequence.blocks[0];
-      t.equal(firstMainBlock.text, 'First verse!');
-      const introId = firstMainBlock.bg.filter(g => g.subType === 'introduction')[0].payload;
-      t.equal(result.data.documents[0].sequences.filter(s => s.id === introId)[0].nBlocks, 6);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `USFM no cell end tags (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(11);
-      const result = await pk4.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      checkResult(t, result);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `USFM Table at End of Doc (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(2);
-      const result = await pk3.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const lastBlockItems = result.data.documents[0].mainSequence.blocks[2].items;
-      t.equal(lastBlockItems.filter(i => i.subType === 'end' && i.payload === 'table').length, 1);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);

package/test/code/main/tags.cjs

@@ -1,248 +0,0 @@
-const test = require('tape');
-const { utils } = require('../../../src/index.cjs');
-const { validateTags } = utils.tags;
-const { pkWithDoc } = require('../../lib/load.js');
-
-const pk = pkWithDoc('../test_data/usx/web_rut.usx', {
-  lang: 'eng',
-  abbr: 'web',
-}, {}, {}, [], ['frob', 'frob2'])[0];
-pk.docSetList()[0].tags.add('foo');
-pk.docSetList()[0].tags.add('foo2');
-const document = Object.values(pk.documents)[0];
-document.sequences[document.mainId].tags.add('banana');
-document.sequences[document.mainId].tags.add('split');
-
-const testGroup = 'Graph Tags';
-
-test(
-  `DocSet accessors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(5);
-      const query = '{ docSets { tags hasFoo: hasTag(tagName:"foo") hasBaa: hasTag(tagName:"baa")} }';
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const docSet = result.data.docSets[0];
-      t.equal(docSet.tags.length, 2);
-      t.ok(docSet.tags.includes('foo'));
-      t.ok(docSet.hasFoo);
-      t.false(docSet.hasBaa);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `DocSet selectors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(8);
-      let query = '{ docSets(withTags:"foo" withoutTags:"oof") { id } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSets.length, 1);
-      query = '{ docSets(withTags:["foo" "foo2"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSets.length, 1);
-      query = '{ docSets(withTags:["foo" "oof"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSets.length, 0);
-      query = '{ docSets(withoutTags:["foo" "oof"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSets.length, 0);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Document accessors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(5);
-      const query = '{ docSets { documents { tags hasFrob: hasTag(tagName:"frob") hasBrof: hasTag(tagName:"brof")} } }';
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const document = result.data.docSets[0].documents[0];
-      t.equal(document.tags.length, 2);
-      t.ok(document.tags.includes('frob'));
-      t.ok(document.hasFrob);
-      t.false(document.hasBrof);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Root-level Document selectors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(8);
-      let query = '{ documents(withTags:"frob" withoutTags:"brof") { id } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents.length, 1);
-      query = '{ documents(withTags:["frob" "frob2"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents.length, 1);
-      query = '{ documents(withTags:["frob" "brof"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents.length, 0);
-      query = '{ documents(withoutTags:["frob" "brof"]) { id } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents.length, 0);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Document in docSet selectors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(8);
-      let query = '{ docSet(id:"eng_web") { documents(withTags:"frob" withoutTags:"brof") { id } } }';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSet.documents.length, 1);
-      query = '{ docSet(id:"eng_web") { documents(withTags:["frob" "frob2"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSet.documents.length, 1);
-      query = '{ docSet(id:"eng_web") { documents(withTags:["frob" "brof"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSet.documents.length, 0);
-      query = '{ docSet(id:"eng_web") { documents(withoutTags:["frob" "brof"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.docSet.documents.length, 0);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Sequence accessors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(5);
-      const query = '{ docSets { documents { mainSequence { tags hasBanana: hasTag(tagName:"banana") hasApple: hasTag(tagName:"apple") } } } }';
-      const result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      const sequence = result.data.docSets[0].documents[0].mainSequence;
-      t.equal(sequence.tags.length, 2);
-      t.ok(sequence.tags.includes('banana'));
-      t.ok(sequence.hasBanana);
-      t.false(sequence.hasApple);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Sequence selectors (${testGroup})`,
-  async function (t) {
-    try {
-      t.plan(8);
-      let query = '{ documents { sequences(withTags:"banana" withoutTags:"melba") { id } } } ';
-      let result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents[0].sequences.length, 1);
-      query = '{ documents { sequences(withTags: ["banana" "split"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents[0].sequences.length, 1);
-      query = '{ documents { sequences(withTags: ["banana" "melba"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents[0].sequences.length, 0);
-      query = '{ documents { sequences(withTags:"banana" withoutTags: ["peach" "split"]) { id } } }';
-      result = await pk.gqlQuery(query);
-      t.equal(result.errors, undefined);
-      t.equal(result.data.documents[0].sequences.length, 0);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Throw on bad tag format (${testGroup})`,
-  // Destructive!
-  function (t) {
-    try {
-      t.plan(2);
-      const importFn = () =>
-        pkWithDoc('../test_data/usx/web_rut.usx', {
-          lang: 'eng',
-          abbr: 'ust',
-        }, {}, {}, [], ['FROB']);
-      t.throws(importFn, /Tag 'FROB' is not valid/);
-      const addTagFn = () => {
-        pk.docSetList()[0].tags.add('FROB');
-        validateTags(pk.docSetList()[0].tags);
-      };
-      t.throws(addTagFn, /Tag 'FROB' is not valid/);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `Support colon tag format (${testGroup})`,
-  // Destructive!
-  function (t) {
-    try {
-      t.plan(2);
-      const importFn = () =>
-        pkWithDoc('../test_data/usx/web_rut.usx', {
-          lang: 'eng',
-          abbr: 'ust',
-        }, {}, {}, [], ['FROB']);
-      t.throws(importFn, /Tag 'FROB' is not valid/);
-      const addTagFn = () => {
-        pk.docSetList()[0].tags.delete('FROB');
-        pk.docSetList()[0].tags.add('frob:Fooie!! §');
-        validateTags(pk.docSetList()[0].tags);
-      };
-      t.doesNotThrow(addTagFn);
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);
-
-test(
-  `tagsKv on docSet (${testGroup})`,
-  // Relies on destructive tests above
-  function (t) {
-    try {
-      t.plan(5);
-      pk.docSetList()[0].tags.add('baa');
-      const result = pk.gqlQuerySync('{ docSets { tagsKv { key value } } }');
-      t.equal(result.errors, undefined);
-      const tagsKv = result.data.docSets[0].tagsKv;
-      t.equal(tagsKv.filter(kv => kv.key === 'baa').length, 1);
-      t.equal(tagsKv.filter(kv => kv.key === 'frob').length, 1);
-      t.equal(tagsKv.filter(kv => kv.key === 'baa')[0].value, '');
-      t.ok(tagsKv.filter(kv => kv.key === 'frob')[0].value.startsWith('Fooie'));
-    } catch (err) {
-      console.log(err);
-    }
-  },
-);