From 9b6597c63dfcef4a013c07b334f0956b59e30f4d Mon Sep 17 00:00:00 2001
From: Patrick Steele-Idem <pnidem@gmail.com>
Date: Mon, 1 Aug 2016 15:03:34 -0600
Subject: [PATCH] Added support for stringifyPrepare/finalize

---
 README.md                     |  19 +++++
 finalize.js                   |   1 +
 src/finalize.js               |  50 ++++++++++++
 src/index.js                  |   4 +-
 src/parse.js                  |  50 +-----------
 src/stringify.js              | 144 +++-------------------------------
 src/stringifyPrepare.js       | 134 +++++++++++++++++++++++++++++++
 stringifyPrepare.js           |   1 +
 test/tests/submodules/test.js |  11 +++
 9 files changed, 230 insertions(+), 184 deletions(-)
 create mode 100644 finalize.js
 create mode 100644 src/finalize.js
 create mode 100644 src/stringifyPrepare.js
 create mode 100644 stringifyPrepare.js
 create mode 100644 test/tests/submodules/test.js

diff --git a/README.md b/README.md
index 42fa520..0223e5f 100644
--- a/README.md
+++ b/README.md
@@ -99,6 +99,25 @@ var parse = require('warp10/parse');
 var object = parse(json);
 ```
 
+## JSON stringifyPrepare/finalize
+
+The `stringifyPrepare` function can be used to produce a JavaScript object that is safe to serialize using the native `JSON.stringify` method. The `finalize` method should be called on the parsed object to produce the final object with duplicate objects and circular dependencies intact.
+
+_On the server:_
+
+```javascript
+var warp10 = require('warp10').stringifyPrepare;
+var object = stringifyPrepare(object); // Returns an Object
+var json = JSON.stringify(object);
+```
+
+_In the browser:_
+
+```javascript
+var finalize = require('warp10/finalize');
+var clone = finalize(JSON.parse(json));
+```
+
 # Examples
 
 ## Serialize examples
diff --git a/finalize.js b/finalize.js
new file mode 100644
index 0000000..17c486c
--- /dev/null
+++ b/finalize.js
@@ -0,0 +1 @@
+module.exports = require('./src/finalize');
\ No newline at end of file
diff --git a/src/finalize.js b/src/finalize.js
new file mode 100644
index 0000000..fed005f
--- /dev/null
+++ b/src/finalize.js
@@ -0,0 +1,50 @@
+var isArray = Array.isArray;
+
+function resolve(object, path, len) {
+    var current = object;
+    for (var i=0; i<len; i++) {
+        current = current[path[i]];
+    }
+
+    return current;
+}
+
+function resolveType(info) {
+    if (info.type === 'Date') {
+        return new Date(info.value);
+    } else {
+        throw new Error('Bad type');
+    }
+}
+
+module.exports = function parse(outer) {
+    var object = outer.object;
+
+    var assignments = outer.assignments;
+    if (assignments) {
+        for (var i=0, len=assignments.length; i<len; i++) {
+            var assignment = assignments[i];
+
+            var rhs = assignment.r;
+            var rhsValue;
+
+            if (isArray(rhs)) {
+                rhsValue = resolve(object, rhs, rhs.length);
+            } else {
+                rhsValue = resolveType(rhs);
+            }
+
+            var lhs = assignment.l;
+            var lhsLast = lhs.length-1;
+
+            if (lhsLast === -1) {
+                return rhsValue;
+            } else {
+                var lhsParent = resolve(object, lhs, lhsLast);
+                lhsParent[lhs[lhsLast]] = rhsValue;
+            }
+        }
+    }
+
+    return object == null ? null : object;
+};
\ No newline at end of file
diff --git a/src/index.js b/src/index.js
index 83db3e8..43689e7 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,4 +1,6 @@
 'use strict';
 exports.serialize = require('./serialize');
 exports.stringify = require('./stringify');
-exports.parse = require('./parse');
\ No newline at end of file
+exports.parse = require('./parse');
+exports.finalize = require('./finalize');
+exports.stringifyPrepare = require('./stringifyPrepare');
\ No newline at end of file
diff --git a/src/parse.js b/src/parse.js
index 8c07898..302bc04 100644
--- a/src/parse.js
+++ b/src/parse.js
@@ -1,52 +1,6 @@
-var isArray = Array.isArray;
-
-function resolve(object, path, len) {
-    var current = object;
-    for (var i=0; i<len; i++) {
-        current = current[path[i]];
-    }
-
-    return current;
-}
-
-function resolveType(info) {
-    if (info.type === 'Date') {
-        return new Date(info.value);
-    } else {
-        throw new Error('Bad type');
-    }
-}
+var finalize = require('./finalize');
 
 module.exports = function parse(json) {
     var outer = JSON.parse(json);
-
-    var object = outer.object;
-
-    var assignments = outer.assignments;
-    if (assignments) {
-        for (var i=0, len=assignments.length; i<len; i++) {
-            var assignment = assignments[i];
-
-            var rhs = assignment.r;
-            var rhsValue;
-
-            if (isArray(rhs)) {
-                rhsValue = resolve(object, rhs, rhs.length);
-            } else {
-                rhsValue = resolveType(rhs);
-            }
-
-            var lhs = assignment.l;
-            var lhsLast = lhs.length-1;
-
-            if (lhsLast === -1) {
-                return rhsValue;
-            } else {
-                var lhsParent = resolve(object, lhs, lhsLast);
-                lhsParent[lhs[lhsLast]] = rhsValue;
-            }
-        }
-    }
-
-    return object == null ? null : object;
+    return finalize(outer);
 };
\ No newline at end of file
diff --git a/src/stringify.js b/src/stringify.js
index aca965a..a4b50c2 100644
--- a/src/stringify.js
+++ b/src/stringify.js
@@ -1,139 +1,6 @@
 'use strict';
-const markerKey = Symbol('warp10');
+const stringifyPrepare = require('./stringifyPrepare');
 const escapeEndingScriptTagRegExp = /<\//g;
-const isArray = Array.isArray;
-
-class Marker {
-    constructor(path, symbol) {
-        this.path = path;
-        this.symbol = symbol;
-    }
-}
-
-function append(array, el) {
-    var len = array.length;
-    var clone = new Array(len+1);
-    for (var i=0; i<len; i++) {
-        clone[i] = array[i];
-    }
-    clone[len] = el;
-    return clone;
-}
-
-class Assignment {
-    constructor(lhs, rhs) {
-        this.l = lhs;
-        this.r = rhs;
-    }
-}
-
-function handleProperty(clone, key, value, valuePath, serializationSymbol, assignments) {
-    if (value.constructor === Date) {
-        assignments.push(new Assignment(valuePath, { type: 'Date', value: value.getTime() }));
-    } else if (isArray(value)) {
-        const marker = value[markerKey];
-
-        if (marker && marker.symbol === serializationSymbol) {
-            assignments.push(new Assignment(valuePath, marker.path));
-        } else {
-            value[markerKey] = new Marker(valuePath, serializationSymbol);
-            clone[key] = pruneArray(value, valuePath, serializationSymbol, assignments);
-        }
-    } else {
-        const marker = value[markerKey];
-        if (marker && marker.symbol === serializationSymbol) {
-            assignments.push(new Assignment(valuePath, marker.path));
-        } else {
-            value[markerKey] = new Marker(valuePath, serializationSymbol);
-            clone[key] = pruneObject(value, valuePath, serializationSymbol, assignments);
-        }
-    }
-}
-
-function pruneArray(array, path, serializationSymbol, assignments) {
-    let len = array.length;
-
-    var clone = new Array(len);
-
-    for (let i=0; i<len; i++) {
-        var value = array[i];
-        if (value == null) {
-            continue;
-        }
-
-        if (value && typeof value === 'object') {
-            handleProperty(clone, i, value, append(path, i), serializationSymbol, assignments);
-        } else {
-            clone[i] = value;
-        }
-    }
-
-    return clone;
-}
-
-function pruneObject(obj, path, serializationSymbol, assignments) {
-    var clone = {};
-
-    for (var key in obj) {
-        var value = obj[key];
-        if (value == null) {
-            continue;
-        }
-
-        if (value && typeof value === 'object') {
-            handleProperty(clone, key, value, append(path, key), serializationSymbol, assignments);
-        } else {
-            clone[key] = value;
-        }
-    }
-
-    return clone;
-}
-
-function stringifyHelper(obj, safe) {
-    /**
-     * Performance notes:
-     *
-     * - It is faster to use native JSON.stringify instead of a custom stringify
-     * - It is faster to first prune and then call JSON.stringify with _no_ replacer
-     */
-    var pruned;
-
-    const assignments = []; // Used to keep track of code that needs to run to fix up the stringified object
-
-    if (typeof obj === 'object') {
-        const serializationSymbol = Symbol(); // Used to detect if the marker is associated with _this_ serialization
-        const path = [];
-
-        obj[markerKey] = new Marker(path, serializationSymbol);
-
-        if (obj.constructor === Date) {
-            pruned = null;
-            assignments.push(new Assignment([], { type: 'Date', value: obj.getTime() }));
-        } else if (isArray(obj)) {
-            pruned = pruneArray(obj, path, serializationSymbol, assignments);
-        } else {
-            pruned = pruneObject(obj, path, serializationSymbol, assignments);
-        }
-    } else {
-        pruned = obj;
-    }
-
-    var final = {
-        object: pruned
-    };
-
-    if (assignments.length) {
-        final.assignments = assignments;
-    }
-
-    let json = JSON.stringify(final);
-    if (safe) {
-        json = json.replace(escapeEndingScriptTagRegExp, '\\u003C/');
-    }
-
-    return json;
-}
 
 module.exports = function stringify(obj, options) {
     if (obj == null) {
@@ -148,5 +15,12 @@ module.exports = function stringify(obj, options) {
         safe = false;
     }
 
-    return stringifyHelper(obj, safe);
+    var final = stringifyPrepare(obj);
+
+    let json = JSON.stringify(final);
+    if (safe) {
+        json = json.replace(escapeEndingScriptTagRegExp, '\\u003C/');
+    }
+
+    return json;
 };
\ No newline at end of file
diff --git a/src/stringifyPrepare.js b/src/stringifyPrepare.js
new file mode 100644
index 0000000..3a31c3d
--- /dev/null
+++ b/src/stringifyPrepare.js
@@ -0,0 +1,134 @@
+'use strict';
+const markerKey = Symbol('warp10');
+const isArray = Array.isArray;
+
+class Marker {
+    constructor(path, symbol) {
+        this.path = path;
+        this.symbol = symbol;
+    }
+}
+
+function append(array, el) {
+    var len = array.length;
+    var clone = new Array(len+1);
+    for (var i=0; i<len; i++) {
+        clone[i] = array[i];
+    }
+    clone[len] = el;
+    return clone;
+}
+
+class Assignment {
+    constructor(lhs, rhs) {
+        this.l = lhs;
+        this.r = rhs;
+    }
+}
+
+function handleProperty(clone, key, value, valuePath, serializationSymbol, assignments) {
+    if (value.constructor === Date) {
+        assignments.push(new Assignment(valuePath, { type: 'Date', value: value.getTime() }));
+    } else if (isArray(value)) {
+        const marker = value[markerKey];
+
+        if (marker && marker.symbol === serializationSymbol) {
+            assignments.push(new Assignment(valuePath, marker.path));
+        } else {
+            value[markerKey] = new Marker(valuePath, serializationSymbol);
+            clone[key] = pruneArray(value, valuePath, serializationSymbol, assignments);
+        }
+    } else {
+        const marker = value[markerKey];
+        if (marker && marker.symbol === serializationSymbol) {
+            assignments.push(new Assignment(valuePath, marker.path));
+        } else {
+            value[markerKey] = new Marker(valuePath, serializationSymbol);
+            clone[key] = pruneObject(value, valuePath, serializationSymbol, assignments);
+        }
+    }
+}
+
+function pruneArray(array, path, serializationSymbol, assignments) {
+    let len = array.length;
+
+    var clone = new Array(len);
+
+    for (let i=0; i<len; i++) {
+        var value = array[i];
+        if (value == null) {
+            continue;
+        }
+
+        if (value && typeof value === 'object') {
+            handleProperty(clone, i, value, append(path, i), serializationSymbol, assignments);
+        } else {
+            clone[i] = value;
+        }
+    }
+
+    return clone;
+}
+
+function pruneObject(obj, path, serializationSymbol, assignments) {
+    var clone = {};
+
+    for (var key in obj) {
+        var value = obj[key];
+        if (value == null) {
+            continue;
+        }
+
+        if (value && typeof value === 'object') {
+            handleProperty(clone, key, value, append(path, key), serializationSymbol, assignments);
+        } else {
+            clone[key] = value;
+        }
+    }
+
+    return clone;
+}
+
+module.exports = function stringifyPrepare(obj) {
+    if (obj == null) {
+        return {};
+    }
+
+    /**
+     * Performance notes:
+     *
+     * - It is faster to use native JSON.stringify instead of a custom stringify
+     * - It is faster to first prune and then call JSON.stringify with _no_ replacer
+     */
+    var pruned;
+
+    const assignments = []; // Used to keep track of code that needs to run to fix up the stringified object
+
+    if (typeof obj === 'object') {
+        const serializationSymbol = Symbol(); // Used to detect if the marker is associated with _this_ serialization
+        const path = [];
+
+        obj[markerKey] = new Marker(path, serializationSymbol);
+
+        if (obj.constructor === Date) {
+            pruned = null;
+            assignments.push(new Assignment([], { type: 'Date', value: obj.getTime() }));
+        } else if (isArray(obj)) {
+            pruned = pruneArray(obj, path, serializationSymbol, assignments);
+        } else {
+            pruned = pruneObject(obj, path, serializationSymbol, assignments);
+        }
+    } else {
+        pruned = obj;
+    }
+
+    var final = {
+        object: pruned
+    };
+
+    if (assignments.length) {
+        final.assignments = assignments;
+    }
+
+    return final;
+};
\ No newline at end of file
diff --git a/stringifyPrepare.js b/stringifyPrepare.js
new file mode 100644
index 0000000..17eb336
--- /dev/null
+++ b/stringifyPrepare.js
@@ -0,0 +1 @@
+module.exports = require('./src/stringifyPrepare');
\ No newline at end of file
diff --git a/test/tests/submodules/test.js b/test/tests/submodules/test.js
new file mode 100644
index 0000000..9c0b63d
--- /dev/null
+++ b/test/tests/submodules/test.js
@@ -0,0 +1,11 @@
+var expect = require('chai').expect;
+
+
+module.exports = function(helpers) {
+    var warp10 = require('../../../');
+    expect(require('../../../finalize')).to.equal(warp10.finalize);
+    expect(require('../../../parse')).to.equal(warp10.parse);
+    expect(require('../../../serialize')).to.equal(warp10.serialize);
+    expect(require('../../../stringify')).to.equal(warp10.stringify);
+    expect(require('../../../finalize')).to.equal(warp10.finalize);
+};
\ No newline at end of file