add unit tests

Author: emilyychenn

Tests/SwiftDocCTests/Model/RenderBlockContent+CapitalizationTests.swift

@@ -0,0 +1,119 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2024 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+import XCTest
+import Markdown
+@testable import SwiftDocC
+
+class RenderBlockContent_CapitalizationTests: XCTestCase {
+    
+    // MARK: - Inlines
+    // Text, Emphasis, Strong are all auto-capitalized, and everything else defaults to not capitalized.
+    
+    func testRenderInlineContentText() {
+        let text = RenderInlineContent.text("hello, world!").capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", text.plainText)
+    }
+    
+    func testRenderInlineContentEmphasis() {
+        let emphasis = RenderInlineContent.emphasis(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", emphasis.plainText)
+    }
+    
+    func testRenderInlineContentStrong() {
+        let strong = RenderInlineContent.strong(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", strong.plainText)
+    }
+    
+    func testRenderInlineContentCodeVoice() {
+        let codeVoice = RenderInlineContent.codeVoice(code: "code voice").capitalizeFirstWord
+        XCTAssertEqual("code voice", codeVoice.plainText)
+    }
+    
+    func testRenderInlineContentReference() {
+        let reference = RenderInlineContent.reference(identifier: .init("Test"), isActive: true, overridingTitle: "hello, world!", overridingTitleInlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", reference.plainText)
+    }
+    
+    func testRenderInlineContentNewTerm() {
+        let newTerm = RenderInlineContent.newTerm(inlineContent: [.text("helloWorld")]).capitalizeFirstWord
+        XCTAssertEqual("helloWorld", newTerm.plainText)
+    }
+    
+    func testRenderInlineContentInlineHead() {
+        let inlineHead = RenderInlineContent.inlineHead(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", inlineHead.plainText)
+    }
+    
+    func testRenderInlineContentSubscript() {
+        let subscriptContent = RenderInlineContent.subscript(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", subscriptContent.plainText)
+    }
+    
+    func testRenderInlineContentSuperscript() {
+        let superscriptContent = RenderInlineContent.superscript(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", superscriptContent.plainText)
+    }
+    
+    func testRenderInlineContentStrikethrough() {
+        let strikethrough = RenderInlineContent.strikethrough(inlineContent: [.text("hello, world!")]).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", strikethrough.plainText)
+    }
+    
+    // MARK: - Blocks
+    // Paragraphs, asides, and small content are all auto-capitalized, and everything else defaults to not capitalized.
+    
+    func testRenderBlockContentParagraph() {
+        let paragraph = RenderBlockContent.paragraph(.init(inlineContent: [.text("hello, world!")])).capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", paragraph.rawIndexableTextContent(references: [:]))
+    }
+    
+    func testRenderBlockContentAside() {
+        let aside = RenderBlockContent.aside(.init(style: .init(rawValue: "Experiment"), content: [.paragraph(.init(inlineContent: [.text("hello, world!")]))])).capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", aside.rawIndexableTextContent(references: [:]))
+    }
+    
+    func testRenderBlockContentSmall() {
+        let small = RenderBlockContent.small(.init(inlineContent: [.text("hello, world!")])).capitalizeFirstWord
+        XCTAssertEqual("Hello, world!", small.rawIndexableTextContent(references: [:]))
+    }
+    
+    func testRenderBlockContentUnorderedList() {
+        let list = RenderBlockContent.unorderedList(.init(items: [
+            .init(content: [
+            .paragraph(.init(inlineContent: [.text("hello,")])),
+                ]),
+            .init(content: [
+                .paragraph(.init(inlineContent: [.text("world!")])),
+                ]),
+        ])).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", list.rawIndexableTextContent(references: [:]))
+    }
+    
+    func testRenderBlockContentStep() {
+        let step = RenderBlockContent.step(.init(content: [.paragraph(.init(inlineContent: [.text("hello, world!")]))], caption: [.paragraph(.init(inlineContent: [.text("Step caption")]))], media: RenderReferenceIdentifier("Media"), code: RenderReferenceIdentifier("Code"), runtimePreview: RenderReferenceIdentifier("Preview"))).capitalizeFirstWord
+        XCTAssertEqual("hello, world! Step caption", step.rawIndexableTextContent(references: [:]))
+    }
+    
+    
+    func testRenderBlockContentOrderedList() {
+        let list = RenderBlockContent.orderedList(.init(items: [
+            .init(content: [
+                .paragraph(.init(inlineContent: [.text("hello,")])),
+                ]),
+            .init(content: [
+                .paragraph(.init(inlineContent: [.text("world!")])),
+                ]),
+        ])).capitalizeFirstWord
+        XCTAssertEqual("hello, world!", list.rawIndexableTextContent(references: [:]))
+    }
+    
+}

Tests/SwiftDocCTests/Utility/String+CapitalizationTests.swift

@@ -0,0 +1,44 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2024 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import XCTest
+@testable import SwiftDocC
+
+class String_CapitalizationTests: XCTestCase {
+    
+    func testAllLowerCase() {
+        let testString = "hello world"
+        XCTAssertEqual("Hello world", testString.capitalizeFirstWord)
+    }
+    
+    func testAllLowerCaseWithPunctuation() {
+        let testString1 = "hello, world"
+        let testString2 = "hello-world"
+        let testString3 = "hello! world"
+        let testString4 = "hello: world"
+        let testString5 = "l'ocean world"
+        XCTAssertEqual("Hello, world", testString1.capitalizeFirstWord)
+        XCTAssertEqual("Hello-world", testString2.capitalizeFirstWord)
+        XCTAssertEqual("Hello! world", testString3.capitalizeFirstWord)
+        XCTAssertEqual("Hello: world", testString4.capitalizeFirstWord)
+        XCTAssertEqual("L'ocean world", testString5.capitalizeFirstWord)
+    }
+    
+    func testInvalidPunctuation() {
+        let testString = "h`ello world"
+        XCTAssertEqual(testString, testString.capitalizeFirstWord)
+    }
+    
+    func testHasUppercase() {
+        let testString = "iPad iOS visionOS"
+        XCTAssertEqual(testString, testString.capitalizeFirstWord)
+    }
+    
+}