Copy Deploy decimal converters for time being

Author: mattbrailsford

src/Umbraco.Commerce.Deploy/Artifacts/ServicePriceArtifact.cs

@@ -1,5 +1,6 @@
 using System.Text.Json.Serialization;
 using Umbraco.Cms.Core;
+using Umbraco.Deploy.Infrastructure.Serialization;
 
 namespace Umbraco.Commerce.Deploy.Artifacts
 {
@@ -9,7 +10,7 @@ public class ServicePriceArtifact
         public GuidUdi? CountryUdi { get; set; }
         public GuidUdi? RegionUdi { get; set; }
 
-        // [JsonConverter(typeof(RoundingDecimalJsonConverter), 3)]
+        [RoundingDecimalConverter(4)]
         public decimal Value { get; set; }
     }
 }

src/Umbraco.Commerce.Deploy/Artifacts/TaxClassArtifact.cs

@@ -1,13 +1,14 @@
 using System.Collections.Generic;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.Deploy;
+using Umbraco.Deploy.Infrastructure.Serialization;
 
 namespace Umbraco.Commerce.Deploy.Artifacts
 {
     public class TaxClassArtifact(GuidUdi? udi, GuidUdi storeUdi, IEnumerable<ArtifactDependency> dependencies = null)
         : StoreEntityArtifactBase(udi, storeUdi, dependencies)
     {
-        // [JsonConverter(typeof(RoundingDecimalJsonConverter), 3)]
+        [RoundingDecimalConverter(3)]
         public decimal DefaultTaxRate { get; set; }
 
         public IEnumerable<CountryRegionTaxRateArtifact>? CountryRegionTaxRates { get; set; }
@@ -21,7 +22,7 @@ public class CountryRegionTaxRateArtifact
 
         public GuidUdi? RegionUdi { get; set; }
 
-        // [JsonConverter(typeof(RoundingDecimalJsonConverter), 3)]
+        [RoundingDecimalConverter(3)]
         public decimal TaxRate { get; set; }
     }
 }

src/Umbraco.Commerce.Deploy/Serialization/RoundingDecimalConverterAttribute.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Deploy.Infrastructure.Serialization;
+
+/// <summary>
+/// Defines an attribute for use with <see cref="RoundingDecimalJsonConverter"/> allowing a parameter
+/// to be passed to define the precision required.
+/// </summary>
+[AttributeUsage(AttributeTargets.Property)]
+public class RoundingDecimalConverterAttribute : JsonConverterAttribute
+{
+    private readonly int _precision;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalConverterAttribute"/> class.
+    /// </summary>
+    /// <param name="precision"></param>
+    public RoundingDecimalConverterAttribute(int precision) => _precision = precision;
+
+    /// <inheritdoc/>
+    public override JsonConverter CreateConverter(Type typeToConvert)
+    {
+        if (typeToConvert != typeof(decimal))
+        {
+            throw new ArgumentException(
+                $"This converter only works with decimal, and it was provided {typeToConvert.Name}.");
+        }
+
+        return new RoundingDecimalJsonConverter(_precision);
+    }
+}

src/Umbraco.Commerce.Deploy/Serialization/RoundingDecimalJsonConverter.cs

@@ -0,0 +1,52 @@
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Deploy.Infrastructure.Serialization;
+
+/// <summary>
+/// Provides a <see cref="JsonConverter"/> for rounding decimal values.
+/// </summary>
+/// <remarks>
+/// The decimal value provided will be rounded to the precision specified.
+/// Unnecessary trailing zeros will be removed (e.g. 1.20 rounded to 2dp will serialize to 1.2).
+/// </remarks>
+public class RoundingDecimalJsonConverter : RoundingDecimalJsonConverterBase<decimal>
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> class using a default precision of 2.
+    /// </summary>
+    public RoundingDecimalJsonConverter()
+        : base(2)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> class using the provided precision.
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    public RoundingDecimalJsonConverter(int precision)
+        : base(precision, MidpointRounding.AwayFromZero)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> classusing the provided precision and midpoint rounding
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    /// <param name="rounding">Required <see cref="MidpointRounding"/>.</param>
+    public RoundingDecimalJsonConverter(int precision, MidpointRounding rounding)
+        : base(precision, rounding)
+    {
+    }
+
+    /// <inheritdoc />
+    public override void Write(Utf8JsonWriter writer, decimal value, JsonSerializerOptions options)
+    {
+        var roundedValue = GetRoundedValue(value);
+
+        roundedValue = RemoveUnnecessaryTrailingZeros(roundedValue);
+
+        JsonSerializer.Serialize(writer, roundedValue, options);
+    }
+}

src/Umbraco.Commerce.Deploy/Serialization/RoundingDecimalJsonConverterBase.cs

