Merge pull request #56 from GeekTree0101/bug/VEditorKit-Support-HTML-Entitles-Handler

[BUG] Support HTML Entitles

Author: OhKanghoon

Example/Tests/VEditorParserSpec.swift

@@ -72,6 +72,21 @@ class VEditorParserSpec: QuickSpec {
                         .to(beTrue())
                 }
             }
+            
+            context("HTML Entities handling test") {
+                
+                it("should be success to parse with HTML entities") {
+                    
+                    expect(parser.parseXMLToAttributedString("<p>hello &amp; world</p>").string == "hello & world")
+                        .to(beTrue())
+                }
+                
+                it("should be fail to parse with HTML entities") {
+                    
+                    expect(parser.parseXMLToAttributedString("<p>hello & world</p>").string == "hello & world")
+                        .to(beFalse())
+                }
+            }
         }
     }
 }

Example/Tests/VEditorXMLBuilderSpec.swift

@@ -92,6 +92,50 @@ class VEditorXMLBuilderSpec: QuickSpec {
                         .to(equal("<content><p>hello<b>world</b>!</p><h2>headingTest</h2><p><b><i>boldItalicTest</i></b></p></content>"))
                 }
             }
+            
+            context("HTML Entities handling test") {
+                
+                var testContents: [VEditorContent]!
+                
+                beforeEach {
+                    var pTagStyle = EditorRule.init().paragraphStyle("p", attributes: [:])
+                    pTagStyle?.add(extraAttributes: [VEditorAttributeKey: ["p"]])
+                    let textNode = NSMutableAttributedString.init()
+                    textNode.append("hello & world".styled(with: pTagStyle!))
+                    testContents = [textNode]
+                    VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler = nil
+                }
+                
+                it("should be success to build with default HTML entities") {
+                    expect(VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler)
+                        .to(beNil())
+                    expect(VEditorXMLBuilder.shared.buildXML(testContents, rule: rule, packageTag: "content"))
+                        .to(equal("<content><p>hello &amp; world</p></content>"))
+                }
+                
+                it("should be success to build with custom HTML entities") {
+                    VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler = { text -> String in
+                        return text.replacingOccurrences(of: "&", with: "&amp;")
+                    }
+                    
+                    expect(VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler)
+                        .toNot(beNil())
+                    expect(VEditorXMLBuilder.shared.buildXML(testContents, rule: rule, packageTag: "content"))
+                        .to(equal("<content><p>hello &amp; world</p></content>"))
+                }
+                
+                it("should be fail to build with custom HTML entities") {
+                    
+                    VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler = { text -> String in
+                        return text
+                    }
+                    
+                    expect(VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler)
+                        .toNot(beNil())
+                    expect(VEditorXMLBuilder.shared.buildXML(testContents, rule: rule, packageTag: "content"))
+                        .toNot(equal("<content><p>hello &amp; world</p></content>"))
+                }
+            }
         }
 
     }

VEditorKit/Classes/VEditorParser.swift

@@ -38,9 +38,7 @@ public final class VEditorParser: NSObject, XMLStyler {
     public func parseXML(_ xmlString: String,
                          onSuccess: (([VEditorContent]) -> Void)? = nil,
                          onError: ((Error?) -> Void)? = nil) {
-        var xmlString = xmlString
-            .replacingOccurrences(of: "\\n", with: "\n")
-            .replacingOccurrences(of: "\\", with: "")
+        var xmlString = xmlString.convertDuplicatedBackSlashToValidParserXML()
 
         // make newlink before block heading if needs
         for blockXML in parserRule.blockStyleXMLTags {
@@ -193,7 +191,7 @@ internal class VEditorContentParser: NSObject, XMLParserDelegate {
 
     func parser(_ parser: XMLParser, foundCharacters string: String) {
         if self.contents.last is String {
-            self.contents.append(string)
+            self.contents.append(string.encodingHTMLEntities())
         }
     }
 

VEditorKit/Classes/VEditorXMLBuilder.swift

@@ -12,6 +12,7 @@ import BonMot
 public final class VEditorXMLBuilder {
 
     public static let shared: VEditorXMLBuilder = .init()
+    public var encodingHTMLEntitiesExternalHandler: ((String) -> String)?
 
     public func buildXML(_ contents: [VEditorContent],
                          rule: VEditorRule,
@@ -73,8 +74,7 @@ public final class VEditorXMLBuilder {
                                  using: { attributes, subRange, _ in
 
                                     var content = attrText.attributedSubstring(from: subRange).string
-                                    content = content
-                                        .replacingOccurrences(of: "\"", with: "\\")
+                                    content = content.encodingHTMLEntities()
 
                                     guard !content.isEmpty else { return }
 
@@ -148,4 +148,26 @@ extension String {
         }
         return xmlString
     }
+    
+    internal func encodingHTMLEntities() -> String {
+        guard let handler = VEditorXMLBuilder.shared.encodingHTMLEntitiesExternalHandler else {
+            // NOTE: default encoding HTML Entities for VEditor
+            // ref: https://dev.w3.org/html5/html-author/charref
+            return self.replacingOccurrences(of: "&", with: "&")
+                .replacingOccurrences(of: "<", with: "&lt;")
+                .replacingOccurrences(of: ">", with: "&gt;")
+                .replacingOccurrences(of: "\"", with: "&quot;")
+                .replacingOccurrences(of: "'", with: "&#x27;")
+                .replacingOccurrences(of: "'", with: "&#x39;")
+                .replacingOccurrences(of: "'", with: "&#x92;")
+                .replacingOccurrences(of: "'", with: "&#x96;")
+        }
+        
+        return handler(self)
+    }
+    
+    internal func convertDuplicatedBackSlashToValidParserXML() -> String {
+        return self.replacingOccurrences(of: "\\n", with: "\n")
+            .replacingOccurrences(of: "\\", with: "")
+    }
 }