Initial import

Author: mattt

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+.swiftpm
+Resources/spec*

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2019 Read Evaluate Press, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,27 @@
+COMMONMARK_SPEC_VERSION=0.29
+
+Tests/CommonMarkSpecTests/XCTestManifests.swift: Resources/XCTestManifests.swift.gyb | Tests/CommonMarkSpecTests
+	@gyb --line-directive '' -o $@ $<; \
+
+Tests/CommonMarkSpecTests: Resources/spec.json | Resources/spec
+	@mkdir -p $@
+	@for section in $(shell jq -c '.[].section' $< | uniq); do \
+		filename=`echo "$${section}" | awk -f Resources/camelcase.awk`; \
+		jq "map(select(.section == \"$${section}\"))" $< > "$|/$${filename}.json" ; \
+		gyb --line-directive '' -o $@/$${filename}Tests.swift -D filename="$${filename}" Resources/CommonMarkSpecTests.swift.gyb; \
+	done
+
+Resources/spec:
+	@mkdir -p Resources/spec
+
+Resources/spec.json:
+	@curl "https://spec.commonmark.org/${COMMONMARK_SPEC_VERSION}/spec.json" > $@
+
+%.swift: %.swift.gyb
+	@gyb --line-directive '' -o $@ $<
+
+.PHONY:
+clean:
+	@rm -f Resources/spec.json
+	@rm -rf Resources/spec
+	@rm -rf Tests/CommonMarkSpecTests

Package.resolved

@@ -0,0 +1,16 @@
+{
+  "object": {
+    "pins": [
+      {
+        "package": "cmark",
+        "repositoryURL": "https://github.com/apple/swift-cmark.git",
+        "state": {
+          "branch": "master",
+          "revision": "2a766030bee955b4806044fd7aca1b6884475138",
+          "version": null
+        }
+      }
+    ]
+  },
+  "version": 1
+}

Package.swift

@@ -0,0 +1,35 @@
+// swift-tools-version:5.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "CommonMark",
+    products: [
+        // Products define the executables and libraries produced by a package, and make them visible to other packages.
+        .library(
+            name: "CommonMark",
+            targets: ["CommonMark"]
+        ),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        .package(url: "https://github.com/apple/swift-cmark.git", .branch("master")),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "CommonMark",
+            dependencies: ["cmark"]
+        ),
+        .testTarget(
+            name: "CommonMarkTests",
+            dependencies: ["CommonMark"]
+        ),
+        .testTarget(
+            name: "CommonMarkSpecTests",
+            dependencies: ["CommonMark"]
+        ),
+    ]
+)

README.md