@@ -0,0 +1,65 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Deploy.Infrastructure.Serialization;
+
+/// <summary>
+/// Provides base functionality for <see cref="JsonConverter"/>s for rounding decimal values.
+/// </summary>
+/// <typeparam name="T">The type of object or value handled by the converter.</typeparam>
+public abstract class RoundingDecimalJsonConverterBase<T> : WriteOnlyJsonConverter<T>
+{
+    private readonly int _precision;
+    private readonly MidpointRounding _rounding;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> class using a default precision of 2.
+    /// </summary>
+    protected RoundingDecimalJsonConverterBase()
+        : this(2)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> class using the provided precision.
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    protected RoundingDecimalJsonConverterBase(int precision)
+        : this(precision, MidpointRounding.AwayFromZero)
+    { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverter"/> classusing the provided precision and midpoint rounding
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    /// <param name="rounding">Required <see cref="MidpointRounding"/>.</param>
+    public RoundingDecimalJsonConverterBase(int precision, MidpointRounding rounding)
+    {
+        _precision = precision;
+        _rounding = rounding;
+    }
+
+    /// <summary>
+    /// Rounds a decimal value.
+    /// </summary>
+    protected decimal GetRoundedValue(decimal value) => Math.Round(value, _precision, _rounding);
+
+    /// <summary>
+    /// Removes unnecessary trailing zeros from a provided decimal value.
+    /// </summary>
+    protected decimal RemoveUnnecessaryTrailingZeros(decimal roundedValue)
+    {
+        for (int i = _precision - 1; i > 0; i--)
+        {
+            var newRoundedValue = Math.Round(roundedValue, i, _rounding);
+            if (newRoundedValue != roundedValue)
+            {
+                break;
+            }
+
+            roundedValue = newRoundedValue;
+        }
+
+        return roundedValue;
+    }
+}

src/Umbraco.Commerce.Deploy/Serialization/RoundingNullableDecimalConverterAttribute.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Deploy.Infrastructure.Serialization;
+
+/// <summary>
+/// Defines an attribute for use with <see cref="RoundingNullableDecimalJsonConverter"/> allowing a parameter
+/// to be passed to define the precision required.
+/// </summary>
+[AttributeUsage(AttributeTargets.Property)]
+public class RoundingNullableDecimalConverterAttribute : JsonConverterAttribute
+{
+    private readonly int _precision;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingDecimalJsonConverterAttribute"/> class.
+    /// </summary>
+    /// <param name="precision"></param>
+    public RoundingNullableDecimalConverterAttribute(int precision) => _precision = precision;
+
+    /// <inheritdoc/>
+    public override JsonConverter CreateConverter(Type typeToConvert)
+    {
+        if (typeToConvert != typeof(decimal?))
+        {
+            throw new ArgumentException(
+                $"This converter only works with nullable decimal, and it was provided {typeToConvert.Name}.");
+        }
+
+        return new RoundingNullableDecimalJsonConverter(_precision);
+    }
+}

src/Umbraco.Commerce.Deploy/Serialization/RoundingNullableDecimalJsonConverter.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Deploy.Infrastructure.Serialization;
+
+/// <summary>
+/// Provides a <see cref="JsonConverter"/> for rounding decimal values.
+/// </summary>
+/// <remarks>
+/// The decimal value provided will be rounded to the precision specified.
+/// Unnecessary trailing zeros will be removed (e.g. 1.20 rounded to 2dp will serialize to 1.2).
+/// </remarks>
+public class RoundingNullableDecimalJsonConverter : RoundingDecimalJsonConverterBase<decimal?>
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingNullableDecimalJsonConverter"/> class using a default precision of 2.
+    /// </summary>
+    public RoundingNullableDecimalJsonConverter()
+        : base(2)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingNullableDecimalJsonConverter"/> class using the provided precision.
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    public RoundingNullableDecimalJsonConverter(int precision)
+        : base(precision, MidpointRounding.AwayFromZero)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RoundingNullableDecimalJsonConverter"/> classusing the provided precision and midpoint rounding
+    /// </summary>
+    /// <param name="precision">Required rounding precision.</param>
+    /// <param name="rounding">Required <see cref="MidpointRounding"/>.</param>
+    public RoundingNullableDecimalJsonConverter(int precision, MidpointRounding rounding)
+        : base(precision, rounding)
+    {
+    }
+
+    /// <inheritdoc />
+    public override void Write(Utf8JsonWriter writer, decimal? value, JsonSerializerOptions options)
+    {
+        if (!value.HasValue)
+        {
+            writer.WriteNullValue();
+            return;
+        }
+
+        var roundedValue = GetRoundedValue(value.Value);
+
+        roundedValue = RemoveUnnecessaryTrailingZeros(roundedValue);
+
+        JsonSerializer.Serialize(writer, roundedValue, options);
+    }
+}