checktheroads-hyperglass/hyperglass/ui/util/common.test.ts

import { all, chunkArray, entries, dedupObjectArray, andJoin } from './common';

test('all - all items are truthy', () => {
  expect(all(1 === 1, true, 'one' === 'one')).toBe(true);
});

test('all - one item is not truthy', () => {
  expect(all(1 === 1, false, 'one' === 'one')).toBe(false);
});

describe('chunkArray - chunk array into arrays of n size', () => {
  const input = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
  const result = chunkArray(input, 2);
  test('chunked array length', () => {
    expect(result).toHaveLength(Math.round(input.length / 2));
  });
  test.each(result)('verify chunk %#', item => {
    expect(input).toContain(item);
  });
});

describe('entries - typed Object.entries()', () => {
  const obj = { one: 1, two: 2, three: 3 };
  const result = entries(obj);
  const expectedKeys = ['one', 'two', 'three'];
  const expectedValues = [1, 2, 3];

  test.each(result)('verify k/v pair %#', (k, v) => {
    expect(expectedKeys).toContain(k);
    expect(expectedValues).toContain(v);
  });
});

describe('dedupObjectArray - deduplicate object array', () => {
  const objArray = [
    { one: 1, two: 2, three: 3 },
    { four: 4, five: 5, six: 6 },
    { seven: 7, eight: 8, nine: 9 },
    { zero: 0, one: 1, thousand: 1_000 },
  ];
  const result = dedupObjectArray(objArray, 'one');
  test('ensure duplicate object is removed', () => {
    expect(result.length).toBe(3);
  });
  test.each(result)('verify objects', obj => {
    expect(obj).toEqual(expect.not.objectContaining(objArray[3]));
  });
});

describe('andJoin - join array of strings to sentence structure', () => {
  test('basic sentence', () => {
    const result = andJoin(['Tom', 'Dick', 'Harry']);
    expect(result).toBe('Tom, Dick, & Harry');
  });
  test('one item', () => {
    const result = andJoin(['Tom']);
    expect(result).toBe('Tom');
  });
  test('mixed types', () => {
    // @ts-expect-error Test case
    const result = andJoin(['Tom', 100, 'Harry']);
    expect(result).toBe('Tom & Harry');
  });
  test('(options) wrapped', () => {
    const result = andJoin(['Tom', 'Dick', 'Harry'], { wrap: '*' });
    expect(result).toBe('*Tom*, *Dick*, & *Harry*');
  });
  test("(options) 'and' separator", () => {
    const result = andJoin(['Tom', 'Dick', 'Harry'], { separator: 'and' });
    expect(result).toBe('Tom, Dick, and Harry');
  });
  test('(options) no oxford comma', () => {
    const result = andJoin(['Tom', 'Dick', 'Harry'], { oxfordComma: false });
    expect(result).toBe('Tom, Dick & Harry');
  });
});