Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support custom localized string loading strategies #842

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Support custom localized string loading strategies #842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ddeb9b
Update StringResource to introduce a LoadingStrategy type to replace …
liamnichols Aug 5, 2023
9877964
Update StringsTable generator to generate source code compatible with…
liamnichols Aug 5, 2023
0eadc50
Add StringResource.LoadingStrategy load(...) method implementation
liamnichols Aug 5, 2023
147ba86
Update generator to expose new LoadingStrategy methods and deprecate …
liamnichols Aug 5, 2023
c83f8a7
Add unit test coverage
liamnichols Aug 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions Examples/LocalizedStringApp/LocalizedStringAppTests/LocalizedStringAppTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,6 +904,14 @@ class LocalizedStringAppTests: XCTestCase {
"ten 1 - 1 thing, localized french")
}

func testCustom() {
XCTAssertEqual(R.string(loadingStrategy: .custom({ key, tableName, _, _, _, _ in "\(tableName)/\(key)" })).six.six2(),
"six/six2")

XCTAssertEqual(R.string.six(loadingStrategy: .custom({ key, tableName, _, _, _, _ in "\(tableName)/\(key)" })).six2(),
"six/six2")
}


func testPrefferedLanguages(myprefs: [String]) {

Expand Down
63 changes: 46 additions & 17 deletions Sources/RswiftGenerators/StringsTable+Generator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ extension Struct {
deploymentTarget: deploymentTarget,
name: SwiftIdentifier(name: name),
typeReference: TypeReference(module: .host, rawName: self.name.value),
valueCodeString: ".init(bundle: bundle, preferredLanguages: nil, locale: nil)"
valueCodeString: ".init(bundle: bundle, loadingStrategy: .default)"
)
}

Expand All @@ -26,32 +26,47 @@ extension Struct {
name: SwiftIdentifier(name: name),
params: [.init(name: "bundle", localName: nil, typeReference: .bundle, defaultValue: nil)],
returnType: TypeReference(module: .host, rawName: self.name.value),
valueCodeString: ".init(bundle: bundle, preferredLanguages: nil, locale: nil)"
valueCodeString: ".init(bundle: bundle, loadingStrategy: .default)"
)
}

public func generateLocaleFunctionForString(name: String) -> Function {
Function(
comments: [],
deploymentTarget: deploymentTarget,
deprecated: "Use \(name)(loadingStrategy: .default(locale: myLocale)) instead",
name: SwiftIdentifier(name: name),
params: [.init(name: "locale", localName: nil, typeReference: .locale, defaultValue: nil)],
returnType: TypeReference(module: .host, rawName: self.name.value),
valueCodeString: ".init(bundle: bundle, preferredLanguages: nil, locale: locale)"
valueCodeString: ".init(bundle: bundle, loadingStrategy: .default(locale: locale))"
)
}

public func generatePreferredLanguagesFunctionForString(name: String) -> Function {
Function(
comments: [],
deploymentTarget: deploymentTarget,
deprecated: "Use \(name)(loadingStrategy: .preferredLanguages(myLanguages, locale: myLocale)) instead",
name: SwiftIdentifier(name: name),
params: [
.init(name: "preferredLanguages", localName: nil, typeReference: .init(module: .stdLib, rawName: "[String]"), defaultValue: nil),
.init(name: "locale", localName: nil, typeReference: .init(module: .stdLib, rawName: "Locale?"), defaultValue: "nil")
],
returnType: TypeReference(module: .host, rawName: self.name.value),
valueCodeString: ".init(bundle: bundle, preferredLanguages: preferredLanguages, locale: locale)"
valueCodeString: ".init(bundle: bundle, loadingStrategy: .preferredLanguages(preferredLanguages, locale: locale))"
)
}

