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.

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

Support namespace prefixes #53

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Support namespace prefixes #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94cdc0e
Refactor duplicate createElement code
nrenner Mar 2, 2021
d569ab3
Add failing tests for namespace prefixes in JSON
nrenner Mar 4, 2021
71a5b09
Support namespace prefixes in JSON
nrenner Mar 4, 2021
5b3c12b
Add failing test for XML round trip with prefixes
nrenner Mar 4, 2021
24eb1aa
Build attributes before elements from XML
nrenner Mar 4, 2021
af66999
Support namespace prefixes for attributes
nrenner Mar 5, 2021
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
126 changes: 82 additions & 44 deletions jxon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,27 +151,6 @@
vResult = nVerb === 0 ? objectify(vBuiltVal) : {};
}

for (var nElId = nLevelStart; nElId < nLevelEnd; nElId++) {

sProp = aCache[nElId].nodeName;
if (opts.lowerCaseTags) {
sProp = sProp.toLowerCase();
}

vContent = createObjTree(aCache[nElId], nVerb, bFreeze, bNesteAttr);
if (vResult.hasOwnProperty(sProp)) {
if (vResult[sProp].constructor !== Array) {
vResult[sProp] = [vResult[sProp]];
}

vResult[sProp].push(vContent);
} else {
vResult[sProp] = vContent;

nLength++;
}
}

if (bAttributes) {
var nAttrLen = oParentNode.attributes.length,
sAPrefix = bNesteAttr ? '' : opts.attrPrefix,
Expand Down Expand Up @@ -201,6 +180,27 @@

}

for (var nElId = nLevelStart; nElId < nLevelEnd; nElId++) {

sProp = aCache[nElId].nodeName;
if (opts.lowerCaseTags) {
sProp = sProp.toLowerCase();
}

vContent = createObjTree(aCache[nElId], nVerb, bFreeze, bNesteAttr);
if (vResult.hasOwnProperty(sProp)) {
if (vResult[sProp].constructor !== Array) {
vResult[sProp] = [vResult[sProp]];
}

vResult[sProp].push(vContent);
} else {
vResult[sProp] = vContent;

nLength++;
}
}

if (nVerb === 3 || (nVerb === 2 || nVerb === 1 && nLength > 0) && sCollectedTxt) {
vResult[opts.valueKey] = vBuiltVal;
} else if (!bHighVerb && nLength === 0 && sCollectedTxt) {
Expand All @@ -214,10 +214,60 @@

return vResult;
}

function getElementNS(sName, vValue, oParentEl) {
var xmlns = opts.attrPrefix + 'xmlns',
isObject = vValue && vValue instanceof Object,
elementNS,
prefix;

if (sName.indexOf(':') !== -1) {
prefix = sName.split(':')[0];

if (isObject) {
elementNS = vValue[xmlns + ':' + prefix];
if (elementNS) return elementNS;
}

elementNS = oParentEl.lookupNamespaceURI(prefix);
if (elementNS) return elementNS;
}
if (isObject) {
elementNS = vValue[xmlns];
}

return elementNS || oParentEl.namespaceURI;
}

function setAttribute(sAttrib, vValue, oParentEl) {
var attributeNS,
prefix;

if (sAttrib.indexOf(':') !== -1) {
prefix = sAttrib.split(':')[0];
attributeNS = oParentEl.lookupNamespaceURI(prefix) || oParentEl.namespaceURI;
oParentEl.setAttributeNS(attributeNS, sAttrib, vValue);
} else {
oParentEl.setAttribute(sAttrib, vValue);
}
}

function createElement(sName, vValue, oParentEl, oXMLDoc) {
var elementNS = getElementNS(sName, vValue, oParentEl),
element;

if (elementNS) {
element = oXMLDoc.createElementNS(elementNS, sName);
} else {
element = oXMLDoc.createElement(sName);
}

return element;
}

