rock-n-code/swift-libs
rock-n-code/swift-libs
1
0
Fork 0
Code Issues 1 Pull Requests Releases 13 Wiki Activity

Implemented the "localise(for: in: value: table:)" function for the String+Localisation extension of the Core library.

Browse Source
This commit is contained in:
Javier Cicchelli 2023-05-19 18:50:38 +02:00
parent 41f019d7b2
commit dfbd892975
2 changed files with 241 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Sources/Core/Extensions/String+Localisation.swift Normal file
View File

@ -0,0 +1,45 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftLibs open source project
//
// Copyright (c) 2023 Röck+Cöde VoF. and the SwiftLibs project authors
// Licensed under the EUPL 1.2 or later.
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftLibs project authors
//
//===----------------------------------------------------------------------===//
import Foundation
public extension String {
// MARK: Functions
/// Localise a string based on a given language code or identifier in an specific bundle.
/// - Parameters:
/// - languageCode: A string that represent a language code or identifier.
/// - bundle: A bundle in which to retrieve a localisation bundle.
/// - value: A default value to return if key is nil or if a localized string for key can’t be found in the table.
/// - table: The receiver’s string table to search. In case of nil or an empty string, the method attempts to use the table in `Localizable.strings`.
/// - Returns: A localized version of the string in case it is found. Otherwise, it returns the original string or a default string, if provided.
func localise(
for languageCode: String,
in bundle: Bundle,
value: String? = nil,
table: String? = nil
) -> String {
do {
return try bundle
.localisation(for: languageCode)
.localizedString(
forKey: self,
value: value,
table: table
)
} catch {
return value ?? self
}
}
}

196
Tests/Core/Cases/Extensions/String+LocalisationTests.swift Normal file
View File

@ -0,0 +1,196 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftLibs open source project
//
// Copyright (c) 2023 Röck+Cöde VoF. and the SwiftLibs project authors
// Licensed under the EUPL 1.2 or later.
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftLibs project authors
//
//===----------------------------------------------------------------------===//
import Core
import Foundation
import XCTest
final class String_LocalisationTests: XCTestCase {
// MARK: Properties
private var languageCode: String!
private var stringToLocalise: String!
private var localisedString: String!
private var defaultValue: String?
// MARK: Tests
func test_localise_definedKey_inDefinedLocalisationBundle() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.someLocalisableString
// WHEN
localisedString = stringToLocalise.localise(for: languageCode, in: .module)
// THEN
XCTAssertEqual(localisedString, .Result.Localisation.someLocalisableString)
}
func test_localise_definedKey_inDefinedLocalisationBundle_withDefaultValue() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.otherLocalisableString
defaultValue = "Some default value goes here..."
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .module,
value: defaultValue
)
// THEN
XCTAssertEqual(localisedString, .Result.Localisation.otherLocalisableString)
}
func test_localise_definedKey_inDefinedLocalisationBundle_withDefinedTable() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.someLocalisableString
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .module,
table: "Some table name goes in here..."
)
// THEN
XCTAssertEqual(localisedString, stringToLocalise)
}
func test_localise_definedKey_inDefinedLocalisationBundle_withDefauledValue_andDefinedTable() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.otherLocalisableString
defaultValue = "Some default value goes in here..."
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .module,
value: defaultValue,
table: "Some table name goes in here..."
)
// THEN
XCTAssertEqual(localisedString, defaultValue)
}
func test_localise_definedKey_inNotDefinedLocalisationBundle() {
// GIVEN
languageCode = "nl"
stringToLocalise = .Seed.Localisation.someLocalisableString
// WHEN
localisedString = stringToLocalise.localise(for: languageCode, in: .module)
// THEN
XCTAssertEqual(localisedString, stringToLocalise)
}
func test_localise_definedKey_inNotDefinedLocalisationBundle_withDefaultValue() {
// GIVEN
languageCode = "nl"
stringToLocalise = .Seed.Localisation.otherLocalisableString
defaultValue = "Some default value goes in here..."
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .module,
value: defaultValue
)
// THEN
XCTAssertEqual(localisedString, defaultValue)
}
func test_localise_notDefinedKey_inDefinedLocalisationBundle() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.notLocalisableString
// WHEN
localisedString = stringToLocalise.localise(for: languageCode, in: .module)
// THEN
XCTAssertEqual(localisedString, stringToLocalise)
}
func test_localise_notDefinedKey_inDefinedLocalisationBundle_withDefaultValue() {
languageCode = "en"
stringToLocalise = .Seed.Localisation.notLocalisableString
defaultValue = "Some default value goes here..."
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .module,
value: defaultValue
)
// THEN
XCTAssertEqual(localisedString, defaultValue)
}
func test_localise_inDifferentBundle() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.someLocalisableString
// WHEN
localisedString = stringToLocalise.localise(for: languageCode, in: .main)
// THEN
XCTAssertEqual(localisedString, stringToLocalise)
}
func test_localise_inDifferentBundle_withDefaultValue() {
// GIVEN
languageCode = "en"
stringToLocalise = .Seed.Localisation.otherLocalisableString
defaultValue = "Some default value goes here..."
// WHEN
localisedString = stringToLocalise.localise(
for: languageCode,
in: .main,
value: defaultValue
)
// THEN
XCTAssertEqual(localisedString, defaultValue)
}
}
// MARK: - String+Seed
private extension String.Seed {
enum Localisation {
static let someLocalisableString = "test.core.bundle.some-localisable-string"
static let otherLocalisableString = "test.core.bundle.other-localisable-string"
static let notLocalisableString = "test.core.bundle.non-localisable-string"
}
}
// MARK: - String+Result
private extension String.Result {
enum Localisation {
static let someLocalisableString = "Some localisable string to use for testing purposes."
static let otherLocalisableString = "Other localisable string to use for testing purposes."
}
}