@borgar/fx/lib/stringifyStructRef.spec.ts

Utilities for working with Excel formulas

import { describe, test, expect } from 'vitest';
import { stringifyStructRef, stringifyStructRefXlsx } from './stringifyStructRef.ts';

describe('serialize structured references', () => {
  test('simple column references', () => {
    expect(stringifyStructRef({
      columns: [ 'foo' ]
    })).toBe('[foo]');

    expect(stringifyStructRef({
      columns: [ 'foo' ],
      table: 'tableName'
    })).toBe('tableName[foo]');

    expect(stringifyStructRef({
      columns: [ 'lorem ipsum' ],
      table: 'tableName'
    })).toBe('tableName[lorem ipsum]');
  });

  test('column range references', () => {
    expect(stringifyStructRef({
      columns: [ 'foo', 'sævör' ],
      table: 'tableName'
    })).toBe('tableName[[foo]:[sævör]]');

    expect(stringifyStructRef({
      columns: [ 'lorem ipsum', 'sævör' ],
      table: 'tableName'
    })).toBe('tableName[[lorem ipsum]:[sævör]]');
  });

  test('section references', () => {
    expect(stringifyStructRef({
      sections: [ 'data' ],
      table: 'tableName'
    })).toBe('tableName[#Data]');

    expect(stringifyStructRef({
      sections: [ 'data', 'headers' ],
      table: 'table'
    })).toBe('table[[#Data],[#Headers]]');
  });

  test('complex references with context', () => {
    expect(stringifyStructRef({
      columns: [ 'my column', 'fo@o' ],
      sections: [ 'data' ],
      table: 'tableName',
      context: [ 'workbook.xlsx' ]
    })).toBe('workbook.xlsx!tableName[[#Data],[my column]:[fo\'@o]]');
  });

  test('this row references', () => {
    expect(stringifyStructRef({
      columns: [ 'bar' ],
      sections: [ 'this row' ],
      table: 'foo'
    })).toBe('foo[@bar]');

    expect(stringifyStructRef({
      columns: [ 'bar', 'baz' ],
      sections: [ 'this row' ],
      table: 'foo'
    })).toBe('foo[@[bar]:[baz]]');

    expect(stringifyStructRef({
      columns: [ 'lorem ipsum', 'baz' ],
      sections: [ 'this row' ],
      table: 'foo'
    })).toBe('foo[@[lorem ipsum]:[baz]]');
  });
});

describe('structured references serialize in xlsx mode', () => {
  test('context vs workbookName/sheetName handling', () => {
    expect(stringifyStructRefXlsx({
      // @ts-expect-error -- this is testing invalid input
      context: [ 'Lorem', 'Ipsum' ],
      columns: [ 'foo' ]
    })).toBe('[foo]');

    expect(stringifyStructRef({
      // @ts-expect-error -- this is testing invalid input
      workbookName: 'Lorem',
      sheetName: 'Ipsum',
      columns: [ 'foo' ]
    })).toBe('[foo]');

    expect(stringifyStructRefXlsx({
      workbookName: 'Lorem',
      sheetName: 'Ipsum',
      columns: [ 'foo' ]
    })).toBe('[Lorem]Ipsum![foo]');
  });

  test('workbook and sheet name handling', () => {
    expect(stringifyStructRefXlsx({
      workbookName: 'Lorem',
      columns: [ 'foo' ]
    })).toBe('[Lorem]![foo]');

    expect(stringifyStructRefXlsx({
      sheetName: 'Ipsum',
      columns: [ 'foo' ]
    })).toBe('Ipsum![foo]');
  });
});

describe('longform serialize (in xlsx mode)', () => {
  test('thisRow option affects output format', () => {
    expect(stringifyStructRefXlsx({
      table: 'Table2',
      columns: [ 'col1' ],
      sections: [ 'this row' ]
    }, { thisRow: true })).toBe('Table2[[#This row],[col1]]');

    expect(stringifyStructRef({
      table: 'Table2',
      columns: [ 'col1' ],
      sections: [ 'this row' ]
    }, { thisRow: true })).toBe('Table2[[#This row],[col1]]');
  });
});