color-2-name/tests/colors_hex.test.ts

Finds the closest color name to a given hex, rgb and hsl color (with and without alpha). It uses the Euclidean distance formula to calculate the distance between colors in the RGB color space

import { describe, expect, it, vi } from "vitest";
/**
 * COMMON FUNCTIONS TESTING:
 */
import { normalizeDegrees } from "../src/common.js";
import {
	hexToRgb,
	parseHex,
	shortHexToLongHex,
	toHex,
} from "../src/hex-utils.js";
import { parseColor } from "../src/index.js";
import { RGB } from "../src/rgb-utils.js";
import { hex_invalid_tests, hex_valid_tests } from "./fixtures/hex_colors.js";
import { normalizeRGB } from "./fixtures/functions.js";
import type { COLORSTRING } from "../lib/types";

describe("HEX COMMON", () => {
	// HEX
	it("Returns the correct rgb representation of the given HEX color", () => {
		expect(parseColor("#000")).toMatchObject({ r: 0, g: 0, b: 0 });
		expect(parseColor("#000000")).toMatchObject({ r: 0, g: 0, b: 0 });
		expect(parseColor("#ff0000")).toMatchObject({ r: 255, g: 0, b: 0 });
		expect(parseColor("#f00")).toMatchObject({ r: 255, g: 0, b: 0 });
		expect(parseColor("#ffffff")).toMatchObject({ r: 255, g: 255, b: 255 });
		expect(parseColor("#fff")).toMatchObject({ r: 255, g: 255, b: 255 });
		expect(parseColor("#ffff")).toMatchObject({ r: 255, g: 255, b: 255 });
		expect(parseColor("#ffffff")).toMatchObject({ r: 255, g: 255, b: 255 });
		expect(parseColor("#ffffffff")).toMatchObject({ r: 255, g: 255, b: 255 });
	});
});

/**
 * HEX FUNCTIONS TESTING:
 */
describe("HEX", () => {
	it("Returns an Object with the triplets of hex color values", () => {
		expect(shortHexToLongHex("")).toMatchObject([]);
		expect(shortHexToLongHex("00")).toMatchObject(["00", "00"]);
		expect(shortHexToLongHex("000")).toMatchObject(["00", "00", "00"]);
		expect(shortHexToLongHex("0000")).toMatchObject(["00", "00", "00", "00"]);
		expect(shortHexToLongHex("F00")).toMatchObject(["FF", "00", "00"]);
		expect(shortHexToLongHex("123")).toMatchObject(["11", "22", "33"]);
		expect(shortHexToLongHex("123")).toMatchObject(["11", "22", "33"]);
	});

	describe("HEX Color Parsing and Conversion", () => {
		for (const [hexString, expectedRgbString, description] of hex_valid_tests) {
			it(
				description || `Parses HEX: ${hexString} to RGB: ${expectedRgbString}`,
				() => {
					expect(RGB(hexToRgb(parseHex(hexString as COLORSTRING)))).toBe(
						normalizeRGB(expectedRgbString),
					);
				},
			);
		}
	});

	describe("Invalid HEX Color Parsing", () => {
		console.warn = vi.fn();
		for (const [hexString, expectedErrorMessage] of hex_invalid_tests) {
			it(`Fails to Parse Invalid HEX: ${hexString} ${expectedErrorMessage}`, () => {
				RGB(hexToRgb(parseHex(hexString as COLORSTRING)));
				expect(console.warn).toBeCalled();
			});
		}
	});

	it("Returns transformation of the hex object into a RGB object", () => {
		expect(hexToRgb(["0", "0", "0"])).toMatchObject({ r: 0, g: 0, b: 0 });
		expect(hexToRgb(["FF", "00", "00"])).toMatchObject({ r: 255, g: 0, b: 0 });
		expect(hexToRgb(["FF", "FF", "FF"])).toMatchObject({
			r: 255,
			g: 255,
			b: 255,
		});
	});

	it("Return the int8 to hex conversion", () => {
		expect(toHex(0)).toBe("00");
		expect(toHex(127)).toBe("7f");
		expect(toHex(255)).toBe("ff");
	});

	it("Return the int8 to hex conversion", () => {
		expect(normalizeDegrees("90deg")).toBe(90);
		expect(normalizeDegrees("90rad")).toBe(117);
		expect(normalizeDegrees("2turn")).toBe(0);
	});
});