rename cdataTagName to cdataPropName & support comments

a-rasin · Nov 18, 2021 · 45b912f · 45b912f
1 parent f379c66
commit 45b912f
Show file tree

Hide file tree

Showing 15 changed files with 234 additions and 42 deletions.
diff --git a/docs/v4/2.XMLparseOptions.md b/docs/v4/2.XMLparseOptions.md
@@ -131,8 +131,8 @@ const options = {
 :
 ```
 
-## cdataTagName
-If `cdataTagName` is not set to some property name, then CDATA values are merged to tag's text value.
+## cdataPropName
+If `cdataPropName` is not set to some property name, then CDATA values are merged to tag's text value.
 
 Eg
 ```js
@@ -152,12 +152,12 @@ Output
     }
 }
 ```
-When `cdataTagName` is set to some property then text value and CDATA are parsed to different properties.
+When `cdataPropName` is set to some property then text value and CDATA are parsed to different properties.
 
 Example 2
 ```js
 const options = {
-    cdataTagName:     "__cdata"
+    cdataPropName:     "__cdata"
 }
 ```
 Output
@@ -174,7 +174,44 @@ Output
     }
 }
 ```
+## commentPropName
+If `commentPropName` is set to some property name, then comments are parsed from XML.
 
+Eg
+```js
+const xmlData = `
+    <!--Students grades are uploaded by months-->
+    <class_list>
+       <student>
+         <!--Student details-->
+         <!--A second comment-->
+         <name>Tanmay</name>
+         <grade>A</grade>
+       </student>
+    </class_list>`;  
+
+const options = {
+    commentPropName: "#comment"
+};
+const parser = new XMLParser(options);
+const output = parser.parse(xmlDataStr);
+```
+Output
+```json
+{
+    "#comment": "Students grades are uploaded by months",
+    "class_list": {
+        "student": {
+            "#comment": [
+                "Student details",
+                "A second comment"
+            ],
+            "name": "Tanmay",
+            "grade": "A"
+        }
+    }
+}
+```
 
 ## ignoreAttributes
 
@@ -403,8 +440,65 @@ Output
     }
 }
 ```
+## preserveOrder
+When `preserveOrder: true` , you get some long ugly result. That's because this option is used to keep the order of tags in result js Object. It also helps XML builder to build the similar kind of XML from the js object without losing information.
 
+```js
+const XMLdata = `
+    <!--Students grades are uploaded by months-->
+    <class_list>
+       <student>
+         <!--Student details-->
+         <!--A second comment-->
+         <name>Tanmay</name>
+         <grade>A</grade>
+       </student>
+    </class_list>`;
 
