Merge pull request #58 from RealAshampoo/develop

Header information when Building a format
Ashampoo · Feb 15, 2023 · 9e41f7c · 9e41f7c
2 parents 34813d8 + e46fe99
commit 9e41f7c
Show file tree

Hide file tree

Showing 29 changed files with 214 additions and 44 deletions.
diff --git a/...shampoo.Translation.Systems.Components/src/Ashampoo.Translation.Systems.Components.csproj b/...shampoo.Translation.Systems.Components/src/Ashampoo.Translation.Systems.Components.csproj
@@ -24,7 +24,7 @@
     <ItemGroup>
         <PackageReference Include="MediatR" Version="11.0.0" />
         <PackageReference Include="MediatR.Extensions.Microsoft.DependencyInjection" Version="11.0.0" />
-        <PackageReference Include="MudBlazor" Version="6.1.2" />
+        <PackageReference Include="MudBlazor" Version="6.1.8" />
     </ItemGroup>
     <ItemGroup>
         <ProjectReference Include="..\..\Ashampoo.Translation.Systems.Formats.Abstractions\src\Ashampoo.Translation.Systems.Formats.Abstractions.csproj" />
@@ -38,7 +38,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>

diff --git a/...Systems.Formats.Abstractions/src/Ashampoo.Translation.Systems.Formats.Abstractions.csproj b/...Systems.Formats.Abstractions/src/Ashampoo.Translation.Systems.Formats.Abstractions.csproj
@@ -18,7 +18,7 @@
         <PackageIcon>ash-logo-icon-big-128x.png</PackageIcon>
         <MinVerTagPrefix>v</MinVerTagPrefix>
         <MinVerIgnoreHeight>true</MinVerIgnoreHeight>
-        <MinVerDefaultPreReleasePhase>prerelease</MinVerDefaultPreReleasePhase>
+        <MinVerDefaultPreReleaseIdentifiers>prerelease.0</MinVerDefaultPreReleaseIdentifiers>
     </PropertyGroup>
 
     <ItemGroup>
@@ -28,14 +28,14 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
           <PrivateAssets>all</PrivateAssets>
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="CommunityToolkit.Diagnostics" Version="8.0.0" />
+        <PackageReference Include="CommunityToolkit.Diagnostics" Version="8.1.0" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
     </ItemGroup>

diff --git a/src/Ashampoo.Translation.Systems.Formats.Abstractions/src/FormatExtensions.cs b/src/Ashampoo.Translation.Systems.Formats.Abstractions/src/FormatExtensions.cs
@@ -170,7 +170,7 @@ private static async Task<IFormat> BuildWithSourceAndTarget
         AssignOptions options
     )
     {
-        if (!await ConfigureOptions(false, options)) throw new InvalidOperationException();
+        if (!await ConfigureOptions(true, options)) throw new InvalidOperationException();
         var filter = options.Filter ?? new DefaultTranslationFilter();
 
         var targetLanguage = options.TargetLanguage;
@@ -181,6 +181,7 @@ AssignOptions options
 
         formatBuilder.SetTargetLanguage(targetLanguage);
         formatBuilder.SetSourceLanguage(sourceLanguage);
+        formatBuilder.SetHeaderInformation(format.Header);
 
         foreach (var unit in format)
         {

diff --git a/src/Ashampoo.Translation.Systems.Formats.Abstractions/src/IFormatBuilder.cs b/src/Ashampoo.Translation.Systems.Formats.Abstractions/src/IFormatBuilder.cs
@@ -12,4 +12,25 @@ public interface IFormatBuilder
     /// The instance of <see cref="IFormat"/>.
     /// </returns>
     IFormat Build();
+
+
+    /// <summary>
+    /// Set the header information. All information will be added to the header and will overwrite
+    /// existing information. All previous information will be removed.
+    /// </summary>
+    /// <param name="header">
+    /// The <see cref="IFormatHeader"/> containing the information.
+    /// </param>
+    void SetHeaderInformation(IFormatHeader header);
+
+    /// <summary>
+    /// Add a header information. If the key already exists, the value will be overwritten.
+    /// </summary>
+    /// <param name="key">
+    /// The key of the information.
+    /// </param>
+    /// <param name="value">
+    /// The value of the information.
+    /// </param>
+    void AddHeaderInformation(string key, string value);
 }
diff --git a/...Formats.Abstractions/tests/Ashampoo.Translation.Systems.Formats.Abstractions.Tests.csproj b/...Formats.Abstractions/tests/Ashampoo.Translation.Systems.Formats.Abstractions.Tests.csproj
@@ -5,7 +5,7 @@
         <IsPackable>false</IsPackable>
     </PropertyGroup>
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.2" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

diff --git a/src/Ashampoo.Translation.Systems.Formats.AshLang/src/AshLangFormatBuilder.cs b/src/Ashampoo.Translation.Systems.Formats.AshLang/src/AshLangFormatBuilder.cs
@@ -13,6 +13,7 @@ public class AshLangFormatBuilder : IFormatBuilderWithSourceAndTarget
     private const string SourceLanguage = "en-US"; // AshLang source is always in English
     private string? targetLanguage;
     private readonly Dictionary<string, (string source, string target)> translations = new();
+    private Dictionary<string, string> information = new();
 
     /// <inheritdoc />
     public IFormat Build()
@@ -26,6 +27,14 @@ public IFormat Build()
                 TargetLanguage = targetLanguage
             }
         };
