tests looking good

Author: joshday

README.md

@@ -43,7 +43,7 @@ doc[end][2]  # Second child of root
 
 ## Data Structures
 
-**`XML.Node`**
+### `XML.Node`
 - An eager data structure that loads the entire XML DOM in memory.
 - **This is what you should use to build an XML document programmatically.**
 - `Node`s have some additional methods that aid in construction/mutation:
@@ -65,11 +65,21 @@ parent[2] = child
 Node(node; kw...)
 ```
 
-**`XML.RowNode`**
+- Bring convenience functions into your namespace with `using XML.NodeConstructors`:
+
+```julia
+using XML.NodeConstructors
+# cdata, comment, declaration, document, dtd, element, processing_instruction, text
+
+cdata("hello > < ' \" I have odd characters")
+# Node CDATA <![CDATA[hello > < ' " I have odd characters]]>
+```
+
+### `XML.RowNode`
 - A data structure that can used as a *Tables.jl* source.  It is only lazy in how it access its children.
 
 
-**`XML.RawData`**
+### `XML.RawData`
 - A super lazy data structure that holds the reference `Vector{UInt8}` data and the sta
 
 ## Reading

src/XML.jl

@@ -518,7 +518,7 @@ Base.show(io::IO, o::Node) = _show_node(io, o)
 
 #-----------------------------------------------------------------------------# Node Constructors
 # auto-detect how to create a Node
-_node(x; depth=-1) = Node(text(string(x)); depth)
+_node(x; depth=-1) = Node(nodetype=TEXT, value=string(x); depth)
 _node(x::Node; depth=x.depth) = Node(x; depth)
 
 module NodeConstructors
@@ -530,26 +530,69 @@ export document, dtd, declaration, processing_instruction, comment, cdata, text,
 
 attrs(kw) = OrderedDict{String,String}(string(k) => string(v) for (k,v) in kw)
 
-document(children::Vector{Node}) = Node(nodetype=DOCUMENT, children)
-document(children::Node...) = document(Node.(children))
+"""
+    document(children::Vector{Node})
+    document(children::Node...)
+"""
+document(children::Vector{Node}) = Node(;nodetype=DOCUMENT, children)
+document(children::Node...) = document(collect(children))
 
+"""
+    dtd(value::AbstractString)
+"""
 dtd(value::AbstractString) = Node(nodetype=DTD, value=String(value))
 
+"""
+    declaration(; attributes...)
+"""
 declaration(attributes::OrderedDict{String,String}) = Node(;nodetype=DECLARATION, attributes)
 declaration(; kw...) = declaration(attrs(kw))
 
+"""
+    processing_instruction(tag::AbstractString; attributes...)
+"""
 processing_instruction(tag, attributes::OrderedDict{String,String}) = Node(;nodetype=PROCESSING_INSTRUCTION, tag=string(tag), attributes)
 processing_instruction(tag; kw...) = processing_instruction(tag, attrs(kw))
 
+"""
+    comment(value::AbstractString)
+"""
 comment(value::AbstractString) = Node(nodetype=COMMENT, value=String(value))
 
+"""
+    cdata(value::AbstractString)
+"""
 cdata(value::AbstractString) = Node(nodetype=CDATA, value=String(value))
 
+"""
+    text(value::AbstractString)
+"""
 text(value::AbstractString) = Node(nodetype=TEXT, value=String(value))
 
+"""
+    element(tag::AbstractString, children::Vector{Node}; attributes...)
+    element(tag::AbstractString, children::Node...; attributes...)
+
+Example:
 
-element(tag, children...; kw...) = Node(; nodetype=ELEMENT, tag=string(tag), attributes=attrs(kw))(children...)
-Base.getproperty(::typeof(element), tag::Symbol) = element(string(tag))
+    using XML.NodeConstructors
+
+    n = element("tag", "child"; key="value")
+    # Node ELEMENT <tag key="value"> (1 child)
+
+    only(n)
+    # Node TEXT "child"
+
+    push!(n, cdata("hello > < ' \" I have odd characters"))
+
+    children(n)
+    # 2-element Vector{Node}:
+    #  Node TEXT "child"
+    #  Node CDATA <![CDATA[hello > < ' " I have odd characters]]>
+"""
+element(tag, children...; kw...) = Node(; nodetype=ELEMENT, tag=string(tag), attributes=attrs(kw))(_node.(children)...)
+element(tag, children::Vector{Node}; kw...) = element(tag, children...; kw...)
+# Base.getproperty(::typeof(element), tag::Symbol) = element(string(tag))
 end
 
 

test/runtests.jl

@@ -1,7 +1,6 @@
 using XML
 using Downloads: download
 using Test
-using AbstractTrees
 using OrderedCollections
 
 #-----------------------------------------------------------------------------# files
@@ -150,5 +149,26 @@ end
 end
 
 #-----------------------------------------------------------------------------# Node writing
+using XML.NodeConstructors
+
 @testset "Node writing" begin
+    doc = document(
+        dtd("root_tag"),
+        declaration(version=1.0),
+        comment("comment"),
+        processing_instruction("xml-stylesheet", href="mystyle.css", type="text/css"),
+        element("root_tag", cdata("cdata"), text("text"))
+    )
+    @test map(nodetype, children(doc)) == [
+        XML.DTD,
+        XML.DECLARATION,
+        XML.COMMENT,
+        XML.PROCESSING_INSTRUCTION,
+        XML.ELEMENT
+    ]
+    @test length(children(doc[end])) == 2
+    @test nodetype(doc[end][1]) == XML.CDATA
+    @test nodetype(doc[end][2]) == XML.TEXT
+    @test value(doc[end][1]) == "cdata"
+    @test value(doc[end][2]) == "text"
 end