@@ -0,0 +1,83 @@
+# CommonMark
+
+A Swift package for parsing and rendering [CommonMark][commonmark].
+It's built on top of [libcmark][cmark] 
+and fully compliant with the [CommonMark Spec][commonmark].
+
+```swift
+import CommonMark
+
+let markdown = #"""
+# [Universal Declaration of Human Rights][uhdr]
+
+## Article 1.
+
+All human beings are born free and equal in dignity and rights. 
+They are endowed with reason and conscience 
+and should act towards one another in a spirit of brotherhood.
+
+[uhdr]: https://www.un.org/en/universal-declaration-human-rights/ "View full version"
+"""#
+
+let document = try Document(markdown)
+
+
+// Rendering to HTML, XML, LaTeX, and Manpage
+let html = document.render(format: .html) // <h1> [ ... ]
+let xml = document.render(format: .xml) // <?xml [ ... ]
+let latex = document.render(format: .latex) // \section{ [ ... ]
+let manpage = document.render(format: .manpage) // .SH [ ... ]
+
+// To get back CommonMark text, 
+// you can either render with the `.commonmark` format...
+document.render(format: .commonmark) // # [Universal  [ ... ]
+// ...or call `description`
+// (individual nodes also return their CommonMark representation as their description)
+document.description // # [Universal  [ ... ]
+
+
+// Inspecting the document tree
+document.children.count // 3
+
+let heading = document.children[0] as! Heading
+heading.headerLevel // 1
+heading.children.count // 1
+
+let link = heading.children[0] as! Link
+link.urlString // "https://www.un.org/en/universal-declaration-human-rights/")
+link.title // "View full version"
+
+let subheading = document.children[1] as! Heading
+subheading.headerLevel // 2
+subheading.children.count // 1
+
+let subheadingText = subheading.children[0] as! Text
+subheadingText.literal // "Article 1."
+
+let paragraph = document.children[2] as! Paragraph
+paragraph.description // "All human beings [ ... ]"
+paragraph.range.lowerBound // (line: 5, column: 1)
+paragraph.range.upperBound // (line: 7, column: 62)
+```
+
+### CommonMark Spec Compliance
+
+This package passes all of the 649 test cases
+in the latest version (0.29) of the [CommonMark Spec][commonmark spec]:
+
+```console
+$ swift test
+	 Executed 649 tests, with 0 failures (0 unexpected) in 0.178 (0.201) seconds
+```
+
+## License
+
+MIT
+
+## Contact
+
+Mattt ([@mattt](https://twitter.com/mattt))
+
+[cmark]: https://github.com/commonmark/cmark
+[commonmark]: https://commonmark.org
+[commonmark spec]: https://spec.commonmark.org

Resources/CommonMarkSpecTests.swift.gyb

@@ -0,0 +1,48 @@
+% warning = "This file was automatically generated and should not be edited."
+// ${warning}
+%{
+# encoding=utf8
+import sys
+reload(sys)
+sys.setdefaultencoding('utf8')
+
+import json
+
+def indent(text, amount, ch=' '):
+    padding = amount * ch
+    return ''.join(padding+line for line in text.splitlines(True))
+}%
+
+import XCTest
+import CommonMark
+
+final class CommonMarkSpec${filename}Tests: XCTestCase {
+% with open('../Resources/spec/%s.json' % filename) as file:
+    %{ spec = json.load(file) }%
+    % for example in spec:
+        %{
+           number = example['example']
+           markdown = example['markdown']
+           html = example['html'] }%
+    func testExample${number}() throws {
+        let markdown = #######"""
+${indent(markdown, 8)}
+        """#######
+
+        let html = #######"""
+${indent(html, 8)}
+        """#######
+
+        let document = try Document(markdown)
+        XCTAssertEqual(document.render(format: .html, options: [.unsafe]), html)
+    }
+
+    % end
+    static var allTests = [
+    % for example in spec:
+        %{ number = example['example'] }%
+        ("testExample${number}", testExample${number}),
+    % end
+    ]
+% end
+}

Resources/XCTestManifests.swift.gyb

@@ -0,0 +1,25 @@
+% warning = "This file was automatically generated and should not be edited."
+// ${warning}
+%{
+# encoding=utf8
+import sys
+reload(sys)
+sys.setdefaultencoding('utf8')
+
+import os
+import glob
+
+names = sorted([os.path.basename(f) for f in glob.glob("../Tests/CommonMarkSpecTests/*Tests.swift")])
+}%
+
+import XCTest
+
+#if !canImport(ObjectiveC)
+public func allTests() -> [XCTestCaseEntry] {
+    return [
+% for name in names:
+        testCase(${name}.allTests),
+% end
+    ]
+}
+#endif

Resources/camelcase.awk

@@ -0,0 +1,10 @@
+#!/usr/bin/awk -f
+
+{
+    text = $0;
+    split(text, words, /[^a-zA-Z]+/);
+    for (i=1; i<=length(words); i++) {
+        res = res toupper(substr(words[i],1,1)) tolower(substr(words[i],2));
+    }
+    print res
+}

Sources/CommonMark/Children.swift

@@ -0,0 +1,35 @@
+import cmark
+
+struct Children: Sequence {
+    var cmark_node: OpaquePointer
+
+    init(of node: Node) {
+        cmark_node = node.cmark_node
+    }
+
+    init(of document: Document) {
+        cmark_node = document.cmark_node
+    }
+
+    func makeIterator() -> AnyIterator<Node> {
+        var iterator = CMarkNodeChildIterator(cmark_node)
+        return AnyIterator {
+            guard let child = iterator.next() else { return nil }
+            return Node.create(for: child)
+        }
+    }
+}
+
+struct CMarkNodeChildIterator: IteratorProtocol {
+    var current: OpaquePointer!
+
+    init(_ node: OpaquePointer!) {
+        current = cmark_node_first_child(node)
+    }
+
+    mutating func next() -> OpaquePointer? {
+        guard let next = current else { return nil }
+        defer { current = cmark_node_next(current) }
+        return next
+    }
+}