vector-im
/
element-x-ios
mirror of https://github.com/vector-im/element-x-ios.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use iOS localization handling for strings. (#803)

This commit is contained in:
Doug 2023-04-17 15:58:39 +01:00 committed by GitHub
parent 6efae84c04
commit d01349a60e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 59 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ElementX/Sources/Application/AppCoordinator.swift
View File

@ -86,8 +86,6 @@ class AppCoordinator: AppCoordinatorProtocol {
ServiceLocator.shared.settings.lastVersionLaunched = currentVersion.description
setupStateMachine()
Bundle.elementFallbackLanguage = "en"
observeApplicationState()
observeNetworkState()

7
ElementX/Sources/Generated/Strings+Untranslated.swift
View File

@ -72,15 +72,10 @@ public enum UntranslatedL10n {
extension UntranslatedL10n {
static func tr(_ table: String, _ key: String, _ args: CVarArg...) -> String {
// No need to check languages, we always default to en for untranslated strings
guard let bundle = Bundle(for: BundleToken.self).lprojBundle(for: "en") else {
// no translations for the desired language
return key
}
guard let bundle = Bundle.lprojBundle(for: "en") else { return key }
let format = NSLocalizedString(key, tableName: table, bundle: bundle, comment: "")
return String(format: format, locale: Locale(identifier: "en"), arguments: args)
}
}
private final class BundleToken {}
// swiftlint:enable all

23
ElementX/Sources/Generated/Strings.swift
View File

@ -802,31 +802,24 @@ public enum L10n {
extension L10n {
static func tr(_ table: String, _ key: String, _ args: CVarArg...) -> String {
let languages = Bundle.preferredLanguages
// Use preferredLocalizations to get a language that is in the bundle and the user's preferred list of languages.
let languages = Bundle.overrideLocalizations ?? Bundle.app.preferredLocalizations
for language in languages {
if let translation = trIn(language, table, key, args) {
return translation
// If we can't find a translation for this language
// we check if we can find one by stripping the region
} else if let langCode = Locale(identifier: language).language.languageCode?.identifier,
let translation = trIn(langCode, table, key, args) {
return translation
}
}
return key
}
return Bundle.app.developmentLocalization.flatMap { trIn($0, table, key, args) } ?? key
}
private static func trIn(_ language: String, _ table: String, _ key: String, _ args: CVarArg...) -> String? {
guard let bundle = Bundle(for: BundleToken.self).lprojBundle(for: language) else {
// no translations for the desired language
return nil
}
guard let bundle = Bundle.lprojBundle(for: language) else { return nil }
let format = NSLocalizedString(key, tableName: table, bundle: bundle, comment: "")
return String(format: format, locale: Locale(identifier: language), arguments: args)
let translation = String(format: format, locale: Locale(identifier: language), arguments: args)
guard translation != key else { return nil }
return translation
}
}
private final class BundleToken {}
// swiftlint:enable all

73
ElementX/Sources/Other/Extensions/Bundle.swift
View File

@ -17,43 +17,7 @@
import Foundation
public extension Bundle {
private static var cachedLocalizationBundles = [String: Bundle]()
/// Get an lproj language bundle from the receiver bundle.
/// - Parameter language: The language to try to load.
/// - Returns: The lproj bundle if found otherwise nil.
func lprojBundle(for language: String) -> Bundle? {
if let bundle = Self.cachedLocalizationBundles[language] {
return bundle
}
guard let lprojURL = Bundle.app.url(forResource: language, withExtension: "lproj") else {
return nil
}
let bundle = Bundle(url: lprojURL)
Self.cachedLocalizationBundles[language] = bundle
return bundle
}
/// Preferred app language for translations. Takes the highest priority in translations. The priority list for translations:
/// - `Bundle.elementLanguage`
/// - `Locale.preferredLanguages`
/// - `Bundle.elementFallbackLanguage`
static var elementLanguage: String? {
didSet {
preferredLanguages = calculatePreferredLanguages()
}
}
/// Preferred fallback language for translations. Only used for strings not translated neither to `elementLanguage` nor to one of the user's preferred languages.
static var elementFallbackLanguage: String? {
didSet {
preferredLanguages = calculatePreferredLanguages()
}
}
/// The top-level bundle that contains the entire app.
static var app: Bundle {
var bundle = Bundle.main
if bundle.bundleURL.pathExtension == "appex" {
@ -65,16 +29,29 @@ public extension Bundle {
}
return bundle
}
/// Preferred languages in the priority order.
private(set) static var preferredLanguages: [String] = calculatePreferredLanguages()
private static func calculatePreferredLanguages() -> [String] {
var set = Set<String>()
return ([Bundle.elementLanguage] +
Locale.preferredLanguages +
[Bundle.elementFallbackLanguage])
.compactMap { $0 }
.filter { set.insert($0).inserted }
// MARK: - Localisation
private static var cachedLocalizationBundles = [String: Bundle]()
/// Get an lproj language bundle from the receiver bundle.
/// - Parameter language: The language to try to load.
/// - Returns: The lproj bundle if found otherwise nil.
static func lprojBundle(for language: String) -> Bundle? {
if let bundle = cachedLocalizationBundles[language] {
return bundle
}
guard let lprojURL = Bundle.app.url(forResource: language, withExtension: "lproj") else {
return nil
}
let bundle = Bundle(url: lprojURL)
cachedLocalizationBundles[language] = bundle
return bundle
}
/// Overrides `Bundle.app.preferredLocalizations` for testing translations.
static var overrideLocalizations: [String]?
}

6
ElementX/Sources/Services/BugReport/BugReportService.swift
View File

@ -160,9 +160,9 @@ class BugReportService: NSObject, BugReportServiceProtocol {
MultipartFormData(key: "version", type: .text(value: InfoPlistReader.main.bundleShortVersionString)),
MultipartFormData(key: "build", type: .text(value: InfoPlistReader.main.bundleVersion)),
MultipartFormData(key: "os", type: .text(value: os)),
MultipartFormData(key: "resolved_language", type: .text(value: Bundle.preferredLanguages[0])),
MultipartFormData(key: "user_language", type: .text(value: Bundle.elementLanguage ?? "null")),
MultipartFormData(key: "fallback_language", type: .text(value: Bundle.elementFallbackLanguage ?? "null")),
MultipartFormData(key: "resolved_languages", type: .text(value: Bundle.app.preferredLocalizations.joined(separator: ", "))),
MultipartFormData(key: "user_languages", type: .text(value: Locale.preferredLanguages.joined(separator: ", "))),
MultipartFormData(key: "fallback_language", type: .text(value: Bundle.app.developmentLocalization ?? "null")),
MultipartFormData(key: "local_time", type: .text(value: localTime)),
MultipartFormData(key: "utc_time", type: .text(value: utcTime)),
MultipartFormData(key: "base_bundle_identifier", type: .text(value: InfoPlistReader.main.baseBundleIdentifier))

2
ElementX/Sources/Services/Notification/Manager/NotificationManager.swift
View File

@ -102,7 +102,7 @@ class NotificationManager: NSObject, NotificationManagerProtocol {
appDisplayName: "\(InfoPlistReader.main.bundleDisplayName) (iOS)",
deviceDisplayName: UIDevice.current.name,
profileTag: pusherProfileTag(),
lang: Bundle.preferredLanguages.first ?? "en")
lang: Bundle.app.preferredLocalizations.first ?? "en")
try await clientProxy.setPusher(with: configuration)
MXLog.info("[NotificationManager] set pusher succeeded")
return true

2
ElementX/Sources/UITests/UITestsAppCoordinator.swift
View File

@ -34,8 +34,6 @@ class UITestsAppCoordinator: AppCoordinatorProtocol {
}
func start() {
Bundle.elementFallbackLanguage = "en"
guard let screenID = Tests.screenID else { fatalError("Unable to launch with unknown screen.") }
let mockScreen = MockScreen(id: screenID)

7
NSE/Sources/NotificationServiceExtension.swift
View File

@ -24,13 +24,6 @@ class NotificationServiceExtension: UNNotificationServiceExtension {
var handler: ((UNNotificationContent) -> Void)?
var modifiedContent: UNMutableNotificationContent?
override init() {
// Use `en` as fallback language
Bundle.elementFallbackLanguage = "en"
super.init()
}
override func didReceive(_ request: UNNotificationRequest,
withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
guard !DataProtectionManager.isDeviceLockedAfterReboot(containerURL: URL.appGroupContainerDirectory),

7
Tools/SwiftGen/Templates/Strings/structured-swift5-element-untranslated.stencil
View File

@ -76,17 +76,12 @@ import Foundation
extension {{enumName}} {
static func tr(_ table: String, _ key: String, _ args: CVarArg...) -> String {
// No need to check languages, we always default to en for untranslated strings
guard let bundle = Bundle(for: BundleToken.self).lprojBundle(for: "en") else {
// no translations for the desired language
return key
}
guard let bundle = Bundle.lprojBundle(for: "en") else { return key }
let format = NSLocalizedString(key, tableName: table, bundle: bundle, comment: "")
return String(format: format, locale: Locale(identifier: "en"), arguments: args)
}
}
private final class BundleToken {}
{% else %}
// No string found
{% endif %}

23
Tools/SwiftGen/Templates/Strings/structured-swift5-element.stencil
View File

@ -75,33 +75,26 @@ import Foundation
extension {{enumName}} {
static func tr(_ table: String, _ key: String, _ args: CVarArg...) -> String {
let languages = Bundle.preferredLanguages
// Use preferredLocalizations to get a language that is in the bundle and the user's preferred list of languages.
let languages = Bundle.overrideLocalizations ?? Bundle.app.preferredLocalizations
for language in languages {
if let translation = trIn(language, table, key, args) {
return translation
// If we can't find a translation for this language
// we check if we can find one by stripping the region
} else if let langCode = Locale(identifier: language).language.languageCode?.identifier,
let translation = trIn(langCode, table, key, args) {
return translation
}
}
return key
}
return Bundle.app.developmentLocalization.flatMap { trIn($0, table, key, args) } ?? key
}
private static func trIn(_ language: String, _ table: String, _ key: String, _ args: CVarArg...) -> String? {
guard let bundle = Bundle(for: BundleToken.self).lprojBundle(for: language) else {
// no translations for the desired language
return nil
}
guard let bundle = Bundle.lprojBundle(for: language) else { return nil }
let format = NSLocalizedString(key, tableName: table, bundle: bundle, comment: "")
return String(format: format, locale: Locale(identifier: language), arguments: args)
let translation = String(format: format, locale: Locale(identifier: language), arguments: args)
guard translation != key else { return nil }
return translation
}
}
private final class BundleToken {}
{% else %}
// No string found
{% endif %}

3
UITests/Sources/Application.swift
View File

@ -24,9 +24,6 @@ struct Application {
"UI_TESTS_SCREEN": identifier.rawValue
]
// Use the same fallback language as the real app so translation comparison works
Bundle.elementFallbackLanguage = "en"
app.launch()
return app
}

31
UnitTests/Sources/LocalizationTests.swift
View File

@ -20,21 +20,13 @@ import XCTest
class LocalizationTests: XCTestCase {
/// Test ElementL10n considers app language changes
func testAppLanguage() {
// set app language to English
Bundle.elementLanguage = "en"
// set app language to English
Bundle.overrideLocalizations = ["en"]
XCTAssertEqual(L10n.testLanguageIdentifier, "en")
// set app language to Italian
Bundle.elementLanguage = "it"
XCTAssertEqual(L10n.testLanguageIdentifier, "it")
}
/// Test fallback language for a language not supported at all
func testStripRegionIfRegionalTranslationIsNotAvailable() {
// set app language to something that includes also a region (it-IT)
Bundle.elementLanguage = "it-IT"
// set app language to Italian
Bundle.overrideLocalizations = ["it"]
XCTAssertEqual(L10n.testLanguageIdentifier, "it")
}
@ -42,8 +34,7 @@ class LocalizationTests: XCTestCase {
/// Test fallback language for a language not supported at all
func testFallbackOnNotSupportedLanguage() {
// set app language to something Element don't support at all (chose non existing identifier)
Bundle.elementLanguage = "xx"
Bundle.elementFallbackLanguage = "en"
Bundle.overrideLocalizations = ["xx"]
XCTAssertEqual(L10n.testLanguageIdentifier, "en")
}
@ -51,8 +42,7 @@ class LocalizationTests: XCTestCase {
/// Test fallback language for a language supported but poorly translated
func testFallbackOnNotTranslatedKey() {
// set app language to something Element supports but use a key that is not translated (we have a key that should never be translated)
Bundle.elementLanguage = "it"
Bundle.elementFallbackLanguage = "en"
Bundle.overrideLocalizations = ["it"]
XCTAssertEqual(L10n.testLanguageIdentifier, "it")
XCTAssertEqual(L10n.testUntranslatedDefaultLanguageIdentifier, "en")
@ -61,19 +51,19 @@ class LocalizationTests: XCTestCase {
/// Test plurals that ElementL10n considers app language changes
func testPlurals() {
// set app language to English
Bundle.elementLanguage = "en"
Bundle.overrideLocalizations = ["en"]
XCTAssertEqual(L10n.commonMemberCount(1), "1 member")
XCTAssertEqual(L10n.commonMemberCount(2), "2 members")
// set app language to Italian
Bundle.elementLanguage = "it"
Bundle.overrideLocalizations = ["it"]
XCTAssertEqual(L10n.commonMemberCount(1), "1 membro")
XCTAssertEqual(L10n.commonMemberCount(2), "2 membri")
// // set app language to Polish
// Bundle.elementLanguage = "pl"
// Bundle.overrideLocalizations = ["pl"]
//
// XCTAssertEqual(L10n.commonMemberCount(1), "1 sekunda") // one
// XCTAssertEqual(L10n.commonMemberCount(2), "2 sekundy") // few
@ -83,8 +73,7 @@ class LocalizationTests: XCTestCase {
/// Test plurals fallback language for a language not supported at all
func testPluralsFallbackOnNotSupportedLanguage() {
// set app language to something Element don't support at all ("invalid identifier")
Bundle.elementLanguage = "xx"
Bundle.elementFallbackLanguage = "en"
Bundle.overrideLocalizations = ["xx"]
XCTAssertEqual(L10n.commonMemberCount(1), "1 member")
XCTAssertEqual(L10n.commonMemberCount(2), "2 members")

2
UnitTests/Sources/NotificationManager/NotificationManagerTests.swift
View File

@ -63,7 +63,7 @@ final class NotificationManagerTests: XCTestCase {
XCTAssertEqual(clientProxy.setPusherArgument?.appDisplayName, "\(InfoPlistReader.main.bundleDisplayName) (iOS)")
XCTAssertEqual(clientProxy.setPusherArgument?.deviceDisplayName, UIDevice.current.name)
XCTAssertNotNil(clientProxy.setPusherArgument?.profileTag)
XCTAssertEqual(clientProxy.setPusherArgument?.lang, Bundle.preferredLanguages.first)
XCTAssertEqual(clientProxy.setPusherArgument?.lang, Bundle.app.preferredLocalizations.first)
guard case let .http(data) = clientProxy.setPusherArgument?.kind else {
XCTFail("Http kind expected")
return

1
changelog.d/pr-803.change Normal file
View File

@ -0,0 +1 @@
Use iOS localization handling for strings.