resolve PR comments

Author: emilyychenn

Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent+Capitalization.swift

@@ -59,20 +59,32 @@ extension RenderBlockContent: AutoCapitalizable {
 
 extension RenderBlockContent.Paragraph: AutoCapitalizable {
     var withFirstWordCapitalized: RenderBlockContent.Paragraph {
+        guard !self.inlineContent.isEmpty else {
+            return self
+        }
+        
         let inlineContent = [self.inlineContent[0].withFirstWordCapitalized] + self.inlineContent[1...]
         return .init(inlineContent: inlineContent)
     }
 }
 
 extension RenderBlockContent.Aside: AutoCapitalizable {
     var withFirstWordCapitalized: RenderBlockContent.Aside {
+        guard !self.content.isEmpty else {
+            return self
+        }
+        
         let content = [self.content[0].withFirstWordCapitalized] + self.content[1...]
         return .init(style: self.style, content: content)
     }
 }
 
 extension RenderBlockContent.Small: AutoCapitalizable {
     var withFirstWordCapitalized: RenderBlockContent.Small {
+        guard !self.inlineContent.isEmpty else {
+            return self
+        }
+        
         let inlineContent = [self.inlineContent[0].withFirstWordCapitalized] + self.inlineContent[1...]
         return .init(inlineContent: inlineContent)
     }

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

@@ -42,7 +42,7 @@ struct RenderContentCompiler: MarkupVisitor {
             content: aside.content.reduce(into: [], { result, child in result.append(contentsOf: visit(child))}) as! [RenderBlockContent]
         )
 
-        return [RenderBlockContent.aside(newAside).withFirstWordCapitalized]
+        return [RenderBlockContent.aside(newAside.withFirstWordCapitalized)]
     }
 
     mutating func visitCodeBlock(_ codeBlock: CodeBlock) -> [RenderContent] {

Sources/SwiftDocC/Utility/FoundationExtensions/String+Capitalization.swift

@@ -19,23 +19,52 @@ extension String {
 
         guard !self.isEmpty else { return self }
 
-        let selfTrimmedWhitespace = self.trimmingCharacters(in: .whitespacesAndNewlines)
+//        let selfTrimmedWhitespace = self.trimmingCharacters(in: .whitespacesAndNewlines)
+//        let firstWord = selfTrimmedWhitespace.prefix(while: { !$0.isWhitespace && !$0.isNewline })
+//        guard firstWord.count > 0 else { return self }
+//        let firstWordCharacters = CharacterSet.init(charactersIn: String(firstWord))
+//        let acceptableCharacters = CharacterSet.lowercaseLetters.union(CharacterSet.punctuationCharacters)
+//        guard firstWordCharacters.isSubset(of: acceptableCharacters) else {
+//            return self
+//        }
 
-        let firstWord = selfTrimmedWhitespace.prefix(while: { !$0.isWhitespace && !$0.isNewline })
 
-        guard firstWord.count > 0 else { return self }
+        guard let firstWordStartIndex = self.firstIndex(where: { !$0.isWhitespace && !$0.isNewline }) else { return self }
 
-        let firstWordCharacters = CharacterSet.init(charactersIn: String(firstWord))
+        // Find where the first word starts: this is additional processing to handle white spaces before the first word.
+        let firstWord = self[firstWordStartIndex...].prefix(while: { !$0.isWhitespace && !$0.isNewline})
 
-        let acceptableCharacters = CharacterSet.lowercaseLetters.union(CharacterSet.punctuationCharacters)
 
+        guard firstWord.count > 0 else { return self }
+        let firstWordCharacters = CharacterSet.init(charactersIn: String(firstWord))
+        let acceptableCharacters = CharacterSet.lowercaseLetters.union(CharacterSet.punctuationCharacters)
         guard firstWordCharacters.isSubset(of: acceptableCharacters) else {
             return self
         }
 
-        let firstWordArray = Array(String(firstWord))
-        let returnFirstWordArray = firstWordArray[0].uppercased() + selfTrimmedWhitespace.dropFirst()
 
-        return String(returnFirstWordArray)
+        // Create the result string and make sure it's big enough to contain all the characters
+        var resultString = String()
+        resultString.reserveCapacity(self.count)
+        
+        // Add the white spaces before the first word
+        resultString.append(contentsOf: self[..<firstWordStartIndex])
+        
+        // Add the capitalized first word (based on the locale)
+        resultString.append(contentsOf: String(firstWord).localizedCapitalized)
+        
+        // Add the rest of the string
+        let restStartIndex = self.index(firstWordStartIndex, offsetBy: firstWord.count)
+        resultString.append(contentsOf: self[restStartIndex...])
+        
+        return resultString
+        
+        
+        
+        
+//        let firstWordArray = Array(String(firstWord))
+//        let returnFirstWordArray = firstWordArray[0].uppercased() + selfTrimmedWhitespace.dropFirst()
+//        
+//        return String(returnFirstWordArray)
     }
 }

Tests/SwiftDocCTests/Infrastructure/AutoCapitalizationTests.swift

@@ -112,7 +112,7 @@ class AutoCapitalizationTests: XCTestCase {
         let paramsRenderSection = translatedParameters?.defaultValue?.section as! ParametersRenderSection
 
         XCTAssertEqual(paramsRenderSection.parameters.map(\.content), [
-            [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("Upper-cased first parameter description.")]))],
+            [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("Upper-Cased first parameter description.")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("The second parameter has extra white spaces")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("inValid third parameter will not be capitalized")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text(""), SwiftDocC.RenderInlineContent.codeVoice(code: "code block"), SwiftDocC.RenderInlineContent.text(" will not be capitalized")]))],
@@ -152,7 +152,7 @@ class AutoCapitalizationTests: XCTestCase {
         let paramsRenderSection = translatedParameters?.defaultValue?.section as! ParametersRenderSection
 
         XCTAssertEqual(paramsRenderSection.parameters.map(\.content), [
-            [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("Upper-cased first parameter description.")]))],
+            [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("Upper-Cased first parameter description.")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("The second parameter has extra white spaces")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text("inValid third parameter will not be capitalized")]))],
             [SwiftDocC.RenderBlockContent.paragraph(SwiftDocC.RenderBlockContent.Paragraph(inlineContent: [SwiftDocC.RenderInlineContent.text(""), SwiftDocC.RenderInlineContent.codeVoice(code: "code block"), SwiftDocC.RenderInlineContent.text(" will not be capitalized")]))],

