Update Swift node type names in accordance with the cmark changes.

Update some tests that broke in the new version.

Author: allevato

Sources/CommonMark/CMarkInterop.swift

@@ -44,12 +44,10 @@ fileprivate func makeNode(from cNode: OpaquePointer) -> MarkdownNode {
       children: makeNodes(fromChildrenOf: cNode) as! [InlineContent],
       sourceRange: sourceRange)
   case CMARK_NODE_HEADING:
-    node = HeaderNode(
-      level: HeaderNode.Level(rawValue: numericCast(cmark_node_get_heading_level(cNode)))!,
+    node = HeadingNode(
+      level: HeadingNode.Level(rawValue: numericCast(cmark_node_get_heading_level(cNode)))!,
       children: makeNodes(fromChildrenOf: cNode) as! [InlineContent],
       sourceRange: sourceRange)
-  case CMARK_NODE_THEMATIC_BREAK:
-    node = HorizontalRuleNode(sourceRange: sourceRange)
   case CMARK_NODE_HTML_BLOCK:
     node = HTMLBlockNode(
       literalContent: String(cString: cmark_node_get_literal(cNode)),
@@ -106,6 +104,8 @@ fileprivate func makeNode(from cNode: OpaquePointer) -> MarkdownNode {
     node = TextNode(
       literalContent: String(cString: cmark_node_get_literal(cNode)),
       sourceRange: sourceRange)
+  case CMARK_NODE_THEMATIC_BREAK:
+    node = ThematicBreakNode(sourceRange: sourceRange)
   default:
     fatalError("Unexpected node type \(type) encountered")
   }
@@ -180,8 +180,7 @@ extension PrimitiveNode: CMarkNodeConvertible {
     case .codeBlock(let node): return node.makeCNode()
     case .document(let node): return node.makeCNode()
     case .emphasis(let node): return node.makeCNode()
-    case .header(let node): return node.makeCNode()
-    case .horizontalRule(let node): return node.makeCNode()
+    case .heading(let node): return node.makeCNode()
     case .htmlBlock(let node): return node.makeCNode()
     case .image(let node): return node.makeCNode()
     case .inlineCode(let node): return node.makeCNode()
@@ -194,6 +193,7 @@ extension PrimitiveNode: CMarkNodeConvertible {
     case .softBreak(let node): return node.makeCNode()
     case .strong(let node): return node.makeCNode()
     case .text(let node): return node.makeCNode()
+    case .thematicBreak(let node): return node.makeCNode()
     }
   }
 }
@@ -239,7 +239,7 @@ extension HTMLBlockNode: CMarkNodeConvertible {
   }
 }
 
