Files
outline/shared/utils/date.test.ts

128 lines
4.2 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import {
dateToReadable,
dateToRelativeReadable,
hasTimeComponent,
parseISODate,
toISODate,
toISODateTime,
} from "./date";
describe("toISODate / parseISODate", () => {
it("round-trips a date through its ISO representation", () => {
const date = new Date(2024, 1, 3); // Feb 3, 2024
const iso = toISODate(date);
expect(iso).toBe("2024-02-03");
expect(parseISODate(iso)).toEqual(date);
});
it("returns null for an invalid ISO string", () => {
expect(parseISODate("not-a-date")).toBeNull();
});
it("rejects strings carrying seconds or a timezone", () => {
expect(parseISODate("2024-02-03T10:00:00Z")).toBeNull();
expect(parseISODate("2024-02-03T10:00:00")).toBeNull();
});
it("parses a date-only string to local midnight", () => {
const date = parseISODate("2024-02-03");
expect(date?.getHours()).toBe(0);
expect(date?.getMinutes()).toBe(0);
});
});
describe("toISODateTime / hasTimeComponent", () => {
it("round-trips a date and time through its ISO representation", () => {
const date = new Date(2024, 1, 3, 13, 5); // Feb 3, 2024 at 1:05pm
const iso = toISODateTime(date);
expect(iso).toBe("2024-02-03T13:05");
expect(parseISODate(iso)).toEqual(date);
});
it("detects whether a value is time-specific", () => {
expect(hasTimeComponent("2024-02-03T13:05")).toBe(true);
expect(hasTimeComponent("2024-02-03")).toBe(false);
expect(hasTimeComponent("nonsense")).toBe(false);
});
});
describe("dateToReadable", () => {
it("includes the year outside the current year", () => {
expect(dateToReadable("2020-02-03")).toBe("February 3rd, 2020");
});
it("omits the year within the current year", () => {
const date = new Date();
date.setMonth(date.getMonth() === 0 ? 6 : 0);
date.setDate(15);
const result = dateToReadable(toISODate(date));
expect(result).not.toContain(`${date.getFullYear()}`);
});
it("returns the original string when invalid", () => {
expect(dateToReadable("nonsense")).toBe("nonsense");
});
it("appends the time when the value is time-specific", () => {
expect(dateToReadable("2020-02-03T13:00")).toBe(
"February 3rd, 2020 at 1:00 PM"
);
});
it("separates the time using the locale's own connector", () => {
expect(dateToReadable("2020-02-03T13:00", "de_DE")).toContain(" um ");
expect(dateToReadable("2020-02-03T13:00", "ja_JP")).not.toContain(" at ");
});
it("does not leak the date's own suffix into the separator", () => {
// Ukrainian places "р." (an abbreviation of "року") after the year, which
// must not be mistaken for part of the separator.
expect(dateToReadable("2020-02-03T13:00", "uk_UA")).toContain(" о ");
expect(dateToReadable("2020-02-03T13:00", "uk_UA")).not.toContain("р.");
});
});
describe("dateToRelativeReadable", () => {
const t = (key: string) => key;
it("returns Today for the current date", () => {
const iso = toISODate(new Date());
expect(dateToRelativeReadable(iso, t)).toBe("Today");
});
it("returns Tomorrow for the next day", () => {
const tomorrow = new Date();
tomorrow.setDate(tomorrow.getDate() + 1);
expect(dateToRelativeReadable(toISODate(tomorrow), t)).toBe("Tomorrow");
});
it("returns Yesterday for the previous day", () => {
const yesterday = new Date();
yesterday.setDate(yesterday.getDate() - 1);
expect(dateToRelativeReadable(toISODate(yesterday), t)).toBe("Yesterday");
});
it("omits the year within the current year", () => {
const date = new Date();
date.setMonth(date.getMonth() === 0 ? 6 : 0); // a different month, same year
date.setDate(15);
const result = dateToRelativeReadable(toISODate(date), t);
expect(result).not.toContain(`${date.getFullYear()}`);
});
it("includes the year for a date in a different year", () => {
expect(dateToRelativeReadable("2020-02-03", t)).toBe("February 3rd, 2020");
});
it("appends the time when the value is time-specific", () => {
const today = new Date();
today.setHours(13, 0);
expect(dateToRelativeReadable(toISODateTime(today), t)).toBe(
"Today at 1:00 PM"
);
expect(dateToRelativeReadable("2020-02-03T13:00", t)).toBe(
"February 3rd, 2020 at 1:00 PM"
);
});
});