0.2.4

This property is only used in the tests. It doesn't exist in Safari 8
and before, so where it's not available this patch polyfills it,
allowing the test to continue.

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.2.4 - 2016-06-28
+
+- Fixed: ``refresh`` should now work (use `this.parseDOM` for refresh)
+  ([#67](https://github.com/MoOx/pjax/pull/67) - @compressed)
+- Fixed: Some attributes, such as `itemscope` have no corresponding value.
+  This change allows them to still be set.
+  ([#67](https://github.com/MoOx/pjax/pull/67) - @compressed)
+- Added: ``cacheBust`` option
+  ([#71](https://github.com/MoOx/pjax/pull/71) - @tremby)
+
 # 0.2.3 - 2016-03-24
 
 - Fixed: ``currentUrlFullReload`` option now works

README.md

@@ -273,6 +273,7 @@ new Pjax({
         }
       }
     }
+  }
 })
 ```
 _Note that remove class include `Animated--reverse` which is a simple way to not have
@@ -381,6 +382,12 @@ It's called every time a page is switched, even for history buttons.
 
 Value (in px) to scrollTo when a page is switched.
 
+##### `cacheBust` (Boolean, default true)
+
+When set to true,
+append a timestamp query string segment to the requested URLs
+in order to skip browser cache.
+
 ##### `debug` (Boolean, default to false)
 
 Enable verbose mode & doesn't use fallback when there is an error.

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "pjax",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Easily enable fast Ajax navigation on any website (using pushState +  xhr)",
   "keywords": [
     "pjax",

index.js

@@ -94,7 +94,12 @@ Pjax.prototype = {
         matches.shift()
         matches.forEach(function(htmlAttrib) {
           var attr = htmlAttrib.trim().split("=")
-          tmpEl.documentElement.setAttribute(attr[0], attr[1].slice(1, -1))
+          if (attr.length === 1) {
+            tmpEl.documentElement.setAttribute(attr[0], true)
+          }
+          else {
+            tmpEl.documentElement.setAttribute(attr[0], attr[1].slice(1, -1))
+          }
         })
       }
     }

lib/proto/parse-options.js

@@ -19,6 +19,7 @@ module.exports = function(options){
     }
   }
   this.options.scrollTo = (typeof this.options.scrollTo === 'undefined') ? 0 : this.options.scrollTo;
+  this.options.cacheBust = (typeof this.options.cacheBust === 'undefined') ? true : this.options.cacheBust
   this.options.debug = this.options.debug || false
 
   // we can’t replace body.outerHTML or head.outerHTML

lib/proto/refresh.js

@@ -1,6 +1,3 @@
-
-var parseDom = require("./parse-dom")
-
 module.exports = function(el) {
-  parseDom(el || document)
+  this.parseDOM(el || document)
 }

lib/request.js

@@ -12,7 +12,12 @@ module.exports = function(location, callback) {
     }
   }
 
-  request.open("GET", location + (!/[?&]/.test(location) ? "?" : "&") + (new Date().getTime()), true)
+  // Add a timestamp as part of the query string if cache busting is enabled
+  if (this.options.cacheBust) {
+    location += (!/[?&]/.test(location) ? "?" : "&") + new Date().getTime()
+  }
+
+  request.open("GET", location, true)
   request.setRequestHeader("X-Requested-With", "XMLHttpRequest")
   request.send(null)
   return request

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pjax",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Easily enable fast Ajax navigation on any website (using pushState +  xhr)",
   "keywords": [
     "pjax",
@@ -26,6 +26,7 @@
     "jscs": "^1.6.2",
     "jshint": "^2.5.6",
     "npmpub": "^3.1.0",
+    "opn-cli": "^3.1.0",
     "serve": "1.4.0",
     "tape": "^3.0.0",
     "testling": "^1.6.1"
@@ -37,9 +38,10 @@
     "test": "npm run lint && npm run standalone && npm run tests",
     "test--html": "testling --html > tests/scripts/index.html",
     "coverage": "browserify -t coverify tests/**/*.js | testling | coverify",
-    "example": "echo '\n==> Open http://localhost:3000/example in your browser.'; serve .",
+    "example": "opn http://localhost:3000/example/; serve .",
     "prepublish": "npm run standalone",
-    "release": "npm test && npmpub --skip-test"
+    "#release": "testling does not work in a process launch by npm... :facepalm:",
+    "release": "echo \"npmpub --skip-test --dry && npm test && npmpub --skip-test --skip-cleanup\""
   },
   "testling": {
     "files": "tests/**/*.js",

tests/lib/proto/parse-options.js

@@ -46,6 +46,7 @@ tape("test parse initalization options function", function(t) {
     t.deepEqual(typeof body_1.options.analytics,"function");
 
     t.deepEqual(body_1.options.scrollTo,0);
+    t.deepEqual(body_1.options.cacheBust,true);
     t.deepEqual(body_1.options.debug,false);
     t.end();
   });

tests/lib/request.js

@@ -2,15 +2,47 @@ var tape = require("tape")
 
 var request = require("../../lib/request.js")
 
+// Polyfill responseURL property into XMLHttpRequest if it doesn't exist,
+// just for the purposes of this test
+// This polyfill is not complete; it won't show the updated location if a
+// redirection occurred, but it's fine for our purposes.
+if (!('responseURL' in XMLHttpRequest.prototype)) {
+  var nativeOpen = XMLHttpRequest.prototype.open
+  XMLHttpRequest.prototype.open = function (method, url) {
+    this.responseURL = url
+    return nativeOpen.apply(this, arguments)
+  }
+}
+
 tape("test xhr request", function(t) {
-  request("https://api.github.com/", function(result) {
-    try {
-      result = JSON.parse(result)
-    }
-    catch (e) {
-      t.fail("xhr doesn't get a JSON response")
-    }
-    t.same(typeof result, "object", "xhr request get a result")
-    t.end()
+  t.test("- request is made, gets a result, and is cache-busted", function(t) {
+    var requestCacheBust = request.bind({
+      options: {
+        cacheBust: true,
+      },
+    });
+    var r = requestCacheBust("https://api.github.com/", function(result) {
+      t.equal(r.responseURL.indexOf("?"), 23, "XHR URL is cache-busted when configured to be")
+      try {
+        result = JSON.parse(result)
+      }
+      catch (e) {
+        t.fail("xhr doesn't get a JSON response")
+      }
+      t.same(typeof result, "object", "xhr request get a result")
+      t.end()
+    })
   })
+  t.test("- request is not cache-busted when configured not to be", function(t) {
+    var requestNoCacheBust = request.bind({
+      options: {
+        cacheBust: false,
+      },
+    });
+    var r = requestNoCacheBust("https://api.github.com/", function() {
+      t.equal(r.responseURL, "https://api.github.com/", "XHR URL is left untouched")
+      t.end()
+    })
+  })
+  t.end()
 })