@checkdigit/time 3.0.0-PR.17-58cd → 4.0.0-PR.18-9134

package/src/date-fns/intlFormatDistance/test.mts

@@ -0,0 +1,794 @@
+import { describe, expect, it } from "vitest";
+import { intlFormatDistance } from "./index";
+
+describe("intlFormatDistance", () => {
+  describe("with default values", () => {
+    describe("works with same dates", () => {
+      it("outputs `now`", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 0),
+          new Date(1986, 3, 5, 10, 30, 0),
+        );
+        expect(result).toBe("now");
+      });
+    });
+
+    describe("works with single second", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 1),
+          new Date(1986, 3, 5, 10, 30, 0),
+        );
+        expect(result).toBe("in 1 second");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 0),
+          new Date(1986, 3, 5, 10, 30, 1),
+        );
+        expect(result).toBe("1 second ago");
+      });
+    });
+
+    describe("works with multiple seconds", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 59),
+          new Date(1986, 3, 5, 10, 30, 0),
+        );
+        expect(result).toBe("in 59 seconds");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 0),
+          new Date(1986, 3, 5, 10, 30, 59),
+        );
+        expect(result).toBe("59 seconds ago");
+      });
+    });
+
+    describe("works with single minute", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 59),
+          new Date(1986, 3, 5, 10, 29, 59),
+        );
+        expect(result).toBe("in 1 minute");
+      });
+
+      it("works with future with over a minute", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30),
+          new Date(1986, 3, 5, 10, 28, 10),
+        );
+        expect(result).toBe("in 1 minute");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 29, 59),
+          new Date(1986, 3, 5, 10, 30, 59),
+        );
+        expect(result).toBe("1 minute ago");
+      });
+
+      it("works with past with over a minute", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 28, 10),
+          new Date(1986, 3, 5, 10, 30),
+        );
+        expect(result).toBe("1 minute ago");
+      });
+    });
+
+    describe("works with multiple minutes", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30),
+          new Date(1986, 3, 5, 10, 28),
+        );
+        expect(result).toBe("in 2 minutes");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 28),
+          new Date(1986, 3, 5, 10, 30),
+        );
+        expect(result).toBe("2 minutes ago");
+      });
+    });
+
+    describe("works with 60 seconds", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 4, 11, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+        );
+        expect(result).toBe("in 1 hour");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 11, 30, 0),
+        );
+        expect(result).toBe("1 hour ago");
+      });
+    });
+
+    describe("works with single hour", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10),
+          new Date(1986, 3, 5, 9),
+        );
+        expect(result).toBe("in 1 hour");
+      });
+
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30),
+          new Date(1986, 3, 5, 9),
+        );
+        expect(result).toBe("in 1 hour");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 9),
+          new Date(1986, 3, 5, 10),
+        );
+        expect(result).toBe("1 hour ago");
+      });
+
+      it("works with past with over an hour", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 9),
+          new Date(1986, 3, 5, 10, 30),
+        );
+        expect(result).toBe("1 hour ago");
+      });
+    });
+
+    describe("works with multiple hours", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10),
+          new Date(1986, 3, 5, 8),
+        );
+        expect(result).toBe("in 2 hours");
+      });
+
+      it("works with future with extra minutes", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30),
+          new Date(1986, 3, 5, 8),
+        );
+        expect(result).toBe("in 2 hours");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 8),
+          new Date(1986, 3, 5, 10),
+        );
+        expect(result).toBe("2 hours ago");
+      });
+
+      it("works with past with extra minutes", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 8),
+          new Date(1986, 3, 5, 10),
+        );
+        expect(result).toBe("2 hours ago");
+      });
+    });
+
+    describe("works with single day", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 6, 22),
+          new Date(1986, 3, 5, 22),
+        );
+        expect(result).toBe("tomorrow");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 22),
+          new Date(1986, 3, 6, 22),
+        );
+        expect(result).toBe("yesterday");
+      });
+
+      it("works with past with an extra hour", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 22),
+          new Date(1986, 3, 6, 22, 5),
+        );
+        expect(result).toBe("yesterday");
+      });
+    });
+
+    describe("works with multiple days", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 6, 22),
+          new Date(1986, 3, 4, 22),
+        );
+        expect(result).toBe("in 2 days");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 4, 22),
+          new Date(1986, 3, 6, 22),
+        );
+        expect(result).toBe("2 days ago");
+      });
+    });
+
+    describe("works with single week", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 10, 22),
+          new Date(1986, 3, 3, 22),
+        );
+        expect(result).toBe("next week");
+      });
+
+      it("works with future with more than a week", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 11, 22),
+          new Date(1986, 3, 3, 22),
+        );
+        expect(result).toBe("next week");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 3, 22),
+          new Date(1986, 3, 10, 22),
+        );
+        expect(result).toBe("last week");
+      });
+
+      it("works with past with more than a week", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 3, 22),
+          new Date(1986, 3, 11, 22),
+        );
+        expect(result).toBe("last week");
+      });
+    });
+
+    describe("works with multiple weeks", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 15),
+          new Date(1986, 3, 1),
+        );
+        expect(result).toBe("in 2 weeks");
+      });
+
+      it("works with future with more than 2 weeks", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 17),
+          new Date(1986, 3, 1),
+        );
+        expect(result).toBe("in 2 weeks");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 1),
+          new Date(1986, 3, 15),
+        );
+        expect(result).toBe("2 weeks ago");
+      });
+
+      it("works with past with more than 2 weeks", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 1),
+          new Date(1986, 3, 17),
+        );
+        expect(result).toBe("2 weeks ago");
+      });
+    });
+
+    describe("works with single month", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 4, 2),
+          new Date(1986, 3, 1),
+        );
+        expect(result).toBe("next month");
+      });
+
+      it("works with future with more than a month", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 4, 22),
+          new Date(1986, 3, 1),
+        );
+        expect(result).toBe("next month");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 1),
+          new Date(1986, 4, 2),
+        );
+        expect(result).toBe("last month");
+      });
+
+      it("works with past with more than a month", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 1),
+          new Date(1986, 4, 22),
+        );
+        expect(result).toBe("last month");
+      });
+    });
+
+    describe("works with single quarter", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 5, 2),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("next quarter");
+      });
+
+      it("works with future with more than a quarter", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 5, 22),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("next quarter");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1986, 5, 2),
+        );
+        expect(result).toBe("last quarter");
+      });
+
+      it("works with past with more than a quarter", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1986, 5, 22),
+        );
+        expect(result).toBe("last quarter");
+      });
+    });
+
+    describe("works with multiple quarters", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 6, 2),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("in 2 quarters");
+      });
+
+      it("works with future with more that X quarters", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 6, 22),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("in 2 quarters");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1986, 6, 2),
+        );
+        expect(result).toBe("2 quarters ago");
+      });
+
+      it("works with past with more that X quarters", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1986, 6, 22),
+        );
+        expect(result).toBe("2 quarters ago");
+      });
+    });
+
+    describe("works with single year", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1987, 1, 2),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("next year");
+      });
+
+      it("works with future with more that a year", () => {
+        const result = intlFormatDistance(
+          new Date(1987, 10, 2),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("next year");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1987, 1, 2),
+        );
+        expect(result).toBe("last year");
+      });
+
+      it("works with past with more than a year", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1987, 10, 2),
+        );
+        expect(result).toBe("last year");
+      });
+    });
+
+    describe("works with multiple years", () => {
+      it("works with future", () => {
+        const result = intlFormatDistance(
+          new Date(1988, 1, 1),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("in 2 years");
+      });
+
+      it("works with future with x years", () => {
+        const result = intlFormatDistance(
+          new Date(2088, 1, 1),
+          new Date(1986, 1, 1),
+        );
+        expect(result).toBe("in 102 years");
+      });
+
+      it("works with past", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 1, 1),
+          new Date(1988, 1, 1),
+        );
+        expect(result).toBe("2 years ago");
+      });
+
+      it("works with past with x years", () => {
+        const result = intlFormatDistance(
+          new Date(1988, 1, 1),
+          new Date(2086, 1, 1),
+        );
+        expect(result).toBe("98 years ago");
+      });
+    });
+  });
+
+  describe("with options", () => {
+    describe("unit option", () => {
+      describe("seconds", () => {
+        it("works with future with seconds", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 4, 10, 31, 30),
+            new Date(1987, 3, 4, 10, 30, 0),
+            { unit: "second" },
+          );
+          expect(result).toBe("in 90 seconds");
+        });
+
+        it("works with past with seconds", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 4, 10, 30, 0),
+            new Date(1987, 3, 4, 10, 31, 30),
+            { unit: "second" },
+          );
+          expect(result).toBe("90 seconds ago");
+        });
+
+        it("works with future with quarters", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 6, 4, 10, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+            { unit: "quarter" },
+          );
+          expect(result).toBe("in 5 quarters");
+        });
+      });
+
+      describe("minutes", () => {
+        it("works with future", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 11, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+            { unit: "minute" },
+          );
+          expect(result).toBe("in 60 minutes");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 10, 30, 0),
+            new Date(1986, 3, 4, 11, 30, 0),
+            { unit: "minute" },
+          );
+          expect(result).toBe("60 minutes ago");
+        });
+      });
+
+      describe("hours", () => {
+        it("works the future", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 11, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+
+            { unit: "hour" },
+          );
+          expect(result).toBe("in 1 hour");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 10, 30, 0),
+            new Date(1986, 3, 4, 11, 30, 0),
+
+            { unit: "hour" },
+          );
+          expect(result).toBe("1 hour ago");
+        });
+      });
+
+      describe("single day", () => {
+        it("works with the future", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 4, 11, 30, 0),
+            new Date(1987, 3, 4, 10, 30, 0),
+            { unit: "day" },
+          );
+          expect(result).toBe("today");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 5, 10, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+          );
+          expect(result).toBe("tomorrow");
+        });
+      });
+
+      describe("multiple days", () => {
+        it("works with the future", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 5, 10, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+            { unit: "day" },
+          );
+          expect(result).toBe("in 366 days");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 10, 30, 0),
+            new Date(1987, 3, 5, 10, 30, 0),
+
+            { unit: "day" },
+          );
+          expect(result).toBe("366 days ago");
+        });
+      });
+
+      describe("single weeks", () => {
+        it("works with the future", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 11, 10, 30, 0),
+            new Date(1987, 3, 4, 10, 30, 0),
+            { unit: "week" },
+          );
+          expect(result).toBe("next week");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 4, 10, 30, 0),
+            new Date(1987, 3, 11, 10, 30, 0),
+            { unit: "week" },
+          );
+          expect(result).toBe("last week");
+        });
+      });
+
+      describe("multiple weeks", () => {
+        it("works with the future", () => {
+          const result = intlFormatDistance(
+            new Date(1987, 3, 6, 10, 30, 0),
+            new Date(1986, 3, 4, 10, 30, 0),
+            { unit: "week" },
+          );
+          expect(result).toBe("in 53 weeks");
+        });
+
+        it("works with the past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 4, 10, 30, 0),
+            new Date(1987, 3, 6, 10, 30, 0),
+
+            { unit: "week" },
+          );
+          expect(result).toBe("53 weeks ago");
+        });
+      });
+    });
+
+    describe("numeric option", () => {
+      describe("works with weeks", () => {
+        it("works with past", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 3, 22),
+            new Date(1986, 3, 10, 22),
+            { numeric: "always" },
+          );
+          expect(result).toBe("1 week ago");
+        });
+
+        it("works with future", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 3, 10, 22),
+            new Date(1986, 3, 3, 22),
+            { numeric: "always" },
+          );
+          expect(result).toBe("in 1 week");
+        });
+      });
+
+      it("works with days", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          { numeric: "always" },
+        );
+        expect(result).toBe("in 1 day");
+      });
+
+      it("works with the same dates", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 10, 30, 0),
+          new Date(1986, 3, 5, 10, 30, 0),
+          { numeric: "auto" },
+        );
+        expect(result).toBe("now");
+      });
+    });
+
+    describe("locale option", () => {
+      describe("locale", () => {
+        it("allows to set Spanish locale", () => {
+          const result = intlFormatDistance(
+            new Date(1986, 4, 4, 10, 30, 0),
+            new Date(1985, 4, 4, 10, 30, 0),
+            { locale: "es" },
+          );
+          expect(result).toBe("el próximo año");
+        });
+      });
+    });
+
+    describe("style option", () => {
+      it("works with years", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 4, 4, 10, 30, 0),
+          new Date(1985, 4, 4, 10, 30, 0),
+          { style: "long" },
+        );
+        expect(result).toBe("next year");
+      });
+    });
+
+    describe("unit and locale options", () => {
+      it("works with multiple options", () => {
+        const result = intlFormatDistance(
+          new Date(1986, 3, 5, 11, 30, 0),
+          new Date(1986, 3, 5, 10, 30, 0),
+          { unit: "minute", locale: "de" },
+        );
+        expect(result).toBe("in 60 Minuten");
+      });
+    });
+
+    describe("edge cases", () => {
+      it("falls back to { numeric: always }", () => {
+        const result = intlFormatDistance(
+          new Date(1985, 4, 5, 10, 30, 0),
+          new Date(1985, 4, 4, 10, 30, 0),
+          { style: "long", numeric: "auto" },
+        );
+        expect(result).toBe("tomorrow");
+      });
+
+      it("handles dates before 100 AD", () => {
+        const result = intlFormatDistance(
+          new Date(1, 3, 4, 11, 30, 0),
+          new Date(1, 3, 4, 10, 30, 0),
+          { unit: "minute" },
+        );
+        expect(result).toBe("in 60 minutes");
+      });
+    });
+
+    describe("errors", () => {
+      it("checks the first date", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(NaN),
+          new Date(1986, 3, 4, 10, 30, 0),
+        )).toThrow(RangeError);
+      });
+
+      it("checks the second date", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(NaN),
+        )).toThrow(RangeError);
+      });
+
+      it("checks both dates", () => {
+        expect(intlFormatDistance.bind(null, new Date(NaN), new Date(NaN))).toThrow(RangeError);
+      });
+
+      it("checks unit", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          // @ts-expect-error - We're testing wrong value
+          { unit: "wrongValue" },
+        )).toThrow(RangeError);
+      });
+
+      it("checks locale", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          { locale: "wrongValue" },
+        )).toThrow(RangeError);
+      });
+
+      it("checks localeMatcher", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          // @ts-expect-error - We're testing wrong value
+          { localeMatcher: "wrongValue" },
+        )).toThrow(RangeError);
+      });
+
+      it("checks numeric", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          // @ts-expect-error - We're testing wrong value
+          { numeric: "wrongValue" },
+        )).toThrow(RangeError);
+      });
+
+      it("checks style", () => {
+        expect(intlFormatDistance.bind(
+          null,
+          new Date(1986, 3, 4, 10, 30, 0),
+          new Date(1986, 3, 4, 10, 30, 0),
+          // @ts-expect-error - We're testing wrong value
+          { style: "wrongValue" },
+        )).toThrow(RangeError);
+      });
+    });
+  });
+});