@borgar/fx/lib/translate-toRC.spec.js

Utilities for working with Excel formulas

import { test, Test } from 'tape';
import { translateToR1C1 } from './translate.js';
import { tokenize } from './lexer.js';
import { addTokenMeta } from './addTokenMeta.js';
import { FUNCTION, FX_PREFIX, OPERATOR, REF_RANGE, REF_BEAM, REF_STRUCT } from './constants.js';

Test.prototype.isA2R = function isTokens (expr, anchor, result) {
  this.is(translateToR1C1(expr, anchor), result, expr);
};

test('translate absolute cells from A1 to RC', t => {
  t.isA2R('=$A$1', 'B2', '=R1C1');
  t.isA2R('=$A$2', 'B2', '=R2C1');
  t.isA2R('=$A$3', 'B2', '=R3C1');
  t.isA2R('=$B$1', 'B2', '=R1C2');
  t.isA2R('=$B$2', 'B2', '=R2C2');
  t.isA2R('=$B$3', 'B2', '=R3C2');
  t.isA2R('=$C$1', 'B2', '=R1C3');
  t.isA2R('=$C$2', 'B2', '=R2C3');
  t.isA2R('=$C$3', 'B2', '=R3C3');
  // absolute cells, anchor has no real effect
  t.isA2R('=$A$1', 'Z19', '=R1C1');
  t.isA2R('=$A$2', 'Z19', '=R2C1');
  t.isA2R('=$A$3', 'Z19', '=R3C1');
  t.isA2R('=$B$1', 'Z19', '=R1C2');
  t.isA2R('=$B$2', 'Z19', '=R2C2');
  t.isA2R('=$B$3', 'Z19', '=R3C2');
  t.isA2R('=$C$1', 'Z19', '=R1C3');
  t.isA2R('=$C$2', 'Z19', '=R2C3');
  t.isA2R('=$C$3', 'Z19', '=R3C3');
  t.end();
});

test('translate relative cells from A1 to RC', t => {
  t.isA2R('=A1', 'B2', '=R[-1]C[-1]');
  t.isA2R('=A2', 'B2', '=RC[-1]');
  t.isA2R('=A3', 'B2', '=R[1]C[-1]');
  t.isA2R('=B1', 'B2', '=R[-1]C');
  t.isA2R('=B2', 'B2', '=RC');
  t.isA2R('=B3', 'B2', '=R[1]C');
  t.isA2R('=C1', 'B2', '=R[-1]C[1]');
  t.isA2R('=C2', 'B2', '=RC[1]');
  t.isA2R('=C3', 'B2', '=R[1]C[1]');
  // relative cells, but with [0] notation
  t.isA2R('=H11', 'I12', '=R[-1]C[-1]');
  t.isA2R('=H12', 'I12', '=RC[-1]');
  t.isA2R('=H13', 'I12', '=R[1]C[-1]');
  t.isA2R('=I11', 'I12', '=R[-1]C');
  t.isA2R('=I12', 'I12', '=RC');
  t.isA2R('=I13', 'I12', '=R[1]C');
  t.isA2R('=J11', 'I12', '=R[-1]C[1]');
  t.isA2R('=J12', 'I12', '=RC[1]');
  t.isA2R('=J13', 'I12', '=R[1]C[1]');
  t.end();
});

test('translate rows from A1 to RC', t => {
  t.isA2R('=2:2', 'B1', '=R[1]');
  t.isA2R('=2:2', 'B2', '=R');
  t.isA2R('=2:2', 'B3', '=R[-1]');
  t.isA2R('=13:13', 'B13', '=R');
  t.isA2R('=$2:$2', 'B2', '=R2');
  t.isA2R('=2:$2', 'B2', '=R:R2');
  t.isA2R('=11:9', 'Z10', '=R[-1]:R[1]');
  t.end();
});

