Code cleanup (#120)

* Lots of code cleanup

* Cleanup parse-options tests
  - Rename objects for clarity and inline unneeded objects
  - Remove unneeded tests
  - Use Object.keys().length instead of a custom function
  - Use typeof === "object" instead of a custom function that checks the prototype tree as well, since we don't expect anything but an object literal.

* Remove old switchFallback code

* Remove polyfill for Function.prototype.bind

* Inline small functions

* Add more documentation and tests for options.currentUrlFullReload
  Closes #17

* Update package.json

Author: BehindTheMath

README.md

@@ -1,19 +1,14 @@
 var clone = require("./lib/clone.js")
 var executeScripts = require("./lib/execute-scripts.js")
-
 var forEachEls = require("./lib/foreach-els.js")
-
+var switches = require("./lib/switches")
 var newUid = require("./lib/uniqueid.js")
 
-var noop = require("./lib/util/noop")
-var contains = require("./lib/util/contains.js")
-
 var on = require("./lib/events/on.js")
-// var off = require("./lib/events/on.js")
 var trigger = require("./lib/events/trigger.js")
 
-var defaultSwitches = require("./lib/switches")
-
+var contains = require("./lib/util/contains.js")
+var noop = require("./lib/util/noop")
 
 var Pjax = function(options) {
     this.state = {
@@ -22,8 +17,8 @@ var Pjax = function(options) {
       options: null
     }
 
-    var parseOptions = require("./lib/proto/parse-options.js");
-    parseOptions.apply(this,[options])
+    var parseOptions = require("./lib/proto/parse-options.js")
+    parseOptions.call(this,options)
     this.log("Pjax options", this.options)
 
     if (this.options.scrollRestoration && "scrollRestoration" in history) {
@@ -40,7 +35,7 @@ var Pjax = function(options) {
         opt.url = st.state.url
         opt.title = st.state.title
         opt.history = false
-        opt.requestOptions = {};
+        opt.requestOptions = {}
         opt.scrollPos = st.state.scrollPos
         if (st.state.uid < this.lastUid) {
           opt.backward = true
@@ -56,18 +51,27 @@ var Pjax = function(options) {
     }.bind(this))
   }
 
-Pjax.switches = defaultSwitches
+Pjax.switches = switches
 
 Pjax.prototype = {
   log: require("./lib/proto/log.js"),
 
-  getElements: require("./lib/proto/get-elements.js"),
+  getElements: function(el) {
+    return el.querySelectorAll(this.options.elements)
+  },
 
-  parseDOM: require("./lib/proto/parse-dom.js"),
+  parseDOM: function(el) {
+    var parseElement = require("./lib/proto/parse-element")
+    forEachEls(this.getElements(el), parseElement, this)
+  },
 
-  refresh: require("./lib/proto/refresh.js"),
+  refresh: function(el) {
+    this.parseDOM(el || document)
+  },
 
-  reload: require("./lib/reload.js"),
+  reload: function() {
+    window.location.reload()
+  },
 
   attachLink: require("./lib/proto/attach-link.js"),
 
@@ -81,15 +85,6 @@ Pjax.prototype = {
     return require("./lib/switches-selectors.js").bind(this)(this.options.switches, this.options.switchesOptions, selectors, fromEl, toEl, options)
   },
 
-  // too much problem with the code below
-  // + it’s too dangerous
-  //   switchFallback: function(fromEl, toEl) {
-  //     this.switchSelectors(["head", "body"], fromEl, toEl)
-  //     // execute script when DOM is like it should be
-  //     Pjax.executeScripts(document.querySelector("head"))
-  //     Pjax.executeScripts(document.querySelector("body"))
-  //   }
-
   latestChance: function(href) {
     window.location = href
   },
@@ -139,16 +134,7 @@ Pjax.prototype = {
       } catch (e) { }
     }
 
-    // try {
     this.switchSelectors(this.options.selectors, tmpEl, document, options)
-
-    // }
-    // catch(e) {
-    //   if (this.options.debug) {
-    //     this.log("Pjax switch fail: ", e)
-    //   }
-    //   this.switchFallback(tmpEl, document)
-    // }
   },
 
   abortRequest: require("./lib/abort-request.js"),
@@ -161,14 +147,14 @@ Pjax.prototype = {
     // Abort any previous request
     this.abortRequest(this.request)
 
-    trigger(document, "pjax:send", options);
+    trigger(document, "pjax:send", options)
 
     // Do the request
     options.requestOptions.timeout = this.options.timeout
     this.request = this.doRequest(href, options.requestOptions, function(html, request) {
       // Fail if unable to load HTML via AJAX
       if (html === false) {
-        trigger(document,"pjax:complete pjax:error", options)
+        trigger(document, "pjax:complete pjax:error", options)
 
         return
       }
@@ -218,8 +204,7 @@ Pjax.prototype = {
           if (console && console.error) {
             console.error("Pjax switch fail: ", e)
           }
-          this.latestChance(href)
-          return
+          return this.latestChance(href)
         }
         else {
           throw e
@@ -236,7 +221,7 @@ Pjax.prototype = {
     // http://www.w3.org/html/wg/drafts/html/master/forms.html
     var autofocusEl = Array.prototype.slice.call(document.querySelectorAll("[autofocus]")).pop()
     if (autofocusEl && document.activeElement !== autofocusEl) {
-      autofocusEl.focus();
+      autofocusEl.focus()
     }
 
     // execute scripts when DOM have been completely updated
@@ -304,7 +289,7 @@ Pjax.prototype = {
             } while (target)
           }
         }
-        window.scrollTo(0, curtop);
+        window.scrollTo(0, curtop)
       }
       else if (state.options.scrollTo !== false) {
         // Scroll page to top on new page load
@@ -328,7 +313,7 @@ Pjax.prototype = {
   }
 }
 
-Pjax.isSupported = require("./lib/is-supported.js");
+Pjax.isSupported = require("./lib/is-supported.js")
 
 // arguably could do `if( require("./lib/is-supported.js")()) {` but that might be a little to simple
 if (Pjax.isSupported()) {

index.js

@@ -1,5 +1,5 @@
 module.exports = function(obj) {
-  if (null === obj || "object" != typeof obj) {
+  if (null === obj || "object" !== typeof obj) {
     return obj
   }
   var copy = obj.constructor()

lib/clone.js

@@ -1,6 +1,6 @@
 module.exports = function(el) {
   var code = (el.text || el.textContent || el.innerHTML || "")
-  var src = (el.src || "");
+  var src = (el.src || "")
   var parent = el.parentNode || document.querySelector("head") || document.documentElement
   var script = document.createElement("script")
 
@@ -13,12 +13,12 @@ module.exports = function(el) {
 
   script.type = "text/javascript"
 
-  if (src != "") {
-    script.src = src;
-    script.async = false; // force synchronous loading of peripheral js
+  if (src !== "") {
+    script.src = src
+    script.async = false // force synchronous loading of peripheral JS
   }
 
-  if (code != "") {
+  if (code !== "") {
     try {
       script.appendChild(document.createTextNode(code))
     }
@@ -29,11 +29,11 @@ module.exports = function(el) {
   }
 
   // execute
-  parent.appendChild(script);
+  parent.appendChild(script)
   // avoid pollution only in head or body tags
-  if (["head","body"].indexOf(parent.tagName.toLowerCase()) > 0) {
+  if (["head", "body"].indexOf(parent.tagName.toLowerCase()) > 0) {
     parent.removeChild(script)
   }
 
-  return true;
+  return true
 }

lib/eval-script.js

@@ -4,7 +4,7 @@ module.exports = function(els, events, opts) {
   events = (typeof events === "string" ? events.split(" ") : events)
 
   events.forEach(function(e) {
-    var event // = new CustomEvent(e) // doesn't everywhere yet
+    var event
     event = document.createEvent("HTMLEvents")
     event.initEvent(e, true, true)
     event.eventName = e
@@ -17,8 +17,8 @@ module.exports = function(els, events, opts) {
     forEachEls(els, function(el) {
       var domFix = false
       if (!el.parentNode && el !== document && el !== window) {
-        // THANKS YOU IE (9/10//11 concerned)
-        // dispatchEvent doesn't work if element is not in the dom
+        // THANK YOU IE (9/10/11)
+        // dispatchEvent doesn't work if the element is not in the DOM
         domFix = true
         document.body.appendChild(el)
       }

lib/events/trigger.js

@@ -3,18 +3,16 @@ var evalScript = require("./eval-script")
 // Finds and executes scripts (used for newly added elements)
 // Needed since innerHTML does not run scripts
 module.exports = function(el) {
-  // console.log("going to execute scripts for ", el)
-
   if (el.tagName.toLowerCase() === "script") {
-    evalScript(el);
+    evalScript(el)
   }
 
   forEachEls(el.querySelectorAll("script"), function(script) {
     if (!script.type || script.type.toLowerCase() === "text/javascript") {
       if (script.parentNode) {
         script.parentNode.removeChild(script)
       }
-      evalScript(script);
+      evalScript(script)
     }
-  });
+  })
 }

lib/execute-scripts.js

@@ -4,6 +4,6 @@ module.exports = function(els, fn, context) {
   if (els instanceof HTMLCollection || els instanceof NodeList || els instanceof Array) {
     return Array.prototype.forEach.call(els, fn, context)
   }
-  // assume simple dom element
+  // assume simple DOM element
   return fn.call(context, els)
 }

lib/foreach-els.js

@@ -1,5 +1,3 @@
-require("../polyfills/Function.prototype.bind")
-
 var on = require("../events/on")
 var clone = require("../clone")
 
@@ -8,27 +6,27 @@ var attrClick = "data-pjax-click-state"
 var formAction = function(el, event) {
   // Since loadUrl modifies options and we may add our own modifications below,
   // clone it so the changes don't persist
-  var options = clone(this.options);
+  var options = clone(this.options)
 
   // Initialize requestOptions
   options.requestOptions = {
     requestUrl: el.getAttribute("action") || window.location.href,
-    requestMethod: el.getAttribute("method") || "GET",
+    requestMethod: el.getAttribute("method") || "GET"
   }
 
   // create a testable virtual link of the form action
-  var virtLinkElement = document.createElement("a");
-  virtLinkElement.setAttribute("href", options.requestOptions.requestUrl);
+  var virtLinkElement = document.createElement("a")
+  virtLinkElement.setAttribute("href", options.requestOptions.requestUrl)
 
   // Ignore external links.
   if (virtLinkElement.protocol !== window.location.protocol || virtLinkElement.host !== window.location.host) {
-    el.setAttribute(attrClick, "external");
+    el.setAttribute(attrClick, "external")
     return
   }
 
   // Ignore click if we are on an anchor on the same page
   if (virtLinkElement.pathname === window.location.pathname && virtLinkElement.hash.length > 0) {
-    el.setAttribute(attrClick, "anchor-present");
+    el.setAttribute(attrClick, "anchor-present")
     return
   }
 
@@ -40,41 +38,39 @@ var formAction = function(el, event) {
 
   // if declared as a full reload, just normally submit the form
   if (options.currentUrlFullReload) {
-    el.setAttribute(attrClick, "reload");
-    return;
+    el.setAttribute(attrClick, "reload")
+    return
   }
 
   event.preventDefault()
 
-  var paramObject = [];
+  var paramObject = []
   for (var elementKey in el.elements) {
-    var element = el.elements[elementKey];
+    var element = el.elements[elementKey]
     // jscs:disable disallowImplicitTypeConversion
     if (!!element.name && element.attributes !== undefined && element.tagName.toLowerCase() !== "button") {
       // jscs:enable disallowImplicitTypeConversion
       if ((element.attributes.type !== "checkbox" && element.attributes.type !== "radio") || element.checked) {
-        paramObject.push({name: encodeURIComponent(element.name), value: encodeURIComponent(element.value)});
+        paramObject.push({name: encodeURIComponent(element.name), value: encodeURIComponent(element.value)})
       }
     }
   }
 
   // Creating a getString
-  var paramsString = (paramObject.map(function(value) {return value.name + "=" + value.value;})).join("&");
+  var paramsString = (paramObject.map(function(value) {return value.name + "=" + value.value})).join("&")
 
-  options.requestOptions.requestPayload = paramObject;
-  options.requestOptions.requestPayloadString = paramsString;
+  options.requestOptions.requestPayload = paramObject
+  options.requestOptions.requestPayloadString = paramsString
 
-  el.setAttribute(attrClick, "submit");
+  el.setAttribute(attrClick, "submit")
 
-
-  options.triggerElement = el;
-  this.loadUrl(virtLinkElement.href, options);
-};
+  options.triggerElement = el
+  this.loadUrl(virtLinkElement.href, options)
+}
 
 var isDefaultPrevented = function(event) {
-  return event.defaultPrevented || event.returnValue === false;
-};
-
+  return event.defaultPrevented || event.returnValue === false
+}
 
 module.exports = function(el) {
   var that = this
@@ -92,8 +88,7 @@ module.exports = function(el) {
       return
     }
 
-
-    if (event.keyCode == 13) {
+    if (event.keyCode === 13) {
       formAction.call(that, el, event)
     }
   }.bind(this))