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

[Enhancement] String localisation (#21)

Browse Source 
This PR contains the work done to provide string localisation support for the `Core` library.

To provide further details about the work done:
- [x] implemented the `localisation(for:)` function for the `Bundle+LocalisationBundle` extension;
- [x] implemented the `localise(for: in: value: table:)` function for the `String+Localisation` extension;
- [x] defined English as the default localisation language in the `Package.swift` file;
- [x] added the "vscode" target to the `Makefile` file.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #21
This commit was merged in pull request #21.
This commit is contained in:
Javier Cicchelli
2023-05-19 16:58:50 +00:00
parent 5286f72f05
commit 060d8a84a9
8 changed files with 370 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Tests/Core/Cases/Extensions/Bundle+LocalisationBundleTests.swift
+49
View File
@@ -0,0 +1,49 @@
//===----------------------------------------------------------------------===//
//
// 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 Bundle_LocalisationBundleTests: XCTestCase {
// MARK: Properties
private let bundle = Bundle.module
private var languageCode: String!
// MARK: Tests
func test_localisation_withExistingLocalisationBundle() throws {
// GIVEN
languageCode = "en"
// WHEN
let localisationBundle = try bundle.localisation(for: languageCode)
// THEN
XCTAssertNotNil(localisationBundle)
XCTAssertEqual(localisationBundle.bundleURL.lastPathComponent, "en.lproj")
}
func test_localisation_withNonExistingLocalisationBundle() throws {
// GIVEN
languageCode = "nl"
// WHEN & THEN
XCTAssertThrowsError(try bundle.localisation(for: languageCode)) { error in
XCTAssertEqual(error as? BundleError, .bundleNotFound)
}
}
}
Tests/Core/Cases/Extensions/String+LocalisationTests.swift
+196
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."
}
}
Tests/Core/Resources/en.lproj/Localizable.strings
+14
View File
@@ -0,0 +1,14 @@
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
"test.core.bundle.some-localisable-string" = "Some localisable string to use for testing purposes.";
"test.core.bundle.other-localisable-string" = "Other localisable string to use for testing purposes.";