function loadObjTree(oXMLDoc, oParentEl, oParentObj) {
var vValue,
oChild,
elementNS;
oChild;

if (oParentObj.constructor === String || oParentObj.constructor === Number || oParentObj.constructor === Boolean) {
oParentEl.appendChild(oXMLDoc.createTextNode(oParentObj.toString())); /* verbosity level is 0 or 1 */
Expand Down Expand Up @@ -250,41 +300,29 @@

} else if (sName === opts.attrKey) { /* verbosity level is 3 */
for (var sAttrib in vValue) {
oParentEl.setAttribute(sAttrib, vValue[sAttrib]);
setAttribute(sAttrib, vValue[sAttrib], oParentEl);
}
} else if (sName === opts.attrPrefix + 'xmlns') {
if (isNodeJs) {
oParentEl.setAttribute(sName.slice(1), vValue);
}
// do nothing: special handling of xml namespaces is done via createElementNS()
} else if (sName.indexOf(opts.attrPrefix + 'xmlns') === 0) {
// explicitly set xmlns and xmlns:* attributes, so they can be set anywhere in the tag hierarchy
oParentEl.setAttributeNS('http://www.w3.org/2000/xmlns/', sName.slice(1), vValue);
} else if (sName.charAt(0) === opts.attrPrefix) {
oParentEl.setAttribute(sName.slice(1), vValue);
setAttribute(sName.slice(1), vValue, oParentEl);
} else if (vValue.constructor === Array) {
for (var nItem in vValue) {
if (!vValue.hasOwnProperty(nItem)) continue;
elementNS = (vValue[nItem] && vValue[nItem][opts.attrPrefix + 'xmlns']) || oParentEl.namespaceURI;
if (elementNS) {
oChild = oXMLDoc.createElementNS(elementNS, sName);
} else {
oChild = oXMLDoc.createElement(sName);
}
oChild = createElement(sName, vValue[nItem], oParentEl, oXMLDoc);
oParentEl.appendChild(oChild);

loadObjTree(oXMLDoc, oChild, vValue[nItem] || {});
oParentEl.appendChild(oChild);
}
} else {
elementNS = (vValue || {})[opts.attrPrefix + 'xmlns'] || oParentEl.namespaceURI;
if (elementNS) {
oChild = oXMLDoc.createElementNS(elementNS, sName);
} else {
oChild = oXMLDoc.createElement(sName);
}
oChild = createElement(sName, vValue, oParentEl, oXMLDoc);
oParentEl.appendChild(oChild);
if (vValue instanceof Object) {
loadObjTree(oXMLDoc, oChild, vValue);
} else if (vValue !== null && (vValue !== true || !opts.trueIsEmpty)) {
oChild.appendChild(oXMLDoc.createTextNode(vValue.toString()));
}
oParentEl.appendChild(oChild);
}
}
}
Expand Down
81 changes: 81 additions & 0 deletions test/spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,5 +173,86 @@ describe('JXON', function() {

assert.equal(strNull, strEmptyObj);
});
it('sets the namespace for array elements', function() {
var obj = {
"element": {
"a": [
{
"$xmlns": "foo",
"_": "1"
},
null,
{
"$xmlns": "foo",
"_": "3"
}
]
}
};
var str = JXON.jsToString(obj);
assert.equal(str, '<element><a xmlns="foo">1</a><a/><a xmlns="foo">3</a></element>');
});
it('sets the corresponding parent namespace for prefix', function() {
var obj = {
root: {
"$xmlns": "urn:default",
"$xmlns:foo": "urn:foo",
element: {
"foo:a": "bar"
}
}
};
var xml = JXON.jsToXml(obj);
var a = xml.documentElement.firstChild.firstChild;
var str = JXON.xmlToString(xml);

assert.equal(a.localName, 'a', 'localName');
assert.equal(a.prefix, 'foo', 'prefix');
assert.equal(a.namespaceURI, 'urn:foo', 'namespaceURI');

assert.equal(str, '<root xmlns="urn:default" xmlns:foo="urn:foo"><element><foo:a>bar</foo:a></element></root>');
});
it('sets the attribute namespace for prefix', function() {
var obj = {
"foo:element": {
"$xmlns:foo": "urn:foo",
"_": "bar"
}
};
var xml = JXON.jsToXml(obj);
var element = xml.documentElement;
var str = JXON.xmlToString(xml);

assert.equal(element.localName, 'element', 'localName');
assert.equal(element.prefix, 'foo', 'prefix');
assert.equal(element.namespaceURI, 'urn:foo', 'namespaceURI');

assert.equal(str, '<foo:element xmlns:foo="urn:foo">bar</foo:element>');
});
it('keeps prefix and namespace on XML round trip', function() {
var str1 = '<root xmlns="urn:default" xmlns:foo="urn:foo"><element><foo:a>bar</foo:a></element></root>';
var obj = JXON.stringToJs(str1);
var str2 = JXON.jsToString(obj);
assert.equal(str1, str2);
});
it('sets the namespace for prefixed attributes', function() {
var obj = {
"element": {
"$xmlns": "urn:default",
"$xmlns:foo": "urn:foo",
"$foo:a": "bar"
}
};
var xml = JXON.jsToXml(obj);
var element = xml.documentElement;
var str = JXON.xmlToString(xml);
var attr = element.attributes[2];

assert.equal(attr.localName, 'a', 'localName');
assert.equal(attr.prefix, 'foo', 'prefix');
assert.equal(attr.namespaceURI, 'urn:foo', 'namespaceURI');

assert.equal(str, '<element xmlns="urn:default" xmlns:foo="urn:foo" foo:a="bar"/>');
});
});
});