Skip to content

A local-first personal finance app

8.1 KB
Raw Blame
import { enUS } from 'date-fns/locale';
import i18next from 'i18next';

import { getRecurringDescription } from '#util/schedule';

// getRecurringDescription uses the full English sentence as the translation
// key, so with no resources i18next echoes the key back with interpolation
// applied — which is exactly what these assertions expect.
void i18next.init({
  lng: 'en',
  interpolation: {
    escapeValue: false,
  },
});

describe('getRecurringDescription', () => {
  it('describes weekly interval', () => {
    expect(
      getRecurringDescription(
        { start: '2021-05-17', frequency: 'weekly' },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every week on Monday');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 weeks on Monday');
  });

  it('describes monthly interval', () => {
    expect(
      getRecurringDescription(
        { start: '2021-04-25', frequency: 'monthly' },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 25th');

    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          interval: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 months on the 25th');

    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [{ type: 'day', value: 25 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 25th');

    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          interval: 2,
          patterns: [{ type: 'day', value: 25 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 months on the 25th');

    // Last day should work
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [{ type: 'day', value: 31 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 31st');

    // -1 should work, representing the last day
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [{ type: 'day', value: -1 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the last day');

    // Day names should work
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [{ type: 'FR', value: 2 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 2nd Friday');

    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [{ type: 'FR', value: -1 }],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the last Friday');
  });

  it('describes monthly interval with multiple days', () => {
    // Note how order doesn't matter - the day should be sorted
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [
            { type: 'day', value: 15 },
            { type: 'day', value: 3 },
            { type: 'day', value: 20 },
          ],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 3rd, 15th, and 20th');

    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [
            { type: 'day', value: 3 },
            { type: 'day', value: -1 },
            { type: 'day', value: 20 },
          ],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 3rd, 20th, and last day');

    // Mix days and day names
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [
            { type: 'day', value: 3 },
            { type: 'day', value: -1 },
            { type: 'FR', value: 2 },
          ],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 2nd Friday, 3rd, and last day');

    // When there is a mixture of types, day names should always come first
    expect(
      getRecurringDescription(
        {
          start: '2021-04-25',
          frequency: 'monthly',
          patterns: [
            { type: 'SA', value: 1 },
            { type: 'day', value: 2 },
            { type: 'FR', value: 3 },
            { type: 'day', value: 10 },
          ],
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every month on the 1st Saturday, 3rd Friday, 2nd, and 10th');
  });

  it('describes yearly interval', () => {
    expect(
      getRecurringDescription(
        { start: '2021-05-17', frequency: 'yearly' },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every year on May 17th');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'yearly',
          interval: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 years on May 17th');
  });

  it('describes intervals with limited occurrences', () => {
    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 2,
          endMode: 'after_n_occurrences',
          endOccurrences: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 weeks on Monday, 2 times');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 2,
          endMode: 'after_n_occurrences',
          endOccurrences: 1,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 weeks on Monday, once');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'monthly',
          interval: 2,
          endMode: 'after_n_occurrences',
          endOccurrences: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 months on the 17th, 2 times');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'yearly',
          interval: 2,
          endMode: 'after_n_occurrences',
          endOccurrences: 2,
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 years on May 17th, 2 times');
  });

  it('describes intervals with an end date', () => {
    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 2,
          endMode: 'on_date',
          endDate: '2021-06-01',
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 weeks on Monday, until 06/01/2021');

    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'monthly',
          interval: 2,
          endMode: 'on_date',
          endDate: '2021-06-01',
        },
        'yyyy-MM-dd',
        enUS,
      ),
    ).toBe('Every 2 months on the 17th, until 2021-06-01');
  });

  it('separates the weekend annotation when there is no end mode', () => {
    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 1,
          skipWeekend: true,
          weekendSolveMode: 'after',
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every week on Monday (after weekend)');
  });

  it('combines the end mode and weekend annotations', () => {
    expect(
      getRecurringDescription(
        {
          start: '2021-05-17',
          frequency: 'weekly',
          interval: 2,
          endMode: 'after_n_occurrences',
          endOccurrences: 2,
          skipWeekend: true,
          weekendSolveMode: 'before',
        },
        'MM/dd/yyyy',
        enUS,
      ),
    ).toBe('Every 2 weeks on Monday, 2 times (before weekend)');
  });
});