Skip to content

Make the default tag for dump and load configurable through the optio… #15

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.

Sign up for GitHub

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

Open
binduwavell wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make the default tag for dump and load configurable through the optio… #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ console.log(json);
// {"key1":[{"$t":"value1"}],"key2":{"key3":[{"$t":"value3"}]}}
```

* `defaultRootTagName` - *string* - If there is one root element and the tag name matches this, we'll exclude the root from the generated JSON : *default : row*


## dump(Object json, Object options)
Transform a Javascript data structure (JSON) in XML string. **Return String.**
Expand All @@ -105,6 +107,7 @@ Transform a Javascript data structure (JSON) in XML string. **Return String.**
* `version` - *string* - Set version attribute of XML header (see header flag); *default : 1.0*
* `encoding` - *string* - Set encoding attribute of XML header (see header flag); *default : UTF-8*
* `specialChar` - *string* - Set the first character of XML tag ($t, $text, $cd, $cdata, $e, $element, $c, $comment); *default : $*
* `defaultRootTagName` - *string* - If there are multiple roots we'll wrap them with this element *default : row*


## tojson(String xml)
Expand All @@ -124,4 +127,3 @@ Alias of dump.


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/touv/node-xml-mapping/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

6 changes: 4 additions & 2 deletions lib/xml-mapping.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ var nameShortTag = 'n';
exports.dump = function (obj, options) {
options = options || {};
options.specialChar = options.specialChar || '$';
options.defaultRootTagName = options.defaultRootTagName || default_tag_name;

if (typeof obj != "object") {
return obj;
Expand Down Expand Up @@ -149,7 +150,7 @@ exports.dump = function (obj, options) {
o = obj;
}
else {
o[default_tag_name] = obj;
o[options.defaultRootTagName] = obj;
}
parse(o);

Expand All @@ -160,6 +161,7 @@ exports.load = function (str, options) {
options = options || {};
options.specialChar = options.specialChar || '$';
options.longTag = options.longTag || false;
options.defaultRootTagName = options.defaultRootTagName || default_tag_name;

if (typeof str != "string") {
if (options.throwErrors) {
Expand Down Expand Up @@ -279,7 +281,7 @@ exports.load = function (str, options) {
});
}

if (stack.length == 1 && node.name == default_tag_name) {
if (stack.length == 1 && node.name == options.defaultRootTagName) {
result = cattr(node.attributes);
stack.push(result);
}
Expand Down
2 changes: 2 additions & 0 deletions test/tojson.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ exports['t02'] = function (test) {
test.deepEqual(XMLMapping.load(input), { key1 : { keyA: 'value1', keyB: 'value2' }, key2 : { keyA: 'value1', keyB: 'value2' } });
input = '<row><key1 keyA="value1" keyB="value2" keyC="value3"/><key2 keyA="value1" keyB="value2" keyC="value3"/></row>';
test.deepEqual(XMLMapping.load(input), { key1 : { keyA: 'value1', keyB: 'value2', keyC: 'value3' }, key2 : { keyA: 'value1', keyB: 'value2', keyC: 'value3' } });
input = '<root><key1 keyA="value1" keyB="value2" keyC="value3"/><key2 keyA="value1" keyB="value2" keyC="value3"/></root>';
test.deepEqual(XMLMapping.load(input, {defaultRootTagName: 'root'}), { key1 : { keyA: 'value1', keyB: 'value2', keyC: 'value3' }, key2 : { keyA: 'value1', keyB: 'value2', keyC: 'value3' } });
test.done();
};

Expand Down
31 changes: 18 additions & 13 deletions test/toxml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ var input;

exports['t00'] = function (test) {
input = {};
test.equal(XMLMapping.dump(input), '<row/>')
test.equal(XMLMapping.dump(input), '<row/>')
input = 'string';
test.equal(XMLMapping.dump(input), 'string')
test.equal(XMLMapping.dump(input), 'string')
input = 1234;
test.equal(XMLMapping.dump(input), 1234)
test.equal(XMLMapping.dump(input), 1234)
test.done();
};
exports['t01'] = function (test) {
input = {
input = {
key : {}
};
test.equal(XMLMapping.dump(input), '<key/>');
Expand All @@ -31,11 +31,11 @@ exports['t01'] = function (test) {
test.done();
};
exports['t02'] = function (test) {
input = {
input = {
key1 : {},
key2 : {}
};
test.equal(XMLMapping.dump(input), '<row><key1/><key2/></row>');
test.equal(XMLMapping.dump(input), '<row><key1/><key2/></row>');
input = {
key1 : {
key: 'value'
Expand All @@ -44,7 +44,7 @@ exports['t02'] = function (test) {
key: 'value'
}
};
test.equal(XMLMapping.dump(input), '<row><key1 key="value"/><key2 key="value"/></row>');
test.equal(XMLMapping.dump(input), '<row><key1 key="value"/><key2 key="value"/></row>');
input = {
key1 : {
keyA: 'value1',
Expand All @@ -56,20 +56,25 @@ exports['t02'] = function (test) {
}
};
test.equal(XMLMapping.dump(input), '<row><key1 keyA="value1" keyB="value2"/><key2 keyA="value1" keyB="value2"/></row>');
input = {
key1 : {},
key2 : {}
};
test.equal(XMLMapping.dump(input, {defaultRootTagName: 'root'}), '<root><key1/><key2/></root>');
test.done();
};
exports['t03a'] = function (test) {
input = {
key : []
};
test.equal(XMLMapping.dump(input), '<key/>');
test.equal(XMLMapping.dump(input), '<key/>');
test.done();
}
exports['t03b'] = function (test) {
input = {
key : [{},{}]
};
test.equal(XMLMapping.dump(input), '<key/><key/>');
test.equal(XMLMapping.dump(input), '<key/><key/>');
test.done();
}
exports['t03c'] = function (test) {
Expand Down Expand Up @@ -113,7 +118,7 @@ exports['t05a'] = function (test) {
input = {
'#element' : [{ $cd : 'value'}, { '#cd' : 'value'}]
};
test.equal(XMLMapping.dump(input), '<![CDATA[value]]><![CDATA[value]]>');
test.equal(XMLMapping.dump(input), '<![CDATA[value]]><![CDATA[value]]>');
test.done();
};
exports['t05b'] = function (test) {
Expand All @@ -122,7 +127,7 @@ exports['t05b'] = function (test) {
'#element' : [{ $t : 'amstra'}, { _t : 'mdram'}]
}
};
test.equal(XMLMapping.dump(input), '<key>amstramdram</key>');
test.equal(XMLMapping.dump(input), '<key>amstramdram</key>');
test.done();
};
exports['t06'] = function (test) {
Expand All @@ -131,13 +136,13 @@ exports['t06'] = function (test) {
'$t' : 1
}
};
test.equal(XMLMapping.dump(input), '<key>1</key>');
test.equal(XMLMapping.dump(input), '<key>1</key>');
input = {
key : {
'$t' : 0
}
};
test.equal(XMLMapping.dump(input), '<key>0</key>');
test.equal(XMLMapping.dump(input), '<key>0</key>');
test.done();
};
exports['t07'] = function (test) {
Expand Down