Merge pull request #68 from mrotrifork/feature/escape-characters

Escape characters when making XML document

Author: kazuhiro4949

SwiftyXMLParser/Accessor.swift

@@ -519,7 +519,7 @@ extension XML {
 
         private func traverse(_ element: Element) -> String {
             let name = element.name
-            let text = element.text ?? ""
+            let text = escapeXMLCharacters(element.text ?? "")
             let attrs = element.attributes.map { (k, v) in "\(k)=\"\(v)\"" }.joined(separator: " ")
 
             let childDocs = element.childElements.reduce("", { (result, element) in
@@ -532,5 +532,16 @@ extension XML {
                 return "<\(name)\(attrs.isEmpty ? "" : " ")\(attrs)>\(text)\(childDocs)</\(name)>"
             }
         }
+
+        private func escapeXMLCharacters(_ string: String) -> String {
+                let charactersToEscape = [
+                    ["&", "&amp;"],
+                    ["<", "&lt;"],
+                    [">", "&gt;"]
+                ]
+                return charactersToEscape.reduce(string) {
+                    $0.replacingOccurrences(of: $1[0], with: $1[1], options: .literal, range: nil)
+                }
+        }
     }
 }

SwiftyXMLParserTests/ConverterTests.swift

@@ -117,6 +117,19 @@ class ConverterTests: XCTestCase {
         }
     }
 
+    func testMakeDocumentEscapingCharacters() throws {
+        let element = XML.Element(name: "name", text: "me&you", childElements: [
+            XML.Element(name: "child", text: "& < > &")
+        ])
+        let converter = XML.Converter(XML.Accessor(element))
+
+        XCTAssertEqual(
+            try converter.makeDocument(),
+            "<?xml version=\"1.0\" encoding=\"UTF-8\"?><name>me&amp;you<child>&amp; &lt; &gt; &amp;</child></name>",
+            "escape characters when making xml document"
+        )
+    }
+
     func testMakeDocumentWithoutAttributes() throws {
         let element = XML.Element(name: "name")
         let converter = XML.Converter(XML.Accessor(element))