3.5.1

bdongus · Apr 10, 2024 · 7ce2987 · 7ce2987
1 parent 209c576
commit 7ce2987
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 16 deletions.
diff --git a/idee5.Globalization.Test/UpdateResourceKeyTests.cs b/idee5.Globalization.Test/UpdateResourceKeyTests.cs
@@ -35,11 +35,9 @@ public async Task CanCreateUpdateAndDeleteTranslation() {
         // Arrange
         var handler = new UpdateResourceKeyCommandHandler(resourceUnitOfWork, new NullLogger<UpdateResourceKeyCommandHandler>());
         var rk = new ResourceKey() { ResourceSet = _resourceSet, Id ="DeRemove" };
-        var translations = new Dictionary<string, string> {
-            { "en-GB", "lsmf" },
-            { "it", "xyz" }
-        };
-        var command = new UpdateResourceKeyCommand(rk, translations.ToImmutableDictionary());
+
+        var translations = ImmutableList.Create(new Translation("en-GB", "lsmf"), new Translation("it", "xyz", "abc"));
+        var command = new UpdateResourceKeyCommand(rk, translations);
 
         // Act
         await handler.HandleAsync(command, CancellationToken.None).ConfigureAwait(false);
@@ -49,6 +47,7 @@ public async Task CanCreateUpdateAndDeleteTranslation() {
         Assert.AreEqual(2, rsc.Count);
         Assert.AreEqual("lsmf", rsc.SingleOrDefault(r => r.Language == "en-GB")?.Value);
         Assert.AreEqual("xyz", rsc.SingleOrDefault(r => r.Language == "it")?.Value);
+        Assert.AreEqual("abc", rsc.SingleOrDefault(r => r.Language == "it")?.Comment);
     }
 
     [TestMethod]
@@ -58,11 +57,8 @@ public async Task CanCreateLogs() {
         var logger = loggerFactory.CreateLogger<UpdateResourceKeyCommandHandler>();
         var handler = new UpdateResourceKeyCommandHandler(resourceUnitOfWork, logger);
         var rk = new ResourceKey() { ResourceSet = _resourceSet, Id ="LogTest" };
-        var translations = new Dictionary<string, string> {
-            { "en-GB", "lsmf" },
-            { "it", "xyz" }
-        };
-        var command = new UpdateResourceKeyCommand(rk, translations.ToImmutableDictionary());
+        var translations = ImmutableList.Create(new Translation("en-GB", "lsmf"), new Translation("it", "xyz"));
+        var command = new UpdateResourceKeyCommand(rk, translations);
 
         // Act
         await handler.HandleAsync(command, CancellationToken.None).ConfigureAwait(false);

diff --git a/idee5.Globalization/Commands/UpdateResourceKeyCommand.cs b/idee5.Globalization/Commands/UpdateResourceKeyCommand.cs
@@ -10,13 +10,13 @@ namespace idee5.Globalization.Commands;
 /// The update resource key command
 /// </summary>
 public record UpdateResourceKeyCommand : ResourceKey {
-    public UpdateResourceKeyCommand(ResourceKey original, ImmutableDictionary<string, string> translations) : base(original) {
+    public UpdateResourceKeyCommand(ResourceKey original, ImmutableList<Translation> translations) : base(original) {
         Translations = translations ?? throw new ArgumentNullException(nameof(translations));
     }
 
     /// <summary>
     /// Translations of the <see cref="ResourceKey">.
     /// The dictionary key is the <see cref="Resource.Language"/>, the value is the <see cref="Resource.Value"/>
     /// </summary>
-    public ImmutableDictionary<string, string> Translations { get; set; }
+    public ImmutableList<Translation> Translations { get; set; }
 }
diff --git a/idee5.Globalization/Commands/UpdateResourceKeyCommandHandler.cs b/idee5.Globalization/Commands/UpdateResourceKeyCommandHandler.cs
@@ -33,11 +33,11 @@ public async Task HandleAsync(UpdateResourceKeyCommand command, CancellationToke
         };
         // first remove all missing translations
         _logger.RemovingTranslations();
-        await _unitOfWork.ResourceRepository.RemoveAsync(Specifications.OfResourceKey(baseResource) & !Specifications.TranslatedTo(command.Translations.Keys), cancellationToken).ConfigureAwait(false);
+        await _unitOfWork.ResourceRepository.RemoveAsync(Specifications.OfResourceKey(baseResource) & !Specifications.TranslatedTo(command.Translations.Select(t => t.Language)), cancellationToken).ConfigureAwait(false);
 
         // then update or add the given translations
         foreach (var translation in command.Translations) {
-            Resource rsc = baseResource with { Language = translation.Key, Value = translation.Value };
+            Resource rsc = baseResource with { Language = translation.Language, Value = translation.Value, Comment = translation.Comment };
             _logger.CreateOrUpdateResource(rsc);
             await _unitOfWork.ResourceRepository.UpdateOrAddAsync(rsc, cancellationToken).ConfigureAwait(false);
         }

diff --git a/idee5.Globalization/Models/Translation.cs b/idee5.Globalization/Models/Translation.cs
@@ -0,0 +1,9 @@
+namespace idee5.Globalization.Models;
+
+/// <summary>
+/// The translation
+/// </summary>
+/// <param name="Language">Language id according to BCP 47 http://tools.ietf.org/html/bcp47</param>
+/// <param name="Value">Value of the resource for the specified culture and parlance</param>
+/// <param name="Comment">Additional information. Mostly used to create semantic context to simplify translations</param>
+public record Translation(string Language, string Value, string? Comment = null);
diff --git a/idee5.Globalization/idee5.Globalization.csproj b/idee5.Globalization/idee5.Globalization.csproj
@@ -13,9 +13,9 @@
     <Description>Globalization extensions. Enables database support for localization resources and parlances for industries and customers..</Description>
     <Company>idee5</Company>
     <Copyright>© idee5 2016 - 2024</Copyright>
-    <Version>3.5.0</Version>
+    <Version>3.5.1</Version>
     <PackageTags>idee5, Globalization, Localization</PackageTags>
-    <PackageReleaseNotes>Update resource key added</PackageReleaseNotes>
+    <PackageReleaseNotes>Update resource key with comment support</PackageReleaseNotes>
     <Nullable>enable</Nullable>
     <Authors>Bernd Dongus</Authors>
     <Title>Globalization tool for parlances for industries and customers</Title>