Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement serializeSelf/deserializeSelf for Map, Set, and WeakMap #1980

Merged
merged 5 commits into from
May 17, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions core/core.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ require("./extras/object");
require("./extras/date");
require("./extras/element");
require("./extras/function");
require("./extras/map");
require("./extras/regexp");
require("./extras/string");
require("./extras/set");
require("./extras/weak-map");
require("proxy-polyfill/proxy.min");


Expand Down
61 changes: 61 additions & 0 deletions core/extras/map.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
Defines extensions to intrinsic `Map`.
@see {external:Map}
@module montage/core/extras/map
*/

/**
* Deserialize a map object included in a serialization
* @param {Deserializer} deserializer The Deserializer containing the serialization information
* @function external:Map.deserializeSelf
*/
Object.defineProperty(Map.prototype, "deserializeSelf", {
value: function (deserializer) {
var entries, keys, values,
i, n;

entries = deserializer.getProperty("entries");
if (entries) {
for (i = 0, n = entries.length; i < n; i++) {
this.set(entries[i].key, entries[i].value);
}
}
if (!entries) {
keys = deserializer.getProperty("keys");
values = deserializer.getProperty("values");
if (keys && values) {
for (i = 0, n = keys.length; i < n; i++) {
this.set(keys[i], values[i]);
}
}
}
},
writable: true,
configurable: true
});


/**
* Sserialize a Map object
* @param {Deserializer} serializer The Serializer building out the serialization
* @function external:Map.serializeSelf
*/
Object.defineProperty(Map.prototype, "serializeSelf", {
value: function (serializer) {
var entries = this.entries(),
serializedKeys = [],
serializedValues = [],
entry;

while ((entry = entries.next().value)) {
serializedKeys.push(entry[0]);
serializedValues.push(entry[1]);
}

serializer.setProperty("keys", serializedKeys);
serializer.setProperty("values", serializedValues);

},
writable: true,
configurable: true
});
48 changes: 48 additions & 0 deletions core/extras/set.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
Defines extensions to intrinsic `Set`.
@see {external:Set}
@module montage/core/extras/set
*/

/**
* Deserialize a set object included in a serialization
* @param {Deserializer} deserializer The Deserializer containing the serialization information
* @function external:Set.deserializeSelf
*/
Object.defineProperty(Set.prototype, "deserializeSelf", {
value: function (deserializer) {
var values,
i, n;

values = deserializer.getProperty("values");
if (values) {
for (i = 0, n = values.length; i < n; i++) {
this.add(values[i]);
}
}
},
writable: true,
configurable: true
});


/**
* Serialize a Set object
* @param {Deserializer} serializer The Serializer building out the serialization
* @function external:Set.serializeSelf
*/
Object.defineProperty(Set.prototype, "serializeSelf", {
value: function (serializer) {
var serializedValues = [],
items = this.keys(),
item;

while ((item = items.next().value)) {
serializedValues.push(item);
}

serializer.setProperty("values", serializedValues);
},
writable: true,
configurable: true
});
59 changes: 59 additions & 0 deletions core/extras/weak-map.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**
Defines extensions to intrinsic `WeakMap`.
@see {external:WeakMap}
@module montage/core/extras/weak-map
*/

/**
* Deserialize a weak-map object included in a serialization
* @param {Deserializer} deserializer The Deserializer containing the serialization information
* @function external:WeakMap.deserializeSelf
*/
Object.defineProperty(WeakMap.prototype, "deserializeSelf", {
value: function (deserializer) {
var entries, keys, values,
i, n;

entries = deserializer.getProperty("entries");
if (entries) {
for (i = 0, n = entries.length; i < n; i++) {
this.set(entries[i].key, entries[i].value);
}
}
if (!entries) {
keys = deserializer.getProperty("keys");
values = deserializer.getProperty("values");
if (keys && values) {
for (i = 0, n = keys.length; i < n; i++) {
this.set(keys[i], values[i]);
}
}
}
},
writable: true,
configurable: true
});


