MagicMirror/tests/unit/functions/calendar_spec.js

const expect = require("chai").expect;

global.moment = require("moment");

describe("Functions into modules/default/calendar/calendar.js", function () {
	// Fake for use by calendar.js
	Module = {};
	Module.definitions = {};
	Module.register = function (name, moduleDefinition) {
		Module.definitions[name] = moduleDefinition;
	};

	before(function () {
		// load calendar.js
		require("../../../modules/default/calendar/calendar.js");
	});

	describe("capFirst", function () {
		const words = {
			rodrigo: "Rodrigo",
			"123m": "123m",
			"magic mirror": "Magic mirror",
			",a": ",a",
			ñandú: "Ñandú"
		};

		Object.keys(words).forEach((word) => {
			it(`for '${word}' should return '${words[word]}'`, function () {
				expect(Module.definitions.calendar.capFirst(word)).to.equal(words[word]);
			});
		});
	});

	describe("getLocaleSpecification", function () {
		it("Should return a valid moment.LocaleSpecification for a 12-hour format", function () {
			expect(Module.definitions.calendar.getLocaleSpecification(12)).to.deep.equal({ longDateFormat: { LT: "h:mm A" } });
		});

		it("Should return a valid moment.LocaleSpecification for a 24-hour format", function () {
			expect(Module.definitions.calendar.getLocaleSpecification(24)).to.deep.equal({ longDateFormat: { LT: "HH:mm" } });
		});

		it("Should return the current system locale when called without timeFormat number", function () {
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: moment.localeData().longDateFormat("LT") } });
		});

		it("Should return a 12-hour longDateFormat when using the 'en' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("en");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "h:mm A" } });
			moment.locale(localeBackup);
		});

		it("Should return a 12-hour longDateFormat when using the 'au' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("au");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "h:mm A" } });
			moment.locale(localeBackup);
		});

		it("Should return a 12-hour longDateFormat when using the 'eg' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("eg");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "h:mm A" } });
			moment.locale(localeBackup);
		});

		it("Should return a 24-hour longDateFormat when using the 'nl' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("nl");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "HH:mm" } });
			moment.locale(localeBackup);
		});

		it("Should return a 24-hour longDateFormat when using the 'fr' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("fr");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "HH:mm" } });
			moment.locale(localeBackup);
		});

		it("Should return a 24-hour longDateFormat when using the 'uk' locale", function () {
			var localeBackup = moment.locale();
			moment.locale("uk");
			expect(Module.definitions.calendar.getLocaleSpecification()).to.deep.equal({ longDateFormat: { LT: "HH:mm" } });
			moment.locale(localeBackup);
		});
	});

	describe("shorten", function () {
		const strings = {
			" String with whitespace at the beginning that needs trimming": { length: 16, return: "String with whit…" },
			"long string that needs shortening": { length: 16, return: "long string that…" },
			"short string": { length: 16, return: "short string" },
			"long string with no maxLength defined": { return: "long string with no maxLength defined" }
		};

		Object.keys(strings).forEach((string) => {
			it(`for '${string}' should return '${strings[string].return}'`, function () {
				expect(Module.definitions.calendar.shorten(string, strings[string].length)).to.equal(strings[string].return);
			});
		});

		it("should return an empty string if shorten is called with a non-string", function () {
			expect(Module.definitions.calendar.shorten(100)).to.equal("");
		});

		it("should not shorten the string if shorten is called with a non-number maxLength", function () {
			expect(Module.definitions.calendar.shorten("This is a test string", "This is not a number")).to.equal("This is a test string");
		});

		it("should wrap the string instead of shorten it if shorten is called with wrapEvents = true (with maxLength defined as 20)", function () {
			expect(Module.definitions.calendar.shorten("This is a wrapEvent test. Should wrap the string instead of shorten it if called with wrapEvent = true", 20, true)).to.equal(
				"This is a <br>wrapEvent test. Should wrap <br>the string instead of <br>shorten it if called with <br>wrapEvent = true"
			);
		});

		it("should wrap the string instead of shorten it if shorten is called with wrapEvents = true (without maxLength defined, default 25)", function () {
			expect(Module.definitions.calendar.shorten("This is a wrapEvent test. Should wrap the string instead of shorten it if called with wrapEvent = true", undefined, true)).to.equal(
				"This is a wrapEvent <br>test. Should wrap the string <br>instead of shorten it if called <br>with wrapEvent = true"
			);
		});

		it("should wrap and shorten the string in the second line if called with wrapEvents = true and maxTitleLines = 2", function () {
			expect(Module.definitions.calendar.shorten("This is a wrapEvent and maxTitleLines test. Should wrap and shorten the string in the second line if called with wrapEvents = true and maxTitleLines = 2", undefined, true, 2)).to.equal(
				"This is a wrapEvent and <br>maxTitleLines test. Should wrap and &hellip;"
			);
		});
	});
});