Add location revival for easier record/replay (#757)

Author: gaearon

modules/Location.js

@@ -9,6 +9,22 @@ var PathUtils = require('./PathUtils');
  */
 class Location {
 
+  /**
+   * Revives the location from its serialized form.
+   * Use `Location.revive` as a second argument to `JSON.parse`.
+   *
+   *   var serialized = JSON.stringify(location);
+   *   var deserialized = JSON.parse(serialized, Location.revive);
+   *
+   */
+  static revive(key, value) {
+    if (key === '') {
+      return new Location(value.path, value.navigationType);
+    } else {
+      return value;
+    }
+  }
+
   constructor(path, navigationType) {
     this.path = path;
     this.navigationType = navigationType || NavigationTypes.POP;
@@ -26,6 +42,13 @@ class Location {
     return PathUtils.getQuery(this.path, options);
   }
 
+  toJSON() {
+    return {
+      path: this.path,
+      navigationType: this.navigationType
+    };
+  }
+
 }
 
 module.exports = Location;

modules/__tests__/Location-test.js

@@ -1,9 +1,21 @@
 var expect = require('expect');
 var Location = require('../Location');
+var NavigationTypes = require('../NavigationTypes');
 
 describe('Location', function () {
   var location;
 
+  it('can be revived', function () {
+    location = new Location('/the/path', NavigationTypes.POP);
+
+    var serialized = JSON.stringify(location);
+    var revived = JSON.parse(serialized, Location.revive);
+
+    expect(revived instanceof Location).toEqual(true);
+    expect(revived.path).toEqual(location.path);
+    expect(revived.navigationType).toEqual(location.navigationType);
+  });
+
   describe('with a query string', function () {
     beforeEach(function () {
       location = new Location('/the/path?the=query');