/**
* Serialize a WeakMap object
* @param {Deserializer} serializer The Serializer building out the serialization
* @function external:WeakMap.serializeSelf
*/
Object.defineProperty(WeakMap.prototype, "serializeSelf", {
value: function (serializer) {
var entries = this.entries(),
serializedKeys = [],
serializedValues = [],
entry;

while ((entry = entries.next().value)) {
serializedKeys.push(entry[0]);
serializedValues.push(entry[1]);
}
serializer.setProperty("keys", serializedKeys);
serializer.setProperty("values", serializedValues);
},
writable: true,
configurable: true
});
5 changes: 4 additions & 1 deletion core/serialization/deserializer/montage-reviver.js
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,10 @@ var MontageReviver = exports.MontageReviver = Montage.specialize(/** @lends Mont
(locationId.endsWith(".mjson") || locationId.endsWith(".meta"))),
module, locationDesc, location, objectName;

if (locationId) {
if (global[locationId] && typeof global[locationId] === "function") {
module = global;
objectName = locationId;
} else if (locationId) {
locationDesc = MontageReviver.parseObjectLocationId(locationId);
module = this.moduleLoader.getModule(locationDesc.moduleId, label);
objectName = locationDesc.objectName;
Expand Down
70 changes: 70 additions & 0 deletions core/serialization/serializer/montage-visitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,23 @@ var MontageVisitor = Montage.specialize({
return "MontageReference";
} else if (typeof Element !== "undefined" && Element.isElement(object)) {
return "Element";
} else if (this._isSerializableNativeObject(object)) {
return "NativeObject";
}
}
},

_isSerializableNativeObject: {
value: function (object) {
var typeName = object.constructor.name,
nativeType = global[typeName],
isNative = typeof nativeType === "function",
isSerializeable = isNative && typeof object.serializeSelf === "function";

return isNative && isSerializeable;
}
},

visitMontageReference: {
value: function (malker, object, name) {
this.builder.top.setProperty(name, object.reference);
Expand Down Expand Up @@ -128,6 +141,34 @@ var MontageVisitor = Montage.specialize({
}
},

visitNativeObject: {
value: function (malker, object, name) {
if (this.isObjectSerialized(object)) {
this.serializeReferenceToMontageObject(malker, object, name);
} else {
this.handleNativeObject(malker, object, name);
}
}
},

handleNativeObject: {
value: function (malker, object, name) {
var builderObject = this.builder.createCustomObject(),
substituteObject;

this.setObjectSerialization(object, builderObject);

substituteObject = this.serializeNativeObject(malker, object, builderObject);

if (substituteObject) {
this.serializeSubstituteObject(malker, object, name, builderObject, substituteObject);
} else {
builderObject.setLabel(this.labeler.getObjectLabel(object));
this.builder.top.setProperty(name, builderObject);
}
}
},

serializeReferenceToMontageObject: {
value: function (malker, object, name) {
var label = this.labeler.getObjectLabel(object),
Expand Down Expand Up @@ -234,6 +275,35 @@ var MontageVisitor = Montage.specialize({
}
},

serializeNativeObject: {
value: function (malker, object, builderObject) {
var selfSerializer,
substituteObject,
valuesBuilderObject = this.builder.createObjectLiteral();

builderObject.setProperty("prototype", object.constructor.name);
builderObject.setProperty("values", valuesBuilderObject);

this.builder.push(builderObject);
selfSerializer = new SelfSerializer().
initWithMalkerAndVisitorAndObject(
malker, this, object, builderObject);
substituteObject = object.serializeSelf(selfSerializer);

this.builder.pop();

// Remove the values unit in case none was serialized,
// we need to add it before any other units to make sure that
// it's the first unit to show up in the serialization, since we
// don't have a way to order the property names in a serialization.
if (valuesBuilderObject.getPropertyNames().length === 0) {
builderObject.clearProperty("values");
}

return substituteObject;
}
},

setObjectType: {
value: function (object, builderObject) {
var isInstance = Montage.getInfoForObject(object).isInstance,
Expand Down
Loading