@borgar/fx 2.1.1 → 3.0.0

package/lib/translate.js

@@ -1,48 +1,36 @@
-import { RANGE, RANGE_BEAM, MAX_ROWS, MAX_COLS } from './constants.js';
+import { MAX_ROWS, MAX_COLS } from './constants.js';
 import { fromA1, toA1 } from './a1.js';
 import { fromRC, toRC } from './rc.js';
 import { tokenize } from './lexer.js';
+import { isRange } from './isType.js';
+
+const calc = (abs, vX, aX) => {
+  if (vX == null) {
+    return null;
+  }
+  return abs ? vX : vX - aX;
+};
 
 export function translateToRC (fx, anchorCell) {
   const { top, left } = fromA1(anchorCell);
   const isString = typeof fx === 'string';
 
   const tokens = isString
-    ? tokenize(fx, { emitRanges: false, mergeRanges: false, r1c2: false })
+    ? tokenize(fx, { emitRanges: false, mergeRanges: false, allowTernary: true, r1c2: false })
     : fx;
 
   tokens.forEach(token => {
-    if (token.type === RANGE) {
-      const range = {};
-      const d = fromA1(token.value);
-
-      range.r0 = d.$top ? d.top : d.top - top;
-      range.$r0 = d.$top;
-      range.r1 = d.$bottom ? d.bottom : d.bottom - top;
-      range.$r1 = d.$bottom;
-
-      range.c0 = d.$left ? d.left : d.left - left;
-      range.$c0 = d.$left;
-      range.c1 = d.$right ? d.right : d.right - left;
-      range.$c1 = d.$right;
-
-      // console.error(token.value, d, range, [ top, left ]);
-      token.value = toRC(range);
-    }
-    else if (token.type === RANGE_BEAM) {
+    if (isRange(token)) {
       const range = {};
       const d = fromA1(token.value);
-
-      range.r0 = d.$top ? d.top : d.top - top;
+      range.r0 = calc(d.$top, d.top, top);
       range.$r0 = d.$top;
-      range.r1 = d.$bottom ? d.bottom : d.bottom - top;
+      range.r1 = calc(d.$bottom, d.bottom, top);
       range.$r1 = d.$bottom;
-
-      range.c0 = d.$left ? d.left : d.left - left;
+      range.c0 = calc(d.$left, d.left, left);
       range.$c0 = d.$left;
-      range.c1 = d.$right ? d.right : d.right - left;
+      range.c1 = calc(d.$right, d.right, left);
       range.$c1 = d.$right;
-
       token.value = toRC(range);
     }
   });
@@ -54,11 +42,11 @@ export function translateToRC (fx, anchorCell) {
 
 function toFixed (val, abs, base, max) {
   let v = val;
-  if (!abs) {
+  if (v != null && !abs) {
     v = base + val;
     // Excel "wraps around" when value goes out of lower bounds.
-    // It's a bit quirky on entry as Excel wants to re-rewite the
-    // references but behaviour is consistent with INDIRECT:
+    // It's a bit quirky on entry as Excel _really wants_ to re-rewite the
+    // references but the behaviour is consistent with INDIRECT:
     // ... In A1: RC[-1] => R1C[16383].
     if (v < 0) {
       v = max + v + 1;
@@ -76,11 +64,11 @@ export function translateToA1 (fx, anchorCell) {
   const isString = typeof fx === 'string';
 
   const tokens = isString
-    ? tokenize(fx, { emitRanges: false, mergeRanges: false, r1c1: true })
+    ? tokenize(fx, { emitRanges: false, mergeRanges: false, allowTernary: true, r1c1: true })
     : fx;
 
   tokens.forEach(token => {
-    if (token.type === RANGE || token.type === RANGE_BEAM) {
+    if (isRange(token)) {
       const range = {};
       const d = fromRC(token.value);
       const r0 = toFixed(d.r0, d.$r0, anchor.top, MAX_ROWS);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@borgar/fx",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "Utilities for working with Excel formulas",
   "main": "dist/fx.js",
   "module": "lib/index.js",
@@ -11,8 +11,10 @@
     }
   },
   "scripts": {
-    "lint": "eslint index.js lib/*.js",
-    "test": "tape lib/*-test.js | tap-min",
+    "preversion": "npm test && npm run lint",
+    "version": "npm run build",
+    "lint": "eslint lib/*.js",
+    "test": "tape lib/*.spec.js | tap-min",
     "build": "NODE_ENV=production rollup -c"
   },
   "repository": {
@@ -36,16 +38,16 @@
   "author": "Borgar Þorsteinsson <borgar@borgar.net> (http://borgar.net/)",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "~7.19.6",
+    "@babel/core": "~7.21.0",
     "@babel/eslint-parser": "~7.19.1",
-    "@babel/preset-env": "~7.19.4",
-    "@borgar/eslint-config": "~2.2.1",
-    "@rollup/plugin-babel": "~6.0.2",
+    "@babel/preset-env": "~7.20.2",
+    "@borgar/eslint-config": "~3.0.0",
+    "@rollup/plugin-babel": "~6.0.3",
     "babel-eslint": "~10.1.0",
-    "eslint": "~8.26.0",
-    "rollup": "~3.2.3",
+    "eslint": "~8.34.0",
+    "rollup": "~3.17.2",
     "rollup-plugin-minification": "~0.2.0",
     "tap-min": "~2.0.0",
-    "tape": "~5.6.1"
+    "tape": "~5.6.3"
   }
 }

package/lib/a1-test.js

@@ -1,158 +0,0 @@
-/* eslint-disable object-property-newline, object-curly-newline */
-import { test, Test } from 'tape';
-import {
-  fromCol,
-  toCol,
-  fromRow,
-  toRow,
-  toRelative,
-  toAbsolute,
-  parseA1Ref
-} from './a1.js';
-
-Test.prototype.isA1Equal = function isTokens (expr, result, opts) {
-  if (result) {
-    result = {
-      sheetName: '',
-      workbookName: '',
-      range: null,
-      name: '',
-      ...result
-    };
-    if (result.range && typeof result.range === 'object') {
-      // mix in some defaults so we don't have to write things out in full
-      result.range = {
-        top: null, left: null, bottom: null, right: null,
-        $top: false, $left: false, $bottom: false, $right: false,
-        ...result.range
-      };
-    }
-  }
-  this.deepEqual(parseA1Ref(expr, opts), result, expr);
-};
-
-// What happens when B2:A1 -> should work!
-test('convert to and from column and row ids', t => {
-  t.is(fromCol('a'), 0);
-  t.is(fromCol('A'), 0);
-  t.is(fromCol('AA'), 26);
-  t.is(fromCol('zz'), 701);
-  t.is(fromCol('ZZZ'), 18277);
-  t.is(toCol(0), 'A');
-  t.is(toCol(26), 'AA');
-  t.is(toCol(701), 'ZZ');
-  t.is(toCol(18277), 'ZZZ');
-  t.is(fromRow('11'), 10);
-  t.is(fromRow('1'), 0);
-  t.is(toRow(12), '13');
-  t.is(toRow(77), '78');
-  t.end();
-});
-
-test('parse A1 references', t => {
-  t.isA1Equal('A1', { range: { top: 0, left: 0, bottom: 0, right: 0 } });
-  t.isA1Equal('A1:B2', { range: { top: 0, left: 0, bottom: 1, right: 1 } });
-
-  t.isA1Equal('$A1:B2', { range: { top: 0, left: 0, bottom: 1, right: 1, $left: true } });
-  t.isA1Equal('A$1:B2', { range: { top: 0, left: 0, bottom: 1, right: 1, $top: true } });
-  t.isA1Equal('A1:$B2', { range: { top: 0, left: 0, bottom: 1, right: 1, $right: true } });
-  t.isA1Equal('A1:B$2', { range: { top: 0, left: 0, bottom: 1, right: 1, $bottom: true } });
-
-  t.isA1Equal('A:A', { range: { top: 0, left: 0, bottom: 1048575, right: 0, $top: true, $bottom: true } });
-  t.isA1Equal('C:C', { range: { top: 0, left: 2, bottom: 1048575, right: 2, $top: true, $bottom: true } });
-  t.isA1Equal('C:$C', { range: { top: 0, left: 2, bottom: 1048575, right: 2, $right: true, $top: true, $bottom: true } });
-  t.isA1Equal('$C:C', { range: { top: 0, left: 2, bottom: 1048575, right: 2, $left: true, $top: true, $bottom: true } });
-  t.isA1Equal('$C:$C', { range: { top: 0, left: 2, bottom: 1048575, right: 2, $left: true, $right: true, $top: true, $bottom: true } });
-
-  t.isA1Equal('1:1', { range: { top: 0, left: 0, bottom: 0, right: 16383, $left: true, $right: true } });
-  t.isA1Equal('10:10', { range: { top: 9, left: 0, bottom: 9, right: 16383, $left: true, $right: true } });
-  t.isA1Equal('10:$10', { range: { top: 9, left: 0, bottom: 9, right: 16383, $bottom: true, $left: true, $right: true } });
-  t.isA1Equal('$10:10', { range: { top: 9, left: 0, bottom: 9, right: 16383, $top: true, $left: true, $right: true } });
-  t.isA1Equal('$10:$10', { range: { top: 9, left: 0, bottom: 9, right: 16383, $top: true, $bottom: true, $left: true, $right: true } });
-
-  t.isA1Equal('XFD1048576', { range: { top: 1048575, left: 16383, bottom: 1048575, right: 16383 } });
-
-  t.isA1Equal('Sheet1!A1', {
-    sheetName: 'Sheet1',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal('\'Sheet1\'!A1', {
-    sheetName: 'Sheet1',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal('\'Sheet1\'\'s\'!A1', {
-    sheetName: 'Sheet1\'s',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal('[Workbook.xlsx]Sheet1!A1', {
-    sheetName: 'Sheet1',
-    workbookName: 'Workbook.xlsx',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal("'[Workbook.xlsx]Sheet1'!A1", {
-    sheetName: 'Sheet1',
-    workbookName: 'Workbook.xlsx',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal("'[Workbook.xlsx]Sheet1'!A1", {
-    sheetName: 'Sheet1',
-    workbookName: 'Workbook.xlsx',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-
-  t.isA1Equal("='[Workbook.xlsx]Sheet1'!A1", {
-    sheetName: 'Sheet1',
-    workbookName: 'Workbook.xlsx',
-    range: { top: 0, left: 0, bottom: 0, right: 0 }
-  });
-  t.isA1Equal('0123456789abcdefghijklmnopqrstuvwxyz!A1', null);
-
-  t.isA1Equal('[Workbook.xlsx]!A1', null);
-  t.isA1Equal('[Workbook.xlsx]!A1:B2', null);
-  t.isA1Equal('[Workbook.xlsx]!A:A', null);
-  t.isA1Equal('[Workbook.xlsx]!1:1', null);
-  t.isA1Equal('[]Sheet1!A1', null);
-  t.isA1Equal('namedrange', { name: 'namedrange' });
-
-  t.isA1Equal('Workbook.xlsx!namedrange', {
-    workbookName: 'Workbook.xlsx',
-    name: 'namedrange'
-  });
-
-  t.isA1Equal("'Workbook.xlsx'!namedrange", {
-    workbookName: 'Workbook.xlsx',
-    name: 'namedrange'
-  });
-
-  t.isA1Equal('[Workbook.xlsx]!namedrange', null);
-  t.isA1Equal('pensioneligibilitypartner1', { name: 'pensioneligibilitypartner1' });
-  t.isA1Equal('XFE1048577', { name: 'XFE1048577' });
-
-  // with named ranges disallowed
-  t.isA1Equal('namedrange', null, false);
-  t.isA1Equal('Workbook.xlsx!namedrange', null, false);
-  t.isA1Equal('pensioneligibilitypartner1', null, false);
-  t.isA1Equal('XFE1048577', null, false);
-
-  t.end();
-});
-
-test('A1 utilities', t => {
-  const relA1Range = {
-    top: 0, left: 0, bottom: 0, right: 0,
-    $top: false, $left: false, $bottom: false, $right: false
-  };
-  const absA1Range = {
-    top: 0, left: 0, bottom: 0, right: 0,
-    $top: true, $left: true, $bottom: true, $right: true
-  };
-  t.deepEqual(toAbsolute(relA1Range), absA1Range);
-  t.deepEqual(toRelative(absA1Range), relA1Range);
-  t.end();
-});
-

package/lib/quickVerify.js

@@ -1,35 +0,0 @@
-export function quickVerifyRangeA1 (tokenValue) {
-  // Quickly determine if range valus are out of bounds: Split the string into
-  // numeric, alphabetical, and "other" chunks and parse them as base 36 numbers.
-  // Both rows and cols can be represented in base 36 and we can decide which we
-  // hold by checking if the chunk was already a finite number. So we can simply
-  // compare against the base 36 parsed versions of XFD and 1048576.
-  return tokenValue.split(/(\d+|[a-zA-Z]+)/).every(d => {
-    const n = parseInt(d, 36);
-    if (!isNaN(n)) {
-      return isFinite(d)
-        ? n <= 2183880786 // max rows
-        : n <= 43321;     // max cols
-    }
-    return true;
-  });
-}
-
-const bounds = {
-  'R': 1048577,
-  'R[': 1048576,
-  'C': 16385,
-  'C[': 16384
-};
-export function quickVerifyRangeRC (tokenValue) {
-  const reNums = /([RC]\[?)(-?\d+)/gi;
-  let m;
-  while ((m = reNums.exec(tokenValue)) !== null) {
-    const x = bounds[m[1]];
-    const val = parseInt(m[2], 10);
-    if (val >= x || val <= -x) {
-      return false;
-    }
-  }
-  return true;
-}

package/lib/rc-test.js

@@ -1,111 +0,0 @@
-/* eslint-disable object-property-newline, object-curly-newline */
-import { test, Test } from 'tape';
-import { MAX_COLS, MAX_ROWS } from './constants.js';
-import { parseRCRef } from './rc.js';
-
-Test.prototype.isRCEqual = function isTokens (expr, result, opts) {
-  if (result) {
-    result = {
-      sheetName: '',
-      workbookName: '',
-      name: '',
-      range: null,
-      ...result
-    };
-    if (result.range && typeof result.range === 'object') {
-      // mix in some defaults so we don't have to write things out in full
-      result.range = {
-        r0: null, c0: null, r1: null, c1: null,
-        $r0: false, $c0: false, $r1: false, $c1: false,
-        ...result.range
-      };
-    }
-  }
-  this.deepEqual(parseRCRef(expr, opts), result, expr);
-};
-
-test('parse single R1C1 references', t => {
-  // current row
-  t.isRCEqual('R', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $c0: true, $c1: true } });
-  t.isRCEqual('R[0]', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $c0: true, $c1: true } });
-  // row N (equivalent to 1:1)
-  t.isRCEqual('R0', { name: 'R0' });
-  t.isRCEqual('R1', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $r0: true, $r1: true, $c0: true, $c1: true } });
-  t.isRCEqual('R10', { range: { r0: 9, c0: 0, r1: 9, c1: MAX_COLS, $r0: true, $r1: true, $c0: true, $c1: true } });
-  // row following current
-  t.isRCEqual('R[1]', { range: { r0: 1, c0: 0, r1: 1, c1: MAX_COLS, $c0: true, $c1: true } });
-  // row preceding current
-  t.isRCEqual('R[-1]', { range: { r0: -1, c0: 0, r1: -1, c1: MAX_COLS, $c0: true, $c1: true } });
-  // current column
-  t.isRCEqual('C', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $r0: true, $r1: true } });
-  t.isRCEqual('C[0]', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $r0: true, $r1: true } });
-  // column N (equivalent to A:A)
-  t.isRCEqual('C0', { name: 'C0' });
-  t.isRCEqual('C1', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('C10', { range: { r0: 0, c0: 9, r1: MAX_ROWS, c1: 9, $c0: true, $c1: true, $r0: true, $r1: true } });
-  // column following current
-  t.isRCEqual('C[1]', { range: { r0: 0, c0: 1, r1: MAX_ROWS, c1: 1, $r0: true, $r1: true } });
-  // column preceding current
-  t.isRCEqual('C[-1]', { range: { r0: 0, c0: -1, r1: MAX_ROWS, c1: -1, $r0: true, $r1: true } });
-  // current cell
-  t.isRCEqual('RC', { range: { r0: 0, c0: 0, r1: 0, c1: 0 } });
-  t.isRCEqual('R0C0', { name: 'R0C0' });
-  // fixed cell
-  t.isRCEqual('R1C1', { range: { r0: 0, c0: 0, r1: 0, c1: 0, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('R10C8', { range: { r0: 9, c0: 7, r1: 9, c1: 7, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('R-10C-8', null);
-  // relative parts
-  t.isRCEqual('R[2]C', { range: { r0: 2, c0: 0, r1: 2, c1: 0 } });
-  t.isRCEqual('R[-2]C', { range: { r0: -2, c0: 0, r1: -2, c1: 0 } });
-  t.isRCEqual('RC[3]', { range: { r0: 0, c0: 3, r1: 0, c1: 3 } });
-  t.isRCEqual('RC[-3]', { range: { r0: 0, c0: -3, r1: 0, c1: -3 } });
-  t.isRCEqual('R[2]C[4]', { range: { r0: 2, c0: 4, r1: 2, c1: 4 } });
-  t.isRCEqual('R[-2]C[-4]', { range: { r0: -2, c0: -4, r1: -2, c1: -4 } });
-  // mixed fixed and relative
-  t.isRCEqual('R[9]C9', { range: { r0: 9, c0: 8, r1: 9, c1: 8, $c0: true, $c1: true } });
-  t.isRCEqual('R9C[9]', { range: { r0: 8, c0: 9, r1: 8, c1: 9, $r0: true, $r1: true } });
-
-  // out of bounds
-  t.isRCEqual('R1048577', { name: 'R1048577' });
-  t.isRCEqual('R[1048576]', null);
-  t.isRCEqual('C16385', { name: 'C16385' });
-  t.isRCEqual('C[16384]', null);
-
-  t.end();
-});
-
-test('parse joined R1C1 references', t => {
-  // all "mirrored" refs are equivalent of the non mirrored counterparts...
-  t.isRCEqual('R:R', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $c0: true, $c1: true } });
-  t.isRCEqual('R[0]:R[0]', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $c0: true, $c1: true } });
-  t.isRCEqual('R1:R1', { range: { r0: 0, c0: 0, r1: 0, c1: MAX_COLS, $r0: true, $r1: true, $c0: true, $c1: true } });
-  t.isRCEqual('R10:R10', { range: { r0: 9, c0: 0, r1: 9, c1: MAX_COLS, $r0: true, $r1: true, $c0: true, $c1: true } });
-  t.isRCEqual('R[1]:R[1]', { range: { r0: 1, c0: 0, r1: 1, c1: MAX_COLS, $c0: true, $c1: true } });
-  t.isRCEqual('R[-1]:R[-1]', { range: { r0: -1, c0: 0, r1: -1, c1: MAX_COLS, $c0: true, $c1: true } });
-  t.isRCEqual('C:C', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $r0: true, $r1: true } });
-  t.isRCEqual('C[0]:C[0]', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $r0: true, $r1: true } });
-  t.isRCEqual('C1:C1', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 0, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('C10:C10', { range: { r0: 0, c0: 9, r1: MAX_ROWS, c1: 9, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('C[1]:C[1]', { range: { r0: 0, c0: 1, r1: MAX_ROWS, c1: 1, $r0: true, $r1: true } });
-  t.isRCEqual('C[-1]:C[-1]', { range: { r0: 0, c0: -1, r1: MAX_ROWS, c1: -1, $r0: true, $r1: true } });
-  t.isRCEqual('R0:R0', null);
-  t.isRCEqual('C0:C0', null);
-  t.isRCEqual('R[9]C9:R[9]C9', { range: { r0: 9, c0: 8, r1: 9, c1: 8, $c0: true, $c1: true } });
-  t.isRCEqual('R9C[9]:R9C[9]', { range: { r0: 8, c0: 9, r1: 8, c1: 9, $r0: true, $r1: true } });
-  t.isRCEqual('R[1]C[1]:R1C1', { range: { r0: 1, c0: 1, r1: 0, c1: 0, $c1: true, $r1: true } });
-  t.isRCEqual('R[1]C[1]:R1C1', { range: { r0: 1, c0: 1, r1: 0, c1: 0, $c1: true, $r1: true } });
-  t.isRCEqual('R1C1:R2C2', { range: { r0: 0, c0: 0, r1: 1, c1: 1, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('R2C2:R1C1', { range: { r0: 1, c0: 1, r1: 0, c1: 0, $c0: true, $c1: true, $r0: true, $r1: true } });
-  // single thing
-  t.isRCEqual('C1:C3', { range: { r0: 0, c0: 0, r1: MAX_ROWS, c1: 2, $c0: true, $c1: true, $r0: true, $r1: true } });
-  t.isRCEqual('R[1]:R3', { range: { r0: 1, c0: 0, r1: 2, c1: MAX_COLS, $c0: true, $c1: true, $r0: false, $r1: true } });
-  t.isRCEqual('R[1]C1:R1C[-1]', { range: { r0: 1, c0: 0, r1: 0, c1: -1, $r0: false, $c0: true, $r1: true, $c1: false } });
-  // many things
-  t.isRCEqual('R:C', null);
-  t.isRCEqual('R:RC', null);
-  t.isRCEqual('RC:R', null);
-  t.isRCEqual('RC:C', null);
-  t.isRCEqual('C:R', null);
-  t.isRCEqual('C:RC', null);
-  t.end();
-});