rg-stats/src/util/throw-if.test.ts

A library for calculating various rhythm game stats.

import t from "tap";
import { TestCase } from "../test-utils/test-case";
import { ErrVars, ThrowIf } from "./throw-if";

type MockThrowFn<C> = (condition: C, errMsg: string, errVars: ErrVars) => void;

t.test("ThrowIf Tests", (t) => {
	function ShouldThrow<C>(throwIfFn: MockThrowFn<C>, condition: C): TestCase {
		return (t) => {
			t.throws(
				() => throwIfFn(condition, "Some Error Message.", { foo: 2, bar: "baz" }),
				/^Invalid input, Some Error Message\. foo=2, bar="baz"\.$/u,
				`${throwIfFn.name} (cond:${condition}) Should throw an error with a pretty message.`
			);
			t.throws(
				() => throwIfFn(condition, "Some Error Message", { foo: 2, bar: "baz" }),
				/^Invalid input, Some Error Message\. foo=2, bar="baz"\.$/u,
				`${throwIfFn.name} (cond:${condition}) Should add a full stop after the error message if one was accidentally forgotten.`
			);
		};
	}

	function ShouldNotThrow<C>(throwIfFn: MockThrowFn<C>, condition: C): TestCase {
		return (t) => {
			t.doesNotThrow(
				() => throwIfFn(condition, "Some Error Message.", { foo: 2, bar: "baz" }),
				`${throwIfFn.name} (cond:${condition}) Should not throw an error.`
			);
		};
	}

	const testCases: TestCase[] = [
		ShouldThrow(ThrowIf, true),
		ShouldThrow(ThrowIf.not, false),
		ShouldThrow(ThrowIf.negative, -1),
		ShouldThrow(ThrowIf.positive, 1),
		ShouldThrow(ThrowIf.positiveOrZero, 1),
		ShouldThrow(ThrowIf.positiveOrZero, 0),
		ShouldThrow(ThrowIf.negativeOrZero, -1),
		ShouldThrow(ThrowIf.negativeOrZero, 0),
		ShouldThrow(ThrowIf.zero, 0),
		ShouldNotThrow(ThrowIf, false),
		ShouldNotThrow(ThrowIf.not, true),
		ShouldNotThrow(ThrowIf.positive, -1),
		ShouldNotThrow(ThrowIf.positive, 0),
		ShouldNotThrow(ThrowIf.negative, 1),
		ShouldNotThrow(ThrowIf.negative, 0),
		ShouldNotThrow(ThrowIf.positiveOrZero, -1),
		ShouldNotThrow(ThrowIf.negativeOrZero, 1),
		ShouldNotThrow(ThrowIf.zero, 1),
		ShouldNotThrow(ThrowIf.zero, -1),
	];

	for (const testCase of testCases) {
		testCase(t);
	}

	t.end();
});

t.test("ThrowIf Formatting Edge Cases", (t) => {
	t.throws(
		() =>
			ThrowIf(true, "msg", {
				foo: "1",
				bar: 1,
			}),
		/^Invalid input, msg\. foo="1", bar=1\.$/u,
		"Should differentiate strings from numbers."
	);

	t.throws(
		() =>
			ThrowIf(true, "msg", {
				foo: "1, bar=1",
			}),
		/^Invalid input, msg\. foo="1, bar=1"\.$/u,
		"Should keep string values inside strings."
	);

	t.throws(
		() =>
			ThrowIf(true, "msg", {
				foo: '1", bar=1',
			}),
		/^Invalid input, msg\. foo="1\\", bar=1"\.$/u,
		"Should escape quotes to not allow breaking out."
	);

	t.end();
});