From ccc6bae28d9c3964053fb44da36514d14e7b99ae Mon Sep 17 00:00:00 2001
From: Dan Allen <dan.j.allen@gmail.com>
Date: Wed, 23 Sep 2015 22:38:58 -0600
Subject: [PATCH] add option to control how history is updated

* Use update option to only process inbound request from URL (no updates on navigation)
* Use history option to control whether history is maintained
---
 README.md                     | 26 ++++++++++++++++
 dist/bespoke-hash.js          | 28 +++++++++++++-----
 dist/bespoke-hash.min.js      |  4 +--
 lib/bespoke-hash.js           | 26 ++++++++++++----
 test/spec/bespoke-hashSpec.js | 56 +++++++++++++++++++++++++++++++++--
 5 files changed, 123 insertions(+), 17 deletions(-)
 mode change 100755 => 100644 dist/bespoke-hash.js
 mode change 100755 => 100644 dist/bespoke-hash.min.js

diff --git a/README.md b/README.md
index 31d4fc9..38daaf6 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,32 @@ If you'd like to use named hash routes instead, add `data-bespoke-hash` attribut
 </article>
 ```
 
+### Disabling updates
+
+You can prevent the URL from being updated after the initial page load by setting the `update` option to `false`. This switch allows you to respond to incoming changes from the URL, but not continue updating the URL when the slide changes.
+
+```
+bespoke.from('article', [
+  bespoke.plugins.hash({ update: false })
+]);
+```
+
+Default value: `true`
+
+### History control
+
+You can control whether this browser history is updated using the `history` option. A value of `false` overwrites the last history entry each time the slide is changed (assuming the `update` option is not `false`).
+
+```
+bespoke.from('article', [
+  bespoke.plugins.hash({ history: false })
+]);
+```
+
+If updates are disabled and the value of the `history` option is false, the hash will be removed from the URL after the deck is loaded.
+
+Default value: `true`
+
 ## Package managers
 
 ### npm
diff --git a/dist/bespoke-hash.js b/dist/bespoke-hash.js
old mode 100755
new mode 100644
index 3c95593..f56c3f5
--- a/dist/bespoke-hash.js
+++ b/dist/bespoke-hash.js
@@ -1,16 +1,18 @@
 /*!
  * bespoke-hash v1.0.2
  *
- * Copyright 2014, Mark Dalgleish
+ * Copyright 2015, Mark Dalgleish
  * This content is released under the MIT license
  * http://mit-license.org/markdalgleish
  */
 
 !function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var n;"undefined"!=typeof window?n=window:"undefined"!=typeof global?n=global:"undefined"!=typeof self&&(n=self);var o=n;o=o.bespoke||(o.bespoke={}),o=o.plugins||(o.plugins={}),o.hash=e()}}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(_dereq_,module,exports){
-module.exports = function() {
+module.exports = function(opts) {
+  opts = opts || {};
   return function(deck) {
+    var loc = window.location;
     var parseHash = function() {
-      var hash = window.location.hash.slice(1),
+      var hash = loc.hash.slice(1),
         slideNumberOrName = parseInt(hash, 10);
 
       if (hash) {
@@ -36,10 +38,22 @@ module.exports = function() {
     setTimeout(function() {
       parseHash();
 
-      deck.on('activate', function(e) {
-        var slideName = e.slide.getAttribute('data-bespoke-hash');
-        window.location.hash = slideName || e.index + 1;
-      });
+      if (opts.update === false) {
+        if (opts.history === false) {
+          window.history.replaceState(null, null, loc.pathname + loc.search);
+        }
+      }
+      else {
+        deck.on('activate', function(e) {
+          var slideName = e.slide.getAttribute('data-bespoke-hash');
+          if (opts.history === false) {
+            window.history.replaceState(null, null, loc.pathname + loc.search + '#' + (slideName || e.index + 1));
+          }
+          else {
+            loc.hash = slideName || e.index + 1;
+          }
+        });
+      }
 
       window.addEventListener('hashchange', parseHash);
     }, 0);
diff --git a/dist/bespoke-hash.min.js b/dist/bespoke-hash.min.js
old mode 100755
new mode 100644
index 68c30eb..8bcf18f
--- a/dist/bespoke-hash.min.js
+++ b/dist/bespoke-hash.min.js
@@ -1,2 +1,2 @@
-/*! bespoke-hash v1.0.2 © 2014 Mark Dalgleish, MIT License */
-!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var n;"undefined"!=typeof window?n=window:"undefined"!=typeof global?n=global:"undefined"!=typeof self&&(n=self);var t=n;t=t.bespoke||(t.bespoke={}),t=t.plugins||(t.plugins={}),t.hash=e()}}(function(){return function e(n,t,o){function i(f,u){if(!t[f]){if(!n[f]){var s="function"==typeof require&&require;if(!u&&s)return s(f,!0);if(r)return r(f,!0);throw new Error("Cannot find module '"+f+"'")}var a=t[f]={exports:{}};n[f][0].call(a.exports,function(e){var t=n[f][1][e];return i(t?t:e)},a,a.exports,e,n,t,o)}return t[f].exports}for(var r="function"==typeof require&&require,f=0;f<o.length;f++)i(o[f]);return i}({1:[function(e,n){n.exports=function(){return function(e){var n=function(){var n=window.location.hash.slice(1),o=parseInt(n,10);n&&(o?t(o-1):e.slides.forEach(function(e,o){e.getAttribute("data-bespoke-hash")===n&&t(o)}))},t=function(n){var t=n>-1&&n<e.slides.length?n:0;t!==e.slide()&&e.slide(t)};setTimeout(function(){n(),e.on("activate",function(e){var n=e.slide.getAttribute("data-bespoke-hash");window.location.hash=n||e.index+1}),window.addEventListener("hashchange",n)},0)}}},{}]},{},[1])(1)});
\ No newline at end of file
+/*! bespoke-hash v1.0.2 © 2015 Mark Dalgleish, MIT License */
+!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var n;"undefined"!=typeof window?n=window:"undefined"!=typeof global?n=global:"undefined"!=typeof self&&(n=self);var t=n;t=t.bespoke||(t.bespoke={}),t=t.plugins||(t.plugins={}),t.hash=e()}}(function(){return function e(n,t,i){function o(u,a){if(!t[u]){if(!n[u]){var f="function"==typeof require&&require;if(!a&&f)return f(u,!0);if(r)return r(u,!0);throw new Error("Cannot find module '"+u+"'")}var s=t[u]={exports:{}};n[u][0].call(s.exports,function(e){var t=n[u][1][e];return o(t?t:e)},s,s.exports,e,n,t,i)}return t[u].exports}for(var r="function"==typeof require&&require,u=0;u<i.length;u++)o(i[u]);return o}({1:[function(e,n){n.exports=function(e){return e=e||{},function(n){var t=window.location,i=function(){var e=t.hash.slice(1),i=parseInt(e,10);e&&(i?o(i-1):n.slides.forEach(function(n,t){n.getAttribute("data-bespoke-hash")===e&&o(t)}))},o=function(e){var t=e>-1&&e<n.slides.length?e:0;t!==n.slide()&&n.slide(t)};setTimeout(function(){i(),e.update===!1?e.history===!1&&window.history.replaceState(null,null,t.pathname+t.search):n.on("activate",function(n){var i=n.slide.getAttribute("data-bespoke-hash");e.history===!1?window.history.replaceState(null,null,t.pathname+t.search+"#"+(i||n.index+1)):t.hash=i||n.index+1}),window.addEventListener("hashchange",i)},0)}}},{}]},{},[1])(1)});
\ No newline at end of file
diff --git a/lib/bespoke-hash.js b/lib/bespoke-hash.js
index 264af06..57579d3 100644
--- a/lib/bespoke-hash.js
+++ b/lib/bespoke-hash.js
@@ -1,7 +1,9 @@
-module.exports = function() {
+module.exports = function(opts) {
+  opts = opts || {};
   return function(deck) {
+    var loc = window.location;
     var parseHash = function() {
-      var hash = window.location.hash.slice(1),
+      var hash = loc.hash.slice(1),
         slideNumberOrName = parseInt(hash, 10);
 
       if (hash) {
@@ -27,10 +29,22 @@ module.exports = function() {
     setTimeout(function() {
       parseHash();
 
-      deck.on('activate', function(e) {
-        var slideName = e.slide.getAttribute('data-bespoke-hash');
-        window.location.hash = slideName || e.index + 1;
-      });
+      if (opts.update === false) {
+        if (opts.history === false) {
+          window.history.replaceState(null, null, loc.pathname + loc.search);
+        }
+      }
+      else {
+        deck.on('activate', function(e) {
+          var slideName = e.slide.getAttribute('data-bespoke-hash');
+          if (opts.history === false) {
+            window.history.replaceState(null, null, loc.pathname + loc.search + '#' + (slideName || e.index + 1));
+          }
+          else {
+            loc.hash = slideName || e.index + 1;
+          }
+        });
+      }
 
       window.addEventListener('hashchange', parseHash);
     }, 0);
diff --git a/test/spec/bespoke-hashSpec.js b/test/spec/bespoke-hashSpec.js
index 267490b..b325a87 100644
--- a/test/spec/bespoke-hashSpec.js
+++ b/test/spec/bespoke-hashSpec.js
@@ -16,7 +16,7 @@ describe("bespoke-hash", function() {
     slides,
     deck;
 
-  var createDeck = function() {
+  var createDeck = function(opts) {
       slides = [];
 
       article = document.createElement(PARENT_TAG);
@@ -34,7 +34,7 @@ describe("bespoke-hash", function() {
       document.body.appendChild(article);
 
       deck = bespoke.from(PARENT_TAG, [
-        hash()
+        hash(opts)
       ]);
 
       // Wait for next tick
@@ -224,4 +224,56 @@ describe("bespoke-hash", function() {
 
   });
 
+  describe("given update mode is deactivated", function() {
+    beforeEach(function() {
+      window.location.hash = 2;
+    });
+
+    [true, false].forEach(function(historyOpt) {
+      describe("when the deck is created with history " + (historyOpt ? 'enabled' : 'disabled'), function() {
+        beforeEach(function() {
+          createDeck({ update: false, history: historyOpt });
+        });
+        afterEach(destroyDeck);
+
+        it("should activate the slide referenced in the hash", function() {
+          expect(deck.slide()).toBe(1);
+          expect(window.location.hash).toBe(historyOpt ? '#2' : '');
+        });
+
+        it("should not update the hash when the slide changes", function() {
+          deck.next();
+          expect(deck.slide()).toBe(2);
+          expect(window.location.hash).toBe(historyOpt ? '#2' : '');
+        });
+      });
+    });
+  });
+
+  describe("given history mode is deactivated", function() {
+    beforeEach(function() {
+      window.location.hash = 2;
+    });
+
+    describe("when the deck is created", function() {
+      beforeEach(function() {
+        createDeck({ history: false });
+      });
+      afterEach(destroyDeck);
+
+      it("should activate the slide referenced in the hash", function() {
+        expect(deck.slide()).toBe(1);
+        expect(window.location.hash).toBe('#2');
+      });
+
+      it("should not add entry to history when the slide changes", function() {
+        var beforeHistoryLength = window.history.length;
+        deck.next();
+        expect(deck.slide()).toBe(2);
+        expect(window.location.hash).toBe('#3');
+        expect(window.history.length).toBe(beforeHistoryLength);
+      });
+    });
+  });
+
 });