Refactor calendar methods into util class (#3088)

Refactored some methods in calendar module:
- move methods into own file 
- dont call shorten method from titelTransform because why? just call
them after each other.
- added tests for util methods
- cleaned up other tests

---------

Co-authored-by: veeck <michael@veeck.de>

tests/unit/modules/default/calendar/calendar_utils_spec.js

@@ -0,0 +1,148 @@
+global.moment = require("moment");
+
+const CalendarUtils = require("../../../../../modules/default/calendar/calendarutils");
+
+describe("Calendar utils tests", () => {
+	describe("capFirst", () => {
+		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]}'`, () => {
+				expect(CalendarUtils.capFirst(word)).toBe(words[word]);
+			});
+		});
+
+		it("should not capitalize other letters", () => {
+			expect(CalendarUtils.capFirst("event")).not.toBe("EVent");
+		});
+	});
+
+	describe("getLocaleSpecification", () => {
+		it("should return a valid moment.LocaleSpecification for a 12-hour format", () => {
+			expect(CalendarUtils.getLocaleSpecification(12)).toEqual({ longDateFormat: { LT: "h:mm A" } });
+		});
+
+		it("should return a valid moment.LocaleSpecification for a 24-hour format", () => {
+			expect(CalendarUtils.getLocaleSpecification(24)).toEqual({ longDateFormat: { LT: "HH:mm" } });
+		});
+
+		it("should return the current system locale when called without timeFormat number", () => {
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: moment.localeData().longDateFormat("LT") } });
+		});
+
+		it("should return a 12-hour longDateFormat when using the 'en' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("en");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "h:mm A" } });
+			moment.locale(localeBackup);
+		});
+
+		it("should return a 12-hour longDateFormat when using the 'au' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("au");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "h:mm A" } });
+			moment.locale(localeBackup);
+		});
+
+		it("should return a 12-hour longDateFormat when using the 'eg' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("eg");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "h:mm A" } });
+			moment.locale(localeBackup);
+		});
+
+		it("should return a 24-hour longDateFormat when using the 'nl' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("nl");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "HH:mm" } });
+			moment.locale(localeBackup);
+		});
+
+		it("should return a 24-hour longDateFormat when using the 'fr' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("fr");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "HH:mm" } });
+			moment.locale(localeBackup);
+		});
+
+		it("should return a 24-hour longDateFormat when using the 'uk' locale", () => {
+			const localeBackup = moment.locale();
+			moment.locale("uk");
+			expect(CalendarUtils.getLocaleSpecification()).toEqual({ longDateFormat: { LT: "HH:mm" } });
+			moment.locale(localeBackup);
+		});
+	});
+
+	describe("shorten", () => {
+		it("should not shorten if short enough", () => {
+			expect(CalendarUtils.shorten("Event 1", 10, false, 1)).toBe("Event 1");
+		});
+
+		it("should shorten into one line", () => {
+			expect(CalendarUtils.shorten("Example event at 12 o clock", 10, true, 1)).toBe("Example …");
+		});
+
+		it("should shorten into three lines", () => {
+			expect(CalendarUtils.shorten("Example event at 12 o clock", 10, true, 3)).toBe("Example <br>event at 12 o <br>clock");
+		});
+
+		it("should not shorten into three lines if wrap is false", () => {
+			expect(CalendarUtils.shorten("Example event at 12 o clock", 10, false, 3)).toBe("Example ev…");
+		});
+
+		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}'`, () => {
+				expect(CalendarUtils.shorten(string, strings[string].length)).toBe(strings[string].return);
+			});
+		});
+
+		it("should return an empty string if shorten is called with a non-string", () => {
+			expect(CalendarUtils.shorten(100)).toBe("");
+		});
+
+		it("should not shorten the string if shorten is called with a non-number maxLength", () => {
+			expect(CalendarUtils.shorten("This is a test string", "This is not a number")).toBe("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)", () => {
+			expect(CalendarUtils.shorten("This is a wrapEvent test. Should wrap the string instead of shorten it if called with wrapEvent = true", 20, true)).toBe(
+				"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)", () => {
+			expect(CalendarUtils.shorten("This is a wrapEvent test. Should wrap the string instead of shorten it if called with wrapEvent = true", undefined, true)).toBe(
+				"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", () => {
+			expect(CalendarUtils.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)).toBe(
+				"This is a wrapEvent and <br>maxTitleLines test. Should wrap and …"
+			);
+		});
+	});
+
+	describe("titleTransform and shorten combined", () => {
+		it("should replace the birthday and wrap nicely", () => {
+			const transformedTitle = CalendarUtils.titleTransform("Michael Teeuw's birthday", {
+				"De verjaardag van ": "",
+				"'s birthday": ""
+			});
+			expect(CalendarUtils.shorten(transformedTitle, 10, true, 2)).toBe("Michael <br>Teeuw");
+		});
+	});
+});

tests/unit/modules/default/weather/weather_object_spec.js

@@ -0,0 +1,84 @@
+const WeatherObject = require("../../../../../modules/default/weather/weatherobject");
+const WeatherUtils = require("../../../../../modules/default/weather/weatherutils");
+
+global.moment = require("moment-timezone");
+global.SunCalc = require("suncalc");
+
+describe("WeatherObject", () => {
+	let originalTimeZone;
+	let weatherobject;
+
+	beforeAll(() => {
+		originalTimeZone = moment.tz.guess();
+		moment.tz.setDefault("Africa/Dar_es_Salaam");
+		weatherobject = new WeatherObject();
+	});
+
+	it("should return true for daytime at noon", () => {
+		weatherobject.date = moment("12:00", "HH:mm");
+		weatherobject.updateSunTime(-6.774877582342688, 37.63345667023327);
+		expect(weatherobject.isDayTime()).toBe(true);
+	});
+
+	it("should return false for daytime at midnight", () => {
+		weatherobject.date = moment("00:00", "HH:mm");
+		weatherobject.updateSunTime(-6.774877582342688, 37.63345667023327);
+		expect(weatherobject.isDayTime()).toBe(false);
+	});
+
+	it("should return sunrise as the next sunaction", () => {
+		weatherobject.updateSunTime(-6.774877582342688, 37.63345667023327);
+		let midnight = moment("00:00", "HH:mm");
+		expect(weatherobject.nextSunAction(midnight)).toBe("sunrise");
+	});
+
+	it("should return sunset as the next sunaction", () => {
+		weatherobject.updateSunTime(-6.774877582342688, 37.63345667023327);
+		let noon = moment(weatherobject.sunrise).hour(14);
+		expect(weatherobject.nextSunAction(noon)).toBe("sunset");
+	});
+
+	it("should return an already defined feelsLike info", () => {
+		weatherobject.feelsLikeTemp = "feelsLikeTempValue";
+		expect(weatherobject.feelsLike()).toBe("feelsLikeTempValue");
+	});
+
+	afterAll(() => {
+		moment.tz.setDefault(originalTimeZone);
+	});
+});
+
+describe("WeatherUtils", () => {
+	it("should convert windspeed correctly from mps to beaufort", () => {
+		expect(Math.round(WeatherUtils.convertWind(5, "beaufort"))).toBe(3);
+		expect(Math.round(WeatherUtils.convertWind(300, "beaufort"))).toBe(12);
+	});
+
+	it("should convert windspeed correctly from mps to kmh", () => {
+		expect(Math.round(WeatherUtils.convertWind(11.75, "kmh"))).toBe(42);
+	});
+
+	it("should convert windspeed correctly from mps to knots", () => {
+		expect(Math.round(WeatherUtils.convertWind(10, "knots"))).toBe(19);
+	});
+
+	it("should convert windspeed correctly from mph to mps", () => {
+		expect(Math.round(WeatherUtils.convertWindToMetric(93.951324266285))).toBe(42);
+	});
+
+	it("should convert windspeed correctly from kmh to mps", () => {
+		expect(Math.round(WeatherUtils.convertWindToMs(151.2))).toBe(42);
+	});
+
+	it("should convert wind direction correctly from cardinal to value", () => {
+		expect(WeatherUtils.convertWindDirection("SSE")).toBe(157);
+	});
+
+	it("should return a calculated feelsLike info", () => {
+		expect(WeatherUtils.calculateFeelsLike(0, 20, 40)).toBe(-9.444444444444445);
+	});
+
+	it("should return a calculated feelsLike info", () => {
+		expect(WeatherUtils.calculateFeelsLike(30, 0, 60)).toBe(32.8320322777777);
+	});
+});

tests/unit/modules/default/weather/weather_utils_spec.js

@@ -2,7 +2,7 @@ const weather = require("../../../../../modules/default/weather/weatherutils");
 
 describe("Weather utils tests", () => {
 	describe("convertPrecipitationUnit tests", () => {
-		it("Should keep value and unit if outputUnit is undefined", () => {
+		it("should keep value and unit if outputUnit is undefined", () => {
 			const values = [1, 2];
 			const units = ["mm", "cm"];
 
@@ -12,7 +12,7 @@ describe("Weather utils tests", () => {
 			}
 		});
 
-		it("Should keep value and unit if outputUnit is metric", () => {
+		it("should keep value and unit if outputUnit is metric", () => {
 			const values = [1, 2];
 			const units = ["mm", "cm"];
 
@@ -22,7 +22,7 @@ describe("Weather utils tests", () => {
 			}
 		});
 
-		it("Should use mm unit if input unit is undefined", () => {
+		it("should use mm unit if input unit is undefined", () => {
 			const values = [1, 2];
 
 			for (let i = 0; i < values.length; i++) {
@@ -31,7 +31,7 @@ describe("Weather utils tests", () => {
 			}
 		});
 
-		it("Should convert value and unit if outputUnit is imperial", () => {
+		it("should convert value and unit if outputUnit is imperial", () => {
 			const values = [1, 2];
 			const units = ["mm", "cm"];
 			const expectedValues = [0.04, 0.79];