SPB Git

Repository Public

LocalizationTests.swift 10.8 KB 180 lines swift

1// Author: Simon-Pierre Boucher — contact@spboucher.ai2// File: Tests/VQuantKitTests/LocalizationTests.swift3// Description: The String Catalog is complete (every key in English and in French, plural forms included), every key4//              the sources ask for exists, nothing bilingual is left hard-coded, and the compiled bundle answers.5import Foundation6import Testing7@testable import VQuantKit89@Suite struct LocalizationTests {10    static let root = URL(fileURLWithPath: #filePath).deletingLastPathComponent().deletingLastPathComponent().deletingLastPathComponent()1112    /// key → language → forms ("" for a plain string, "one"/"other"… for a plural)13    static func catalog() throws -> [String: [String: [String: String]]] {14        let data = try Data(contentsOf: root.appendingPathComponent("Sources/VQuantKit/Resources/Localizable.xcstrings"))15        let json = try JSONSerialization.jsonObject(with: data) as? [String: Any]16        var out: [String: [String: [String: String]]] = [:]17        func translated(_ unit: Any?) -> String? {18            guard let u = unit as? [String: Any], u["state"] as? String == "translated" else { return nil }19            return u["value"] as? String20        }21        for (key, entry) in json?["strings"] as? [String: [String: Any]] ?? [:] {22            var languages: [String: [String: String]] = [:]23            for (language, l) in entry["localizations"] as? [String: [String: Any]] ?? [:] {24                var forms: [String: String] = [:]25                if let v = translated(l["stringUnit"]) { forms[""] = v }26                let plural = (l["variations"] as? [String: Any])?["plural"] as? [String: [String: Any]] ?? [:]27                for (category, f) in plural { if let v = translated(f["stringUnit"]) { forms[category] = v } }28                languages[language] = forms29            }30            out[key] = languages31        }32        return out33    }3435    /// The format specifiers of a string, sorted ("%1$@", "%lld"…), `%%` aside.36    static func specifiers(_ s: String) -> [String] {37        let re = try! NSRegularExpression(pattern: "%(?:\\d+\\$)?(?:lld|@|d)")38        let clean = s.replacingOccurrences(of: "%%", with: "")39        return re.matches(in: clean, range: NSRange(clean.startIndex..., in: clean)).map { String(clean[Range($0.range, in: clean)!]) }.sorted()40    }4142    static func sources() throws -> [(name: String, text: String)] {43        let dir = root.appendingPathComponent("Sources")44        let files = FileManager.default.enumerator(at: dir, includingPropertiesForKeys: nil)?.compactMap { $0 as? URL }.filter { $0.pathExtension == "swift" } ?? []45        return try files.map { ($0.lastPathComponent, try String(contentsOf: $0, encoding: .utf8)) }46    }4748    /// The value of a Swift string literal body (escapes resolved); nil when it interpolates.49    static func unescape(_ body: Substring) -> String? {50        var out = "", i = body.startIndex51        while i < body.endIndex {52            let c = body[i]53            guard c == "\\" else { out.append(c); i = body.index(after: i); continue }54            let n = body[body.index(after: i)]55            switch n {56            case "(": return nil57            case "n": out.append("\n")58            case "t": out.append("\t")59            case "u":60                guard let close = body[i...].firstIndex(of: "}"), let v = UInt32(body[body.index(i, offsetBy: 3)..<close], radix: 16), let u = Unicode.Scalar(v) else { return nil }61                out.unicodeScalars.append(u); i = body.index(after: close); continue62            default: out.append(n)63            }64            i = body.index(i, offsetBy: 2)65        }66        return out67    }6869    /// Every string literal of the sources, by file.70    static func literals(_ text: String) -> [String] {71        let re = try! NSRegularExpression(pattern: "\"((?:[^\"\\\\\\n]|\\\\.)*)\"")72        return re.matches(in: text, range: NSRange(text.startIndex..., in: text)).compactMap { unescape(text[Range($0.range(at: 1), in: text)!]) }73    }7475    @Test func everyKeyIsTranslatedInEnglishAndFrench() throws {76        let catalog = try Self.catalog()77        #expect(catalog.count > 250)78        var problems: [String] = []79        for (key, languages) in catalog {80            for language in ["en", "fr"] {81                guard let forms = languages[language], !forms.isEmpty else { problems.append("\(language) missing: \(key)"); continue }82                if forms[""] == nil, forms["one"] == nil || forms["other"] == nil { problems.append("\(language) plural needs one + other: \(key)") }83                for (category, value) in forms {84                    if value.trimmingCharacters(in: .whitespaces).isEmpty, !key.trimmingCharacters(in: .whitespaces).isEmpty { problems.append("\(language) empty \(category): \(key)") }85                    if Self.specifiers(value) != Self.specifiers(key) { problems.append("\(language) \(category) arguments differ: \(key) → \(value)") }86                }87            }88            // a plural key is plural in both languages89            if (languages["en"]?[""] == nil) != (languages["fr"]?[""] == nil) { problems.append("plural in one language only: \(key)") }90        }91        #expect(problems.isEmpty, "\(problems.sorted().joined(separator: "\n"))")92    }9394    @Test func everyKeyTheSourcesAskForIsInTheCatalog() throws {95        let catalog = try Self.catalog()96        // `.l("key"…`, `VQL10n.string("key"…`, `msg("key"…` and the two branches of `cond ? "key" : "key"` inside them97        let call = try NSRegularExpression(pattern: "(?:\\.l|VQL10n\\.string|\\bmsg)\\((?:[\\w. ]+\\? )?\"((?:[^\"\\\\\\n]|\\\\.)*)\"(?: : \"((?:[^\"\\\\\\n]|\\\\.)*)\")?")98        var asked = Set<String>(), missing: [String] = [], all = Set<String>()99        for (name, text) in try Self.sources() {100            all.formUnion(Self.literals(text))101            for m in call.matches(in: text, range: NSRange(text.startIndex..., in: text)) {102                for g in 1...2 where m.range(at: g).location != NSNotFound {103                    guard let key = Self.unescape(text[Range(m.range(at: g), in: text)!]) else { missing.append("\(name): interpolated key"); continue }104                    asked.insert(key)105                    if catalog[key] == nil { missing.append("\(name): \(key)") }106                }107            }108        }109        #expect(missing.isEmpty, "\(missing.joined(separator: "\n"))")110        #expect(asked.count > 200)111        // and nothing in the catalog is dead weight112        let unused = catalog.keys.filter { !all.contains($0) }113        #expect(unused.isEmpty, "\(unused.sorted().joined(separator: "\n"))")114    }115116    @Test func noViewHardCodesALanguage() throws {117        var problems: [String] = []118        let bilingual = try NSRegularExpression(pattern: "\\.t\\(\"|\\bfr \\? \"|== \\.fr \\? \"[^\"]*[a-z]{3}")119        let french = try NSRegularExpression(pattern: "\"[^\"\\n]*[éèêàçùûôîÉÀ«»][^\"\\n]*\"")120        // VQFormat lays dates out per language (day-month order, "14 h 32"): formatting, like the number locale121        for (name, text) in try Self.sources() where name != "main.swift" && name != "VQFormat.swift" {122            for (n, line) in text.components(separatedBy: "\n").enumerated() where !line.trimmingCharacters(in: .whitespaces).hasPrefix("//") {123                let range = NSRange(line.startIndex..., in: line)124                if bilingual.firstMatch(in: line, range: range) != nil, !line.contains("\"fr_CA\"") { problems.append("\(name):\(n + 1) picks a language in code") }125                // French belongs in the catalog126                if french.firstMatch(in: line, range: range) != nil { problems.append("\(name):\(n + 1) French literal") }127            }128        }129        #expect(problems.isEmpty, "\(problems.joined(separator: "\n"))")130    }131132    @Test func pluralsFollowEachLanguage() {133        #expect(VQL10n.string("%lld defects left", .en, 1) == "1 defect left")134        #expect(VQL10n.string("%lld defects left", .en, 2) == "2 defects left")135        #expect(VQL10n.string("%lld defects left", .en, 0) == "0 defects left")136        #expect(VQL10n.string("%lld defects left", .fr, 1) == "1 défaut restant")137        #expect(VQL10n.string("%lld defects left", .fr, 2) == "2 défauts restants")138        #expect(VQL10n.string("%lld defects left", .fr, 0) == "0 défaut restant")      // French: zero is singular139        #expect(VQL10n.string("%lld executions", .fr, 3) == "3 exécutions")140        #expect(VQL10n.string("%lld steps", .en, 1) == "1 step")141        #expect(VQL10n.string("%lld min ago", .fr, 5) == "il y a 5 min")142        #expect(VQFormat.relative(Date(timeIntervalSince1970: 0), now: Date(timeIntervalSince1970: 7200), language: .en) == "2 h ago")143        #expect(VQFormat.relative(Date(timeIntervalSince1970: 0), now: Date(timeIntervalSince1970: 10), language: .fr) == "à l'instant")144    }145146    @Test func theCompiledBundleHoldsTheWholeCatalog() throws {147        for (key, languages) in try Self.catalog() {148            guard let en = languages["en"]?[""], let fr = languages["fr"]?[""] else { continue }149            #expect(VQL10n.string(key, .en) == en, "\(key)")150            #expect(VQL10n.string(key, .fr) == fr, "\(key)")151        }152    }153154    @Test func argumentsAndFallbacks() {155        #expect(VQL10n.string("%1$@ at %2$@", .fr, "20 novembre 2026", "14 h 32") == "20 novembre 2026 à 14 h 32")156        #expect(VQL10n.string("Not in the catalog", .fr) == "Not in the catalog")157        #expect(VQLanguage(locale: Locale(identifier: "fr_CA")) == .fr)158        #expect(VQLanguage(locale: Locale(identifier: "fr")) == .fr)159        #expect(VQLanguage(locale: Locale(identifier: "en_US")) == .en)160        #expect(VQLanguage(locale: Locale(identifier: "de_DE")) == .en)161        #expect(VQL10n.languages == [.fr, .en] || VQL10n.languages == [.en, .fr])162    }163164    @Test func kitSentencesComeInBothLanguages() throws {165        #expect(VQFreshness.Kind.eod.label(.en) == "Close")166        #expect(VQFreshness.Kind.eod.label(.fr) == "Clôture")167        #expect(VQValueKind.forecast.short(.fr) == "PRÉV")168        #expect(VQValueKind.forecast.short(.en) == "FCST")169        #expect(VQDatasetUpload.Refusal.empty.message(.en) == "This file is empty.")170        #expect(VQDatasetUpload.Refusal.empty.message(.fr) == "Ce fichier est vide.")171        let tool = try #require(VQLabTool(json: ["id": "t", "title": "T", "params": [["name": "symbol", "label": "Symbol", "type": "symbol", "required": true], ["name": "n", "label": "Window", "type": "int", "min": 2, "max": 10]]]))172        var form = VQLabForm(tool: tool)173        form["n"] = "99"174        #expect(form.issue(for: "symbol", language: .en) == "Symbol is required.")175        #expect(form.issue(for: "symbol", language: .fr) == "Symbol : valeur requise.")176        #expect(form.issue(for: "n", language: .en) == "Window: must be between 2 and 10.")177        #expect(form.issue(for: "n", language: .fr) == "Window : doit être entre 2 et 10.")178    }179}180
Files main
Menu

Theme