test('translate cols from A1 to RC', t => {
  t.isA2R('=B:B', 'A2', '=C[1]');
  t.isA2R('=B:B', 'B2', '=C');
  t.isA2R('=B:B', 'C2', '=C[-1]');
  t.isA2R('=Z:Z', 'Z2', '=C');
  t.isA2R('=B:B', 'B2', '=C');
  t.isA2R('=$B:$B', 'B2', '=C2');
  t.isA2R('=B:$B', 'B2', '=C:C2');
  t.isA2R('=N:L', 'M10', '=C[-1]:C[1]');
  t.end();
});

test('translate partials from A1 to RC', t => {
  t.isA2R('=A1:A', 'C6', '=R[-5]C[-2]:C[-2]');
  t.isA2R('=A1:1', 'D6', '=R[-5]C[-3]:R[-5]');
  t.isA2R('=$A1:$A', 'C7', '=R[-6]C1:C1');
  t.isA2R('=$A:$A1', 'D7', '=R[-6]C1:C1');
  t.isA2R('=$A1:1', 'C7', '=R[-6]C1:R[-6]');
  t.isA2R('=1:$A1', 'C7', '=R[-6]C1:R[-6]');
  t.isA2R('=A$1:A', 'C6', '=R1C[-2]:C[-2]');
  t.isA2R('=A:A$1', 'C6', '=R1C[-2]:C[-2]');
  t.isA2R('=A$1:$1', 'D6', '=R1C[-3]:R1');
  t.isA2R('=$1:A$1', 'D6', '=R1C[-3]:R1');
  t.isA2R('=$A$1:$A', 'D6', '=R1C1:C1');
  t.isA2R('=$A:$A$1', 'D6', '=R1C1:C1');
  t.isA2R('=$A$1:$1', 'D6', '=R1C1:R1');
  t.isA2R('=$1:$A$1', 'D6', '=R1C1:R1');
  t.end();
});

test('translate boundary coords from A1 to RC', t => {
  t.isA2R('=XFD:XFD', 'A1', '=C[16383]');
  t.isA2R('=A1', 'B1', '=RC[-1]');
  t.isA2R('=B1', 'C1', '=RC[-1]');
  t.isA2R('=1048576:1048576', 'A1', '=R[1048575]');
  t.isA2R('=$1:$1048576', 'A1', '=R1:R1048576');
  t.isA2R('=$A:$XFD', 'A1', '=C1:C16384');
  t.isA2R('=$A$1:$XFD$1048576', 'A1', '=R1C1:R1048576C16384');
  t.isA2R('=A1', 'A2', '=R[-1]C');
  t.isA2R('=A2', 'A3', '=R[-1]C');
  t.end();
});

test('translate mixed rel/abs coords from A1 to RC', t => {
  t.isA2R('=B$1', 'B2', '=R1C');
  t.isA2R('=$D8', 'B4', '=R[4]C4');
  t.isA2R('=8:$10', 'B4', '=R[4]:R10');
  t.isA2R('=$J:L', 'B4', '=C10:C[10]');
  t.isA2R('=$A$1:$B$2', 'D4', '=R1C1:R2C2');
  t.isA2R('=C3:F6', 'D4', '=R[-1]C[-1]:R[2]C[2]');
  t.end();
});

test('translate involved cases from A1 to RC', t => {
  t.isA2R('=SUM(IF(E10,$E$2,$E$3),Sheet1!$2:$2*Sheet2!B:B)', 'D10',
    '=SUM(IF(RC[1],R2C5,R3C5),Sheet1!R2*Sheet2!C[-2])');

  // make sure we don't get confused by structured, or named refs
  t.isA2R('=A1+Table1[#Data]', 'D10', '=R[-9]C[-3]+Table1[#Data]');
  t.isA2R('=A1+foobar', 'D10', '=R[-9]C[-3]+foobar');

  // This [123]Sheet!A1 variant of the syntax is used internally in xlsx files
  t.isA2R('=[2]Sheet1!A1', 'D10', '=[2]Sheet1!R[-9]C[-3]');

  t.end();
});

