Breaking: Initial upgrade of converters to real generated functions, …

…see #620
protobufjs · Jan 12, 2017 · 3946e0f · 3946e0f
1 parent f230d98
commit 3946e0f
Show file tree

Hide file tree

Showing 45 changed files with 7,902 additions and 3,960 deletions.
diff --git a/README.md b/README.md
@@ -175,13 +175,13 @@ While only useful for the adventurous cherishing an aversion to [generated stati
 ```js
 var writer = protobuf.Writer.create();
 var buffer = writer
-    .int32(/* id */ 1 << 3 | /* wireType */ 2)
+    .uint32(/* id */ 1 << 3 | /* wireType */ 2)
     .string("hello world!")
     .finish();
 
 var reader = protobuf.Reader.create(buffer);
 while (reader.pos < reader.len) {
-    var tag = reader.int32();
+    var tag = reader.uint32();
     switch (/* id */ tag >>> 3) {
         case 1:
             console.log(reader.string());

diff --git a/bench/index.js b/bench/index.js
@@ -94,17 +94,17 @@ setTimeout(function() {
     .run();
 
     var dataMessage = Test.from(data);
-    var dataJson = dataMessage.asJSON();
+    var dataObject = dataMessage.toObject();
 
-    newSuite("converting from JSON")
-    .add("Message.from", function() {
-        Test.from(dataJson);
+    newSuite("message from object")
+    .add("Type.fromObject", function() {
+        Test.fromObject(dataObject);
     })
     .run();
 
-    newSuite("converting to JSON")
-    .add("Message#asJSON", function() {
-        dataMessage.asJSON();
+    newSuite("message to object")
+    .add("Type.toObject", function() {
+        Test.toObject(dataMessage);
     })
     .run();
 

diff --git a/cli/pbjs.js b/cli/pbjs.js
@@ -91,7 +91,7 @@ exports.main = function(args, callback) {
                 "",
                 chalk.bold.gray("  Static targets only:"),
                 "",
-                "  --no-create     Does not generate create functions used for runtime compatibility.",
+                "  --no-create     Does not generate create functions used for reflection compatibility.",
                 "  --no-encode     Does not generate encode functions.",
                 "  --no-decode     Does not generate decode functions.",
                 "  --no-verify     Does not generate verify functions.",

diff --git a/cli/targets/static.js b/cli/targets/static.js
@@ -154,11 +154,12 @@ function beautify(code) {
         .replace(/\bc2\b/g, "end2")
         .replace(/\bk\b/g, "key")
         .replace(/\bks\b/g, "keys")
+        .replace(/\bks2\b/g, "keys2")
         .replace(/\be\b/g, "err")
         .replace(/\bf\b/g, "impl")
         .replace(/\bo\b/g, "options")
-        .replace(/\bs\b/g, "src")
-        .replace(/\bd\b/g, "dst"),
+        .replace(/\bd\b/g, "object")
+        .replace(/\bn\b/g, "long"),
         {
             fromString: true,
             compress: false,
@@ -443,40 +444,63 @@ function buildType(ref, type) {
     if (config.convert) {
         push("");
         pushComment([
-            "Converts " + aOrAn(type.name) + " message.",
-            "@function",
-            "@param {" + fullName + "|Object} source " + type.name + " message or plain object to convert",
-            "@param {*} impl Converter implementation to use",
-            "@param {Object.<string,*>} [options] Conversion options",
-            "@returns {" + fullName + "|Object} Converted message"
+            "Creates " + aOrAn(type.name) + " message from a plain object. Also converts values to their respective internal types.",
+            "@param {Object.<string,*>} object Plain object",
+            "@returns {" + fullName + "} " + type.name
         ]);
-        buildFunction(type, "convert", protobuf.converter(type), {
+        buildFunction(type, "fromObject", protobuf.converter.fromObject(type), {
             util  : "$protobuf.util",
             types : hasTypes ? "$types" : undefined
         });
 
         push("");
         pushComment([
-            "Creates " + aOrAn(type.name) + " message from JSON.",
-            "@param {Object.<string,*>} source Source object",
-            "@param {Object.<string,*>} [options] Conversion options",
+            "Creates " + aOrAn(type.name) + " message from a plain object. Also converts values to their respective internal types.",
+            "This is an alias of {@link " + fullName + ".fromObject}.",
+            "@function",
+            "@param {Object.<string,*>} object Plain object",
             "@returns {" + fullName + "} " + type.name
         ]);
-        push(name(type.name) + ".from = function from(source, options) {");
+        push(name(type.name) + ".from = " + name(type.name) + ".fromObject;");
+
+        push("");
+        pushComment([
+            "Creates a plain object from " + aOrAn(type.name) + " message. Also converts values to other types if specified.",
+            "@param {" + fullName + "} message " + type.name,
+            "@param {$protobuf.ConversionOptions} [options] Conversion options",
+            "@returns {Object.<string,*>} Plain object"
+        ]);
+        buildFunction(type, "toObject", protobuf.converter.toObject(type), {
+            util  : "$protobuf.util",
+            types : hasTypes ? "$types" : undefined
+        });
+
+        push("");
+        pushComment([
+            "Creates a plain object from this " + type.name + " message. Also converts values to other types if specified.",
+            "@param {$protobuf.ConversionOptions} [options] Conversion options",
+            "@returns {Object.<string,*>} Plain object"
+        ]);
+        push("$prototype.toObject = function toObject(options) {");
         ++indent;
-        push("return this.convert(source, $protobuf.converters.message, options);");
+            push("return this.constructor.toObject(this, options);");
         --indent;
         push("};");
 
         push("");
         pushComment([
-            "Converts this " + type.name + " message to JSON.",
-            "@param {Object.<string,*>} [options] Conversion options",
+            "Converts this " + type.name + " to JSON.",
             "@returns {Object.<string,*>} JSON object"
         ]);
-        push("$prototype.asJSON = function asJSON(options) {");
+        push("$prototype.toJSON = function toJSON() {");
         ++indent;
-        push("return this.constructor.convert(this, $protobuf.converters.json, options);");
+            push("return this.constructor.toObject(this, {");
+            ++indent;
+                push("longs: String,");
+                push("enums: String,");
+                push("bytes: String");
+            --indent;
+            push("});");
         --indent;
         push("};");
     }