+    const options = {
+        commentPropName: "#comment",
+        preserveOrder: true
+    };
+    const parser = new XMLParser(options);
+    let result = parser.parse(XMLdata);
+```
+```json
+[
+    {
+        "#comment": [
+            { "#text": "Students grades are uploaded by months" }
+        ]
+    },
+    {
+        "class_list": [
+            {
+                "student": [
+                    {
+                        "#comment": [
+                            { "#text": "Student details" }
+                        ]
+                    },
+                    {
+                        "#comment": [
+                            { "#text": "A second comment" }
+                        ]
+                    },
+                    {
+                        "name": [
+                            { "#text": "Tanmay" }
+                        ]
+                    },
+                    {
+                        "grade": [
+                            { "#text": "A" }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+]
+```
 ## removeNSPrefix
 
 Remove namespace string from tag and attribute names.

diff --git a/docs/v4/3.XMLBuilder.md b/docs/v4/3.XMLBuilder.md
@@ -59,8 +59,10 @@ To recognize attribute properties group in the JS object so that they can be tri
 ## attributeValueProcessor
 To customize the bahaviour of parsing an attribute value to the string value. It accepts attribute name and value.
 
-## cdataTagName
-To recognize CDATA properties in a JS object so that they can be transformed correcty. This option is useful only if `preserveOrder: true`
+## cdataPropName
+To recognize CDATA properties in a JS object so that they can be transformed correcty. This option is supported only if `preserveOrder: true`
+## commentPropName
+To recognize commentsin a JS object so that they can be transformed correcty. This option is supported only if `preserveOrder: true` because position of comment is important.
 
 ## format
 By default, parsed XML is single line XML string. By `format: true`, you can format it for better view.

diff --git a/spec/attr_spec.js b/spec/attr_spec.js
@@ -46,7 +46,7 @@ describe("XMLParser", function() {
         const parser = new XMLParser(options);
         let result = parser.parse(xmlData);
 
-        console.log(JSON.stringify(result,null,4));
+        // console.log(JSON.stringify(result,null,4));
         // expect(result).toEqual(expected);
 
         result = XMLValidator.validate(xmlData);

diff --git a/spec/cdata_spec.js b/spec/cdata_spec.js
@@ -261,7 +261,7 @@ patronymic</person></root>`;
 
         const options = {
             ignoreAttributes: false,
-            cdataTagName:     "__cdata"
+            cdataPropName:     "__cdata"
         };
         const parser = new XMLParser(options);
         let result = parser.parse(xmlData);
@@ -297,7 +297,7 @@ patronymic</person></root>`;
 
         const options = {
             ignoreAttributes: false,
-            cdataTagName:     "__cdata"
+            cdataPropName:     "__cdata"
         };
         const parser = new XMLParser(options);
         let result = parser.parse(xmlData);

diff --git a/spec/comments_spec.js b/spec/comments_spec.js
@@ -0,0 +1,36 @@
+
+const { XMLParser, XMLBuilder, XMLValidator} = require("../src/fxp");
+
+describe("Comments", function() {
+
+  it("should parse comment and build them back", function() {
+    const XMLdata = `
+    <!--Students grades are uploaded by months-->
+    <class_list>
+       <student>
+         <!--Student details-->
+         <!--A second comment-->
+         <name>Tanmay</name>
+         <grade>A</grade>
+       </student>
+    </class_list>`;
+
+      const options = {
+        ignoreAttributes: false,
+        format: true,
+        commentPropName: "#comment",
+        preserveOrder: true
+      };
+      const parser = new XMLParser(options);
+      let result = parser.parse(XMLdata);
+    //   console.log(JSON.stringify(result, null,4));
+
+      const builder = new XMLBuilder(options);
+      const output = builder.build(result);
+    //   console.log(output);
+      expect(output.replace(/\s+/g, "")).toEqual(XMLdata.replace(/\s+/g, ""));
+});
+
+
+});
+
diff --git a/spec/inputType_spec.js b/spec/inputType_spec.js
@@ -46,21 +46,41 @@ describe("XMLParser", function() {
         expect(result).toEqual(expected);
     });
 
-    it("should not parse when invalid value is given", function() {
+    xit("should not parse when invalid value is given", function() {
+        const parser = new XMLParser();
+        const result = parser.parse(23);
+        // console.log(result)
+        expect(result).toBeUndefined();
+    });
 
+    xit("should not parse when invalid value is given", function() {
         const parser = new XMLParser();
-        expect(parser.parse(23)).toBeUndefined();
+        const result = parser.parse([]);
+        // console.log(result)
+        expect(result).toBeUndefined();
     });
 
-    it("should not parse when invalid value is given", function() {
+    xit("should not parse when invalid value is given", function() {
+        const parser = new XMLParser( { preserveOrder: true});
+        const result = parser.parse([]);
+        expect(result).toBeUndefined();
+    });
 
+    it("should not parse when null", function() {
         const parser = new XMLParser( { preserveOrder: true});
-        expect(parser.parse([])).toBeUndefined();
+        expect(() => {
+            parser.parse(null);
+            // console.log(result);
+        }).toThrowError("Cannot read property 'toString' of null");
     });
-
-    it("should not parse when invalid value is given", function() {
 
-        const parser = new XMLParser();
-        expect(parser.parse([])).toBeUndefined();
+    it("should not parse when undefined", function() {
+        const parser = new XMLParser( { preserveOrder: true});
+        expect(() => {
+            parser.parse();
+            // console.log(result);
+        }).toThrowError("Cannot read property 'toString' of undefined");
     });
+
+
 });
diff --git a/spec/j2x_ordered_spec.js b/spec/j2x_ordered_spec.js
@@ -62,7 +62,7 @@ describe("XMLBuilder", function() {
     const options = {
       ignoreAttributes: false,
       preserveOrder: true,
-      cdataTagName: "#CDATA",
+      cdataPropName: "#CDATA",
       allowBooleanAttributes: true,
     //   format: true,
 
@@ -173,7 +173,7 @@ describe("XMLBuilder", function() {
         const options = {
             preserveOrder: true,
             format: true,
-            // cdataTagName: "#CDATA"
+            // cdataPropName: "#CDATA"
         }
         const parser = new XMLParser(options);
         let result = parser.parse(XMLdata);
@@ -208,7 +208,7 @@ describe("XMLBuilder", function() {
         const options = {
             preserveOrder: true,
             format: true,
-            cdataTagName: "#CDATA"
+            cdataPropName: "#CDATA"
         }
         const parser = new XMLParser(options);
         let result = parser.parse(XMLdata);

diff --git a/spec/j2x_spec.js b/spec/j2x_spec.js
@@ -222,7 +222,7 @@ describe("XMLBuilder", function() {
             }
         };
         const builder = new XMLBuilder({
-                                      cdataTagName:   "__cdata",
+                                      cdataPropName:   "__cdata",
                                       attributesGroupName:   "@",
                                       encodeHTMLchar: true,
                                       format:         true,
@@ -274,7 +274,7 @@ textvalue&gt;  <tag>
       }
     };
     const builder = new XMLBuilder({
-      cdataTagName: "__cdata",
+      cdataPropName: "__cdata",
       attributesGroupName: "@",
       encodeHTMLchar: true,
       format: true,
@@ -358,7 +358,7 @@ textvalue&gt;  <tag>
             attributesGroupName:        "$",
             textNodeName:        "_",
             ignoreAttributes:    false,
-            cdataTagName:        "$cdata",
+            cdataPropName:        "$cdata",
             cdataPositionChar:   "\\c",
             format:              false,
             indentBy:            "\t",

diff --git a/spec/valueProcessors_spec.js b/spec/valueProcessors_spec.js
@@ -273,7 +273,7 @@ describe("XMLParser", function() {
       const options = {
         ignoreAttributes: false,
         preserveOrder: true,
-        cdataTagName: "#CDATA",
+        cdataPropName: "#CDATA",
         tagValueProcessor: (tagName, tagValue, jPath, hasAttributes, isLeafNode) => {
         //   console.log(tagName, tagValue, jPath, hasAttributes, isLeafNode);
         tagValueProcessorCalls.push(`${tagName} ${tagValue} ${jPath} ${hasAttributes} ${isLeafNode}`);
@@ -301,7 +301,7 @@ describe("XMLParser", function() {
       const options = {
         ignoreAttributes: false,
         preserveOrder: true,
-        cdataTagName: "#CDATA",
+        cdataPropName: "#CDATA",
         tagValueProcessor: (tagName, tagValue, jPath, hasAttributes, isLeafNode) => {
         //   console.log(tagName, tagValue, jPath, hasAttributes, isLeafNode);
         tagValueProcessorCalls.push(`${tagName} ${tagValue} ${jPath} ${hasAttributes} ${isLeafNode}`);

diff --git a/src/fxp.d.ts b/src/fxp.d.ts
@@ -9,7 +9,8 @@ type X2jOptions = {
   parseTagValue: boolean;
   parseAttributeValue: boolean;
   trimValues: boolean;
-  cdataTagName: false | string;
+  cdataPropName: false | string;
+  commentPropName: false | string;
   tagValueProcessor: (tagName: string, tagValue: string, jPath: string, hasAttributes: boolean, isLeafNode: boolean) => string;
   attributeValueProcessor: (attrName: string, attrValue: string, jPath: string) => string;
   numberParseOptions: strnumOptions;
@@ -33,7 +34,8 @@ type XmlBuilderOptions = {
   attributesGroupName: false | string;
   textNodeName: string;
   ignoreAttributes: boolean;
-  cdataTagName: false | string;
+  cdataPropName: false | string;
+  commentPropName: false | string;
   format: boolean;
   indentBy: string;
   arrayNodeName: string;

diff --git a/src/xmlbuilder/json2xml.js b/src/xmlbuilder/json2xml.js
@@ -8,7 +8,7 @@ const defaultOptions = {
   attributesGroupName: false,
   textNodeName: '#text',
   ignoreAttributes: true,
-  cdataTagName: false,
+  cdataPropName: false,
   format: false,
   indentBy: '  ',
   suppressEmptyNode: false,
@@ -18,22 +18,24 @@ const defaultOptions = {
   attributeValueProcessor: function(attrName, a) {
     return a;
   },
-  preserveOrder: false
+  preserveOrder: false,
+  commentPropName: false
 };
 
 const props = [
   'attributeNamePrefix',
   'attributesGroupName',
   'textNodeName',
   'ignoreAttributes',
-  'cdataTagName',
+  'cdataPropName',
   'format',
   'indentBy',
   'suppressEmptyNode',
   'tagValueProcessor',
   'attributeValueProcessor',
   'arrayNodeName', //when array as root
   'preserveOrder',
+  "commentPropName",
   // 'rootNodeName', //when jsObject have multiple properties on root level
 ];