test('translate works with merged ranges', t => {
  // This tests that:
  // - Translate works with ranges that have context attached
  // - If input is a tokenlist, output is also a tokenlist
  // - If tokens have ranges, those ranges are adjusted to new token lengths
  // - Properties added by addTokenMeta are preserved
  const expr = '=SUM(IF(E10,$E$2,$E$3),Sheet1!$2:$2*Sheet2!B:B)';
  const tokens = addTokenMeta(tokenize(expr, { withLocation: true }));
  const expected = [
    { type: FX_PREFIX, value: '=', loc: [ 0, 1 ], index: 0, depth: 0 },
    { type: FUNCTION, value: 'SUM', loc: [ 1, 4 ], index: 1, depth: 0 },
    { type: OPERATOR, value: '(', loc: [ 4, 5 ], index: 2, depth: 1, groupId: 'fxg7' },
    { type: FUNCTION, value: 'IF', loc: [ 5, 7 ], index: 3, depth: 1 },
    { type: OPERATOR, value: '(', loc: [ 7, 8 ], index: 4, depth: 2, groupId: 'fxg4' },
    { type: REF_RANGE, value: 'RC[1]', loc: [ 8, 13 ], index: 5, depth: 2, groupId: 'fxg1' },
    { type: OPERATOR, value: ',', loc: [ 13, 14 ], index: 6, depth: 2 },
    { type: REF_RANGE, value: 'R2C5', loc: [ 14, 18 ], index: 7, depth: 2, groupId: 'fxg2' },
    { type: OPERATOR, value: ',', loc: [ 18, 19 ], index: 8, depth: 2 },
    { type: REF_RANGE, value: 'R3C5', loc: [ 19, 23 ], index: 9, depth: 2, groupId: 'fxg3' },
    { type: OPERATOR, value: ')', loc: [ 23, 24 ], index: 10, depth: 2, groupId: 'fxg4' },
    { type: OPERATOR, value: ',', loc: [ 24, 25 ], index: 11, depth: 1 },
    { type: REF_BEAM, value: 'Sheet1!R2', loc: [ 25, 34 ], index: 12, depth: 1, groupId: 'fxg5' },
    { type: OPERATOR, value: '*', loc: [ 34, 35 ], index: 13, depth: 1 },
    { type: REF_BEAM, value: 'Sheet2!C[-2]', loc: [ 35, 47 ], index: 14, depth: 1, groupId: 'fxg6' },
    { type: OPERATOR, value: ')', loc: [ 47, 48 ], index: 15, depth: 1, groupId: 'fxg7' }
  ];
  t.deepEqual(translateToR1C1(tokens, 'D10'), expected, expr);
  t.end();
});

test('translate works with xlsx mode', t => {
  const testExpr = (expr, anchor, expected) => {
    const opts = { mergeRefs: true, xlsx: true, r1c1: false };
    const tokens = tokenize(expr, opts);
    t.deepEqual(translateToR1C1(tokens, anchor, opts), expected, expr);
  };
  testExpr("'[My Fancy Workbook.xlsx]'!B$1", 'B2', [
    { type: REF_RANGE, value: "'[My Fancy Workbook.xlsx]'!R1C" }
  ]);
  testExpr('[Workbook.xlsx]!B$1', 'B2', [
    { type: REF_RANGE, value: '[Workbook.xlsx]!R1C' }
  ]);
  testExpr('[Workbook.xlsx]Sheet1!B$1', 'B2', [
    { type: REF_RANGE, value: '[Workbook.xlsx]Sheet1!R1C' }
  ]);
  testExpr('[Workbook.xlsx]!table[#data]', 'B2', [
    { type: REF_STRUCT, value: '[Workbook.xlsx]!table[#data]' }
  ]);
  t.end();
});

test('translate works with trimmed ranges', t => {
  const testExpr = (expr, anchor, expected) => {
    const opts = { mergeRefs: true, xlsx: true, r1c1: false };
    t.deepEqual(translateToR1C1(tokenize(expr, opts), anchor, opts), expected, expr);
  };
  testExpr('Sheet!A1.:.B2*Sheet2!AZ.:.ZZ', 'B2', [
    { type: 'range', value: 'Sheet!R[-1]C[-1].:.RC' },
    { type: 'operator', value: '*' },
    { type: 'range_beam', value: 'Sheet2!C[50].:.C[700]' }
  ]);
  t.end();
});