Encode predefined XML entities also for code blocks in HTML generator.

Author: objecthub

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.3 (2022-02-07)
+- Fix build breakage for Linux
+- Encode predefined XML entities also for code blocks
+- Migrate framework to Xcode 13
+
 ## 1.1.2 (2021-06-30)
 - Allow creation of definition lists outside of MarkdownKit
 

Package.swift

@@ -13,7 +13,7 @@
 //  `swift test`
 //
 //  Created by Matthias Zenger on 09/08/2019.
-//  Copyright © 2019-2021 Google LLC.
+//  Copyright © 2019-2022 Google LLC.
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.

README.md

@@ -376,5 +376,5 @@ _Swift Package Manager_ is not needed.
 ## Copyright
 
 Author: Matthias Zenger (<[email protected]>)  
-Copyright © 2019-2021 Google LLC.  
+Copyright © 2019-2022 Google LLC.  
 _Please note: This is not an official Google product._

Sources/MarkdownKit/CustomBlock.swift

@@ -28,7 +28,7 @@ public protocol CustomBlock: CustomStringConvertible, CustomDebugStringConvertib
   func equals(to other: CustomBlock) -> Bool
   func parse(via parser: InlineParser) -> Block
   func generateHtml(via htmlGen: HtmlGenerator, tight: Bool) -> String
-  #if !os(Linux)
+  #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
   func generateHtml(via htmlGen: HtmlGenerator,
                     and attGen: AttributedStringGenerator?,
                     tight: Bool) -> String

Sources/MarkdownKit/CustomTextFragment.swift

@@ -28,7 +28,7 @@ public protocol CustomTextFragment: CustomStringConvertible, CustomDebugStringCo
   func equals(to other: CustomTextFragment) -> Bool
   func transform(via transformer: InlineTransformer) -> TextFragment
   func generateHtml(via htmlGen: HtmlGenerator) -> String
-  #if !os(Linux)
+  #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
   func generateHtml(via htmlGen: HtmlGenerator, and attrGen: AttributedStringGenerator?) -> String
   #endif
   var rawDescription: String { get }

Sources/MarkdownKit/HTML/HtmlGenerator.swift

@@ -75,14 +75,18 @@ open class HtmlGenerator {
         let tag = "h\(n > 0 && n < 7 ? n : 1)>"
         return "<\(tag)\(self.generate(text: text))</\(tag)\n"
       case .indentedCode(let lines):
-        return "<pre><code>" + self.generate(lines: lines) + "</code></pre>\n"
+        return "<pre><code>" +
+               self.generate(lines: lines).encodingPredefinedXmlEntities() +
+               "</code></pre>\n"
       case .fencedCode(let lang, let lines):
         if let language = lang {
           return "<pre><code class=\"\(language)\">" +
-                 self.generate(lines: lines, separator: "") +
+                 self.generate(lines: lines, separator: "").encodingPredefinedXmlEntities() +
                  "</code></pre>\n"
         } else {
-          return "<pre><code>" + self.generate(lines: lines, separator: "") + "</code></pre>\n"
+          return "<pre><code>" +
+                 self.generate(lines: lines, separator: "").encodingPredefinedXmlEntities() +
+                 "</code></pre>\n"
         }
       case .htmlBlock(let lines):
         return self.generate(lines: lines)

Sources/MarkdownKit/Info.plist

@@ -19,6 +19,6 @@
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>
-	<string>Copyright © 2019-2021 Google LLC.</string>
+	<string>Copyright © 2019-2022 Google LLC.</string>
 </dict>
 </plist>

Tests/MarkdownKitTests/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.4</string>
+	<string>1.1.3</string>
 	<key>CFBundleVersion</key>
 	<string>1</string>
 </dict>

Tests/MarkdownKitTests/MarkdownBlockTests.swift

@@ -141,6 +141,10 @@ class MarkdownBlockTests: XCTestCase, MarkdownKitFactory {
                             indentedCode("  foo\n", "bar\n"),
                             paragraph("goo"),
                             paragraph("two")))
+    XCTAssertEqual(parseBlocks("one\n\n     \n    <b>foo</b>\n    <i>bar</i>\n    \n\n\ntwo"),
+                   document(paragraph("one"),
+                            indentedCode("<b>foo</b>\n", "<i>bar</i>\n"),
+                            paragraph("two")))
   }
 
   func testListItem() {

Tests/MarkdownKitTests/MarkdownHtmlTests.swift

@@ -96,6 +96,12 @@ class MarkdownHtmlTests: XCTestCase, MarkdownKitFactory {
                    "<p>Test <a href=\"http://www.example.com\">http://www.example.com</a> test</p>")
   }
 
+  func testCodeBlocks() {
+    XCTAssertEqual(generateHtml("Test\n\n```\nThis should <b>not be bold</b>.\n```\n"),
+                   "<p>Test</p>\n<pre><code>This should &lt;b&gt;not be bold&lt;/b&gt;.\n" +
+                   "</code></pre>")
+  }
+  
   static let allTests = [
     ("testBasics", testBasics),
     ("testLists", testLists),