[Bug] Handle the '\r\n' newline correctly (#169)

[Bug] Handle the '\r\n' newline correctly

### Motivation

Fixes #143, which tracks including the '\r\n' newline in a description in the OpenAPI document.

### Modifications

Replaces the '\r\n' character with '\n' before rendering comments, as '\n' is handled properly.

### Result

OpenAPI documents that include '\r\n' in a description produce compiling code now.

### Test Plan

Added a unit test for this case.


Reviewed by: simonjbeaumont

Builds:
     ✔︎ pull request validation (5.8) - Build finished. 
     ✔︎ pull request validation (5.9) - Build finished. 
     ✔︎ pull request validation (docc test) - Build finished. 
     ✔︎ pull request validation (integration test) - Build finished. 
     ✔︎ pull request validation (nightly) - Build finished. 
     ✔︎ pull request validation (soundness) - Build finished. 

#169

Author: czechboy0

Sources/_OpenAPIGeneratorCore/Renderer/TextBasedRenderer.swift

@@ -54,12 +54,14 @@ struct TextBasedRenderer: RendererProtocol {
             prefix = "// MARK:"
             commentString = string
         }
-        return commentString.transformingLines { line in
-            if line.isEmpty {
-                return prefix
+        return
+            commentString
+            .transformingLines { line in
+                if line.isEmpty {
+                    return prefix
+                }
+                return "\(prefix) \(line)"
             }
-            return "\(prefix) \(line)"
-        }
     }
 
     /// Renders the specified import statements.
@@ -721,7 +723,7 @@ fileprivate extension String {
     /// Returns an array of strings, where each string represents one line
     /// in the current string.
     func asLines() -> [String] {
-        split(separator: "\n", omittingEmptySubsequences: false)
+        split(omittingEmptySubsequences: false, whereSeparator: \.isNewline)
             .map(String.init)
     }
 

Tests/OpenAPIGeneratorCoreTests/Renderer/Test_TextBasedRenderer.swift

@@ -67,6 +67,19 @@ final class Test_TextBasedRenderer: XCTestCase {
                 // MARK: - Lorem ipsum
                 """#
         )
+        try _test(
+            .inline(
+                """
+                Generated by foo\r\nAlso, bar
+                """
+            ),
+            renderedBy: renderer.renderedComment,
+            rendersAs:
+                #"""
+                // Generated by foo
+                // Also, bar
+                """#
+        )
     }
 
     func testImports() throws {

Tests/OpenAPIGeneratorReferenceTests/Resources/Docs/petstore.yaml

@@ -16,7 +16,7 @@ paths:
     description: "Even more information about working with pets"
     get:
       summary: List all pets
-      description: "You can fetch all the pets here"
+      description: "You can fetch\r\nall the pets here"
       operationId: listPets
       tags:
         - pets

Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Client.swift

@@ -35,7 +35,8 @@ public struct Client: APIProtocol {
     private var converter: Converter { client.converter }
     /// List all pets
     ///
-    /// You can fetch all the pets here
+    /// You can fetch
+    /// all the pets here
     ///
     /// - Remark: HTTP `GET /pets`.
     /// - Remark: Generated from `#/paths//pets/get(listPets)`.

Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Server.swift

@@ -60,7 +60,8 @@ extension APIProtocol {
 fileprivate extension UniversalServer where APIHandler: APIProtocol {
     /// List all pets
     ///
-    /// You can fetch all the pets here
+    /// You can fetch
+    /// all the pets here
     ///
     /// - Remark: HTTP `GET /pets`.
     /// - Remark: Generated from `#/paths//pets/get(listPets)`.

Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Types.swift

@@ -9,7 +9,8 @@ import Foundation
 public protocol APIProtocol: Sendable {
     /// List all pets
     ///
-    /// You can fetch all the pets here
+    /// You can fetch
+    /// all the pets here
     ///
     /// - Remark: HTTP `GET /pets`.
     /// - Remark: Generated from `#/paths//pets/get(listPets)`.
@@ -704,7 +705,8 @@ public enum Components {
 public enum Operations {
     /// List all pets
     ///
-    /// You can fetch all the pets here
+    /// You can fetch
+    /// all the pets here
     ///
     /// - Remark: HTTP `GET /pets`.
     /// - Remark: Generated from `#/paths//pets/get(listPets)`.