ISSUE-12 - Improved locale format handling to match RFC 5646

- Updated README with instructions on how to migrate locale identifiers - Added tests for locale validation - Removed obsolete Swift 4 code (library has Swift 5 as minimum version)
miroslavkovac · Apr 6, 2022 · c6f6a80 · c6f6a80
1 parent e4b032f
commit c6f6a80
Show file tree

Hide file tree

Showing 155 changed files with 249 additions and 304 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 </p>
 
 <p align="center">
-	<img src="https://img.shields.io/badge/swift-5-brightgreen.svg" alt="swift 4"/>
+	<img src="https://img.shields.io/badge/swift-5-brightgreen.svg" alt="swift 5"/>
 	<img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License"/>
 </p>
 
@@ -23,7 +23,7 @@
 * **String interpolation**
 * **Flexible data source** (read localizations from a JSON file, database or whatever suites your workflow the best)
 * **Default locale** - if the localization for a requested locale is not available, it will fallback to the default one
-* **Locale validation** - the library will warn you for using invalid locale identifiers (`en_fr` instead of `en_FR` etc.)
+* **Locale validation** - the library will warn you for using invalid locale identifiers (`en-fr` instead of `en-FR` etc.)
 
 ## Setup
 
@@ -46,7 +46,7 @@ Add the dependency:
 ```swift
 dependencies: [
 	...,
-	.Package(url: "https://github.com/miroslavkovac/Lingo.git", majorVersion: 3)
+	.Package(url: "https://github.com/miroslavkovac/Lingo.git", majorVersion: 4)
 ]
 ```
 
@@ -56,6 +56,12 @@ Create an instance of `Lingo` object passing the root directory path where the l
 let lingo = try Lingo(rootPath: "path/to/localizations", defaultLocale: "en")
 ```
 
+## Upgrading from version 3 to version 4
+
+In the version 4 the format of locale identifiers was changed to match [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646). The version 3 used `_` to separate _language code_ and _country code_, and now the version 4 uses `-`. 
+
+If you were using any locales which include a country code, you would need to rename related translation files to match the new format.    
+
 ## Usage
 
 Use the following syntax for defining localizations in a JSON file:
@@ -115,9 +121,9 @@ print(unread24) // Will print: "You have 24 unread messages."
 ```
 
 Each language contains custom pluralization rules that define which plural category should be used for which numeric value. Lingo currently implements rules for the following languages:
-> ak, am, ar, az, be, bg, bh, bm, bn, bo, br, bs, by, ca, cs, cy, da, de\_AT, de\_CH, de\_DE, de, dz, el, en\_AU, en\_CA, en\_GB, en\_IN, en\_NZ, en, eo, es\_419, es\_AR, es\_CL, es\_CO, es\_CR, es\_EC, es\_ES, es\_MX, es\_NI, es\_PA, es\_PE, es\_US, es\_VE, es, et, eu, fa, ff, fi, fil, fr\_CA, fr\_CH, fr\_FR, fr, ga, gd, gl, guw, gv, he, hi\_IN, hi, hr, hsb, hu, id, ig, ii, it\_CH, it, iu, ja, jv, ka, kab, kde, kea, km, kn, ko, ksh, kw, lag, ln, lo, lt, lv, mg, mk, ml, mn, mo, mr\_IN, ms, mt, my, naq, nb, ne, nl, nn, nso, or, pa, pl, pt, pt_BR, ro, root, ru, sah, se, ses, sg, sh, shi, sk, sl, sma, smi, smj, smn, sms, sr, sv\_SE, sv, sw, th, ti, tl, to, tr, tzm, uk, ur, vi, wa, wo, yo, zh\_CN, zh\_HK, zh\_TW, zh\_YUE, zh
+> ak, am, ar, az, be, bg, bm, bn, bo, br, bs, ca, cs, cy, da, de\-AT, de\-CH, de\-DE, de, dz, el, en\-AU, en\-CA, en\-GB, en\-IN, en\-NZ, en, eo, es\-419, es\-AR, es\-CL, es\-CO, es\-CR, es\-EC, es\-ES, es\-MX, es\-NI, es\-PA, es\-PE, es\-US, es\-VE, es, et, eu, fa, ff, fi, fil, fr\-CA, fr\-CH, fr\-FR, fr, ga, gd, gl, gv, he, hi\-IN, hi, hr, hsb, hu, id, ig, ii, it\-CH, it, iu, ja, jv, ka, kab, kde, kea, km, kn, ko, ksh, kw, lag, ln, lo, lt, lv, mg, mk, ml, mn, mr\-IN, ms, mt, my, naq, nb, ne, nl, nn, nso, or, pa, pl, pt, pt-BR, ro, ru, sah, se, ses, sg, shi, sk, sl, smn, sr, sv\-SE, sv, sw, th, ti, to, tr, tzm, uk, ur, vi, wa, wo, yo, zh\-CN, zh\-HK, zh\-TW, zh
 
