adding monkeytype

frontend/__tests__/utils/format.spec.ts

@@ -0,0 +1,280 @@
+import { describe, it, expect } from "vitest";
+import { getDefaultConfig } from "../../src/ts/constants/default-config";
+import { Formatting } from "../../src/ts/utils/format";
+import { Config } from "@monkeytype/schemas/configs";
+
+describe("format.ts", () => {
+  describe("typingsSpeed", () => {
+    it("should format with typing speed and decimalPlaces from configuration", () => {
+      //wpm, no decimals
+      const wpmNoDecimals = getInstance({
+        typingSpeedUnit: "wpm",
+        alwaysShowDecimalPlaces: false,
+      });
+      expect(wpmNoDecimals.typingSpeed(12.5)).toEqual("13");
+      expect(wpmNoDecimals.typingSpeed(0)).toEqual("0");
+
+      //cpm, no decimals
+      const cpmNoDecimals = getInstance({
+        typingSpeedUnit: "cpm",
+        alwaysShowDecimalPlaces: false,
+      });
+      expect(cpmNoDecimals.typingSpeed(12.5)).toEqual("63");
+      expect(cpmNoDecimals.typingSpeed(0)).toEqual("0");
+
+      //wpm, with decimals
+      const wpmWithDecimals = getInstance({
+        typingSpeedUnit: "wpm",
+        alwaysShowDecimalPlaces: true,
+      });
+      expect(wpmWithDecimals.typingSpeed(12.5)).toEqual("12.50");
+      expect(wpmWithDecimals.typingSpeed(0)).toEqual("0.00");
+
+      //cpm, with decimals
+      const cpmWithDecimals = getInstance({
+        typingSpeedUnit: "cpm",
+        alwaysShowDecimalPlaces: true,
+      });
+      expect(cpmWithDecimals.typingSpeed(12.5)).toEqual("62.50");
+      expect(cpmWithDecimals.typingSpeed(0)).toEqual("0.00");
+    });
+
+    it("should format with fallback", () => {
+      //default fallback
+      const format = getInstance();
+      expect(format.typingSpeed(null)).toEqual("-");
+      expect(format.typingSpeed(undefined)).toEqual("-");
+
+      //provided fallback
+      expect(format.typingSpeed(null, { fallback: "none" })).toEqual("none");
+      expect(format.typingSpeed(null, { fallback: "" })).toEqual("");
+      expect(format.typingSpeed(undefined, { fallback: "none" })).toEqual(
+        "none",
+      );
+
+      expect(format.typingSpeed(undefined, { fallback: "" })).toEqual("");
+      expect(format.typingSpeed(undefined, { fallback: undefined })).toEqual(
+        "",
+      );
+    });
+
+    it("should format with decimals", () => {
+      //force with decimals
+      const wpmNoDecimals = getInstance({
+        typingSpeedUnit: "wpm",
+        alwaysShowDecimalPlaces: false,
+      });
+      expect(
+        wpmNoDecimals.typingSpeed(100, { showDecimalPlaces: true }),
+      ).toEqual("100.00");
+      //force without decimals
+      const wpmWithDecimals = getInstance({
+        typingSpeedUnit: "wpm",
+        alwaysShowDecimalPlaces: true,
+      });
+      expect(
+        wpmWithDecimals.typingSpeed(100, { showDecimalPlaces: false }),
+      ).toEqual("100");
+    });
+
+    it("should format with suffix", () => {
+      const format = getInstance({
+        typingSpeedUnit: "wpm",
+        alwaysShowDecimalPlaces: false,
+      });
+      expect(format.typingSpeed(100, { suffix: " raw" })).toEqual("100 raw");
+      expect(format.typingSpeed(100, { suffix: undefined })).toEqual("100");
+      expect(format.typingSpeed(0, { suffix: " raw" })).toEqual("0 raw");
+      expect(format.typingSpeed(null, { suffix: " raw" })).toEqual("-");
+      expect(format.typingSpeed(undefined, { suffix: " raw" })).toEqual("-");
+    });
+
+    it("should format with rounding", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.typingSpeed(80.25)).toEqual("80");
+      expect(format.typingSpeed(80.25, { rounding: Math.ceil })).toEqual("81");
+      expect(format.typingSpeed(80.75, { rounding: Math.floor })).toEqual("80");
+    });
+  });
+
+  describe("percentage", () => {
+    it("should format with decimalPlaces from configuration", () => {
+      //no decimals
+      const noDecimals = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(noDecimals.percentage(12.5)).toEqual("13%");
+      expect(noDecimals.percentage(0)).toEqual("0%");
+
+      //with decimals
+      const withDecimals = getInstance({ alwaysShowDecimalPlaces: true });
+      expect(withDecimals.percentage(12.5)).toEqual("12.50%");
+      expect(withDecimals.percentage(0)).toEqual("0.00%");
+    });
+
+    it("should format with fallback", () => {
+      //default fallback
+      const format = getInstance();
+      expect(format.percentage(null)).toEqual("-");
+      expect(format.percentage(undefined)).toEqual("-");
+
+      //provided fallback
+      expect(format.percentage(null, { fallback: "none" })).toEqual("none");
+      expect(format.percentage(null, { fallback: "" })).toEqual("");
+      expect(format.percentage(undefined, { fallback: "none" })).toEqual(
+        "none",
+      );
+
+      expect(format.percentage(undefined, { fallback: "" })).toEqual("");
+      expect(format.percentage(undefined, { fallback: undefined })).toEqual("");
+    });
+
+    it("should format with decimals", () => {
+      //force with decimals
+      const noDecimals = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(noDecimals.percentage(100, { showDecimalPlaces: true })).toEqual(
+        "100.00%",
+      );
+      //force without decimals
+      const withDecimals = getInstance({ alwaysShowDecimalPlaces: true });
+      expect(
+        withDecimals.percentage(100, { showDecimalPlaces: false }),
+      ).toEqual("100%");
+    });
+
+    it("should format with suffix", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.percentage(100, { suffix: " raw" })).toEqual("100% raw");
+      expect(format.percentage(100, { suffix: undefined })).toEqual("100%");
+      expect(format.percentage(0, { suffix: " raw" })).toEqual("0% raw");
+      expect(format.percentage(null, { suffix: " raw" })).toEqual("-");
+      expect(format.percentage(undefined, { suffix: " raw" })).toEqual("-");
+    });
+
+    it("should format with rounding", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.percentage(80.25)).toEqual("80%");
+      expect(format.percentage(80.25, { rounding: Math.ceil })).toEqual("81%");
+      expect(format.percentage(80.75, { rounding: Math.floor })).toEqual("80%");
+    });
+  });
+
+  describe("accuracy", () => {
+    it("should floor decimals by default", () => {
+      //no decimals
+      const noDecimals = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(noDecimals.accuracy(12.75)).toEqual("12%");
+      //with decimals
+      const withDecimals = getInstance({ alwaysShowDecimalPlaces: true });
+      expect(withDecimals.accuracy(12.75)).toEqual("12.75%");
+    });
+
+    it("should format with rounding", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.accuracy(80.5)).toEqual("80%");
+      expect(format.accuracy(80.25, { rounding: Math.ceil })).toEqual("81%");
+      expect(format.accuracy(80.75, { rounding: Math.floor })).toEqual("80%");
+    });
+  });
+
+  describe("decimals", () => {
+    it("should format with decimalPlaces from configuration", () => {
+      //no decimals
+      const noDecimals = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(noDecimals.decimals(12.5)).toEqual("13");
+      expect(noDecimals.decimals(0)).toEqual("0");
+
+      //with decimals
+      const withDecimals = getInstance({ alwaysShowDecimalPlaces: true });
+      expect(withDecimals.decimals(12.5)).toEqual("12.50");
+      expect(withDecimals.decimals(0)).toEqual("0.00");
+    });
+
+    it("should format with fallback", () => {
+      //default fallback
+      const format = getInstance();
+      expect(format.decimals(null)).toEqual("-");
+      expect(format.decimals(undefined)).toEqual("-");
+
+      //provided fallback
+      expect(format.decimals(null, { fallback: "none" })).toEqual("none");
+      expect(format.decimals(null, { fallback: "" })).toEqual("");
+      expect(format.decimals(undefined, { fallback: "none" })).toEqual("none");
+
+      expect(format.decimals(undefined, { fallback: "" })).toEqual("");
+      expect(format.decimals(undefined, { fallback: undefined })).toEqual("");
+    });
+
+    it("should format with decimals", () => {
+      //force with decimals
+      const noDecimals = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(noDecimals.decimals(100, { showDecimalPlaces: true })).toEqual(
+        "100.00",
+      );
+      //force without decimals
+      const withDecimals = getInstance({ alwaysShowDecimalPlaces: true });
+      expect(withDecimals.decimals(100, { showDecimalPlaces: false })).toEqual(
+        "100",
+      );
+    });
+
+    it("should format with suffix", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.decimals(100, { suffix: " raw" })).toEqual("100 raw");
+      expect(format.decimals(100, { suffix: undefined })).toEqual("100");
+      expect(format.decimals(0, { suffix: " raw" })).toEqual("0 raw");
+      expect(format.decimals(null, { suffix: " raw" })).toEqual("-");
+      expect(format.decimals(undefined, { suffix: " raw" })).toEqual("-");
+    });
+
+    it("should format with rounding", () => {
+      const format = getInstance({ alwaysShowDecimalPlaces: false });
+      expect(format.decimals(80.25)).toEqual("80");
+      expect(format.decimals(80.25, { rounding: Math.ceil })).toEqual("81");
+      expect(format.decimals(80.75, { rounding: Math.floor })).toEqual("80");
+    });
+  });
+
+  describe("rank", () => {
+    it("should format with default fallback", () => {
+      const format = getInstance();
+      expect(format.rank(1)).toEqual("1st");
+      expect(format.rank(2)).toEqual("2nd");
+      expect(format.rank(3)).toEqual("3rd");
+      expect(format.rank(4)).toEqual("4th");
+
+      expect(format.rank(11)).toEqual("11th");
+      expect(format.rank(12)).toEqual("12th");
+      expect(format.rank(13)).toEqual("13th");
+      expect(format.rank(14)).toEqual("14th");
+
+      expect(format.rank(21)).toEqual("21st");
+      expect(format.rank(22)).toEqual("22nd");
+      expect(format.rank(23)).toEqual("23rd");
+      expect(format.rank(24)).toEqual("24th");
+    });
+
+    it("should format with fallback", () => {
+      const format = getInstance();
+
+      expect(format.rank(0)).toEqual("0th");
+      expect(format.rank(null)).toEqual("-");
+      expect(format.rank(undefined)).toEqual("-");
+
+      expect(format.rank(0, {})).toEqual("0th");
+      expect(format.rank(null, {})).toEqual("-");
+      expect(format.rank(undefined, {})).toEqual("-");
+
+      expect(format.rank(0, { fallback: "none" })).toEqual("0th");
+      expect(format.rank(null, { fallback: "none" })).toEqual("none");
+      expect(format.rank(undefined, { fallback: "none" })).toEqual("none");
+
+      expect(format.rank(0, { fallback: "" })).toEqual("0th");
+      expect(format.rank(null, { fallback: "" })).toEqual("");
+      expect(format.rank(undefined, { fallback: "" })).toEqual("");
+    });
+  });
+});
+
+function getInstance(config?: Partial<Config>): Formatting {
+  const target: Config = { ...getDefaultConfig(), ...config };
+  return new Formatting(target);
+}