added special key for node element name aliases

Author: bschaepper

lib/js2xmlparser.js

@@ -25,6 +25,7 @@
     var xmlVersion = "1.0";
     var xmlEncoding = "UTF-8";
     var attributeString = "@";
+    var nodeAliasString = "=";
     var valueString = "#";
     var prettyPrinting = true;
     var indentString = "\t";
@@ -85,6 +86,14 @@
                     throw new Error("valueString option must be a string");
                 }
             }
+            if ("nodeAliasString" in options) {
+                if (typeof options.nodeAliasString === "string") {
+                    nodeAliasString = options.nodeAliasString;
+                }
+                else {
+                    throw new Error("attributeString option must be a string");
+                }
+            }
             if ("prettyPrinting" in options) {
                 if ("enabled" in options.prettyPrinting) {
                     if (typeof options.prettyPrinting.enabled === "boolean") {
@@ -163,6 +172,16 @@
                     elementName = "_" + property;
                 }
 
+                // Allow to use an alias for element names
+                if (Object.prototype.toString.call(object[property]) === "[object Object]" && nodeAliasString in object[property]) {
+                    elementName = object[property][nodeAliasString];
+                }
+
+                // Skip alias key
+                if (elementName === nodeAliasString) {
+                    continue;
+                }
+
                 // Arrays
                 if (Object.prototype.toString.call(object[property]) === "[object Array]") {
                     // Create separate XML elements for each array element
@@ -173,6 +192,7 @@
                         xml = toXML(tempObject, xml, level);
                     }
                 }
+
                 // JSON-type objects with properties
                 else if (Object.prototype.toString.call(object[property]) === "[object Object]") {
                     xml += addIndent("<" + elementName, level);
@@ -321,6 +341,7 @@
         xmlVersion = "1.0";
         xmlEncoding = "UTF-8";
         attributeString = "@";
+        nodeAliasString = "=";
         valueString = "#";
         prettyPrinting = true;
         indentString = "\t";

test/test.js

@@ -968,6 +968,107 @@
                     res.should.equal("<base><a><![CDATA[b'c]]></a></base>");
                 });
             });
+
+            describe("nodeAliasString", function () {
+
+                it("should raise an error when options is defined and options.nodeAliasString is undefined", function () {
+                    var res;
+                    try {
+                        res = js2xmlparser(defaultRoot, defaultData, {
+                            nodeAliasString: undefined
+                        });
+                    } catch (e) {
+                        e.should.match(/nodeAliasString option must be a string/);
+                    }
+                    should.not.exist(res);
+                });
+
+                it("should raise an error when options is defined and options.nodeAliasString is an object", function () {
+                    var res;
+                    try {
+                        res = js2xmlparser(defaultRoot, defaultData, {
+                            nodeAliasString: {}
+                        });
+                    } catch (e) {
+                        e.should.match(/nodeAliasString option must be a string/);
+                    }
+                    should.not.exist(res);
+                });
+
+                it("should raise an error when options is defined and options.nodeAliasString is an array", function () {
+                    var res;
+                    try {
+                        res = js2xmlparser(defaultRoot, defaultData, {
+                            nodeAliasString: []
+                        });
+                    } catch (e) {
+                        e.should.match(/nodeAliasString option must be a string/);
+                    }
+                    should.not.exist(res);
+                });
+
+                it("should raise an error when options is defined and options.nodeAliasString is a number", function () {
+                    var res;
+                    try {
+                        res = js2xmlparser(defaultRoot, defaultData, {
+                            nodeAliasString: 2
+                        });
+                    } catch (e) {
+                        e.should.match(/nodeAliasString option must be a string/);
+                    }
+                    should.not.exist(res);
+                });
+
+                it("should raise an error when options is defined and options.nodeAliasString is a boolean", function () {
+                    var res;
+                    try {
+                        res = js2xmlparser(defaultRoot, defaultData, {
+                            nodeAliasString: true
+                        });
+                    } catch (e) {
+                        e.should.match(/nodeAliasString option must be a string/);
+                    }
+                    should.not.exist(res);
+                });
+
+                it("should create XML with node alias string '=' when options.nodeAliasString is not specified", function () {
+                    var res = js2xmlparser(defaultRoot, {
+                        a: {
+                            "=": "b"
+                        }
+                    }, defaultOptions);
+                    res.should.equal("<base><b></b></base>");
+                });
+
+                it("should create XML with node alias string '__alias' when options.nodeAliasString is '__alias'", function () {
+                    var res = js2xmlparser(defaultRoot, {
+                        a: {
+                            "__alias": "b"
+                        }
+                    }, {
+                        declaration: {
+                            include: false
+                        },
+                        prettyPrinting: {
+                            enabled: false
+                        },
+                        nodeAliasString: "__alias"
+                    });
+                    res.should.equal("<base><b></b></base>");
+                });
+
+                it("should create XML with options.nodeAliasString and data is an array", function () {
+                    var res = js2xmlparser(defaultRoot, {
+                        a: [{
+                            "=": "b"
+                        }, {
+                            "=": "c"
+                        }]
+                    }, defaultOptions);
+                    res.should.equal("<base><b></b><c></c></base>");
+                });
+
+            })
         });
 
         describe("data", function () {