+
+        var appIdChunk = ashLang.Chunks.OfType<AppIdChunk>().FirstOrDefault();
+        if ( appIdChunk is not null && information.TryGetValue("Name", out var name))
+        {
+            appIdChunk.Name = name;
+            information.Remove("Name");
+        }
+
         var translationChunk = (TranslationChunk)ashLang.Chunks.Last();
 
         foreach (var (id, (source, target)) in translations)
@@ -62,4 +71,16 @@ public void SetTargetLanguage(string language)
     {
         targetLanguage = language;
     }
+
+    /// <inheritdoc />
+    public void SetHeaderInformation(IFormatHeader header)
+    {
+        information = new Dictionary<string, string>(header);
+    }
+
+    /// <inheritdoc />
+    public void AddHeaderInformation(string key, string value)
+    {
+        information.Add(key, value);
+    }
 }
diff --git a/src/Ashampoo.Translation.Systems.Formats.AshLang/src/AshLangFormatHeader.cs b/src/Ashampoo.Translation.Systems.Formats.AshLang/src/AshLangFormatHeader.cs
@@ -116,7 +116,7 @@ public void CopyTo(KeyValuePair<string, string>[] array, int arrayIndex)
     /// <inheritdoc />
     public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
     {
-        throw new NotImplementedException();
+        return XDataChunk.GetEnumerator();
     }
 
     /// <inheritdoc />
@@ -139,6 +139,6 @@ public bool TryGetValue(string key, [MaybeNullWhen(false)] out string value)
 
     IEnumerator IEnumerable.GetEnumerator()
     {
-        throw new NotImplementedException();
+        return XDataChunk.GetEnumerator();
     }
 }
diff --git a/...anslation.Systems.Formats.AshLang/src/Ashampoo.Translation.Systems.Formats.AshLang.csproj b/...anslation.Systems.Formats.AshLang/src/Ashampoo.Translation.Systems.Formats.AshLang.csproj
@@ -18,7 +18,7 @@
         <PackageIcon>ash-logo-icon-big-128x.png</PackageIcon>
         <MinVerTagPrefix>v</MinVerTagPrefix>
         <MinVerIgnoreHeight>true</MinVerIgnoreHeight>
-        <MinVerDefaultPreReleasePhase>prerelease</MinVerDefaultPreReleasePhase>
+        <MinVerDefaultPreReleaseIdentifiers>prerelease.0</MinVerDefaultPreReleaseIdentifiers>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
@@ -34,7 +34,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>

diff --git a/...n.Systems.Formats.AshLang/tests/Ashampoo.Translation.Systems.Formats.AshLang.Tests.csproj b/...n.Systems.Formats.AshLang/tests/Ashampoo.Translation.Systems.Formats.AshLang.Tests.csproj
@@ -6,9 +6,9 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.2" />
-        <PackageReference Include="Xunit.DependencyInjection" Version="8.6.1" />
+        <PackageReference Include="Xunit.DependencyInjection" Version="8.7.0" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>

