-
-
Notifications
You must be signed in to change notification settings - Fork 314
feat: Apple String Catalog Support #2893
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.
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3f4562d
WIP export works
neo773 d4d288e
WIP add import
neo773 25ac114
add tests
neo773 c85f49e
fix: Remove duplicate Apple .xcstrings export format entry in de.json
neo773 4404489
add changes
neo773 872e7c3
add changes and run ktlint
neo773 6f20044
Rename XCSTRINGS import format to APPLE_XCSTRINGS
neo773 9ef91f7
Merge remote-tracking branch 'upstream/main'
neo773 47812b9
fix translation states and add description
neo773 b6d42aa
parse translationState
neo773 5e8b8c2
add test and fix: Use xcstrings key as base translation when missing
neo773 f87a038
add changes and remove translation state
neo773 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
backend/data/src/main/kotlin/io/tolgee/formats/apple/in/xcstrings/XcstringsFileProcessor.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| package io.tolgee.formats.apple.`in`.xcstrings | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode | ||
| import com.fasterxml.jackson.databind.ObjectMapper | ||
| import io.tolgee.exceptions.ImportCannotParseFileException | ||
| import io.tolgee.formats.ImportFileProcessor | ||
| import io.tolgee.formats.apple.`in`.guessNamespaceFromPath | ||
| import io.tolgee.formats.importCommon.ImportFormat | ||
| import io.tolgee.service.dataImport.processors.FileProcessorContext | ||
|
|
||
| class XcstringsFileProcessor( | ||
| override val context: FileProcessorContext, | ||
| private val objectMapper: ObjectMapper, | ||
| ) : ImportFileProcessor() { | ||
|
|
||
| override fun process() { | ||
| try { | ||
| val root = objectMapper.readTree(context.file.data.inputStream()) | ||
| val strings = root.get("strings") ?: throw ImportCannotParseFileException( | ||
| context.file.name, | ||
| "Missing 'strings' object in xcstrings file" | ||
| ) | ||
|
|
||
| strings.fields().forEach { (key, value) -> | ||
| processKey(key, value) | ||
| } | ||
|
|
||
| context.namespace = guessNamespaceFromPath(context.file.name) | ||
| } catch (e: Exception) { | ||
| throw ImportCannotParseFileException(context.file.name, e.message) | ||
| } | ||
| } | ||
|
|
||
| private fun processKey(key: String, value: JsonNode) { | ||
| val localizations = value.get("localizations") ?: return | ||
|
|
||
| val metadata = mutableMapOf<String, Any?>() | ||
| value.fields().forEach { (fieldName, fieldValue) -> | ||
| if (fieldName != "localizations") { | ||
| metadata[fieldName] = when { | ||
| fieldValue.isTextual -> fieldValue.asText() | ||
| fieldValue.isBoolean -> fieldValue.asBoolean() | ||
| fieldValue.isObject -> objectMapper.convertValue(fieldValue, Map::class.java) | ||
| else -> fieldValue.toString() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| localizations.fields().forEach { (languageTag, localization) -> | ||
| when { | ||
| localization.has("stringUnit") -> { | ||
| processSingleTranslation(key, languageTag, localization, metadata) | ||
| } | ||
| localization.has("variations") -> { | ||
| processPluralTranslation(key, languageTag, localization, metadata) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun processSingleTranslation( | ||
| key: String, | ||
| languageTag: String, | ||
| localization: JsonNode, | ||
| metadata: Map<String, Any?> | ||
| ) { | ||
| val stringUnit = localization.get("stringUnit") | ||
| val translationValue = stringUnit?.get("value")?.asText() | ||
|
|
||
| if (translationValue != null) { | ||
| context.addTranslation( | ||
| keyName = key, | ||
| languageName = languageTag, | ||
| value = translationValue, | ||
| convertedBy = importFormat, | ||
| metadata = metadata | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private fun processPluralTranslation( | ||
| key: String, | ||
| languageTag: String, | ||
| localization: JsonNode, | ||
| metadata: Map<String, Any?> | ||
| ) { | ||
| val variations = localization.get("variations")?.get("plural") ?: return | ||
| val forms = mutableMapOf<String, String>() | ||
|
|
||
| variations.fields().forEach { (form, content) -> | ||
| val value = content.get("stringUnit")?.get("value")?.asText() | ||
| if (value != null) { | ||
| forms[form] = value | ||
| } | ||
| } | ||
|
|
||
| if (forms.isNotEmpty()) { | ||
| val converted = messageConvertor.convert( | ||
| forms, | ||
| languageTag, | ||
| context.importSettings.convertPlaceholdersToIcu, | ||
| context.projectIcuPlaceholdersEnabled | ||
| ) | ||
|
|
||
| context.addTranslation( | ||
| keyName = key, | ||
| languageName = languageTag, | ||
| value = converted.message, | ||
| pluralArgName = converted.pluralArgName, | ||
| rawData = forms, | ||
| convertedBy = importFormat, | ||
| metadata = metadata | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
| private val importFormat = ImportFormat.XCSTRINGS | ||
| private val messageConvertor = importFormat.messageConvertor | ||
| } | ||
| } |
123 changes: 123 additions & 0 deletions
123
backend/data/src/main/kotlin/io/tolgee/formats/apple/out/AppleXcstringsExporter.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| package io.tolgee.formats.apple.out | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper | ||
| import com.fasterxml.jackson.databind.node.ObjectNode | ||
| import io.tolgee.dtos.IExportParams | ||
| import io.tolgee.service.export.ExportFilePathProvider | ||
| import io.tolgee.service.export.dataProvider.ExportTranslationView | ||
| import io.tolgee.service.export.exporters.FileExporter | ||
| import java.io.InputStream | ||
|
|
||
| class AppleXcstringsExporter( | ||
| private val translations: List<ExportTranslationView>, | ||
| private val exportParams: IExportParams, | ||
| private val objectMapper: ObjectMapper, | ||
| private val isProjectIcuPlaceholdersEnabled: Boolean = true, | ||
| ) : FileExporter { | ||
| private val preparedFiles = mutableMapOf<String, ObjectNode>() | ||
|
|
||
| override fun produceFiles(): Map<String, InputStream> { | ||
| translations.forEach { handleTranslation(it) } | ||
|
|
||
| return preparedFiles.mapValues { (_, jsonContent) -> | ||
| val root = objectMapper.createObjectNode().apply { | ||
| put("sourceLanguage", exportParams.languages?.firstOrNull() ?: "en") | ||
| put("version", "1.0") | ||
| set<ObjectNode>("strings", jsonContent) | ||
| } | ||
| objectMapper.writeValueAsString(root).byteInputStream() | ||
| } | ||
| } | ||
|
|
||
| private fun handleTranslation(translation: ExportTranslationView) { | ||
| val baseFilePath = getBaseFilePath(translation) | ||
| val fileContent = preparedFiles.getOrPut(baseFilePath) { objectMapper.createObjectNode() } | ||
|
|
||
| val keyData = fileContent.get(translation.key.name)?.let { | ||
| it as ObjectNode | ||
| } ?: createKeyEntry(translation) | ||
| fileContent.set<ObjectNode>(translation.key.name, keyData) | ||
|
|
||
| val converted = IcuToAppleMessageConvertor( | ||
| message = translation.text ?: "", | ||
| translation.key.isPlural, | ||
| isProjectIcuPlaceholdersEnabled | ||
| ).convert() | ||
|
|
||
| val localizations = keyData.get("localizations")?.let { | ||
| it as ObjectNode | ||
| } ?: objectMapper.createObjectNode() | ||
|
|
||
| if (converted.isPlural()) { | ||
| handlePluralTranslation(localizations, translation, converted.formsResult) | ||
| } else { | ||
| handleSingleTranslation(localizations, translation, converted.singleResult) | ||
| } | ||
|
|
||
| keyData.set<ObjectNode>("localizations", localizations) | ||
| } | ||
|
|
||
| private fun handleSingleTranslation( | ||
| localizations: ObjectNode, | ||
| translation: ExportTranslationView, | ||
| convertedText: String? | ||
| ) { | ||
| if (convertedText == null) return | ||
|
|
||
| localizations.set<ObjectNode>( | ||
| translation.languageTag, | ||
| objectMapper.createObjectNode().apply { | ||
| set<ObjectNode>("stringUnit", objectMapper.createObjectNode().apply { | ||
| put("state", "translated") | ||
| put("value", convertedText) | ||
| }) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| private fun handlePluralTranslation( | ||
| localizations: ObjectNode, | ||
| translation: ExportTranslationView, | ||
| forms: Map<String, String>? | ||
| ) { | ||
| if (forms == null) return | ||
|
|
||
| val pluralForms = objectMapper.createObjectNode() | ||
| forms.forEach { (form, text) -> | ||
| pluralForms.set<ObjectNode>(form, objectMapper.createObjectNode().apply { | ||
| set<ObjectNode>("stringUnit", objectMapper.createObjectNode().apply { | ||
| put("state", "translated") | ||
| put("value", text) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| localizations.set<ObjectNode>( | ||
| translation.languageTag, | ||
| objectMapper.createObjectNode().apply { | ||
| set<ObjectNode>("variations", objectMapper.createObjectNode().apply { | ||
| set<ObjectNode>("plural", pluralForms) | ||
| }) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| private fun createKeyEntry(translation: ExportTranslationView): ObjectNode { | ||
| return objectMapper.createObjectNode().apply { | ||
| translation.key.description?.let { | ||
| put("extractionState", "manual") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun getBaseFilePath(translation: ExportTranslationView): String { | ||
| return ExportFilePathProvider( | ||
| exportParams, | ||
| "xcstrings" | ||
| ).getFilePath( | ||
| translation.key.namespace, | ||
| null, | ||
| replaceExtension = true | ||
| ) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.