nodebb-plugin-poll 1.1.7 → 2.0.2

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "nodebb-plugin-poll",
-  "version": "1.1.7",
+  "version": "2.0.2",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {
+    "lint": "eslint .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -21,11 +22,15 @@
     "url": "https://github.com/Schamper/nodebb-plugin-poll/issues"
   },
   "dependencies": {
-    "async": "~1.5.2",
-    "xregexp": "~3.1.0",
-    "cron": "~1.1.0"
+    "async": "^3.2.0",
+    "cron": "^1.8.2"
   },
   "nbbpm": {
-    "compatibility": "^1.15.0"
+    "compatibility": "^1.17.0"
+  },
+  "devDependencies": {
+    "eslint": "^7.31.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.23.4"
   }
 }

package/plugin.json

@@ -26,7 +26,8 @@
     { "hook": "action:topic.restore", "method": "hooks.action.topicRestore" }
   ],
   "staticDirs": {
-    "public": "public"
+    "public": "public",
+    "vendor": "vendor"
   },
   "less": [
     "public/less/style.less"
@@ -36,14 +37,19 @@
     "public/js/poll/serializer.js",
     "public/js/poll/sockets.js",
     "public/js/poll/creator.js",
-    "public/js/poll/view.js",
-    "public/js/vendor/moment.min.js",
-    "public/js/vendor/flatpickr.min.js",
-    "public/js/vendor/jquery.serialize-object.min.js"
+    "public/js/poll/view.js"
   ],
   "acpScripts": [
     "public/js/admin.js"
   ],
+  "modules": {
+    "dayjs.js": "vendor/dayjs.min.js",
+    "flatpickr.js": "vendor/flatpickr.min.js",
+    "flatpickr.i10n.js": "vendor/flatpickr.l10n.js"
+  },
+  "css": [
+    "vendor/flatpickr.min.css"
+  ],
   "templates": "templates",
   "languages": "languages",
   "upgrades": [

package/public/js/.eslintrc

@@ -0,0 +1,82 @@
+{
+	"globals": {
+		"app": true,
+		"io": true,
+		"socket": true,
+		"ajaxify": true,
+		"config": true,
+		"utils": true,
+		"overrides": true,
+		"componentHandler": true,
+		"bootbox": true,
+		"Visibility": true,
+		"Tinycon": true,
+		"Promise": true
+	},
+	"env": {
+		"jquery": true,
+		"amd": true,
+		"browser": true,
+		"es6": true
+	},
+	"rules": {
+		"comma-dangle": ["error", {
+			"arrays": "always-multiline",
+			"objects": "always-multiline",
+			"imports": "always-multiline",
+			"exports": "always-multiline",
+			"functions": "never"
+		}],
+		"block-scoped-var": "off",
+		"no-dupe-class-members": "off",
+		"prefer-object-spread": "off",
+		"prefer-reflect": "off",
+
+		// ES6
+		"prefer-rest-params": "off",
+		"prefer-spread": "off",
+		"prefer-arrow-callback": "off",
+		"prefer-template": "off",
+		"no-var": "off",
+		"object-shorthand": "off",
+		"vars-on-top": "off",
+		"prefer-destructuring": "off",
+		// identical to airbnb rule
+		// except for allowing for..in, because for..of is unavailable on some clients
+		"no-restricted-syntax": [
+			"error",
+			{
+				"selector": "ForOfStatement",
+				"message": "iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations."
+			},
+			{
+				"selector": "LabeledStatement",
+				"message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand."
+			},
+			{
+				"selector": "WithStatement",
+				"message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
+			}
+		]
+	},
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"ecmaFeatures": {
+			"classes": false,
+			"defaultParams": false,
+			"blockBindings": false,
+			"forOf": false,
+			"generators": false,
+			"globalReturn": false,
+			"jsx": false,
+			"modules": false,
+			"objectLiteralComputedProperties": false,
+			"objectLiteralDuplicateProperties": false,
+			"objectLiteralShorthandMethods": false,
+			"objectLiteralShorthandProperties": false,
+			"impliedStrict": false,
+			"restParams": false,
+			"superInFunctions": false
+		}
+	}
+}

package/public/js/admin.js

@@ -1,36 +1,38 @@
 'use strict';
-/* globals $, app, socket, define, bootbox */
 