Tests/SwiftDocCTests/Utility/String+CapitalizationTests.swift

@@ -20,12 +20,12 @@ class String_CapitalizationTests: XCTestCase {
 
     func testAllLowerCaseWithPunctuation() {
         let testString1 = "hello, world"
-        let testString2 = "hello-world"
+        let testString2 = "twenty-one"
         let testString3 = "hello! world"
         let testString4 = "hello: world"
         let testString5 = "l'ocean world"
         XCTAssertEqual("Hello, world", testString1.capitalizeFirstWord())
-        XCTAssertEqual("Hello-world", testString2.capitalizeFirstWord())
+        XCTAssertEqual("Twenty-One", testString2.capitalizeFirstWord())
         XCTAssertEqual("Hello! world", testString3.capitalizeFirstWord())
         XCTAssertEqual("Hello: world", testString4.capitalizeFirstWord())
         XCTAssertEqual("L'ocean world", testString5.capitalizeFirstWord())
@@ -44,8 +44,8 @@ class String_CapitalizationTests: XCTestCase {
     func testWhiteSpaces() {
         let testString1 = "       has many spaces"
         let testString2 = "     has a tab"
-        XCTAssertEqual("Has many spaces", testString1.capitalizeFirstWord())
-        XCTAssertEqual("Has a tab", testString2.capitalizeFirstWord())
+        XCTAssertEqual("       Has many spaces", testString1.capitalizeFirstWord())
+        XCTAssertEqual("     Has a tab", testString2.capitalizeFirstWord())
     }