Retrieving state by suid

.github/FUNDING.yml

@@ -0,0 +1,6 @@
+github: [balupton]
+patreon: bevry
+open_collective: bevry
+ko_fi: balupton
+liberapay: bevry
+custom: ['https://bevry.me/fund']

license.txt → LICENSE.md

@@ -1,10 +1,14 @@
-Copyright (c) 2011, Benjamin Arthur Lupton
-All rights reserved.
+# License
+
+Copyright &copy; 2014+ Bevry Pty Ltd <[email protected]> (http://bevry.me)
+<br/>Copyright &copy; 2011-2013 Benjamin Lupton <[email protected]> (http://balupton.com)
+
+## The New BSD License
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-  • Neither the name of Benjamin Arthur Lupton nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+- Neither the name of Benjamin Arthur Lupton nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,7 +1,35 @@
+Memo
+==================
+While there are some [legitimate bugs and differences in state handling even in modern browsers](https://github.com/browserstate/history.js/wiki/The-State-of-the-HTML5-History-API), they are relatively small enough now that you can just use the native HTML5 History API. If you intend to support legacy browsers, then History.js is your bet.
+
+This notice is here as History.js does not receive enough funding to be maintained, so it exists only in legacy condition for legacy browsers. Perhaps it still works for modern browsers, but it could really do with maintenance. Maintenance is very difficult as the library requires manual testing in HTML5 and HTML4 modes, and for each adapter, and for each browser. So that means `2^(# of adapters)^(# of browsers and their versions)` tests that need to be run by a human. Tests need to be run by a human as certain failures require browser interactions, such as navigating from the test suite to a different domain and back again, or clicking the physical back buttons, or checking if the physical back buttons actually work. This takes a lot of time.
+
+Despite History.js being one of the most popular JavaScript libraries there is, and has been used by even multi-million-user companies in its time - the reality of economy and company practices seems to be that companies prefer to fork their own internal versions and fix locally with their own devs rather than fund open-source maintainers what they would pay their own devs to make things better for everyone, including themselves, which would be cheaper - but no, that would require too many tiers of company approval that don't understand the need.
+
+As such, if you are an open-source developer, I'd recommend just working on open-source projects that are paid for by your own consulting work or your own company (e.g. every successful open-source project). As otherwise, when they become popular, you better hope they are easily maintainable and testable, otherwise the cost of maintenance is higher than the free time of the maintainers.
+
+So with all that said, this repo still exists for archival purposes, legacy browsers, and a hub for anarachistic issue & fork maintenance.
+
+Cheers,
+Benjamin Lupton, founder of Bevry, creator of History.js
+
+
 Welcome to History.js <br/> v1.8b2, June 22 2013
 ==================
 
-[![Flattr this project](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=balupton&url=https://github.com/browserstate/history.js&title=History.js&language=&tags=github&category=software)
+<!-- BADGES/ -->
+
+<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
+<span class="badge-patreon"><a href="http://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
+<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
+<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
+
+<!-- /BADGES -->
+
+
 
 ## News
 - 22/06/2013: Beta 2 of v1.8 is released. Fixes and uncompressed bundled files.
@@ -11,14 +39,15 @@ Welcome to History.js <br/> v1.8b2, June 22 2013
 - 21/01/2013: Alpha 2 of v1.8 is released. Correct statechange behaviour.
 - 19/01/2013: Alpha 1 of v1.8 is released. Started to categorize old balupton's issues.
 
+
 ### History
+[See the `HISTORY.md` file for a detailed list of features, changes, solved issues and bugs](https://github.com/browserstate/history.js/blob/master/HISTORY.md#files)
 
-See the [`History.md`](https://github.com/browserstate/history.js/blob/master/History.md#files) file for a detailed list of features, changes, solved issues and bugs
 
 ### Involve
-
 Please create an issue if something doesn't work or if there is a browser specific bug. I'll try to fix it as soon as possible. Please send me your Pull requests if you have a nice solution! I'm also going to review old issues in balupton's repository and try to solve them too.
 
+
 ## Aims
 
 - Follow the [HTML5 History API](https://developer.mozilla.org/en/DOM/Manipulating_the_browser_history) as much as possible
@@ -27,16 +56,21 @@ Please create an issue if something doesn't work or if there is a browser specif
 - Provide a forwards-compatible experience for HTML4 States to HTML5 States (so if a hash-fallbacked url is accessed by a HTML5 browser it is naturally transformed into its non-hashed url equivalent)
 - Provide support for as many javascript frameworks as possible via adapters; especially [Dojo](http://dojotoolkit.org/), [ExtJS](http://www.sencha.com/), [jQuery](http://jquery.com/), [MooTools](http://mootools.net/), [Right.js](http://rightjs.org/) and [Zepto](http://zeptojs.com/).
 
-## Usage
 
-### Instant
+## Quick Install
 
-To ajaxify your entire website with the HTML5 History API, History.js and jQuery the [Ajaxify Script](https://github.com/browserstate/ajaxify) is all you need. It's that easy.
+### Via Ajaxify Script
+To ajaxify your entire website with the HTML5 History API, History.js and jQuery the [Ajaxify script](https://github.com/browserstate/ajaxify) is all you need. It's that easy.
 
-### Ruby On Rails
+### Via Ajaxify Extension
+If you don't have access to your server, or just want to try out the Ajaxify script first, you can install the [History.js It! Google Chrome Extension](https://github.com/browserstate/historyjsit.crx) to try out History.js via Ajaxify on select websites without actually installing History.js/Ajaxify on your server.
 
+### Via Ruby On Rails Gem
 If you are using Rails, then the easiest way for you to try History.js would be to use [Wiselinks](https://github.com/igor-alexandrov/wiselinks) gem. Wiselinks integrates  into Rails application and allows you to start using History.js with three lines of code.
 
+
+## Direct Install
+
 ### Working with History.js directly
 
 ``` javascript
@@ -60,6 +94,7 @@ If you are using Rails, then the easiest way for you to try History.js would be
 })(window);
 ```
 
+
 ### How would the above operations look in a HTML5 Browser?
 
 1. www.mysite.com
@@ -74,6 +109,7 @@ If you are using Rails, then the easiest way for you to try History.js would be
 
 > Note: These urls also work in HTML4 browsers and Search Engines. So no need for the hashbang (`#!`) fragment-identifier that google ["recommends"](https://github.com/browserstate/history.js/wiki/Intelligent-State-Handling).
 
+
 ### How would they look in a HTML4 Browser?
 
 1. www.mysite.com
@@ -92,6 +128,7 @@ If you are using Rails, then the easiest way for you to try History.js would be
 >
 > Note 3: Support for HTML4 browsers (this hash fallback) is optional [- why supporting HTML4 browsers could be either good or bad based on my app's use cases](https://github.com/browserstate/history.js/wiki/Intelligent-State-Handling)
 
+
 ### What's the deal with the SUIDs used in the HTML4 States?
 
 - SUIDs (State Unique Identifiers) are used when we utilise a `title` and/or `data` in our state. Adding a SUID allows us to associate particular states with data and titles while keeping the urls as simple as possible (don't worry it's all tested, working and a lot smarter than I'm making it out to be).
@@ -100,11 +137,13 @@ If you are using Rails, then the easiest way for you to try History.js would be
 - It works with domains, subdomains, subdirectories, whatever - doesn't matter where you put it. It's smart.
 - Safari 5 will also have a SUID appended to the URL, it is entirely transparent but just a visible side-effect. It is required to fix a bug with Safari 5.
 
+
 ### Is there a working demo?
 
 - Sure is, give it a download and navigate to the demo directory in your browser :-)
 - If you are after something a bit more adventurous than a end-user demo, open up the tests directory in your browser and editor - it'll rock your world and show all the vast use cases that History.js supports.
 
+
 ## Download & Installation
 
 - Download History.js and upload it to your webserver. Download links: [tar.gz](https://github.com/browserstate/history.js/tarball/master) or [zip](https://github.com/browserstate/history.js/zipball/master)
@@ -183,6 +222,7 @@ If you are using Rails, then the easiest way for you to try History.js would be
 Thanks! every bit of help really does make a difference!
 
 
+
 ## Browsers: Tested and Working In
 
 ### HTML5 Browsers
@@ -193,6 +233,7 @@ Thanks! every bit of help really does make a difference!
 - Safari 5.0+
 - Safari iOS 4.3+
 
+
 ### HTML4 Browsers
 
 - IE 6, 7, 8, 9, (10)
@@ -202,11 +243,13 @@ Thanks! every bit of help really does make a difference!
 - Safari iOS 4.2, 4.1, 4.0, 3.2
 
 
+
 ## Exposed API
 
 ### Functions
 
 #### States
+
 - `History.pushState(data,title,url)` <br/> Pushes a new state to the browser; `data` can be null or an object, `title` can be null or a string, `url` must be a string
 - `History.replaceState(data,title,url)` <br/> Replaces the existing state with a new state to the browser; `data` can be null or an object, `title` can be null or a string, `url` must be a string
 - `History.getState()` <br/> Gets the current state of the browser, returns an object with `data`, `title` and `url`
@@ -215,18 +258,21 @@ Thanks! every bit of help really does make a difference!
 - `History.getHash()` <br/> Gets the current hash of the browser
 
 #### Adapter
+
 - `History.Adapter.bind(element,event,callback)` <br/> A framework independent event binder, you may either use this or your framework's native event binder.
 - `History.Adapter.trigger(element,event)` <br/> A framework independent event trigger, you may either use this or your framework's native event trigger.
 - `History.Adapter.onDomLoad(callback)` <br/> A framework independent onDomLoad binder, you may either use this or your framework's native onDomLoad binder.
 
 #### Navigation
+
 - `History.back()` <br/> Go back once through the history (same as hitting the browser's back button)
 - `History.forward()` <br/> Go forward once through the history (same as hitting the browser's forward button)
 - `History.go(X)` <br/> If X is negative go back through history X times, if X is positive go forwards through history X times
 
 #### Debug
+
 - `History.log(...)` <br/> Logs messages to the console, the log element, and fallbacks to alert if neither of those two exist
-- `History.debug(...)` <br/> Same as `History.log` but only runs if `History.debug.enable === true`
+- `History.debug(...)` <br/> Same as `History.log` but only runs if `History.options.debug === true`
 
 
 
@@ -243,6 +289,7 @@ Thanks! every bit of help really does make a difference!
 - `History.options.html4Mode` <br/> If true, will force HTMl4 mode (hashtags)
 - `History.options.delayInit` <br/> Want to override default options and call init manually.
 
+
 ### Events
 
 - `window.onstatechange` <br/> Fired when the state of the page changes (does not include hash changes)
@@ -281,12 +328,11 @@ Thanks! every bit of help really does make a difference!
 	- `window.onanchorchange`: this is the same as the `onhashchange` event except it does not fire for states
 
 
-## History
-
-You can discover the history inside the [History.md](https://github.com/browserstate/history.js/blob/master/History.md#files) file
-
 
 ## License
 
 Licensed under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause)
-<br/>Copyright &copy;  2011+ [Benjamin Arthur Lupton](http://balupton.com)
+<br/>Copyright &copy;  2014+ [Bevry Pty Ltd](http://bevry.me) <[email protected]>
+<br/>Copyright &copy;  2011-2013 [Benjamin Arthur Lupton](http://balupton.com) <[email protected]>
+
+For support see the [Getting Support](#get-support) section.

scripts/bundled-uncompressed/html4+html5/dojo.history.js

@@ -1307,7 +1307,7 @@ if (typeof JSON !== 'object') {
 		console = window.console||undefined, // Prevent a JSLint complain
 		document = window.document, // Make sure we are using the correct document
 		navigator = window.navigator, // Make sure we are using the correct navigator
-		sessionStorage = window.sessionStorage||false, // sessionStorage
+		sessionStorage = false, // sessionStorage
 		setTimeout = window.setTimeout,
 		clearTimeout = window.clearTimeout,
 		setInterval = window.setInterval,
@@ -1318,6 +1318,7 @@ if (typeof JSON !== 'object') {
 		history = window.history; // Old History Object
 
 	try {
+		sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
 		sessionStorage.setItem('TEST', '1');
 		sessionStorage.removeItem('TEST');
 	} catch(e) {

scripts/bundled-uncompressed/html4+html5/extjs.history.js

@@ -1277,7 +1277,7 @@ if (typeof JSON !== 'object') {
 		console = window.console||undefined, // Prevent a JSLint complain
 		document = window.document, // Make sure we are using the correct document
 		navigator = window.navigator, // Make sure we are using the correct navigator
-		sessionStorage = window.sessionStorage||false, // sessionStorage
+		sessionStorage = false, // sessionStorage
 		setTimeout = window.setTimeout,
 		clearTimeout = window.clearTimeout,
 		setInterval = window.setInterval,
@@ -1288,6 +1288,7 @@ if (typeof JSON !== 'object') {
 		history = window.history; // Old History Object
 
 	try {
+		sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
 		sessionStorage.setItem('TEST', '1');
 		sessionStorage.removeItem('TEST');
 	} catch(e) {

scripts/bundled-uncompressed/html4+html5/jquery.history.js

@@ -1263,7 +1263,7 @@ if (typeof JSON !== 'object') {
 		console = window.console||undefined, // Prevent a JSLint complain
 		document = window.document, // Make sure we are using the correct document
 		navigator = window.navigator, // Make sure we are using the correct navigator
-		sessionStorage = window.sessionStorage||false, // sessionStorage
+		sessionStorage = false, // sessionStorage
 		setTimeout = window.setTimeout,
 		clearTimeout = window.clearTimeout,
 		setInterval = window.setInterval,
@@ -1274,6 +1274,7 @@ if (typeof JSON !== 'object') {
 		history = window.history; // Old History Object
 
 	try {
+		sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
 		sessionStorage.setItem('TEST', '1');
 		sessionStorage.removeItem('TEST');
 	} catch(e) {

scripts/bundled-uncompressed/html4+html5/mootools.history.js

@@ -1270,7 +1270,7 @@ if (typeof JSON !== 'object') {
 		console = window.console||undefined, // Prevent a JSLint complain
 		document = window.document, // Make sure we are using the correct document
 		navigator = window.navigator, // Make sure we are using the correct navigator
-		sessionStorage = window.sessionStorage||false, // sessionStorage
+		sessionStorage = false, // sessionStorage
 		setTimeout = window.setTimeout,
 		clearTimeout = window.clearTimeout,
 		setInterval = window.setInterval,
@@ -1281,6 +1281,7 @@ if (typeof JSON !== 'object') {
 		history = window.history; // Old History Object
 
 	try {
+		sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
 		sessionStorage.setItem('TEST', '1');
 		sessionStorage.removeItem('TEST');
 	} catch(e) {

scripts/bundled-uncompressed/html4+html5/native.history.js

@@ -1307,7 +1307,7 @@ if (typeof JSON !== 'object') {
 		console = window.console||undefined, // Prevent a JSLint complain
 		document = window.document, // Make sure we are using the correct document
 		navigator = window.navigator, // Make sure we are using the correct navigator
-		sessionStorage = window.sessionStorage||false, // sessionStorage
+		sessionStorage = false, // sessionStorage
 		setTimeout = window.setTimeout,
 		clearTimeout = window.clearTimeout,
 		setInterval = window.setInterval,
@@ -1318,6 +1318,7 @@ if (typeof JSON !== 'object') {
 		history = window.history; // Old History Object
 
 	try {
+		sessionStorage = window.sessionStorage; // This will throw an exception in some browsers when cookies/localStorage are explicitly disabled (i.e. Chrome)
 		sessionStorage.setItem('TEST', '1');
 		sessionStorage.removeItem('TEST');
 	} catch(e) {