@borgar/fx 4.12.0 → 5.0.0

package/lib/parseSRange.js

@@ -1,167 +0,0 @@
-const re_SRcolumnB = /^\[('['#@[\]]|[^'#@[\]])*\]/i;
-const re_SRcolumnN = /^([^#@[\]:]+)/i;
-
-const keyTerms = {
-  'headers': 1,
-  'data': 2,
-  'totals': 4,
-  'all': 8,
-  'this row': 16,
-  '@': 16
-};
-
-const fz = (...a) => Object.freeze(a);
-
-// only combinations allowed are: #data + (#headers | #totals | #data)
-const sectionMap = {
-  // no terms
-  0: fz(),
-  // single term
-  1: fz('headers'),
-  2: fz('data'),
-  4: fz('totals'),
-  8: fz('all'),
-  16: fz('this row'),
-  // headers+data
-  3: fz('headers', 'data'),
-  // totals+data
-  6: fz('data', 'totals')
-};
-
-const matchColumn = (s, allowUnbraced = true) => {
-  let m = re_SRcolumnB.exec(s);
-  if (m) {
-    const value = m[0].slice(1, -1).replace(/'(['#@[\]])/g, '$1');
-    return [ m[0], value ];
-  }
-  if (allowUnbraced) {
-    m = re_SRcolumnN.exec(s);
-    if (m) {
-      return [ m[0], m[0] ];
-    }
-  }
-  return null;
-};
-
-export function parseSRange (raw) {
-  const columns = [];
-  let pos = 0;
-  let s = raw;
-  let m;
-  let m1;
-  let terms = 0;
-
-  // start of structured ref?
-  if ((m = /^(\[\s*)/.exec(s))) {
-    // quickly determine if this is a simple keyword or column
-    // [#keyword]
-    if ((m1 = /^\[#([a-z ]+)\]/i.exec(s))) {
-      const k = m1[1].toLowerCase();
-      pos += m1[0].length;
-      if (keyTerms[k]) {
-        terms |= keyTerms[k];
-      }
-      else {
-        return null;
-      }
-    }
-    // [column]
-    else if ((m1 = matchColumn(s, false))) {
-      pos += m1[0].length;
-      if (m1[1]) {
-        columns.push(m1[1]);
-      }
-    }
-    // use the "normal" method
-    // [[#keyword]]
-    // [[column]]
-    // [@]
-    // [@column]
-    // [@[column]]
-    // [@column:column]
-    // [@column:[column]]
-    // [@[column]:column]
-    // [@[column]:[column]]
-    // [column:column]
-    // [column:[column]]
-    // [[column]:column]
-    // [[column]:[column]]
-    // [[#keyword],column]
-    // [[#keyword],column:column]
-    // [[#keyword],[#keyword],column:column]
-    // ...
-    else {
-      let expect_more = true;
-      s = s.slice(m[1].length);
-      pos += m[1].length;
-      // match keywords as we find them
-      while (
-        expect_more &&
-        (m = /^\[#([a-z ]+)\](\s*,\s*)?/i.exec(s))
-      ) {
-        const k = m[1].toLowerCase();
-        if (keyTerms[k]) {
-          terms |= keyTerms[k];
-          s = s.slice(m[0].length);
-          pos += m[0].length;
-          expect_more = !!m[2];
-        }
-        else {
-          return null;
-        }
-      }
-      // is there an @ specifier?
-      if (expect_more && (m = /^@/.exec(s))) {
-        terms |= keyTerms['@'];
-        s = s.slice(1);
-        pos += 1;
-        expect_more = s[0] !== ']';
-      }
-      // not all keyword terms may be combined
-      if (!(terms in sectionMap)) {
-        return null;
-      }
-      // column definitions
-      const leftCol = expect_more ? matchColumn(raw.slice(pos)) : null;
-      if (leftCol) {
-        pos += leftCol[0].length;
-        columns.push(leftCol[1]);
-        s = raw.slice(pos);
-        if (s[0] === ':') {
-          s = s.slice(1);
-          pos++;
-          const rightCol = matchColumn(s);
-          if (rightCol) {
-            pos += rightCol[0].length;
-            columns.push(rightCol[1]);
-          }
-          else {
-            return null;
-          }
-        }
-        expect_more = false;
-      }
-      // advance ws
-      while (raw[pos] === ' ') {
-        pos++;
-      }
-      // close the ref
-      if (expect_more || raw[pos] !== ']') {
-        return null;
-      }
-      // step over the closing ]
-      pos++;
-    }
-  }
-  else {
-    return null;
-  }
-
-  const sections = sectionMap[terms];
-  return {
-    columns,
-    sections: sections ? sections.concat() : sections,
-    length: pos,
-    token: raw.slice(0, pos)
-  };
-}

package/lib/parseStructRef.js

@@ -1,48 +0,0 @@
-import { parseRef } from './parseRef.js';
-import { parseSRange } from './parseSRange.js';
-
-/**
- * Parse a structured reference string into an object representing it.
- *
- * ```js
- * parseStructRef('workbook.xlsx!tableName[[#Data],[Column1]:[Column2]]');
- * // => {
- * //   context: [ 'workbook.xlsx' ],
- * //   sections: [ 'data' ],
- * //   columns: [ 'my column', '@foo' ],
- * //   table: 'tableName',
- * // }
- * ```
- *
- * For A:A or A1:A style ranges, `null` will be used for any dimensions that the
- * syntax does not specify:
- *
- * @tutorial References.md
- * @param {string} ref  A structured reference string
- * @param {object} [options={}]  Options
- * @param {boolean} [options.xlsx=false]  Switches to the `[1]Sheet1!A1` or `[1]!name` prefix syntax form for external workbooks. See: [Prefixes.md](./Prefixes.md)
- * @returns {(ReferenceStruct|null)} An object representing a valid reference or null if it is invalid.
- */
-export function parseStructRef (ref, options = { xlsx: false }) {
-  const r = parseRef(ref, options);
-  if (r && r.struct) {
-    const structData = parseSRange(r.struct);
-    if (structData && structData.length === r.struct.length) {
-      return options.xlsx
-        ? {
-          workbookName: r.workbookName,
-          sheetName: r.sheetName,
-          table: r.name,
-          columns: structData.columns,
-          sections: structData.sections
-        }
-        : {
-          context: r.context,
-          table: r.name,
-          columns: structData.columns,
-          sections: structData.sections
-        };
-    }
-  }
-  return null;
-}

package/lib/parseStructRef.spec.js

@@ -1,164 +0,0 @@
-/* eslint-disable object-property-newline, object-curly-newline */
-import { test, Test } from 'tape';
-import { parseStructRef } from './parseStructRef.js';
-
-Test.prototype.isSREqual = function isSREqual (expr, expect, opts) {
-  if (expect) {
-    expect = opts?.xlsx
-      ? {
-        workbookName: '',
-        sheetName: '',
-        table: '',
-        columns: [],
-        sections: [],
-        ...expect
-      }
-      : {
-        context: [],
-        table: '',
-        columns: [],
-        sections: [],
-        ...expect
-      };
-  }
-  this.deepEqual(parseStructRef(expr, opts), expect, expr);
-};
-
-test.only('parse structured references', t => {
-  t.isSREqual('table[col]', {
-    table: 'table',
-    columns: [ 'col' ]
-  });
-
-  t.isSREqual('table[]', {
-    table: 'table'
-  });
-
-  t.isSREqual('[#All]', {
-    sections: [ 'all' ]
-  });
-
-  t.isSREqual('[column name]', {
-    columns: [ 'column name' ]
-  });
-
-  t.isSREqual('[column name]!foo', null);
-  t.isSREqual('[foo]bar', null);
-
-  t.isSREqual('[[my column]]', {
-    columns: [ 'my column' ]
-  });
-
-  t.isSREqual('[[my column]:otherColumn]', {
-    columns: [ 'my column', 'otherColumn' ]
-  });
-
-  t.isSREqual('[ [my column]:otherColumn ]', {
-    columns: [ 'my column', 'otherColumn ' ]
-  });
-
-  t.isSREqual('[ [my column]: otherColumn ]', {
-    columns: [ 'my column', ' otherColumn ' ]
-  });
-
-  t.isSREqual('[ @[ my column ]: otherColumn ]', {
-    columns: [ ' my column ', ' otherColumn ' ],
-    sections: [ 'this row' ]
-  });
-
-  t.isSREqual('[[#Data], [my column]:otherColumn]', {
-    columns: [ 'my column', 'otherColumn' ],
-    sections: [ 'data' ]
-  });
-
-  t.isSREqual('[ [#Data], [my column]:[\'@foo] ]', {
-    columns: [ 'my column', '@foo' ],
-    sections: [ 'data' ]
-  });
-
-  t.isSREqual('workbook.xlsx!tableName[ [#Data], [my column]:[\'@foo] ]', {
-    columns: [ 'my column', '@foo' ],
-    sections: [ 'data' ],
-    table: 'tableName',
-    context: [ 'workbook.xlsx' ]
-  });
-
-  t.isSREqual('[[#Data],[#data],[#Data],[#Data],[#Totals],[#Totals],[#Totals],foo]', {
-    columns: [ 'foo' ],
-    sections: [ 'data', 'totals' ]
-  });
-
-  t.isSREqual("'Sheet'!Table[Column]", {
-    columns: [ 'Column' ],
-    table: 'Table',
-    context: [ 'Sheet' ]
-  });
-
-  t.isSREqual("Sheet1!Table1[foo '[bar']]", {
-    columns: [ 'foo [bar]' ],
-    table: 'Table1',
-    context: [ 'Sheet1' ]
-  });
-
-  t.isSREqual('[myworkbook.xlsx]Sheet1!TMP8w0habhr[#All]', {
-    columns: [],
-    table: 'TMP8w0habhr',
-    context: [ 'myworkbook.xlsx', 'Sheet1' ],
-    sections: [ 'all' ]
-  });
-
-  t.end();
-});
-
-test('structured references parse in xlsx mode', t => {
-  t.isSREqual('[Workbook.xlsx]!Table[#Data]', {
-    workbookName: 'Workbook.xlsx',
-    table: 'Table',
-    sections: [ 'data' ]
-  }, { xlsx: true });
-
-  t.isSREqual('[Workbook.xlsx]Sheet1!Table[#Data]', {
-    workbookName: 'Workbook.xlsx',
-    sheetName: 'Sheet1',
-    table: 'Table',
-    sections: [ 'data' ]
-  }, { xlsx: true });
-
-  t.isSREqual('Sheet1!Table[#Data]', {
-    sheetName: 'Sheet1',
-    table: 'Table',
-    sections: [ 'data' ]
-  }, { xlsx: true });
-
-  t.end();
-});
-
-test('longform prase (in xlsx mode)', t => {
-  // thisRow should have no effect when parsing
-  t.isSREqual('Table2[[#This Row],[col1]]', {
-    table: 'Table2',
-    columns: [ 'col1' ],
-    sections: [ 'this row' ]
-  }, { xlsx: true, thisRow: true });
-
-  t.isSREqual('Table2[[#This Row],[col1]]', {
-    table: 'Table2',
-    columns: [ 'col1' ],
-    sections: [ 'this row' ]
-  }, { xlsx: true, thisRow: false });
-
-  t.isSREqual('Table2[[#This Row],[col1]]', {
-    table: 'Table2',
-    columns: [ 'col1' ],
-    sections: [ 'this row' ]
-  }, { xlsx: false, thisRow: true });
-
-  t.isSREqual('Table2[[#This Row],[col1]]', {
-    table: 'Table2',
-    columns: [ 'col1' ],
-    sections: [ 'this row' ]
-  }, { xlsx: false, thisRow: false });
-
-  t.end();
-});
-