-The origial seed of pluralization rules was translated from [Rails i18n](https://github.com/svenfuchs/rails-i18n/tree/master/rails/pluralization) into Swift.
+The original seed of pluralization rules was translated from [Rails i18n](https://github.com/svenfuchs/rails-i18n/tree/master/rails/pluralization) into Swift.
 
 ## Performance
 

diff --git a/Sources/Lingo/Lingo.swift b/Sources/Lingo/Lingo.swift
@@ -85,13 +85,13 @@ extension LocaleIdentifier {
 
     /// Returns `true` if the locale identifier contains both, language and country code
     var hasCountryCode: Bool {
-        return self.components(separatedBy: "_").count == 2
+        return self.components(separatedBy: "-").count == 2
     }
 
     /// Returns language code from the locale identifier string.
-    /// For locales which contains a country code (en_US, de_CH), the country code is removed.
+    /// For locales which contains a country code (en-US, de-CH), the country code is removed.
     var languageCode: String {
-        let components = self.components(separatedBy: "_")
+        let components = self.components(separatedBy: "-")
         return components.count == 2 ? components.first! : self
     }
 

diff --git a/Sources/Lingo/LocaleValidator.swift b/Sources/Lingo/LocaleValidator.swift
@@ -1,16 +1,20 @@
 import Foundation
 
-class LocaleValidator {
+final class LocaleValidator {
 
-    // On Linux `Locale.availableIdentifiers` throws an exception.
-    // Issue reported: https://bugs.swift.org/browse/SR-3634
-    // Pull request with fix: https://github.com/apple/swift-corelibs-foundation/pull/944
-    // This check can be removed when the changes are available in a new Swift version.
-    #if os(Linux)
-        private static let validLocaleIdentifiers = Set<String>()
-    #else
-        private static let validLocaleIdentifiers = Set(Locale.availableIdentifiers)
-    #endif
+    private static let validLocaleIdentifiers: Set<String> = {
+        /// Make sure locales are in the correct format as per [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646)
+        var correctedLocaleIdentifiers = Locale.availableIdentifiers.map { $0.replacingOccurrences(of: "_", with: "-") }
+
+        /// Append missing locales not by default included
+        correctedLocaleIdentifiers.append(contentsOf: [
+            "zh-CN",
+            "zh-HK",
+            "zh-TW"
+        ])
+
+        return Set(correctedLocaleIdentifiers)
+    }()
 
     /// Checks if given locale is present in Locale.availableIdentifiers
     func validate(locale: LocaleIdentifier) -> Bool {

diff --git a/Sources/Lingo/LocalizationsModel.swift b/Sources/Lingo/LocalizationsModel.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class LocalizationsModel {
+final class LocalizationsModel {
 
     enum LocalizationResult {
         case success(localization: String)

diff --git a/Sources/Lingo/Pluralization/Concrete/ak.swift b/Sources/Lingo/Pluralization/Concrete/ak.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class ak: OneWithZeroOther, PluralizationRule {
+final class ak: OneWithZeroOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "ak"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/am.swift b/Sources/Lingo/Pluralization/Concrete/am.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class am: OneWithZeroOther, PluralizationRule {
+final class am: OneWithZeroOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "am"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/ar.swift b/Sources/Lingo/Pluralization/Concrete/ar.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class ar: PluralizationRule {
+final class ar: PluralizationRule {
 
     let locale: LocaleIdentifier = "ar"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/az.swift b/Sources/Lingo/Pluralization/Concrete/az.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class az: Other, PluralizationRule {
+final class az: Other, PluralizationRule {
 
     let locale: LocaleIdentifier = "az"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/be.swift b/Sources/Lingo/Pluralization/Concrete/be.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class be: EastSlavic, PluralizationRule {
+final class be: EastSlavic, PluralizationRule {
 
     let locale: LocaleIdentifier = "be"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/bg.swift b/Sources/Lingo/Pluralization/Concrete/bg.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class bg: OneOther, PluralizationRule {
+final class bg: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "bg"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/bh.swift b/Sources/Lingo/Pluralization/Concrete/bh.swift
diff --git a/Sources/Lingo/Pluralization/Concrete/bm.swift b/Sources/Lingo/Pluralization/Concrete/bm.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class bm: Other, PluralizationRule {
+final class bm: Other, PluralizationRule {
 
     let locale: LocaleIdentifier = "bm"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/bn.swift b/Sources/Lingo/Pluralization/Concrete/bn.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class bn: OneOther, PluralizationRule {
+final class bn: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "bn"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/bo.swift b/Sources/Lingo/Pluralization/Concrete/bo.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class bo: Other, PluralizationRule {
+final class bo: Other, PluralizationRule {
 
     let locale: LocaleIdentifier = "bo"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/br.swift b/Sources/Lingo/Pluralization/Concrete/br.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class br: PluralizationRule {
+final class br: PluralizationRule {
 
     let locale: LocaleIdentifier = "br"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/bs.swift b/Sources/Lingo/Pluralization/Concrete/bs.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class bs: EastSlavic, PluralizationRule {
+final class bs: EastSlavic, PluralizationRule {
 
     let locale: LocaleIdentifier = "bs"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/by.swift b/Sources/Lingo/Pluralization/Concrete/by.swift
diff --git a/Sources/Lingo/Pluralization/Concrete/ca.swift b/Sources/Lingo/Pluralization/Concrete/ca.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class ca: OneOther, PluralizationRule {
+final class ca: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "ca"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/cs.swift b/Sources/Lingo/Pluralization/Concrete/cs.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class cs: WestSlavic, PluralizationRule {
+final class cs: WestSlavic, PluralizationRule {
 
     let locale: LocaleIdentifier = "cs"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/cy.swift b/Sources/Lingo/Pluralization/Concrete/cy.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class cy: PluralizationRule {
+final class cy: PluralizationRule {
 
     let locale: LocaleIdentifier = "cy"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/da.swift b/Sources/Lingo/Pluralization/Concrete/da.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class da: OneOther, PluralizationRule {
+final class da: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "da"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/de.swift b/Sources/Lingo/Pluralization/Concrete/de.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class de: OneOther, PluralizationRule {
+final class de: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "de"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/de_AT.swift b/Sources/Lingo/Pluralization/Concrete/de_AT.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class de_AT: OneOther, PluralizationRule {
+final class de_AT: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "de_AT"
+    let locale: LocaleIdentifier = "de-AT"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/de_CH.swift b/Sources/Lingo/Pluralization/Concrete/de_CH.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class de_CH: OneOther, PluralizationRule {
+final class de_CH: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "de_CH"
+    let locale: LocaleIdentifier = "de-CH"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/de_DE.swift b/Sources/Lingo/Pluralization/Concrete/de_DE.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class de_DE: OneOther, PluralizationRule {
+final class de_DE: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "de_DE"
+    let locale: LocaleIdentifier = "de-DE"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/dz.swift b/Sources/Lingo/Pluralization/Concrete/dz.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class dz: Other, PluralizationRule {
+final class dz: Other, PluralizationRule {
 
     let locale: LocaleIdentifier = "dz"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/el.swift b/Sources/Lingo/Pluralization/Concrete/el.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class el: OneOther, PluralizationRule {
+final class el: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "el"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/en.swift b/Sources/Lingo/Pluralization/Concrete/en.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class en: OneOther, PluralizationRule {
+final class en: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "en"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/en_AU.swift b/Sources/Lingo/Pluralization/Concrete/en_AU.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class en_AU: OneOther, PluralizationRule {
+final class en_AU: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "en_AU"
+    let locale: LocaleIdentifier = "en-AU"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/en_CA.swift b/Sources/Lingo/Pluralization/Concrete/en_CA.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class en_CA: OneOther, PluralizationRule {
+final class en_CA: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "en_CA"
+    let locale: LocaleIdentifier = "en-CA"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/en_GB.swift b/Sources/Lingo/Pluralization/Concrete/en_GB.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class en_GB: OneOther, PluralizationRule {
+final class en_GB: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "en_GB"
+    let locale: LocaleIdentifier = "en-GB"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/en_IN.swift b/Sources/Lingo/Pluralization/Concrete/en_IN.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class en_IN: OneOther, PluralizationRule {
+final class en_IN: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "en_IN"
+    let locale: LocaleIdentifier = "en-IN"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/en_NZ.swift b/Sources/Lingo/Pluralization/Concrete/en_NZ.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class en_NZ: OneOther, PluralizationRule {
+final class en_NZ: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "en_NZ"
+    let locale: LocaleIdentifier = "en-NZ"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/eo.swift b/Sources/Lingo/Pluralization/Concrete/eo.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class eo: OneOther, PluralizationRule {
+final class eo: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "eo"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/es.swift b/Sources/Lingo/Pluralization/Concrete/es.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class es: OneOther, PluralizationRule {
+final class es: OneOther, PluralizationRule {
 
     let locale: LocaleIdentifier = "es"
 

diff --git a/Sources/Lingo/Pluralization/Concrete/es_419.swift b/Sources/Lingo/Pluralization/Concrete/es_419.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class es_419: OneOther, PluralizationRule {
+final class es_419: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "es_419"
+    let locale: LocaleIdentifier = "es-419"
 
 }
diff --git a/Sources/Lingo/Pluralization/Concrete/es_AR.swift b/Sources/Lingo/Pluralization/Concrete/es_AR.swift
@@ -1,7 +1,7 @@
 import Foundation
 
-class es_AR: OneOther, PluralizationRule {
+final class es_AR: OneOther, PluralizationRule {
 
-    let locale: LocaleIdentifier = "es_AR"
+    let locale: LocaleIdentifier = "es-AR"
 
 }