Fixes for the Localization package (#26)

This PR contains the work done to

Reviewed-on: rock-n-code/loud-amsterdam#26
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>

Packages/Localization/Tests/Cases/Public/Methods/LocalizeTests.swift

@@ -32,6 +32,36 @@ struct LocalizeTests {
         #expect(text == "Hallo")
     }
 
+    @Test
+    func `resolves a key in a regional locale`() {
+        let text = localize(
+            "test.greeting",
+            locale: Locale(identifier: "pt-BR"),
+        )
+
+        #expect(text == "Olá")
+    }
+
+    @Test
+    func `falls back to the primary language for an unmatched regional locale`() {
+        let text = localize(
+            "test.greeting",
+            locale: Locale(identifier: "de-AT"),
+        )
+
+        #expect(text == "Hallo")
+    }
+
+    @Test
+    func `falls back to the source language for an unsupported locale`() {
+        let text = localize(
+            "test.greeting",
+            locale: Locale(identifier: "fr"),
+        )
+
+        #expect(text == "Hello")
+    }
+
     @Test
     func `falls back to the key for an unknown entry`() {
         let text = localize(
@@ -42,4 +72,60 @@ struct LocalizeTests {
         #expect(text == "unknown.key")
     }
 
+    @Test
+    func `falls back to the key for a missing catalog`() {
+        let localize = Localize(bundle: .main)
+
+        let text = localize(
+            "test.greeting",
+            locale: Locale(identifier: "en")
+        )
+
+        #expect(text == "test.greeting")
+    }
+
+    // MARK: Properties tests
+
+    @Test
+    func `reports a loaded catalog`() {
+        #expect(localize.catalogState == .loaded)
+    }
+
+    @Test
+    func `reports a missing catalog`() {
+        let localize = Localize(bundle: .main)
+
+        #expect(localize.catalogState == .missing)
+    }
+
+    // A malformed catalog cannot ship as a test resource — Xcode generates string symbols for every
+    // bundled `.xcstrings` and fails the build on invalid JSON — so one is staged in a temporary
+    // directory bundle instead.
+    @Test
+    func `reports an undecodable catalog`() throws {
+        let directory = URL(fileURLWithPath: NSTemporaryDirectory())
+            .appendingPathComponent(
+                "UndecodableCatalog-\(UUID().uuidString)",
+                isDirectory: true
+            )
+
+        try FileManager.default.createDirectory(
+            at: directory,
+            withIntermediateDirectories: true
+        )
+
+        defer {
+            try? FileManager.default.removeItem(at: directory)
+        }
+
+        try Data("not a catalog".utf8).write(
+            to: directory.appendingPathComponent("Localizable.xcstrings")
+        )
+
+        let bundle = try #require(Bundle(url: directory))
+        let localize = Localize(bundle: bundle)
+
+        #expect(localize.catalogState == .undecodable)
+    }
+
 }

Packages/Localization/Tests/Cases/Public/Methods/NegotiateTests.swift

@@ -26,6 +26,20 @@ struct NegotiateTests {
         #expect(language == "de")
     }
 
+    @Test
+    func `matches a regional catalog language exactly`() {
+        let language = negotiate(acceptLanguage: "pt-BR")
+
+        #expect(language == "pt-BR")
+    }
+
+    @Test
+    func `matches a regional catalog language by its primary subtag`() {
+        let language = negotiate(acceptLanguage: "pt")
+
+        #expect(language == "pt-BR")
+    }
+
     @Test
     func `respects the header order of preference`() {
         let language = negotiate(acceptLanguage: "de, en")
@@ -34,12 +48,47 @@ struct NegotiateTests {
     }
 
     @Test
-    func `strips quality weights from the language tags`() {
-        let language = negotiate(acceptLanguage: "de;q=0.5, en;q=0.9")
+    func `orders the language tags by descending quality weight`() {
+        let language = negotiate(acceptLanguage: "en;q=0.5, de;q=0.9")
 
         #expect(language == "de")
     }
 
+    @Test
+    func `treats a tag without a weight as the highest preference`() {
+        let language = negotiate(acceptLanguage: "en;q=0.9, de")
+
+        #expect(language == "de")
+    }
+
+    @Test
+    func `treats a tag with a malformed weight as the highest preference`() {
+        let language = negotiate(acceptLanguage: "en;q=0.9, de;q=broken")
+
+        #expect(language == "de")
+    }
+
+    @Test
+    func `drops language tags weighted as not acceptable`() {
+        let language = negotiate(acceptLanguage: "de;q=0, en;q=0.8")
+
+        #expect(language == "en")
+    }
+
+    @Test
+    func `falls back to the default when every tag is weighted as not acceptable`() {
+        let language = negotiate(acceptLanguage: "de;q=0, fr;q=0")
+
+        #expect(language == "en")
+    }
+
+    @Test
+    func `serves the default language for a wildcard`() {
+        let language = negotiate(acceptLanguage: "fr;q=0.9, *;q=0.5")
+
+        #expect(language == "en")
+    }
+
     @Test
     func `trims whitespace around the language tags`() {
         let language = negotiate(acceptLanguage: " de , en ")

Packages/Localization/Tests/Cases/Public/Types/LanguageListTests.swift

@@ -20,16 +20,39 @@ struct LanguageListTests {
         }
 
         @Test
-        func `uses the provided default language`() {
+        func `follows the catalog's source language`() {
             let list = LanguageList(
-                bundle: .module,
-                default: "de"
+                resolver: StubCatalog(
+                    sourceLanguage: "de",
+                    languages: ["de", "en"]
+                )
             )
 
             #expect(list.default == "de")
         }
     }
 
+    @Suite("catalogState")
+    struct CatalogState {
+        @Test
+        func `reports a loaded catalog`() {
+            let list = LanguageList(
+                bundle: .module
+            )
+
+            #expect(list.catalogState == .loaded)
+        }
+
+        @Test
+        func `reports a missing catalog`() {
+            let list = LanguageList(
+                bundle: .main
+            )
+
+            #expect(list.catalogState == .missing)
+        }
+    }
+
     @Suite("all")
     struct All {
         @Test
@@ -45,20 +68,34 @@ struct LanguageListTests {
         @Test
         func `excludes the base localization`() {
             let list = LanguageList(
-                bundle: .module
+                resolver: StubCatalog(
+                    sourceLanguage: "en",
+                    languages: ["Base", "de", "en"]
+                )
             )
 
-            #expect(!list.all.contains("Base"))
+            #expect(list.all == ["de", "en"])
         }
 
         @Test
-        func `lists each language only once`() {
+        func `sorts the languages`() {
             let list = LanguageList(
-                bundle: .module
+                resolver: StubCatalog(
+                    sourceLanguage: "en",
+                    languages: ["fr", "en", "de"]
+                )
             )
-            let all = list.all
 
-            #expect(all.count == Set(all).count)
+            #expect(list.all == ["de", "en", "fr"])
+        }
+
+        @Test
+        func `degrades to the default language for a missing catalog`() {
+            let list = LanguageList(
+                bundle: .main
+            )
+
+            #expect(list.all == ["en"])
         }
     }