proskomma-core 0.9.7 → 0.9.12

package/test/code/main/blocks_with_atts.cjs

@@ -0,0 +1,150 @@
+const test = require('tape');
+
+const { pkWithDoc } = require('../../lib/load.js');
+
+const testGroup = 'Blocks with Atts';
+
+const pk = pkWithDoc('../test_data/usfm/1pe_webbe.usfm', {
+  lang: 'eng',
+  abbr: 'hello',
+})[0];
+
+test(
+  `attSpecs +  !attValues (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"1PE") {' +
+        '    mainSequence {' +
+        '      blocks(' +
+        '        attSpecs: [[{attType:"spanWithAtts", tagName:"w", attKey:"strongs", valueN:0}]]' +
+        '      ) {' +
+        '        cBL' +
+        '        }' +
+        '      }' +
+        '    }' +
+        '  }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors.length, 1);
+      t.ok(result.errors[0].message.includes('Cannot specify attSpecs without attValues'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `!attSpecs +  attValues (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"1PE") {' +
+        '    mainSequence {' +
+        '      blocks(' +
+        '        attValues:[["H5662"]]' +
+        '      ) {' +
+        '        cBL' +
+        '        }' +
+        '      }' +
+        '    }' +
+        '  }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors.length, 1);
+      t.ok(result.errors[0].message.includes('Cannot specify attValues without attSpecs'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Filter by att (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"1PE") {' +
+        '    mainSequence {' +
+        '      blocks(' +
+        '        attSpecs: [[{attType:"spanWithAtts", tagName:"w", attKey:"strong", valueN:0}]]' +
+        '        attValues:[["G2587"]]' +
+        '      ) {' +
+        '        cBL' +
+        '        }' +
+        '      }' +
+        '    }' +
+        '  }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      t.equal(result.data.docSets[0].document.mainSequence.blocks.length, 1);
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Any matching att (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"1PE") {' +
+        '    mainSequence {' +
+        '      blocks(' +
+        '        attSpecs: [' +
+        '          [{attType:"spanWithAtts", tagName:"w", attKey:"strong", valueN:0}],' +
+        '          [{attType:"spanWithAtts", tagName:"w", attKey:"strong", valueN:0}]' +
+        '        ]' +
+        '        attValues:[["G2587"], ["G2962"]]' +
+        '      ) {' +
+        '        cBL' +
+        '        }' +
+        '      }' +
+        '    }' +
+        '  }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      t.equal(result.data.docSets[0].document.mainSequence.blocks.length, 2);
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `All matching atts (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"1PE") {' +
+        '    mainSequence {' +
+        '      blocks(' +
+        '        attSpecs: [' +
+        '          [{attType:"spanWithAtts", tagName:"w", attKey:"strong", valueN:0}],' +
+        '          [{attType:"spanWithAtts", tagName:"w", attKey:"strong", valueN:0}]' +
+        '        ]' +
+        '        attValues:[["G2532", "G9999"], ["G1519", "G0000"]]' +
+        '        allAtts:true' +
+        '      ) {' +
+        '        cBL' +
+        '        }' +
+        '      }' +
+        '    }' +
+        '  }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      t.equal(result.data.docSets[0].document.mainSequence.blocks.length, 1);
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);

package/test/code/main/blocks_with_cv.cjs

@@ -0,0 +1,250 @@
+const test = require('tape');
+
+const { pkWithDoc } = require('../../lib/load.js');
+
+const testGroup = 'Blocks with CV';
+
+const pk = pkWithDoc('../test_data/usx/web_rut.usx', {
+  lang: 'fra',
+  abbr: 'hello',
+})[0];
+
+const pk2 = pkWithDoc('../test_data/usx/web_psa_40_60.usx', {
+  lang: 'eng',
+  abbr: 'web',
+})[0];
+
+test(
+  `Bad bookScope (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '     mainSequence { blocks(withScriptureCV:2) { cBL } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors.length, 1);
+      t.equal(result.errors.filter(e => e.message.includes('cannot represent a non string value: 2')).length, 1);
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `bookScope + withScopes (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"2" withScopes:[]) { cBL } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors.length, 1);
+      t.ok(result.errors[0].message.includes('Cannot specify both withScopes and withScriptureCV'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `One chapter (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"2") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('Naomi had a relative of her husband'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('lived with her mother-in-law.'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Chapter range (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"1-3") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('In the days when the judges judged'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('until he has settled this today.”'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Reverse chapter range (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"3-1") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors.length, 1);
+      t.ok(result.errors[0].message.includes('Chapter range must be from min to max'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `One verse (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"1:14") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('They lifted up their voices'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('Follow your sister-in-law.”'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Verse zero (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"PSA") {' +
+        '      mainSequence { blocks(withScriptureCV:"51:0") { text } } } }' +
+        '}';
+      const result = await pk2.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('For the Chief'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('Bathsheba.'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Verse range (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"1:10-13") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('Then she kissed them'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('hand has gone out against me.”'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Verse range from zero (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"PSA") {' +
+        '      mainSequence { blocks(withScriptureCV:"51:0-1") { text } } } }' +
+        '}';
+      const result = await pk2.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('For the Chief'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('transgressions.'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Chapter/verse range (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"RUT") {' +
+        '      mainSequence { blocks(withScriptureCV:"1:22-3:4") { text } } } }' +
+        '}';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('She said to them,'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('Then he will tell you what to do.”'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Chapter/verse range to verse 0 (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"PSA") {' +
+        '      mainSequence { blocks(withScriptureCV:"50:23-51:0") { text } } } }' +
+        '}';
+      const result = await pk2.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('Whoever offers'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('Bathsheba.'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Chapter/verse range from verse 0 (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query =
+        '{ docSets { document(bookCode:"PSA") {' +
+        '      mainSequence { blocks(withScriptureCV:"51:0-52:1") { text } } } }' +
+        '}';
+      const result = await pk2.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const blocks = result.data.docSets[0].document.mainSequence.blocks;
+      t.ok(blocks[0].text.startsWith('For the Chief'));
+      t.ok(blocks[blocks.length - 1].text.endsWith('continually.'));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+

package/test/code/main/break.cjs

@@ -0,0 +1,73 @@
+const test = require('tape');
+
+const { pkWithDoc } = require('../../lib/load.js');
+
+const testGroup = 'Lexing Breaks';
+
+const pk = pkWithDoc('../test_data/usfm/no_break_space.usfm', {
+  lang: 'fra',
+  abbr: 'hello',
+})[0];
+const pk2 = pkWithDoc('../test_data/usfm/soft_line_break.usfm', {
+  lang: 'fra',
+  abbr: 'hello',
+})[0];
+const pk3 = pkWithDoc('../test_data/usx/opt_break.usx', {
+  lang: 'fra',
+  abbr: 'hello',
+})[0];
+
+test(
+  `NBSP (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query = `{ documents { mainSequence { blocks { items {type subType payload} } } } }`;
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const secondItem = result.data.documents[0].mainSequence.blocks[0].items[1];
+      t.equal(secondItem.subType, 'lineSpace');
+      t.equal(secondItem.payload, '\xa0');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Soft line break with USFM (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const query = `{ documents { mainSequence { blocks { items {type subType payload} } } } }`;
+      const result = await pk2.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const secondItem = result.data.documents[0].mainSequence.blocks[0].items[1];
+      t.equal(secondItem.subType, 'softLineBreak');
+      t.equal(secondItem.payload, '//');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Soft line break with USX (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(5);
+      const query = `{ documents { sequences { type blocks { items {type subType payload} } } } }`;
+      const result = await pk3.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const sequences = result.data.documents[0].sequences;
+      const headingSequence = sequences.filter(s => s.type === 'heading')[0];
+      t.equal(headingSequence.blocks[0].items[3].subType, 'softLineBreak');
+      t.equal(headingSequence.blocks[0].items[3].payload, '//');
+      const titleSequence = sequences.filter(s => s.type === 'title')[0];
+      t.equal(titleSequence.blocks[0].items[3].subType, 'softLineBreak');
+      t.equal(titleSequence.blocks[0].items[3].payload, '//');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);

package/test/code/main/checksum.cjs

@@ -0,0 +1,36 @@
+const test = require('tape');
+
+const { pkWithDocs } = require('../../lib/load.js');
+
+const testGroup = 'Checksum';
+
+test(
+  `4 docs in 3 docSets (${testGroup})`,
+  function (t) {
+    try {
+      t.plan(1);
+      const pk = pkWithDocs([
+        ['../test_data/usx/web_psa150.usx', {
+          lang: 'eng',
+          abbr: 'webbe',
+        }],
+        ['../test_data/usx/web_rut.usx', {
+          lang: 'eng',
+          abbr: 'webbe',
+        }],
+        ['../test_data/usfm/ust_psa.usfm', {
+          lang: 'eng',
+          abbr: 'ust',
+        }],
+        ['../test_data/usx/not_nfc18_phm.usx', {
+          lang: 'eng',
+          abbr: 'nnfc18',
+        }],
+      ]);
+      const cs = pk.checksum();
+      t.ok(cs);
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);

package/test/code/main/cl_global.cjs

@@ -0,0 +1,35 @@
+const test = require('tape');
+
+const { pkWithDoc } = require('../../lib/load.js');
+
+const testGroup = 'Global CL';
+
+const [pk] = pkWithDoc('../test_data/usfm/cl.usfm', {
+  lang: 'eng',
+  abbr: 'ult',
+});
+
+test(
+  `Global CL (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(5);
+      const query = '{ documents { headers { key value } sequences { type blocks { text } } } }';
+      const result = await pk.gqlQuery(query);
+      t.equal(result.errors, undefined);
+      const titleSequence = result.data.documents[0].sequences.filter(s => s.type === 'title')[0];
+      t.equal(titleSequence.blocks.length, 1);
+      t.equal(titleSequence.blocks[0].text, 'Psalms');
+      const headersArray = result.data.documents[0].headers;
+      const headers = {};
+
+      for (const header of headersArray) {
+        headers[header.key] = header.value;
+      }
+      t.ok('cl' in headers);
+      t.equal(headers.cl, 'Psalm');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);

package/test/code/main/class_for_fragment.cjs

@@ -0,0 +1,18 @@
+/* eslint-disable require-await */
+const test = require('tape');
+const { preTokenClassForFragment } = require('../../../src/parser/lexers/object_for_fragment.cjs');
+const { lexingRegexes } = require('../../../src/parser/lexers/lexingRegexes.cjs');
+
+const testGroup = 'Class for Fragment';
+
+test(
+  `Exception (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(1);
+      t.throws(() => preTokenClassForFragment('', lexingRegexes));
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);

package/test/code/main/clean_usfm.cjs

@@ -0,0 +1,46 @@
+/* eslint-disable require-await */
+const path = require('path');
+const test = require('tape');
+const fse = require('fs-extra');
+const { Proskomma } = require('../../../src/index.cjs');
+
+const testGroup = 'cleanUSFM';
+
+test(
+  `Remove chapters (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(2);
+      const pk = new Proskomma();
+      let fp = '../../test_data/usfm/frt.usfm';
+      let content = fse.readFileSync(path.resolve(__dirname, fp));
+      let cleanedLines = pk.cleanUsfm(content, { remove: ['\\c'] })
+        .split('\n')
+        .filter(l => l.length > 0);
+      t.equal(cleanedLines.length, 4);
+      t.equal(cleanedLines[1], '\\mt1 USFM');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);
+
+test(
+  `Keep chapters (${testGroup})`,
+  async function (t) {
+    try {
+      t.plan(3);
+      const pk = new Proskomma();
+      let fp = '../../test_data/usfm/frt.usfm';
+      let content = fse.readFileSync(path.resolve(__dirname, fp));
+      let cleanedLines = pk.cleanUsfm(content)
+        .split('\n')
+        .filter(l => l.length > 0);
+      t.equal(cleanedLines.length, 5);
+      t.equal(cleanedLines[1], '\\mt1 USFM');
+      t.equal(cleanedLines[3], '\\c 1');
+    } catch (err) {
+      console.log(err);
+    }
+  },
+);