unescape!

Author: joshday

README.md

@@ -199,4 +199,6 @@ Platform Info:
 
 # Possible Gotchas
 
-XML.jl doesn't escape special characters (`<`, `>`, `&`, `"`, and `'` ) for you, but it provides `XML.escape(::String)` and `XML.unescape(::String)` utility functions.
+- XML.jl doesn't automatically escape special characters (`<`, `>`, `&`, `"`, and `'` ) for you.
+  - Use the `XML.escape(::String)` and `XML.unescape(::String)` utility functions to convert strings back and forth.
+  - You can also use `XML.escape!(::Node)` which will escape the strings of all child `Text` nodes.

src/XML.jl

@@ -166,6 +166,15 @@ function escape!(o::Node, warn::Bool=true)
     map!(x -> escape!(x, false), o.children, o.children)
     o
 end
+function unescape!(o::Node, warn::Bool=true)
+    if o.nodetype == Text
+        warn && @warn "unescape!() called on a Text Node creates a new node."
+        return Text(unescape(o.value))
+    end
+    isnothing(o.children) && return o
+    map!(x -> unescape!(x, false), o.children, o.children)
+    o
+end
 
 
 Base.read(filename::AbstractString, ::Type{Node}) = Node(read(filename, Raw))

test/runtests.jl

@@ -19,13 +19,22 @@ all_files = [
     "example.kml" => example_kml
 ]
 
-#-----------------------------------------------------------------------------# utils
-@testset "utils" begin
+#-----------------------------------------------------------------------------# escaping/unescaping
+@testset "escaping/unescaping" begin
     s = "This > string < has & some \" special ' characters"
     @test escape(s) == "This &gt; string &lt; has &amp; some &quot; special &apos; characters"
     @test escape(escape(s)) == escape(s)
     @test s == unescape(escape(s))
     @test s == unescape(unescape(escape(s)))
+
+    n = Element("tag", Text(s))
+    @test XML.simplevalue(n) == s
+
+    XML.escape!(n)
+    @test XML.simplevalue(n) == escape(s)
+
+    XML.unescape!(n)
+    @test XML.simplevalue(n) == s
 end
 
 #-----------------------------------------------------------------------------# Raw