diff --git a/...o.Translation.Systems.Formats.Gengo/src/Ashampoo.Translation.Systems.Formats.Gengo.csproj b/...o.Translation.Systems.Formats.Gengo/src/Ashampoo.Translation.Systems.Formats.Gengo.csproj
@@ -18,7 +18,7 @@
         <PackageIcon>ash-logo-icon-big-128x.png</PackageIcon>
         <MinVerTagPrefix>v</MinVerTagPrefix>
         <MinVerIgnoreHeight>true</MinVerIgnoreHeight>
-        <MinVerDefaultPreReleasePhase>prerelease</MinVerDefaultPreReleasePhase>
+        <MinVerDefaultPreReleaseIdentifiers>prerelease.0</MinVerDefaultPreReleaseIdentifiers>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
@@ -28,7 +28,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.Toolkit.Diagnostics" Version="7.1.2" />
-        <PackageReference Include="NPOI" Version="2.5.6" />
+        <PackageReference Include="NPOI" Version="2.6.0" />
     </ItemGroup>
 
     <ItemGroup>
@@ -39,7 +39,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>

diff --git a/src/Ashampoo.Translation.Systems.Formats.Gengo/src/GengoFormatBuilder.cs b/src/Ashampoo.Translation.Systems.Formats.Gengo/src/GengoFormatBuilder.cs
@@ -40,9 +40,11 @@ public IFormat Build()
         foreach (var keyValuePair in translations)
         {
             var sourceTranslationString =
-                new DefaultTranslationString(keyValuePair.Key, keyValuePair.Value.Item1, sourceLanguage); //Create new translation string
+                new DefaultTranslationString(keyValuePair.Key, keyValuePair.Value.Item1,
+                    sourceLanguage); //Create new translation string
             var targetTranslationString =
-                new DefaultTranslationString(keyValuePair.Key, keyValuePair.Value.Item2, targetLanguage); //Create new translation string
+                new DefaultTranslationString(keyValuePair.Key, keyValuePair.Value.Item2,
+                    targetLanguage); //Create new translation string
 
             var translationUnit = new DefaultTranslationUnit(keyValuePair.Key) //Create new translation unit
             {
@@ -67,4 +69,31 @@ public void SetTargetLanguage(string language)
     {
         targetLanguage = language;
     }
+
+    /// <summary>
+    /// This method is not supported because <see cref="GengoFormat"/> does not support header information,
+    /// it will do nothing.
+    /// </summary>
+    /// <param name="header">
+    /// The <see cref="IFormatHeader"/> containing the information.
+    /// </param>
+    public void SetHeaderInformation(IFormatHeader header)
+    {
+        // Do nothing, Gengo does not support header information
+    }
+
+    /// <summary>
+    /// This method is not supported because <see cref="GengoFormat"/> does not support header information,
+    /// it will do nothing.
+    /// </summary>
+    /// <param name="key">
+    /// The key of the header information.
+    /// </param>
+    /// <param name="value">
+    /// The value of the header information.
+    /// </param>
+    public void AddHeaderInformation(string key, string value)
+    {
+        // Do nothing, Gengo does not support header information
+    }
 }
diff --git a/...ation.Systems.Formats.Gengo/tests/Ashampoo.Translation.Systems.Formats.Gengo.Tests.csproj b/...ation.Systems.Formats.Gengo/tests/Ashampoo.Translation.Systems.Formats.Gengo.Tests.csproj
@@ -5,9 +5,9 @@
         <IsPackable>false</IsPackable>
     </PropertyGroup>
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.2" />
-        <PackageReference Include="Xunit.DependencyInjection" Version="8.6.1" />
+        <PackageReference Include="Xunit.DependencyInjection" Version="8.7.0" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>

diff --git a/...poo.Translation.Systems.Formats.Json/src/Ashampoo.Translation.Systems.Formats.Json.csproj b/...poo.Translation.Systems.Formats.Json/src/Ashampoo.Translation.Systems.Formats.Json.csproj
@@ -18,7 +18,7 @@
         <PackageIcon>ash-logo-icon-big-128x.png</PackageIcon>
         <MinVerTagPrefix>v</MinVerTagPrefix>
         <MinVerIgnoreHeight>true</MinVerIgnoreHeight>
-        <MinVerDefaultPreReleasePhase>prerelease</MinVerDefaultPreReleasePhase>
+        <MinVerDefaultPreReleaseIdentifiers>prerelease.0</MinVerDefaultPreReleaseIdentifiers>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
@@ -34,7 +34,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>

diff --git a/src/Ashampoo.Translation.Systems.Formats.Json/src/JsonFormatBuilder.cs b/src/Ashampoo.Translation.Systems.Formats.Json/src/JsonFormatBuilder.cs
@@ -43,6 +43,25 @@ public IFormat Build()
         return jsonFormat;
     }
 