-define('admin/plugins/poll', ['settings'], function(Settings) {
+define('admin/plugins/poll', ['settings'], function (Settings) {
 	var wrapper;
 
 	var ACP = {};
 
-	ACP.init = function() {
+	ACP.init = function () {
 		wrapper = $('.poll-settings');
 
 		Settings.sync('poll', wrapper);
 
-		$('#save').on('click', function() {
+		$('#save').on('click', function () {
 			save();
 		});
 
-		$('#reset').click(function() {
+		$('#reset').click(function () {
 			reset();
 		});
 	};
 
 	function save() {
-		Settings.persist('poll', wrapper, function() {
+		Settings.persist('poll', wrapper, function () {
 			socket.emit('admin.plugins.poll.sync');
 		});
 	}
 
 	function reset() {
-		bootbox.confirm('Are you sure you wish to reset the settings?', function(sure) {
+		bootbox.confirm('Are you sure you wish to reset the settings?', function (sure) {
 			if (sure) {
 				socket.emit('admin.plugins.poll.getDefaults', null, function (err, data) {
-					Settings.set('poll', data, wrapper, function(){
+					if (err) {
+						console.error(err);
+					}
+					Settings.set('poll', data, wrapper, function () {
 						socket.emit('admin.plugins.poll.sync');
 					});
 				});
@@ -39,4 +41,4 @@ define('admin/plugins/poll', ['settings'], function(Settings) {
 	}
 
 	return ACP;
-});
+});

package/public/js/poll/creator.js

@@ -1,8 +1,6 @@
-"use strict";
-/* globals $, app, templates, bootbox, define */
-
-(function(Poll) {
+'use strict';
 
+(function (Poll) {
 	var Creator = {};
 
 	function init() {
@@ -10,7 +8,7 @@
 
 		$(window).on('action:redactor.load', initRedactor);
 
-		$(window).on('action:composer.loaded', function(ev, data) {
+		$(window).on('action:composer.loaded', function (ev, data) {
 			if ($.Redactor) {
 				if (data.composerData.isMain && $.Redactor.opts.plugins.indexOf('poll') === -1) {
 					$.Redactor.opts.plugins.push('poll');
@@ -22,9 +20,9 @@
 	}
 
 	function initComposer() {
-		require(['composer', 'composer/formatting', 'composer/controls'], function(composer, formatting, controls) {
+		require(['composer', 'composer/formatting', 'composer/controls'], function (composer, formatting, controls) {
 			if (formatting && controls) {
-				formatting.addButtonDispatch('poll', function(textarea) {
+				formatting.addButtonDispatch('poll', function (textarea) {
 					composerBtnHandle(composer, textarea);
 				});
 			}
@@ -39,45 +37,49 @@
 
 					// require translator as such because it was undefined without it
 					require(['translator'], function (translator) {
-						translator.translate('[[poll:creator_title]]', function(translated) {
+						translator.translate('[[poll:creator_title]]', function (translated) {
 							var button = self.button.add('poll', translated);
 							self.button.setIcon(button, '<i class="fa fa-bar-chart-o"></i>');
 							self.button.addCallback(button, self.poll.onClick);
 						});
-					})
+					});
 				},
 				onClick: function () {
 					var self = this;
 					var code = this.code.get();
-					require(['composer'], function(composer) {
+					require(['composer'], function (composer) {
 						composerBtnHandle(composer, {
 							value: code,
 							redactor: function (code) {
 								self.code.set(code);
-							}
+							},
 						});
 					});
-				}
+				},
 			};
 		};
 	}
 
 	function composerBtnHandle(composer, textarea) {
-		require(['composer/controls'], function(controls) {
+		require(['composer/controls'], function (controls) {
 			var post = composer.posts[composer.active];
 			if (!post || !post.isMain || (isNaN(parseInt(post.cid, 10)) && isNaN(parseInt(post.pid, 10)))) {
 				return app.alertError('[[poll:error.not_main]]');
 			}
 			if (parseInt(post.cid, 10) === 0) {
-				return app.alertError("[[error:category-not-selected]]");
+				return app.alertError('[[error:category-not-selected]]');
 			}
 
-			Poll.sockets.canCreate({cid: post.cid, pid: post.pid}, function(err, canCreate) {
+			Poll.sockets.canCreate({ cid: post.cid, pid: post.pid }, function (err, canCreate) {
 				if (err || !canCreate) {
 					return app.alertError(err.message);
 				}
 
-				Poll.sockets.getConfig(null, function(err, config) {
+				Poll.sockets.getConfig(null, function (err, config) {
+					if (err) {
+						console.error(err);
+					}
+
 					var poll = {};
 
 					// If there's already a poll in the post, serialize it for editing
@@ -91,7 +93,7 @@
 						}
 					}
 
-					Creator.show(poll, config, function(data) {
+					Creator.show(poll, config, function (data) {
 						// Anything invalid will be discarded by the serializer
 						var markup = Poll.serializer.deserialize(data, config);
 
@@ -114,85 +116,97 @@
 		});
 	}
 
-	Creator.show = function(poll, config, callback) {
+	Creator.show = function (poll, config, callback) {
 		if (poll.hasOwnProperty('info')) {
 			return app.alertError('Editing not implemented.');
 		}
 
-		app.parseAndTranslate('poll/creator', { poll: poll, config: config, isRedactor: !!$.Redactor }, function(html) {
-			// Initialise modal
-			var modal = bootbox.dialog({
-				title: '[[poll:creator_title]]',
-				message: html,
-				className: 'poll-creator',
-				buttons: {
-					cancel: {
-						label: '[[modules:bootbox.cancel]]',
-						className: 'btn-default',
-						callback: function() {
-							return true
-						}
+		require(['flatpickr', 'flatpickr.i10n', 'bootbox', 'dayjs', 'translator'], function (flatpickr, flatpickrI10N, bootbox, dayjs, Translator) {
+			app.parseAndTranslate('poll/creator', { poll: poll, config: config, isRedactor: !!$.Redactor }, function (html) {
+				// Initialise modal
+				var modal = bootbox.dialog({
+					title: '[[poll:creator_title]]',
+					message: html,
+					className: 'poll-creator',
+					buttons: {
+						cancel: {
+							label: '[[modules:bootbox.cancel]]',
+							className: 'btn-default',
+							callback: function () {
+								return true;
+							},
+						},
+						save: {
+							label: '[[modules:bootbox.confirm]]',
+							className: 'btn-primary',
+							callback: function (e) {
+								clearErrors();
+								var form = $(e.currentTarget).parents('.bootbox').find('#pollCreator');
+								var obj = serializeObjectFromForm(form);
+
+								// Let's be nice and at least show an error if there are no options
+								obj.options.filter(function (obj) {
+									return obj.length;
+								});
+
+								if (obj.options.length === 0) {
+									return error('[[poll:error.no_options]]');
+								}
+
+								if (obj.settings.end && !dayjs(new Date(obj.settings.end)).isValid()) {
+									return error('[[poll:error.valid_date]]');
+								} else if (obj.settings.end) {
+									obj.settings.end = dayjs(new Date(obj.settings.end)).valueOf();
+								}
+
+								callback(obj);
+								return true;
+							},
+						},
 					},
-					save: {
-						label: '[[modules:bootbox.confirm]]',
-						className: 'btn-primary',
-						callback: function(e) {
-							clearErrors();
-							var form = $(e.currentTarget).parents('.bootbox').find('#pollCreator');
-							var obj = form.serializeObject();
-
-							// Let's be nice and at least show an error if there are no options
-							obj.options.filter(function(obj) {
-								return obj.length;
-							});
-
-							if (obj.options.length == 0) {
-								return error('[[poll:error.no_options]]');
-							}
+				});
 
-							if (obj.settings.end && !moment(new Date(obj.settings.end)).isValid()) {
-								return error('[[poll:error.valid_date]]');
-							} else if (obj.settings.end) {
-								obj.settings.end = moment(new Date(obj.settings.end)).valueOf();
-							}
+				// Add option adder
+				modal.find('#pollAddOption')
+					.off('click')
+					.on('click', function (e) {
+						var el = $(e.currentTarget);
+						var prevOption = el.prev();
 
-							callback(obj);
-							return true;
+						if (config.limits.maxOptions <= el.prevAll('input').length) {
+							clearErrors();
+							require(['translator'], function (translator) {
+								translator.translate('[[poll:error.max_options]]', function (text) {
+									error(text.replace('%d', config.limits.maxOptions));
+								});
+							});
+							return false;
 						}
-					}
-				}
-			});
 
-			// Add option adder
-			modal.find('#pollAddOption')
-				.off('click')
-				.on('click', function(e) {
-					var el = $(e.currentTarget);
-					var prevOption = el.prev();
-
-					if (config.limits.maxOptions <= el.prevAll('input').length) {
-						clearErrors();
-						translator.translate('[[poll:error.max_options]]', function(text) {
-							error(text.replace('%d', config.limits.maxOptions));
-						});
-						return false;
-					}
-
-					if (prevOption.val().length != 0) {
-						prevOption.clone().val('').insertBefore(el).focus();
-					}
-				});
+						if (prevOption.val().length !== 0) {
+							prevOption.clone().val('').insertBefore(el).focus();
+						}
+					});
 
-				flatpickr("#pollInputEnd", {
+				var currentLocale = Translator.getLanguage();
+				var flatpickrInstance = flatpickr('.flatpickr', {
 					enableTime: true,
-					altFormat: "F j, Y h:i K",
+					altFormat: 'F j, Y h:i K',
 					time_24hr: false,
-					wrap: true
+					wrap: true,
+					locale: getFlatpickrLocale(currentLocale, flatpickrI10N.default),
+					onOpen: function () {
+						modal.removeAttr('tabindex');
+					},
+					onClose: function () {
+						modal.attr('tabindex', -1);
+					},
 				});
 
 				if (poll.settings && poll.settings.end) {
-					flatpickr.setDate(poll.settings.end)
+					flatpickrInstance.setDate(poll.settings.end);
 				}
+			});
 		});
 	};
 
@@ -209,31 +223,29 @@
 		$('#pollErrorBox').addClass('hidden').html('');
 	}
 
-	function dumbifyObject(obj) {
-		var result = {};
+	function serializeObjectFromForm(form) {
+		var obj = form.serializeObject();
+		var result = {
+			options: obj.options,
+			settings: {
+				title: obj['settings.title'],
+				maxvotes: obj['settings.maxvotes'],
+				disallowVoteUpdate: obj['settings.disallowVoteUpdate'] === 'on' ? 'true' : 'false',
+				end: obj['settings.end'],
+			},
+		};
 
-		for (var key in obj) {
-			if (obj.hasOwnProperty(key)) {
-				var val = obj[key];
+		return result;
+	}
 
-				if (jQuery.isPlainObject(val)) {
-					var obj1 = dumbifyObject(val);
-					for (var k1 in obj1) {
-						if (obj1.hasOwnProperty(k1)) {
-							result[key + '.' + k1] = obj1[k1];
-						}
-					}
-				} else {
-					result[key] = val;
-				}
-			}
+	function getFlatpickrLocale(nodebbLocale, flatpickrLocales = {}) {
+		if (Object.keys(flatpickrLocales).includes(nodebbLocale.toLowerCase())) {
+			return flatpickrLocales[nodebbLocale];
 		}
-
-		return result;
+		return flatpickrLocales.default;
 	}
 
 	Poll.creator = Creator;
 
 	init();
-
-})(window.Poll);
+}(window.Poll));

package/public/js/poll/main.js

@@ -1,16 +1,15 @@
-"use strict";
+'use strict';
 
 var Poll = {};
 
-(function() {
-
-	$(window).on('action:topic.loading', function() {
+(function () {
+	$(window).on('action:topic.loading', function () {
 		if (ajaxify.data.posts.length > 0 && ajaxify.data.posts[0].hasOwnProperty('pollId')) {
 			getPoll(ajaxify.data.posts[0].pollId);
 		}
 	});
 
-	$(window).on('action:posts.edited', function(ev, data) {
+	$(window).on('action:posts.edited', function (ev, data) {
 		if (data.post.hasOwnProperty('pollId')) {
 			getPoll(data.post.pollId);
 		}
@@ -20,7 +19,7 @@ var Poll = {};
 		pollId = parseInt(pollId, 10);
 
 		if (!isNaN(pollId)) {
-			Poll.sockets.getPoll({pollId: pollId}, function(err, pollData) {
+			Poll.sockets.getPoll({ pollId: pollId }, function (err, pollData) {
 				if (err) {
 					return app.alertError(err.message);
 				}
@@ -28,5 +27,4 @@ var Poll = {};
 			});
 		}
 	}
-
-})();
+}());