From f118bc9cd5f7c26d78c1bd0d5c2979ec2927f406 Mon Sep 17 00:00:00 2001
From: smhg <sam.hauglustaine@gmail.com>
Date: Mon, 27 Jul 2020 20:51:25 +0200
Subject: [PATCH] improve code readability

---
 src/connector.js      |   2 +
 src/customevents.js   |  11 ++--
 src/less.js           |   3 ++
 src/livereload.js     |  35 ++++++++-----
 src/options.js        |  11 ++--
 src/protocol.js       |  20 ++++---
 src/reloader.js       |  95 +++++++++++++++++++++++----------
 test/reloader_test.js | 119 +++++++++++++++++++++++++++++-------------
 version-bower.js      |   6 ++-
 9 files changed, 211 insertions(+), 91 deletions(-)

diff --git a/src/connector.js b/src/connector.js
index 5924e61..8f1ce5e 100644
--- a/src/connector.js
+++ b/src/connector.js
@@ -121,6 +121,7 @@ class Connector {
   _closeOnError () {
     this._handshakeTimeout.stop();
     this._disconnectionReason = 'error';
+
     return this.socket.close();
   }
 
@@ -130,6 +131,7 @@ class Connector {
 
     // start handshake
     const hello = { command: 'hello', protocols: [PROTOCOL_6, PROTOCOL_7] };
+
     hello.ver = VERSION;
 
     if (this.options.ext) {
diff --git a/src/customevents.js b/src/customevents.js
index ab6fa71..9bf9582 100644
--- a/src/customevents.js
+++ b/src/customevents.js
@@ -2,21 +2,26 @@ const CustomEvents = {
   bind (element, eventName, handler) {
     if (element.addEventListener) {
       return element.addEventListener(eventName, handler, false);
-    } else if (element.attachEvent) {
+    }
+
+    if (element.attachEvent) {
       element[eventName] = 1;
+
       return element.attachEvent('onpropertychange', function (event) {
         if (event.propertyName === eventName) {
           return handler();
         }
       });
-    } else {
-      throw new Error(`Attempt to attach custom event ${eventName} to something which isn't a DOMElement`);
     }
+
+    throw new Error(`Attempt to attach custom event ${eventName} to something which isn't a DOMElement`);
   },
   fire (element, eventName) {
     if (element.addEventListener) {
       const event = document.createEvent('HTMLEvents');
+
       event.initEvent(eventName, true, true);
+
       return document.dispatchEvent(event);
     } else if (element.attachEvent) {
       if (element[eventName]) {
diff --git a/src/less.js b/src/less.js
index dbbed14..7c46328 100644
--- a/src/less.js
+++ b/src/less.js
@@ -20,13 +20,16 @@ class LessPlugin {
 
   reloadLess (path) {
     let link;
+
     const links = ((() => {
       const result = [];
+
       for (link of Array.from(document.getElementsByTagName('link'))) {
         if ((link.href && link.rel.match(/^stylesheet\/less$/i)) || (link.rel.match(/stylesheet/i) && link.type.match(/^text\/(x-)?less$/i))) {
           result.push(link);
         }
       }
+
       return result;
     })());
 
diff --git a/src/livereload.js b/src/livereload.js
index e58badb..690fd12 100644
--- a/src/livereload.js
+++ b/src/livereload.js
@@ -29,20 +29,25 @@ class LiveReload {
     // i can haz sockets?
     if (!(this.WebSocket = this.window.WebSocket || this.window.MozWebSocket)) {
       this.console.error('LiveReload disabled because the browser does not seem to support web sockets');
+
       return;
     }
 
     // i can haz options?
     if ('LiveReloadOptions' in window) {
       this.options = new Options();
+
       for (const k of Object.keys(window.LiveReloadOptions || {})) {
         const v = window.LiveReloadOptions[k];
+
         this.options.set(k, v);
       }
     } else {
       this.options = Options.extract(this.window.document);
+
       if (!this.options) {
         this.console.error('LiveReload disabled because it could not find its own <SCRIPT> tag');
+
         return;
       }
     }
@@ -82,6 +87,7 @@ class LiveReload {
         if (typeof this.listeners.disconnect === 'function') {
           this.listeners.disconnect();
         }
+
         switch (reason) {
           case 'cannot-connect':
             return this.log(`LiveReload cannot connect to ${this.options.host}:${this.options.port}, will retry in ${nextDelay} sec.`);
@@ -144,6 +150,7 @@ class LiveReload {
 
     this.connector.disconnect();
     this.log('LiveReload disconnected.');
+
     return (typeof this.listeners.shutdown === 'function' ? this.listeners.shutdown() : undefined);
   }
 
@@ -162,19 +169,20 @@ class LiveReload {
 
     this.pluginIdentifiers[PluginClass.identifier] = true;
 
-    const plugin = new PluginClass(this.window, {
-
-      // expose internal objects for those who know what they're doing
-      // (note that these are private APIs and subject to change at any time!)
-      _livereload: this,
-      _reloader: this.reloader,
-      _connector: this.connector,
-
-      // official API
-      console: this.console,
-      Timer,
-      generateCacheBustUrl: url => this.reloader.generateCacheBustUrl(url)
-    }
+    const plugin = new PluginClass(
+      this.window,
+      {
+        // expose internal objects for those who know what they're doing
+        // (note that these are private APIs and subject to change at any time!)
+        _livereload: this,
+        _reloader: this.reloader,
+        _connector: this.connector,
+
+        // official API
+        console: this.console,
+        Timer,
+        generateCacheBustUrl: url => this.reloader.generateCacheBustUrl(url)
+      }
     );
 
     // API that PluginClass can/must provide:
@@ -213,6 +221,7 @@ class LiveReload {
 
     for (const plugin of this.plugins) {
       var pluginData = (typeof plugin.analyze === 'function' ? plugin.analyze() : undefined) || {};
+
       pluginsData[plugin.constructor.identifier] = pluginData;
       pluginData.version = plugin.constructor.version;
     }
diff --git a/src/options.js b/src/options.js
index 29a5b79..02f4812 100644
--- a/src/options.js
+++ b/src/options.js
@@ -13,6 +13,7 @@ class Options {
     this.handshake_timeout = 5000;
 
     var pluginOrder = [];
+
     Object.defineProperty(this, 'pluginOrder', {
       get () { return pluginOrder; },
       set (v) { pluginOrder.push.apply(pluginOrder, v.split(/[,;]/)); }
@@ -34,13 +35,17 @@ class Options {
 
 Options.extract = function (document) {
   for (const element of Array.from(document.getElementsByTagName('script'))) {
-    var m; var mm;
-    var src = element.src; var srcAttr = element.getAttribute('src');
+    var src = element.src;
+    var srcAttr = element.getAttribute('src');
     var lrUrlRegexp = /^([^:]+:\/\/([^/:]+)(?::(\d+))?\/|\/\/|\/)?([^/].*\/)?z?livereload\.js(?:\?(.*))?$/;
     //                   ^proto:// ^host       ^port     ^//  ^/   ^folder
     var lrUrlRegexpAttr = /^(?:(?:([^:/]+)?:?)\/{0,2})([^:]+)(?::(\d+))?/;
     //                              ^proto             ^host/folder ^port
-    if ((m = src.match(lrUrlRegexp)) && (mm = srcAttr.match(lrUrlRegexpAttr))) {
+
+    var m = src.match(lrUrlRegexp);
+    var mm = srcAttr.match(lrUrlRegexpAttr);
+
+    if (m && mm) {
       const [, , host, port, , params] = m;
       const [, , , portFromAttr] = mm;
       const options = new Options();
diff --git a/src/protocol.js b/src/protocol.js
index 94dc859..5713630 100644
--- a/src/protocol.js
+++ b/src/protocol.js
@@ -21,6 +21,7 @@ class Parser {
   process (data) {
     try {
       let message;
+
       if (!this.protocol) {
         if (data.match(new RegExp('^!!ver:([\\d.]+)$'))) {
           this.protocol = 6;
@@ -37,12 +38,17 @@ class Parser {
         }
 
         return this.handlers.connected(this.protocol);
-      } else if (this.protocol === 6) {
+      }
+
+      if (this.protocol === 6) {
         message = JSON.parse(data);
+
         if (!message.length) {
           throw new ProtocolError('protocol 6 messages must be arrays');
         }
+
         const [command, options] = Array.from(message);
+
         if (command !== 'refresh') {
           throw new ProtocolError('unknown protocol 6 command');
         }
@@ -52,17 +58,17 @@ class Parser {
           path: options.path,
           liveCSS: options.apply_css_live != null ? options.apply_css_live : true
         });
-      } else {
-        message = this._parseMessage(data, ['reload', 'alert']);
-
-        return this.handlers.message(message);
       }
+
+      message = this._parseMessage(data, ['reload', 'alert']);
+
+      return this.handlers.message(message);
     } catch (e) {
       if (e instanceof ProtocolError) {
         return this.handlers.error(e);
-      } else {
-        throw e;
       }
+
+      throw e;
     }
   }
 
diff --git a/src/reloader.js b/src/reloader.js
index 5a52c02..ee2539e 100644
--- a/src/reloader.js
+++ b/src/reloader.js
@@ -1,15 +1,17 @@
 /* global CSSRule */
-const splitUrl = function (url) {
-  let hash, index, params;
-  if ((index = url.indexOf('#')) >= 0) {
+function splitUrl (url) {
+  let hash = '';
+  let params = '';
+  let index = url.indexOf('#');
+
+  if (index >= 0) {
     hash = url.slice(index);
     url = url.slice(0, index);
-  } else {
-    hash = '';
   }
 
   // http://your.domain.com/path/to/combo/??file1.css,file2,css
   const comboSign = url.indexOf('??');
+
   if (comboSign >= 0) {
     if ((comboSign + 1) !== url.lastIndexOf('?')) {
       index = url.lastIndexOf('?');
@@ -17,22 +19,24 @@ const splitUrl = function (url) {
   } else {
     index = url.indexOf('?');
   }
+
   if (index >= 0) {
     params = url.slice(index);
     url = url.slice(0, index);
-  } else {
-    params = '';
   }
 
   return { url, params, hash };
 };
 
-const pathFromUrl = function (url) {
+function pathFromUrl (url) {
   if (!url) {
     return '';
   }
+
   let path;
+
   ({ url } = splitUrl(url));
+
   if (url.indexOf('file://') === 0) {
     path = url.replace(new RegExp('^file://(localhost)?'), '');
   } else {
@@ -42,13 +46,15 @@ const pathFromUrl = function (url) {
 
   // decodeURI has special handling of stuff like semicolons, so use decodeURIComponent
   return decodeURIComponent(path);
-};
+}
 
-const pickBestMatch = function (path, objects, pathFunc) {
+function pickBestMatch (path, objects, pathFunc) {
   let score;
   let bestMatch = { score: 0 };
+
   for (const object of objects) {
     score = numberOfMatchingSegments(path, pathFunc(object));
+
     if (score > bestMatch.score) {
       bestMatch = { object, score };
     }
@@ -59,30 +65,33 @@ const pickBestMatch = function (path, objects, pathFunc) {
   }
 
   return bestMatch;
-};
+}
 
-var numberOfMatchingSegments = function (path1, path2) {
+function numberOfMatchingSegments (left, right) {
   // get rid of leading slashes and normalize to lower case
-  path1 = path1.replace(/^\/+/, '').toLowerCase();
-  path2 = path2.replace(/^\/+/, '').toLowerCase();
+  left = left.replace(/^\/+/, '').toLowerCase();
+  right = right.replace(/^\/+/, '').toLowerCase();
 
-  if (path1 === path2) {
+  if (left === right) {
     return 10000;
   }
 
-  const comps1 = path1.split('/').reverse();
-  const comps2 = path2.split('/').reverse();
+  const comps1 = left.split('/').reverse();
+  const comps2 = right.split('/').reverse();
   const len = Math.min(comps1.length, comps2.length);
 
   let eqCount = 0;
+
   while ((eqCount < len) && (comps1[eqCount] === comps2[eqCount])) {
     ++eqCount;
   }
 
   return eqCount;
-};
+}
 
-const pathsMatch = (path1, path2) => numberOfMatchingSegments(path1, path2) > 0;
+function pathsMatch (left, right) {
+  return numberOfMatchingSegments(left, right) > 0;
+}
 
 const IMAGE_STYLES = [
   { selector: 'background', styleNames: ['backgroundImage'] },
@@ -108,6 +117,7 @@ class Reloader {
 
   reload (path, options) {
     this.options = options; // avoid passing it through all the funcs
+
     if (!this.options.stylesheetReloadTimeout) {
       this.options.stylesheetReloadTimeout = 15000;
     }
@@ -122,19 +132,23 @@ class Reloader {
         return;
       }
     }
+
     if (options.liveCSS && path.match(/\.css(?:\.map)?$/i)) {
       if (this.reloadStylesheet(path)) {
         return;
       }
     }
+
     if (options.liveImg && path.match(/\.(jpe?g|png|gif)$/i)) {
       this.reloadImages(path);
       return;
     }
+
     if (options.isChromeExtension) {
       this.reloadChromeExtension();
       return;
     }
+
     return this.reloadPage();
   }
 
@@ -147,22 +161,26 @@ class Reloader {
           }
         }
       }
+
       if (pluginId === 'img') {
         if (options.liveImg && path.match(/\.(jpe?g|png|gif)$/i)) {
           this.reloadImages(path);
           return true;
         }
       }
+
       if (pluginId === 'extension') {
         if (options.isChromeExtension) {
           this.reloadChromeExtension();
           return true;
         }
       }
+
       if (pluginId === 'others') {
         this.reloadPage();
         return true;
       }
+
       if (pluginId === 'external') {
         return this.plugins.some(plugin => {
           if (plugin.reload && plugin.reload(path, options)) {
@@ -173,11 +191,12 @@ class Reloader {
 
       return this.plugins.filter(
         plugin => plugin.constructor.identifier === pluginId
-      ).some(plugin => {
-        if (plugin.reload && plugin.reload(path, options)) {
-          return true;
-        }
-      });
+      )
+        .some(plugin => {
+          if (plugin.reload && plugin.reload(path, options)) {
+            return true;
+          }
+        });
     });
   }
 
@@ -216,6 +235,7 @@ class Reloader {
 
   reloadStylesheetImages (styleSheet, path, expando) {
     let rules;
+
     try {
       rules = (styleSheet || {}).cssRules;
     } catch (e) {}
@@ -244,14 +264,16 @@ class Reloader {
   reloadStyleImages (style, styleNames, path, expando) {
     for (const styleName of styleNames) {
       const value = style[styleName];
+
       if (typeof value === 'string') {
         const newValue = value.replace(new RegExp('\\burl\\s*\\(([^)]*)\\)'), (match, src) => {
           if (pathsMatch(path, pathFromUrl(src))) {
             return `url(${this.generateCacheBustUrl(src, expando)})`;
-          } else {
-            return match;
           }
+
+          return match;
         });
+
         if (newValue !== value) {
           style[styleName] = newValue;
         }
@@ -263,23 +285,28 @@ class Reloader {
     // has to be a real array, because DOMNodeList will be modified
     let style;
     let link;
+
     const links = ((() => {
       const result = [];
+
       for (link of Array.from(this.document.getElementsByTagName('link'))) {
         if (link.rel.match(/^stylesheet$/i) && !link.__LiveReload_pendingRemoval) {
           result.push(link);
         }
       }
+
       return result;
     })());
 
     // find all imported stylesheets
     const imported = [];
+
     for (style of Array.from(this.document.getElementsByTagName('style'))) {
       if (style.sheet) {
         this.collectImportedStylesheets(style, style.sheet, imported);
       }
     }
+
     for (link of Array.from(links)) {
       this.collectImportedStylesheets(link, link.sheet, imported);
     }
@@ -292,6 +319,7 @@ class Reloader {
     }
 
     this.console.log(`LiveReload found ${links.length} LINKed stylesheets, ${imported.length} @imported stylesheets`);
+
     const match = pickBestMatch(
       path,
       links.concat(imported),
@@ -311,6 +339,7 @@ class Reloader {
         this.console.log(`LiveReload will reload all stylesheets because path '${path}' did not match any specific one. \
 To disable this behavior, set 'options.reloadMissingCSS' to 'false'.`
         );
+
         for (link of Array.from(links)) {
           this.reattachStylesheetLink(link);
         }
@@ -382,9 +411,9 @@ and 'options.reloadMissingCSS' was set to 'false'.`
           this.console.log('LiveReload is polling until the new CSS finishes loading...');
 
           return executeCallback();
-        } else {
-          return this.Timer.start(50, poll);
         }
+
+        return this.Timer.start(50, poll);
       })();
     }
 
@@ -400,7 +429,11 @@ and 'options.reloadMissingCSS' was set to 'false'.`
   reattachStylesheetLink (link) {
     // ignore LINKs that will be removed by LR soon
     let clone;
-    if (link.__LiveReload_pendingRemoval) { return; }
+
+    if (link.__LiveReload_pendingRemoval) {
+      return;
+    }
+
     link.__LiveReload_pendingRemoval = true;
 
     if (link.tagName === 'STYLE') {
@@ -417,6 +450,7 @@ and 'options.reloadMissingCSS' was set to 'false'.`
 
     // insert the new LINK before the old one
     const parent = link.parentNode;
+
     if (parent.lastChild === link) {
       parent.appendChild(clone);
     } else {
@@ -508,12 +542,15 @@ and 'options.reloadMissingCSS' was set to 'false'.`
     if (!expando) {
       expando = this.generateUniqueString();
     }
+
     ({ url, hash, params: oldParams } = splitUrl(url));
 
     if (this.options.overrideURL) {
       if (url.indexOf(this.options.serverURL) < 0) {
         const originalUrl = url;
+
         url = this.options.serverURL + this.options.overrideURL + '?url=' + encodeURIComponent(url);
+
         this.console.log(`LiveReload is overriding source URL ${originalUrl} with ${url}`);
       }
     }
diff --git a/test/reloader_test.js b/test/reloader_test.js
index a68c57b..2bca11c 100644
--- a/test/reloader_test.js
+++ b/test/reloader_test.js
@@ -72,10 +72,18 @@ describe('Reloader', () => {
     });
 
     it('should reload when doc at the same location changed', (done) => {
+      const location = {
+        pathname: '/1.html',
+        reload: done
+      };
+
       const window = {
-        document: { location: { pathname: '/1.html', reload: done } }
+        document: {
+          location
+        },
+        location
       };
-      window.location = window.document.location;
+
       const reloader = new Reloader(
         window,
         console,
@@ -99,17 +107,20 @@ describe('Reloader', () => {
     });
 
     it('should not reload when different html changed', (done) => {
+      const location = {
+        pathname: '/1.html',
+        reload () {
+          throw new Error('Shall not reload!');
+        }
+      };
+
       const window = {
         document: {
-          location: {
-            pathname: '/1.html',
-            reload () {
-              throw new Error('Shall not reload!');
-            }
-          }
-        }
+          location
+        },
+        location
       };
-      window.location = window.document.location;
+
       const reloader = new Reloader(
         window,
         console,
@@ -137,18 +148,24 @@ describe('Reloader', () => {
     });
 
     it('should not reload the page with liveCSS and css file updated', (done) => {
+      const window = {
+        document: {
+          location: {
+            reload () {
+              throw new Error('Shall not reload!');
+            }
+          },
+          getElementsByTagName () { return []; }
+        }
+      };
+
+      const console = {
+        log () {}
+      };
+
       const reloader = new Reloader(
-        {
-          document: {
-            location: {
-              reload () {
-                throw new Error('Shall not reload!');
-              }
-            },
-            getElementsByTagName () { return []; }
-          }
-        },
-        { log () {} },
+        window,
+        console,
         Timer
       );
 
@@ -169,8 +186,14 @@ describe('Reloader', () => {
 
   describe('reload() with plugin order', () => {
     it('should reload with same plugin order', (done) => {
+      const window = {
+        document: {
+          location: { reload: done }
+        }
+      };
+
       const reloader = new Reloader(
-        { document: { location: { reload: done } } },
+        window,
         console,
         Timer
       );
@@ -191,8 +214,18 @@ describe('Reloader', () => {
     });
 
     it('should not reload with unknown url and no `others` plugin', (done) => {
+      const window = {
+        document: {
+          location: {
+            reload () {
+              throw new Error('Shall not reload!');
+            }
+          }
+        }
+      };
+
       const reloader = new Reloader(
-        { document: { location: { reload () { throw new Error('Shall not reload!'); } } } },
+        window,
         console,
         Timer
       );
@@ -217,8 +250,16 @@ describe('Reloader', () => {
     });
 
     it('should reload anyway', (done) => {
+      const window = {
+        document: {
+          location: {
+            reload: done
+          }
+        }
+      };
+
       const reloader = new Reloader(
-        { document: { location: { reload: done } } },
+        window,
         console,
         Timer
       );
@@ -235,18 +276,26 @@ describe('Reloader', () => {
     });
 
     it('should not reload the page with liveCSS and css file updated', (done) => {
-      const reloader = new Reloader(
-        {
-          document: {
-            location: {
-              reload () {
-                throw new Error('Shall not reload!');
-              }
-            },
-            getElementsByTagName () { return []; }
+      const window = {
+        document: {
+          location: {
+            reload () {
+              throw new Error('Shall not reload!');
+            }
+          },
+          getElementsByTagName () {
+            return [];
           }
-        },
-        { log () {} },
+        }
+      };
+
+      const console = {
+        log () {}
+      };
+
+      const reloader = new Reloader(
+        window,
+        console,
         Timer
       );
 
diff --git a/version-bower.js b/version-bower.js
index 7eccc10..e99eaf1 100755
--- a/version-bower.js
+++ b/version-bower.js
@@ -5,7 +5,11 @@ const writeFile = promisify(require('fs').writeFile);
 const { version } = require('./package.json');
 const bwr = require('./bower.json');
 
-writeFile('./bower.json', `${JSON.stringify({ ...bwr, version }, null, 2)}\n`, 'utf8')
+writeFile(
+  './bower.json',
+  `${JSON.stringify({ ...bwr, version }, null, 2)}\n`,
+  'utf8'
+)
   .catch(err => {
     throw err;
   });