fix tests for capitalization by locale

Author: emilyychenn

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

@@ -12,37 +12,24 @@ import Foundation
 
 extension String {
 
+    /// Precomputes the CharacterSet to use in capitalizeFirstWord().
+    private static let charactersPreventingWordCapitalization = CharacterSet.lowercaseLetters.union(.punctuationCharacters).inverted
+    
     /// Returns the string with the first letter capitalized.
     /// This auto-capitalization only occurs if the first word is all lowercase and contains only lowercase letters.
     /// The first word can also contain punctuation (e.g. a period, comma, hyphen, semi-colon, colon).
     func capitalizeFirstWord() -> String {
-        
-        guard !self.isEmpty else { return self }
-        
         guard let firstWordStartIndex = self.firstIndex(where: { !$0.isWhitespace && !$0.isNewline }) else { return self }
-        
-        // 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})
 
-        
-        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 {
+        guard firstWord.rangeOfCharacter(from: Self.charactersPreventingWordCapitalization) == nil else {
             return self
         }
 
-        // Create the result string and make sure it's big enough to contain all the characters
-        var resultString = String()
+        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...])
 

Tests/SwiftDocCTests/Infrastructure/AutoCapitalizationTests.swift

@@ -111,8 +111,12 @@ class AutoCapitalizationTests: XCTestCase {
         let translatedParameters = parameterSectionTranslator.translateSection(for: symbol, renderNode: &renderNode, renderNodeTranslator: &renderNodeTranslator)
         let paramsRenderSection = translatedParameters?.defaultValue?.section as! ParametersRenderSection
 
+        // Different locales treat capitalization of hyphenated words differently (e.g. Upper-Cased vs Upper-cased).
+        let hyphenatedString = "upper-cased"
+        let hyphenatedCapitalizedResult = hyphenatedString.localizedCapitalized + " first parameter description."
+        
         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(hyphenatedCapitalizedResult)]))],
             [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")]))],
@@ -151,8 +155,12 @@ class AutoCapitalizationTests: XCTestCase {
         let translatedParameters = parameterSectionTranslator.translateSection(for: symbol, renderNode: &renderNode, renderNodeTranslator: &renderNodeTranslator)
         let paramsRenderSection = translatedParameters?.defaultValue?.section as! ParametersRenderSection
 
+        // Different locales treat capitalization of hyphenated words differently (e.g. Upper-Cased vs Upper-cased).
+        let hyphenatedString = "upper-cased"
+        let hyphenatedCapitalizedResult = hyphenatedString.localizedCapitalized + " first parameter description."
+        
         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(hyphenatedCapitalizedResult)]))],
             [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

@@ -44,8 +44,10 @@ class String_CapitalizationTests: XCTestCase {
     func testWhiteSpaces() {
         let testString1 = "       has many spaces"
         let testString2 = "     has a tab"
+        let testString3 = "         has many spaces     "
         XCTAssertEqual("       Has many spaces", testString1.capitalizeFirstWord())
         XCTAssertEqual("     Has a tab", testString2.capitalizeFirstWord())
+        XCTAssertEqual("         Has many spaces     ", testString3.capitalizeFirstWord())
     }