public func generateLoadingStrategyFunctionForString(name: String) -> Function {
Function(
comments: [],
deploymentTarget: deploymentTarget,
name: SwiftIdentifier(name: name),
params: [
.init(name: "loadingStrategy", localName: nil, typeReference: .init(module: .rswiftResources, rawName: "StringResource.LoadingStrategy"), defaultValue: nil)
],
returnType: TypeReference(module: .host, rawName: self.name.value),
valueCodeString: ".init(bundle: bundle, loadingStrategy: loadingStrategy)"
)
}
}
Expand Down Expand Up @@ -85,9 +100,10 @@ extension StringsTable {
initBundlePreferredLanguages

for name in groupedLocalized.uniques.map(\.0) {
generateBundleLocaleVarGetter(name: SwiftIdentifier(name: name), tableName: name)
generateBundleLocaleVarGetter(name: SwiftIdentifier(name: name))
// generateBundleLocaleFunction(name: SwiftIdentifier(name: name))
generatePreferredLanguagesFunction(name: SwiftIdentifier(name: name), tableName: name)
generatePreferredLanguagesFunction(name: SwiftIdentifier(name: name))
generateLoadingStrategyFunction(name: SwiftIdentifier(name: name))
}
structs
}
Expand All @@ -98,13 +114,11 @@ extension StringsTable {
comments: [],
params: [
.init(name: "bundle", localName: nil, typeReference: .bundle, defaultValue: nil),
.init(name: "preferredLanguages", localName: nil, typeReference: .init(module: .stdLib, rawName: "[String]?"), defaultValue: "nil"),
.init(name: "locale", localName: nil, typeReference: .init(module: .stdLib, rawName: "Locale?"), defaultValue: "nil"),
.init(name: "loadingStrategy", localName: nil, typeReference: .init(module: .rswiftResources, rawName: "StringResource.LoadingStrategy"), defaultValue: nil),
],
valueCodeString: """
self.bundle = bundle
self.preferredLanguages = preferredLanguages
self.locale = locale
self.loadingStrategy = loadingStrategy
"""
)
}
Expand Down Expand Up @@ -135,19 +149,21 @@ extension StringsTable {
Init(
comments: [],
params: [
.init(name: "source", localName: nil, typeReference: .init(module: .rswiftResources, rawName: "StringResource.Source"), defaultValue: nil),
.init(name: "bundle", localName: nil, typeReference: .init(module: .stdLib, rawName: "Bundle"), defaultValue: nil),
.init(name: "loadingStrategy", localName: nil, typeReference: .init(module: .rswiftResources, rawName: "StringResource.LoadingStrategy"), defaultValue: nil),
],
valueCodeString: """
self.source = source
self.bundle = bundle
self.loadingStrategy = loadingStrategy
"""
)
}

public static func generateBundleLocaleVarGetter(name: SwiftIdentifier, tableName: String) -> VarGetter {
public static func generateBundleLocaleVarGetter(name: SwiftIdentifier) -> VarGetter {
VarGetter(
name: name,
typeReference: TypeReference(module: .host, rawName: name.value),
valueCodeString: #".init(source: .init(bundle: bundle, tableName: "\#(tableName.escapedStringLiteral)", preferredLanguages: preferredLanguages, locale: locale))"#
valueCodeString: ".init(bundle: bundle, loadingStrategy: loadingStrategy)"
)
}

Expand All @@ -164,15 +180,28 @@ extension StringsTable {
)
}

public static func generatePreferredLanguagesFunction(name: SwiftIdentifier, tableName: String) -> Function {
public static func generatePreferredLanguagesFunction(name: SwiftIdentifier) -> Function {
Function(
comments: [],
deprecated: "Use \(name.value)(loadingStrategy: .preferredLanguages(...)) instead",
name: name,
params: [
.init(name: "preferredLanguages", localName: nil, typeReference: TypeReference(module: .stdLib, rawName: "[String]"), defaultValue: nil),
],
returnType: TypeReference(module: .host, rawName: name.value),
valueCodeString: #".init(source: .init(bundle: bundle, tableName: "\#(tableName.escapedStringLiteral)", preferredLanguages: preferredLanguages, locale: locale))"#
valueCodeString: #".init(bundle: bundle, loadingStrategy: .preferredLanguages(preferredLanguages, locale: nil))"#
)
}

public static func generateLoadingStrategyFunction(name: SwiftIdentifier) -> Function {
Function(
comments: [],
name: name,
params: [
.init(name: "loadingStrategy", localName: nil, typeReference: TypeReference(module: .rswiftResources, rawName: "StringResource.LoadingStrategy"), defaultValue: nil),
],
returnType: TypeReference(module: .host, rawName: name.value),
valueCodeString: #".init(bundle: bundle, loadingStrategy: loadingStrategy)"#
)
}

Expand Down Expand Up @@ -363,7 +392,7 @@ private struct StringWithParams {

let typeReference = TypeReference(module: .rswiftResources, name: "StringResource\(params.isEmpty ? "" : "\(params.count)")", genericArgs: params.map(\.spec.typeReference))

let varValueCodeString = #".init(key: "\#(key.escapedStringLiteral)", tableName: "\#(tableName)", source: source, developmentValue: \#(developmentValue), comment: nil)"#
let varValueCodeString = #".init(key: "\#(key.escapedStringLiteral)", tableName: "\#(tableName)", bundle: bundle, loadingStrategy: loadingStrategy, developmentValue: \#(developmentValue), comment: nil)"#

return VarGetter(
comments: self.comments,
Expand Down