Remove dummy nodes from the XML tree.

Author: oozcitak

src/XMLNode.coffee

@@ -289,7 +289,13 @@ module.exports = class XMLNode
   # Adds a dummy node
   dummy: () ->
     child = new XMLDummy @
-    @children.push child
+    # Normally when a new node is created it is added to the child node collection.
+    # However, dummy nodes are never added to the XML tree. They are created while
+    # converting JS objects to XML nodes in order not to break the recursive function
+    # chain. They can be thought of as invisible nodes. They can be traversed through
+    # by using prev(), next(), up(), etc. functions but they do not exists in the tree.
+    #
+    # @children.push child
     return child
 
   # Adds a processing instruction
@@ -435,9 +441,6 @@ module.exports = class XMLNode
   prev: () ->
     i = @parent.children.indexOf @
 
-    # skip dummy nodes
-    i = i - 1 while i > 0 and @parent.children[i - 1].type is NodeType.Dummy
-
     if i < 1
       throw new Error "Already at the first node. " + @debugInfo()
 
@@ -448,9 +451,6 @@ module.exports = class XMLNode
   next: () ->
     i = @parent.children.indexOf @
 
-    # skip dummy nodes
-    i = i + 1 while i < @parent.children.length - 1 and @parent.children[i + 1].type is NodeType.Dummy
-
     if i == -1 || i == @parent.children.length - 1
       throw new Error "Already at the last node. " + @debugInfo()
 
@@ -482,26 +482,6 @@ module.exports = class XMLNode
       "node: <" + name + ">, parent: <" + @parent.name + ">"
 
 
-  # Count the number of child nodes which are not `XMLDummy`
-  countNonDummy: () ->
-    if not @children or @children.length is 0
-      return 0
-    else
-      count = 0
-      for child in @children
-        count++ unless child.type is NodeType.Dummy
-      return count
-
-  # Returns the first child node which is not an `XMLDummy`
-  firstNonDummy: () ->
-    if not @children or @children.length is 0
-      return null
-    else
-      for child in @children
-        return child unless child.type is NodeType.Dummy
-      return null
-
-
   # Aliases
   ele: (name, attributes, text) -> @element name, attributes, text
   nod: (name, attributes, text) -> @node name, attributes, text

src/XMLStreamWriter.coffee

@@ -62,7 +62,7 @@ module.exports = class XMLStreamWriter extends XMLWriterBase
       @stream.write ' SYSTEM "' + node.sysID + '"'
 
     # internal subset
-    if node.countNonDummy() > 0
+    if node.children.length > 0
       @stream.write ' ['
       @stream.write @endline(node, options, level)
       options.state = WriterState.InsideTag
@@ -90,8 +90,8 @@ module.exports = class XMLStreamWriter extends XMLWriterBase
     for own name, att of node.attributes
       @attribute att, options, level
 
-    childNodeCount = node.countNonDummy()
-    firstNonDummyChildNode = node.firstNonDummy()
+    childNodeCount = node.children.length
+    firstChildNode = if childNodeCount is 0 then null else node.children[0]
     if childNodeCount == 0 or node.children.every((e) -> (e.type is NodeType.Text or e.type is NodeType.Raw) and e.value == '')
       # empty element
       if options.allowEmpty
@@ -101,13 +101,13 @@ module.exports = class XMLStreamWriter extends XMLWriterBase
       else
         options.state = WriterState.CloseTag
         @stream.write options.spaceBeforeSlash + '/>'
-    else if options.pretty and childNodeCount == 1 and (firstNonDummyChildNode.type is NodeType.Text or firstNonDummyChildNode.type is NodeType.Raw) and firstNonDummyChildNode.value?
+    else if options.pretty and childNodeCount == 1 and (firstChildNode.type is NodeType.Text or firstChildNode.type is NodeType.Raw) and firstChildNode.value?
       # do not indent text-only nodes
       @stream.write '>'
       options.state = WriterState.InsideTag
       options.suppressPrettyCount++
       prettySuppressed = true
-      @writeChildNode firstNonDummyChildNode, options, level + 1
+      @writeChildNode firstChildNode, options, level + 1
       options.suppressPrettyCount--
       prettySuppressed = false
       options.state = WriterState.CloseTag

src/XMLWriterBase.coffee

@@ -156,7 +156,7 @@ module.exports = class XMLWriterBase
       r += ' SYSTEM "' + node.sysID + '"'
 
     # internal subset
-    if node.countNonDummy() > 0
+    if node.children.length > 0
       r += ' ['
       r += @endline(node, options, level)
       options.state = WriterState.InsideTag
@@ -189,8 +189,8 @@ module.exports = class XMLWriterBase
     for own name, att of node.attributes
       r += @attribute att, options, level
 
-    childNodeCount = node.countNonDummy()
-    firstNonDummyChildNode = node.firstNonDummy()
+    childNodeCount = node.children.length
+    firstChildNode = if childNodeCount is 0 then null else node.children[0]
     if childNodeCount == 0 or node.children.every((e) -> (e.type is NodeType.Text or e.type is NodeType.Raw) and e.value == '')
       # empty element
       if options.allowEmpty
@@ -200,13 +200,13 @@ module.exports = class XMLWriterBase
       else
         options.state = WriterState.CloseTag
         r += options.spaceBeforeSlash + '/>' + @endline(node, options, level)
-    else if options.pretty and childNodeCount == 1 and (firstNonDummyChildNode.type is NodeType.Text or firstNonDummyChildNode.type is NodeType.Raw) and firstNonDummyChildNode.value?
+    else if options.pretty and childNodeCount == 1 and (firstChildNode.type is NodeType.Text or firstChildNode.type is NodeType.Raw) and firstChildNode.value?
       # do not indent text-only nodes
       r += '>'
       options.state = WriterState.InsideTag
       options.suppressPrettyCount++
       prettySuppressed = true
-      r += @writeChildNode firstNonDummyChildNode, options, level + 1
+      r += @writeChildNode firstChildNode, options, level + 1
       options.suppressPrettyCount--
       prettySuppressed = false
       options.state = WriterState.CloseTag

test/basic/nodetype.coffee

@@ -11,7 +11,6 @@ suite 'Check node type:', ->
 
     doc = xml(obj, { sysID: 'hello.dtd' }).doc()
     root = doc.root()
-    root.dummy()
 
     eq(doc.type, builder.nodeType.Document)
     eq(doc.children[0].type, builder.nodeType.Declaration)
@@ -22,7 +21,6 @@ suite 'Check node type:', ->
     eq(root.children[2].type, builder.nodeType.CData)
     eq(root.children[3].type, builder.nodeType.Comment)
     eq(root.children[4].type, builder.nodeType.ProcessingInstruction)
-    eq(root.children[5].type, builder.nodeType.Dummy)
 
   test 'DTD node types', ->
     dtd = xml('root', { headless: true }).dtd()