Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Drop Verwendungszweck
MEHRMINDERMBENGENABRECHNUNG to avoid further …
…undefined behaviour; Add Lenient Converters for Legacy Data/Consistency (#518) --------- Co-authored-by: Konstantin <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains 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 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 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 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 @@ | ||
| using System; | ||
| using BO4E.ENUM; | ||
|
|
||
| namespace BO4E.meta.LenientConverters; | ||
|
|
||
| /// <summary> | ||
| /// Converts 'MEHRMINDERMBENGENABRECHNUNG' (with typo!) to Enum Member <see cref="Verwendungszweck.MEHRMINDERMENGENABRECHNUNG"/>. | ||
| /// </summary> | ||
| public class SystemTextVerwendungszweckStringEnumConverter : System.Text.Json.Serialization.JsonConverter<Verwendungszweck?> | ||
| { | ||
| /// <inheritdoc /> | ||
| public override Verwendungszweck? Read(ref System.Text.Json.Utf8JsonReader reader, Type typeToConvert, | ||
| System.Text.Json.JsonSerializerOptions options) | ||
| { | ||
| if (reader.TokenType == System.Text.Json.JsonTokenType.Null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| if (reader.TokenType == System.Text.Json.JsonTokenType.Number) | ||
| { | ||
| var integerValue = reader.GetInt64(); | ||
| return (Verwendungszweck)Enum.ToObject(typeof(Verwendungszweck), integerValue); | ||
| } | ||
|
|
||
| if (reader.TokenType == System.Text.Json.JsonTokenType.String) | ||
| { | ||
| string enumString = reader.GetString(); | ||
|
|
||
| return enumString switch | ||
| { | ||
| "MEHRMINDERMBENGENABRECHNUNG" => Verwendungszweck.MEHRMINDERMENGENABRECHNUNG, | ||
| _ => Enum.TryParse<Verwendungszweck>(enumString, true, out var result) | ||
| ? result | ||
| : throw new System.Text.Json.JsonException($"Invalid value for {typeToConvert.Name}: {enumString}") | ||
| }; | ||
| } | ||
|
|
||
| throw new System.Text.Json.JsonException($"Unexpected token parsing {typeToConvert.Name}. Expected String or Number, got {reader.TokenType}."); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override void Write(System.Text.Json.Utf8JsonWriter writer, Verwendungszweck? value, | ||
| System.Text.Json.JsonSerializerOptions options) | ||
| { | ||
| if (value is null) | ||
| { | ||
| writer.WriteNullValue(); | ||
| } | ||
| else | ||
| { | ||
| writer.WriteStringValue(value.ToString()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// converts 'MEHRMINDERMBENGENABRECHNUNG' (with typo!) to Enum Member <see cref="Verwendungszweck.MEHRMINDERMENGENABRECHNUNG"/> | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// It is intended, that you use this converter TOGETHER with the <see cref="Newtonsoft.Json.Converters.StringEnumConverter"/>. | ||
| /// In this case you need to add this converter BEFORE the <see cref="Newtonsoft.Json.Converters.StringEnumConverter"/> in the list of converters. | ||
| /// <code> | ||
| /// var settings = new Newtonsoft.Json.JsonSerializerSettings() | ||
| /// { | ||
| /// Converters = { new NewtonsoftVerwendungszweckStringEnumConverter(), new StringEnumConverter() } | ||
| /// }; | ||
| /// </code> | ||
| /// </remarks> | ||
| /// <remarks><seealso cref="SystemTextVerwendungszweckStringEnumConverter"/></remarks> | ||
| public class NewtonsoftVerwendungszweckStringEnumConverter : Newtonsoft.Json.JsonConverter<Verwendungszweck?> | ||
| { | ||
| /// <inheritdoc />> | ||
| public override Verwendungszweck? ReadJson(Newtonsoft.Json.JsonReader reader, Type objectType, | ||
| Verwendungszweck? existingValue, bool hasExistingValue, Newtonsoft.Json.JsonSerializer serializer) | ||
| { | ||
| if (reader.TokenType == Newtonsoft.Json.JsonToken.Null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| if (reader.TokenType == Newtonsoft.Json.JsonToken.Integer) | ||
| { | ||
| var integerValue = Convert.ToInt64(reader.Value); | ||
| return (Verwendungszweck)Enum.ToObject(typeof(Verwendungszweck), integerValue); | ||
| } | ||
|
|
||
| if (reader.TokenType == Newtonsoft.Json.JsonToken.String) | ||
| { | ||
| string enumString = reader.Value.ToString(); | ||
|
|
||
| return enumString switch | ||
| { | ||
| "MEHRMINDERMBENGENABRECHNUNG" => Verwendungszweck.MEHRMINDERMENGENABRECHNUNG, | ||
| _ => Enum.TryParse(enumString, out Verwendungszweck result) | ||
| ? result | ||
| : throw new Newtonsoft.Json.JsonSerializationException( | ||
| $"Invalid value for {objectType}: {enumString}") | ||
| }; | ||
| } | ||
|
|
||
| throw new Newtonsoft.Json.JsonSerializationException("Expected string value."); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override void WriteJson(Newtonsoft.Json.JsonWriter writer, Verwendungszweck? value, | ||
| Newtonsoft.Json.JsonSerializer serializer) | ||
| { | ||
| if (value is null) | ||
| { | ||
| writer.WriteNull(); | ||
| } | ||
| else | ||
| { | ||
| writer.WriteValue(value.ToString()); | ||
| } | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override bool CanWrite => true; | ||
| } |
This file contains 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 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,29 @@ | ||
| using System; | ||
| using System.Linq; | ||
| using System.Reflection; | ||
| using FluentAssertions; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| namespace TestBO4E; | ||
| [TestClass] | ||
| public class TestEnums | ||
| { | ||
| [TestMethod] | ||
| public void No_Two_Enum_Members_Share_The_Same_Integer_Value() | ||
| { | ||
| var arbitraryEnumType = typeof(BO4E.ENUM.Abweichungsgrund); | ||
| var enumAssembly = Assembly.GetAssembly(arbitraryEnumType); | ||
| enumAssembly.Should().NotBeNull(); | ||
| var enumTypesWithDuplicateValues = enumAssembly!.GetTypes() | ||
| .Where(t => t.IsEnum) | ||
| .Where(t => | ||
| { | ||
| var values = Enum.GetValues(t).Cast<int>(); | ||
| var valueGroups = values.GroupBy(v => v).Where(g => g.Count() > 1).ToList(); | ||
| return valueGroups.Any(); | ||
| }) | ||
| .ToList(); | ||
| enumTypesWithDuplicateValues.Should().BeEmpty("this may cause undefined behaviour"); | ||
| // https://github.com/dotnet/runtime/issues/107296#issuecomment-2327881647 | ||
| } | ||
| } |
This file contains 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