+    /// <summary>
+    /// This method does nothing, because JsonFormat does not support header information.
+    /// </summary>
+    /// <param name="header"></param>
+    public void SetHeaderInformation(IFormatHeader header)
+    {
+        // Do nothing, JsonFormat does not support header information
+    }
+
+    /// <summary>
+    /// This method does nothing, because JsonFormat does not support header information.
+    /// </summary>
+    /// <param name="key"></param>
+    /// <param name="value"></param>
+    public void AddHeaderInformation(string key, string value)
+    {
+        // Do nothing, JsonFormat does not support header information
+    }
+
     /// <inheritdoc />
     public void SetTargetLanguage(string language)
     {

diff --git a/...slation.Systems.Formats.Json/tests/Ashampoo.Translation.Systems.Formats.Json.Tests.csproj b/...slation.Systems.Formats.Json/tests/Ashampoo.Translation.Systems.Formats.Json.Tests.csproj
@@ -5,9 +5,9 @@
         <IsPackable>false</IsPackable>
     </PropertyGroup>
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.2" />
-        <PackageReference Include="Xunit.DependencyInjection" Version="8.6.1" />
+        <PackageReference Include="Xunit.DependencyInjection" Version="8.7.0" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>

diff --git a/...o.Translation.Systems.Formats.NLang/src/Ashampoo.Translation.Systems.Formats.NLang.csproj b/...o.Translation.Systems.Formats.NLang/src/Ashampoo.Translation.Systems.Formats.NLang.csproj
@@ -18,7 +18,7 @@
         <PackageIcon>ash-logo-icon-big-128x.png</PackageIcon>
         <MinVerTagPrefix>v</MinVerTagPrefix>
         <MinVerIgnoreHeight>true</MinVerIgnoreHeight>
-        <MinVerDefaultPreReleasePhase>prerelease</MinVerDefaultPreReleasePhase>
+        <MinVerDefaultPreReleaseIdentifiers>prerelease.0</MinVerDefaultPreReleaseIdentifiers>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
@@ -34,7 +34,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-        <PackageReference Include="MinVer" Version="4.2.0">
+        <PackageReference Include="MinVer" Version="4.3.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>

diff --git a/src/Ashampoo.Translation.Systems.Formats.NLang/src/NLangFormatBuilder.cs b/src/Ashampoo.Translation.Systems.Formats.NLang/src/NLangFormatBuilder.cs
@@ -47,4 +47,23 @@ public void SetTargetLanguage(string language)
     {
         targetLanguage = language;
     }
+
+    /// <summary>
+    /// This method does nothing, because NLangFormat does not support header information.
+    /// </summary>
+    /// <param name="header"></param>
+    public void SetHeaderInformation(IFormatHeader header)
+    {
+        // Do nothing, NLangFormat does not support header information
+    }
+
+    /// <summary>
+    /// This method does nothing, because NLangFormat does not support header information.
+    /// </summary>
+    /// <param name="key"></param>
+    /// <param name="value"></param>
+    public void AddHeaderInformation(string key, string value)
+    {
+        // Do nothing, NLangFormat does not support header information
+    }
 }
diff --git a/...ation.Systems.Formats.NLang/tests/Ashampoo.Translation.Systems.Formats.NLang.Tests.csproj b/...ation.Systems.Formats.NLang/tests/Ashampoo.Translation.Systems.Formats.NLang.Tests.csproj
@@ -5,9 +5,9 @@
         <IsPackable>false</IsPackable>
     </PropertyGroup>
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
         <PackageReference Include="xunit" Version="2.4.2" />
-        <PackageReference Include="Xunit.DependencyInjection" Version="8.6.1" />
+        <PackageReference Include="Xunit.DependencyInjection" Version="8.7.0" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>