-extension HeaderNode: CMarkNodeConvertible {
+extension HeadingNode: CMarkNodeConvertible {
 
   func makeCNode() -> OpaquePointer {
     let cNode = cmark_node_new(CMARK_NODE_HEADING)!
@@ -251,13 +251,6 @@ extension HeaderNode: CMarkNodeConvertible {
   }
 }
 
-extension HorizontalRuleNode: CMarkNodeConvertible {
-
-  func makeCNode() -> OpaquePointer {
-    return cmark_node_new(CMARK_NODE_THEMATIC_BREAK)!
-  }
-}
-
 extension ImageNode: CMarkNodeConvertible {
 
   func makeCNode() -> OpaquePointer {
@@ -388,3 +381,10 @@ extension TextNode: CMarkNodeConvertible {
     return cNode
   }
 }
+
+extension ThematicBreakNode: CMarkNodeConvertible {
+
+  func makeCNode() -> OpaquePointer {
+    return cmark_node_new(CMARK_NODE_THEMATIC_BREAK)!
+  }
+}

Sources/CommonMark/HeaderNode.swift renamed to Sources/CommonMark/HeadingNode.swift

@@ -10,11 +10,11 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// A block element that represents a section header.
-public struct HeaderNode: BlockContent {
+/// A block element that represents a section heading.
+public struct HeadingNode: BlockContent {
 
-  /// The level of a header, which describes its position in the hierarchy of a document and the
-  /// size at which the header is rendered.
+  /// The level of a heading, which describes its position in the hierarchy of a document and the
+  /// size at which the heading is rendered.
   public enum Level: Int {
     case h1 = 1
     case h2 = 2
@@ -24,20 +24,20 @@ public struct HeaderNode: BlockContent {
     case h6 = 6
   }
 
-  /// The level of the header.
+  /// The level of the heading.
   public let level: Level
 
   /// The children of the receiver.
   public let children: [InlineContent]
 
   public let sourceRange: Range<SourceLocation>?
 
-  public var primitiveRepresentation: PrimitiveNode { return .header(self) }
+  public var primitiveRepresentation: PrimitiveNode { return .heading(self) }
 
-  /// Creates a new header node.
+  /// Creates a new heading node.
   ///
   /// - Parameters:
-  ///   - level: The level of the header. If omitted, `.h1` is used.
+  ///   - level: The level of the heading. If omitted, `.h1` is used.
   ///   - children: Inline content nodes that are children of the new node.
   ///   - sourceRange: The source range from which the node was parsed, if known.
   public init(
@@ -55,25 +55,25 @@ public struct HeaderNode: BlockContent {
   ///
   /// - Parameter level: The new level.
   /// - Returns: The new node.
-  public func replacingLevel(_ level: Level) -> HeaderNode {
-    return HeaderNode(level: level, children: children, sourceRange: sourceRange)
+  public func replacingLevel(_ level: Level) -> HeadingNode {
+    return HeadingNode(level: level, children: children, sourceRange: sourceRange)
   }
 
   /// Returns a new node equivalent to the receiver, but whose children have been replaced with the
   /// given list of nodes.
   ///
   /// - Parameter children: The new list of children.
   /// - Returns: The new node.
-  public func replacingChildren(_ children: [InlineContent]) -> HeaderNode {
-    return HeaderNode(level: level, children: children, sourceRange: sourceRange)
+  public func replacingChildren(_ children: [InlineContent]) -> HeadingNode {
+    return HeadingNode(level: level, children: children, sourceRange: sourceRange)
   }
 
   /// Returns a new node equivalent to the receiver, but whose source range has been replaced with
   /// the given value.
   ///
   /// - Parameter sourceRange: The new source range.
   /// - Returns: The new node.
-  public func replacingSourceRange(_ sourceRange: Range<SourceLocation>?) -> HeaderNode {
-    return HeaderNode(children: children, sourceRange: sourceRange)
+  public func replacingSourceRange(_ sourceRange: Range<SourceLocation>?) -> HeadingNode {
+    return HeadingNode(children: children, sourceRange: sourceRange)
   }
 }

Sources/CommonMark/MarkdownRewriter.swift

@@ -36,8 +36,7 @@ open class MarkdownRewriter {
     case let castNode as CodeBlockNode: return visit(castNode)
     case let castNode as EmphasisNode: return visit(castNode)
     case let castNode as HTMLBlockNode: return visit(castNode)
-    case let castNode as HeaderNode: return visit(castNode)
-    case let castNode as HorizontalRuleNode: return visit(castNode)
+    case let castNode as HeadingNode: return visit(castNode)
     case let castNode as ImageNode: return visit(castNode)
     case let castNode as InlineCodeNode: return visit(castNode)
     case let castNode as InlineHTMLNode: return visit(castNode)
@@ -50,6 +49,7 @@ open class MarkdownRewriter {
     case let castNode as SoftBreakNode: return visit(castNode)
     case let castNode as StrongNode: return visit(castNode)
     case let castNode as TextNode: return visit(castNode)
+    case let castNode as ThematicBreakNode: return visit(castNode)
     case let castNode as BlockContent: return visit(extension: castNode)
     case let castNode as InlineContent: return visit(extension: castNode)
     default:
@@ -121,28 +121,18 @@ open class MarkdownRewriter {
     return node
   }
 
-  /// Called when a `HeaderNode` is visited, replacing it in the AST with the returned node.
+  /// Called when a `HeadingNode` is visited, replacing it in the AST with the returned node.
   ///
   /// The base class implementation of this method automatically visits the children of the node and
   /// returns a node whose children have been replaced by the results of that visitation. If you
   /// override it, you must call `super.visit(node)` if you wish to visit the children as well.
   ///
   /// - Parameter node: The node being visited.
   /// - Returns: The node that should replace the given node in the AST.
-  open func visit(_ node: HeaderNode) -> BlockContent {
+  open func visit(_ node: HeadingNode) -> BlockContent {
     return node.replacingChildren(visitAll(node.children))
   }
 
-  /// Called when a `HorizontalRuleNode` is visited, replacing it in the AST with the returned node.
-  ///
-  /// The base class implementation of this method simply returns the same node.
-  ///
-  /// - Parameter node: The node being visited.
-  /// - Returns: The node that should replace the given node in the AST.
-  open func visit(_ node: HorizontalRuleNode) -> BlockContent {
-    return node
-  }
-
   /// Called when a `ImageNode` is visited, replacing it in the AST with the returned node.
   ///
   /// The base class implementation of this method automatically visits the children of the node and
@@ -277,6 +267,16 @@ open class MarkdownRewriter {
     return node
   }
 
+  /// Called when a `ThematicBreakNode` is visited, replacing it in the AST with the returned node.
+  ///
+  /// The base class implementation of this method simply returns the same node.
+  ///
+  /// - Parameter node: The node being visited.
+  /// - Returns: The node that should replace the given node in the AST.
+  open func visit(_ node: ThematicBreakNode) -> BlockContent {
+    return node
+  }
+
   /// Visits a custom block extension node, replacing it in the AST with the returned node.
   ///
   /// If you have defined custom extension nodes and use them in your AST, then this method will be

Sources/CommonMark/MarkdownVisitor.swift

@@ -33,8 +33,7 @@ open class MarkdownVisitor {
     case let castNode as CodeBlockNode: visit(castNode)
     case let castNode as EmphasisNode: visit(castNode)
     case let castNode as HTMLBlockNode: visit(castNode)
-    case let castNode as HeaderNode: visit(castNode)
-    case let castNode as HorizontalRuleNode: visit(castNode)
+    case let castNode as HeadingNode: visit(castNode)
     case let castNode as ImageNode: visit(castNode)
     case let castNode as InlineCodeNode: visit(castNode)
     case let castNode as InlineHTMLNode: visit(castNode)
@@ -47,6 +46,7 @@ open class MarkdownVisitor {
     case let castNode as SoftBreakNode: visit(castNode)
     case let castNode as StrongNode: visit(castNode)
     case let castNode as TextNode: visit(castNode)
+    case let castNode as ThematicBreakNode: visit(castNode)
     default: visit(extension: node)
     }
     afterVisit(node)
@@ -104,23 +104,16 @@ open class MarkdownVisitor {
   /// - Parameter node: The node being visited.
   open func visit(_ node: HTMLBlockNode) {}
 
-  /// Called when a `HeaderNode` is visited.
+  /// Called when a `HeadingNode` is visited.
   ///
   /// The base class implementation of this method automatically visits the children of the node. If
   /// you override it, you must call `super.visit(node)` if you wish to visit the children as well.
   ///
   /// - Parameter node: The node being visited.
-  open func visit(_ node: HeaderNode) {
+  open func visit(_ node: HeadingNode) {
     visitAll(node.children)
   }
 
-  /// Called when a `HorizontalRuleNode` is visited.
-  ///
-  /// The base class implementation of this method does nothing.
-  ///
-  /// - Parameter node: The node being visited.
-  open func visit(_ node: HorizontalRuleNode) {}
-
   /// Called when a `ImageNode` is visited.
   ///
   /// The base class implementation of this method automatically visits the children of the node. If
@@ -226,6 +219,13 @@ open class MarkdownVisitor {
   /// - Parameter node: The node being visited.
   open func visit(_ node: TextNode) {}
 
+  /// Called when a `ThematicBreakNode` is visited.
+  ///
+  /// The base class implementation of this method does nothing.
+  ///
+  /// - Parameter node: The node being visited.
+  open func visit(_ node: ThematicBreakNode) {}
+
   /// Visits a custom extension node.
   ///
   /// If you have defined custom extension nodes and use them in your AST, then this method will be

Sources/CommonMark/PrimitiveNode.swift

@@ -31,9 +31,7 @@ public enum PrimitiveNode {
 
   case emphasis(EmphasisNode)
 
-  case header(HeaderNode)
-
-  case horizontalRule(HorizontalRuleNode)
+  case heading(HeadingNode)
 
   case htmlBlock(HTMLBlockNode)
 
@@ -58,4 +56,6 @@ public enum PrimitiveNode {
   case strong(StrongNode)
 
   case text(TextNode)
+
+  case thematicBreak(ThematicBreakNode)
 }

Sources/CommonMark/HorizontalRuleNode.swift renamed to Sources/CommonMark/ThematicBreakNode.swift

@@ -10,14 +10,15 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// A block element that represents a horizontal rule.
-public struct HorizontalRuleNode: BlockContent {
+/// A block element that represents a thematic break between large ranges of Markdown content (which
+/// is typically rendered as a horizontal rule).
+public struct ThematicBreakNode: BlockContent {
 
   public let sourceRange: Range<SourceLocation>?
 
-  public var primitiveRepresentation: PrimitiveNode { return .horizontalRule(self) }
+  public var primitiveRepresentation: PrimitiveNode { return .thematicBreak(self) }
 
-  /// Creates a new horizontal rule node.
+  /// Creates a new thematic break node.
   ///
   /// - Parameter sourceRange: The source range from which the node was parsed, if known.
   public init(sourceRange: Range<SourceLocation>? = nil) {
@@ -29,7 +30,7 @@ public struct HorizontalRuleNode: BlockContent {
   ///
   /// - Parameter sourceRange: The new source range.
   /// - Returns: The new node.
-  public func replacingSourceRange(_ sourceRange: Range<SourceLocation>?) -> HorizontalRuleNode {
-    return HorizontalRuleNode(sourceRange: sourceRange)
+  public func replacingSourceRange(_ sourceRange: Range<SourceLocation>?) -> ThematicBreakNode {
+    return ThematicBreakNode(sourceRange: sourceRange)
   }
 }

Tests/CommonMarkTests/MarkdownDocumentTest.swift

@@ -50,28 +50,15 @@ final class MarkdownDocumentTest: XCTestCase {
       """)
   }
 
-  func testInitByParsing_header() {
+  func testInitByParsing_heading() {
     let document = MarkdownDocument(byParsing: "# Foo")
 
-    let header = document.children[0] as! HeaderNode
-    XCTAssertEqual(header.level, .h1)
-    let text = header.children[0] as! TextNode
+    let heading = document.children[0] as! HeadingNode
+    XCTAssertEqual(heading.level, .h1)
+    let text = heading.children[0] as! TextNode
     XCTAssertEqual(text.literalContent, "Foo")
   }
 
-  func testInitByParsing_horizontalRule() {
-    let document = MarkdownDocument(byParsing: """
-      foo
-
-      ---
-
-      bar
-      """)
-
-    let rule = document.children[1] as? HorizontalRuleNode
-    XCTAssertNotNil(rule)
-  }
-
   func testInitByParsing_image() {
     let document = MarkdownDocument(byParsing: "![foo](http://bar \"title\")")
 
@@ -173,6 +160,19 @@ final class MarkdownDocumentTest: XCTestCase {
     let text = paragraph.children[0] as! TextNode
     XCTAssertEqual(text.literalContent, "basic")
   }
+
+  func testInitByParsing_thematicBreak() {
+    let document = MarkdownDocument(byParsing: """
+      foo
+
+      ---
+
+      bar
+      """)
+
+    let rule = document.children[1] as? ThematicBreakNode
+    XCTAssertNotNil(rule)
+  }
 }
 
 #if !os(macOS)