Merge pull request #2089 from rejas/newsfeed

Cleaned up newsfeed module code

CHANGELOG.md

@@ -18,6 +18,7 @@ _This release is scheduled to be released on 2020-10-01._
 ### Updated
 
 - Change incorrect weather.js default properties.
+- Cleaned up newsfeed module.
 
 ### Deleted
 

modules/default/newsfeed/newsfeed.js

@@ -84,11 +84,11 @@ Module.register("newsfeed", {
 
 	// Override dom generator.
 	getDom: function () {
-		var wrapper = document.createElement("div");
+		const wrapper = document.createElement("div");
 
 		if (this.config.feedUrl) {
 			wrapper.className = "small bright";
-			wrapper.innerHTML = this.translate("configuration_changed");
+			wrapper.innerHTML = this.translate("MODULE_CONFIG_CHANGED", { MODULE_NAME: "Newsfeed" });
 			return wrapper;
 		}
 
@@ -99,7 +99,7 @@ Module.register("newsfeed", {
 		if (this.newsItems.length > 0) {
 			// this.config.showFullArticle is a run-time configuration, triggered by optional notifications
 			if (!this.config.showFullArticle && (this.config.showSourceTitle || this.config.showPublishDate)) {
-				var sourceAndTimestamp = document.createElement("div");
+				const sourceAndTimestamp = document.createElement("div");
 				sourceAndTimestamp.className = "newsfeed-source light small dimmed";
 
 				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") {
@@ -157,22 +157,22 @@ Module.register("newsfeed", {
 			}
 
 			if (!this.config.showFullArticle) {
-				var title = document.createElement("div");
+				const title = document.createElement("div");
 				title.className = "newsfeed-title bright medium light" + (!this.config.wrapTitle ? " no-wrap" : "");
 				title.innerHTML = this.newsItems[this.activeItem].title;
 				wrapper.appendChild(title);
 			}
 
 			if (this.isShowingDescription) {
-				var description = document.createElement("div");
+				const description = document.createElement("div");
 				description.className = "newsfeed-desc small light" + (!this.config.wrapDescription ? " no-wrap" : "");
-				var txtDesc = this.newsItems[this.activeItem].description;
+				const txtDesc = this.newsItems[this.activeItem].description;
 				description.innerHTML = this.config.truncDescription ? (txtDesc.length > this.config.lengthDescription ? txtDesc.substring(0, this.config.lengthDescription) + "..." : txtDesc) : txtDesc;
 				wrapper.appendChild(description);
 			}
 
 			if (this.config.showFullArticle) {
-				var fullArticle = document.createElement("iframe");
+				const fullArticle = document.createElement("iframe");
 				fullArticle.className = "";
 				fullArticle.style.width = "100vw";
 				// very large height value to allow scrolling
@@ -332,17 +332,6 @@ Module.register("newsfeed", {
 		}, this.config.updateInterval);
 	},
 
-	/* capitalizeFirstLetter(string)
-	 * Capitalizes the first character of a string.
-	 *
-	 * argument string string - Input string.
-	 *
-	 * return string - Capitalized output string.
-	 */
-	capitalizeFirstLetter: function (string) {
-		return string.charAt(0).toUpperCase() + string.slice(1);
-	},
-
 	resetDescrOrFullArticleAndTimer: function () {
 		this.isShowingDescription = this.config.showDescription;
 		this.config.showFullArticle = false;
@@ -356,7 +345,7 @@ Module.register("newsfeed", {
 	},
 
 	notificationReceived: function (notification, payload, sender) {
-		var before = this.activeItem;
+		const before = this.activeItem;
 		if (notification === "ARTICLE_NEXT") {
 			this.activeItem++;
 			if (this.activeItem >= this.newsItems.length) {

modules/default/newsfeed/newsfeedfetcher.js

@@ -1,10 +1,9 @@
 /* Magic Mirror
- * Fetcher
+ * Node Helper: Newsfeed - NewsfeedFetcher
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
 const Log = require("../../../js/logger.js");
 const FeedMe = require("feedme");
 const request = require("request");
@@ -17,39 +16,39 @@ const iconv = require("iconv-lite");
  * attribute reloadInterval number - Reload interval in milliseconds.
  * attribute logFeedWarnings boolean - Log warnings when there is an error parsing a news article.
  */
+const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings) {
+	const self = this;
+
+	let reloadTimer = null;
+	let items = [];
+
+	let fetchFailedCallback = function () {};
+	let itemsReceivedCallback = function () {};
 
-var Fetcher = function (url, reloadInterval, encoding, logFeedWarnings) {
-	var self = this;
 	if (reloadInterval < 1000) {
 		reloadInterval = 1000;
 	}
 
-	var reloadTimer = null;
-	var items = [];
-
-	var fetchFailedCallback = function () {};
-	var itemsReceivedCallback = function () {};
-
 	/* private methods */
 
 	/* fetchNews()
 	 * Request the new items.
 	 */
-	var fetchNews = function () {
+	const fetchNews = function () {
 		clearTimeout(reloadTimer);
 		reloadTimer = null;
 		items = [];
 
-		var parser = new FeedMe();
+		const parser = new FeedMe();
 
 		parser.on("item", function (item) {
-			var title = item.title;
-			var description = item.description || item.summary || item.content || "";
-			var pubdate = item.pubdate || item.published || item.updated || item["dc:date"];
-			var url = item.url || item.link || "";
+			const title = item.title;
+			let description = item.description || item.summary || item.content || "";
+			const pubdate = item.pubdate || item.published || item.updated || item["dc:date"];
+			const url = item.url || item.link || "";
 
 			if (title && pubdate) {
-				var regex = /(<([^>]+)>)/gi;
+				const regex = /(<([^>]+)>)/gi;
 				description = description.toString().replace(regex, "");
 
 				items.push({
@@ -77,10 +76,17 @@ var Fetcher = function (url, reloadInterval, encoding, logFeedWarnings) {
 			scheduleTimer();
 		});
 
-		var nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
-		var headers = { "User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)", "Cache-Control": "max-age=0, no-cache, no-store, must-revalidate", Pragma: "no-cache" };
+		const nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
+		const opts = {
+			headers: {
+				"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)",
+				"Cache-Control": "max-age=0, no-cache, no-store, must-revalidate",
+				Pragma: "no-cache"
+			},
+			encoding: null
+		};
 
-		request({ uri: url, encoding: null, headers: headers })
+		request(url, opts)
 			.on("error", function (error) {
 				fetchFailedCallback(self, error);
 				scheduleTimer();
@@ -92,7 +98,7 @@ var Fetcher = function (url, reloadInterval, encoding, logFeedWarnings) {
 	/* scheduleTimer()
 	 * Schedule the timer for the next update.
 	 */
-	var scheduleTimer = function () {
+	const scheduleTimer = function () {
 		clearTimeout(reloadTimer);
 		reloadTimer = setTimeout(function () {
 			fetchNews();
@@ -148,4 +154,4 @@ var Fetcher = function (url, reloadInterval, encoding, logFeedWarnings) {
 	};
 };
 
-module.exports = Fetcher;
+module.exports = NewsfeedFetcher;

modules/default/newsfeed/node_helper.js

@@ -7,7 +7,7 @@
 
 const NodeHelper = require("node_helper");
 const validUrl = require("valid-url");
-const Fetcher = require("./fetcher.js");
+const NewsfeedFetcher = require("./newsfeedfetcher.js");
 const Log = require("../../../js/logger");
 
 module.exports = NodeHelper.create({
@@ -32,37 +32,35 @@ module.exports = NodeHelper.create({
 	 * attribute config object - A configuration object containing reload interval in milliseconds.
 	 */
 	createFetcher: function (feed, config) {
-		var self = this;
-
-		var url = feed.url || "";
-		var encoding = feed.encoding || "UTF-8";
-		var reloadInterval = feed.reloadInterval || config.reloadInterval || 5 * 60 * 1000;
+		const url = feed.url || "";
+		const encoding = feed.encoding || "UTF-8";
+		const reloadInterval = feed.reloadInterval || config.reloadInterval || 5 * 60 * 1000;
 
 		if (!validUrl.isUri(url)) {
-			self.sendSocketNotification("INCORRECT_URL", url);
+			this.sendSocketNotification("INCORRECT_URL", url);
 			return;
 		}
 
-		var fetcher;
-		if (typeof self.fetchers[url] === "undefined") {
+		let fetcher;
+		if (typeof this.fetchers[url] === "undefined") {
 			Log.log("Create new news fetcher for url: " + url + " - Interval: " + reloadInterval);
-			fetcher = new Fetcher(url, reloadInterval, encoding, config.logFeedWarnings);
+			fetcher = new NewsfeedFetcher(url, reloadInterval, encoding, config.logFeedWarnings);
 
-			fetcher.onReceive(function (fetcher) {
-				self.broadcastFeeds();
+			fetcher.onReceive(() => {
+				this.broadcastFeeds();
 			});
 
-			fetcher.onError(function (fetcher, error) {
-				self.sendSocketNotification("FETCH_ERROR", {
+			fetcher.onError((fetcher, error) => {
+				this.sendSocketNotification("FETCH_ERROR", {
 					url: fetcher.url(),
 					error: error
 				});
 			});
 
-			self.fetchers[url] = fetcher;
+			this.fetchers[url] = fetcher;
 		} else {
 			Log.log("Use existing news fetcher for url: " + url);
-			fetcher = self.fetchers[url];
+			fetcher = this.fetchers[url];
 			fetcher.setReloadInterval(reloadInterval);
 			fetcher.broadcastItems();
 		}

modules/default/newsfeed/translations/de.json

@@ -1,3 +0,0 @@
-{
-	"configuration_changed": "Die Konfigurationsoptionen für das Newsfeed-Modul haben sich geändert. \nBitte überprüfen Sie die Dokumentation."
-}

modules/default/newsfeed/translations/en.json

@@ -1,3 +0,0 @@
-{
-	"configuration_changed": "The configuration options for the newsfeed module have changed.\nPlease check the documentation."
-}

modules/default/newsfeed/translations/es.json

@@ -1,3 +0,0 @@
-{
-	"configuration_changed": "Las opciones de configuración para el módulo de suministro de noticias han cambiado. \nVerifique la documentación."
-}

modules/default/newsfeed/translations/fr.json

@@ -1,3 +0,0 @@
-{
-	"configuration_changed": "Les options de configuration du module newsfeed ont changé. \nVeuillez consulter la documentation."
-}

tests/unit/functions/newsfeed_spec.js

@@ -1,29 +1,15 @@
 const expect = require("chai").expect;
 
 describe("Functions into modules/default/newsfeed/newsfeed.js", function () {
+	// Fake for use by newsletter.js
 	Module = {};
 	Module.definitions = {};
 	Module.register = function (name, moduleDefinition) {
 		Module.definitions[name] = moduleDefinition;
 	};
 
-	// load newsfeed.js
-	require("../../../modules/default/newsfeed/newsfeed.js");
-
-	describe("capitalizeFirstLetter", 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.newsfeed.capitalizeFirstLetter(word)).to.equal(words[word]);
-			});
-		});
+	before(function () {
+		// load newsfeed.js
+		require("../../../modules/default/newsfeed/newsfeed.js");
 	});
 });

translations/de.json

@@ -26,6 +26,8 @@
 	"NW": "NW",
 	"NNW": "NNW",
 
+	"MODULE_CONFIG_CHANGED": "Die Konfigurationsoptionen für das {MODULE_NAME} Modul haben sich geändert. \nBitte überprüfen Sie die Dokumentation.",
+
 	"UPDATE_NOTIFICATION": "Aktualisierung für MagicMirror² verfügbar.",
 	"UPDATE_NOTIFICATION_MODULE": "Aktualisierung für das {MODULE_NAME} Modul verfügbar.",
 	"UPDATE_INFO_SINGLE": "Die aktuelle Installation ist {COMMIT_COUNT} Commit hinter dem {BRANCH_NAME} Branch.",

translations/en.json

@@ -26,6 +26,8 @@
 	"NW": "NW",
 	"NNW": "NNW",
 
+	"MODULE_CONFIG_CHANGED": "The configuration options for the {MODULE_NAME} module have changed.\nPlease check the documentation.",
+
 	"UPDATE_NOTIFICATION": "MagicMirror² update available.",
 	"UPDATE_NOTIFICATION_MODULE": "Update available for {MODULE_NAME} module.",
 	"UPDATE_INFO_SINGLE": "The current installation is {COMMIT_COUNT} commit behind on the {BRANCH_NAME} branch.",

translations/es.json

@@ -26,6 +26,8 @@
 	"NW": "NO",
 	"NNW": "NNO",
 
+	"MODULE_CONFIG_CHANGED": "Las opciones de configuración para el módulo {MODULE_NAME} han cambiado. \nVerifique la documentación.",
+
 	"UPDATE_NOTIFICATION": "MagicMirror² actualización disponible.",
 	"UPDATE_NOTIFICATION_MODULE": "Disponible una actualización para el módulo {MODULE_NAME}.",
 	"UPDATE_INFO_SINGLE": "Tu actual instalación está {COMMIT_COUNT} commit cambios detrás de la rama {BRANCH_NAME}.",

translations/fr.json

@@ -26,6 +26,8 @@
 	"NW": "NO",
 	"NNW": "NNO",
 
+	"MODULE_CONFIG_CHANGED": "Les options de configuration du module {MODULE_NAME} ont changé. \nVeuillez consulter la documentation.",
+
 	"UPDATE_NOTIFICATION": "Une mise à jour de MagicMirror² est disponible",
 	"UPDATE_NOTIFICATION_MODULE": "Une mise à jour est disponible pour le module {MODULE_NAME} .",
 	"UPDATE_INFO_SINGLE": "L'installation actuelle est {COMMIT_COUNT} commit en retard sur la branche {BRANCH_NAME} .",