XML: undocument constructors and drop XML::Node.new(node)

Author: ysbaddaden

src/xml/attributes.cr

@@ -3,13 +3,13 @@ require "./node"
 class XML::Attributes
   include Enumerable(Node)
 
+  # :nodoc:
   def initialize(@node : Node)
   end
 
   def empty? : Bool
     return true unless @node.element?
 
-    props = self.props
     props.null?
   end
 
@@ -54,8 +54,8 @@ class XML::Attributes
 
     props = self.props
     until props.null?
-      yield Node.new(props, @node.document)
-      props = props.value.next
+      yield Node.new(props.as(LibXML::Node*), @node.document)
+      props = props.value.next.as(LibXML::Attr*)
     end
   end
 
@@ -73,7 +73,7 @@ class XML::Attributes
     pp.list("[", self, "]")
   end
 
-  protected def props
+  protected def props : LibXML::Attr*
     @node.to_unsafe.value.properties
   end
 end

src/xml/builder.cr

@@ -28,6 +28,7 @@ class XML::Builder
     @writer = LibXML.xmlNewTextWriter(buffer)
   end
 
+  # :nodoc:
   def finalize
     LibXML.xmlFreeTextWriter(@writer)
   end

src/xml/namespace.cr

@@ -1,6 +1,7 @@
 class XML::Namespace
   getter document : Node
 
+  # :nodoc:
   def initialize(@document : Node, @ns : LibXML::NS*)
   end
 

src/xml/node.cr

@@ -11,32 +11,18 @@ class XML::Node
   # and thus need to keep it alive.
   @unlinked = false
 
-  # Creates a new node.
-  def initialize(node : LibXML::Attr*, @document : Node)
-    @node = node.as(LibXML::Node*)
-  end
-
-  # :ditto:
+  # :nodoc:
   def initialize(node : LibXML::Doc*, @errors : Array(XML::Error)? = nil)
     @node = node.as(LibXML::Node*)
     @document = uninitialized Node
     @document = self
   end
 
-  # :ditto:
-  @[Deprecated("Use the XML::Node.new(doc, errors) or XML::Node.new(node, doc) constructors")]
-  def initialize(@node : LibXML::Node*)
-    unless @node.value.type.in?(Type::DOCUMENT_NODE, Type::HTML_DOCUMENT_NODE)
-      raise ArgumentError.new("XML::Node must be a document node")
-    end
-    @document = uninitialized Node
-    @document = self
-  end
-
-  # :ditto:
+  # :nodoc:
   def initialize(@node : LibXML::Node*, @document : Node)
   end
 
+  # :nodoc:
   def finalize
     if document?
       # free the document, which will recursively free the DOM tree, NS, ...

src/xml/node_set.cr

@@ -1,19 +1,23 @@
 class XML::NodeSet
   include Enumerable(Node)
 
+  # :nodoc:
   def initialize(@doc : Node, @xpath_object : LibXML::XPathObject*)
     @set = @xpath_object.value.nodesetval
   end
 
+  # :nodoc:
   def initialize(@doc : Node, @set : LibXML::NodeSet*)
     @xpath_object = Pointer(LibXML::XPathObject).null
   end
 
+  # :nodoc:
   def initialize(@doc : Node)
     @xpath_object = Pointer(LibXML::XPathObject).null
     @set = LibXML.xmlXPathNodeSetCreate(nil)
   end
 
+  # :nodoc:
   def finalize
     if @xpath_object.null?
       LibXML.xmlXPathFreeNodeSet(@set)

src/xml/reader.cr

@@ -49,6 +49,7 @@ class XML::Reader
     LibXML.xmlTextReaderSetStructuredErrorHandler(@reader, ->Error.structured_callback, Box.box(@errors))
   end
 
+  # :nodoc:
   def finalize
     LibXML.xmlFreeTextReader(@reader)
   end

src/xml/xpath_context.cr

@@ -11,6 +11,7 @@ class XML::XPathContext
     {% end %}
   end
 
+  # :nodoc:
   def finalize
     LibXML.xmlXPathFreeContext(@ctx)
   end