Merge pull request #1875 from jnyrup/ImproveNumericDifference

Improve difference calculation of overflowing integrals
fluentassertions · Apr 3, 2022 · ef914ec · ef914ec
2 parents f9b57ae + 4f4a96f
commit ef914ec
Show file tree

Hide file tree

Showing 24 changed files with 141 additions and 183 deletions.
diff --git a/Src/FluentAssertions/Numeric/ByteAssertions.cs b/Src/FluentAssertions/Numeric/ByteAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,10 +14,10 @@ internal ByteAssertions(byte value)
         {
         }
 
-        private protected override byte? CalculateDifferenceForFailureMessage(byte expected)
+        private protected override string CalculateDifferenceForFailureMessage(byte subject, byte expected)
         {
-            var difference = (byte?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/DecimalAssertions.cs b/Src/FluentAssertions/Numeric/DecimalAssertions.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,12 +15,12 @@ internal DecimalAssertions(decimal value)
         {
         }
 
-        private protected override decimal? CalculateDifferenceForFailureMessage(decimal expected)
+        private protected override string CalculateDifferenceForFailureMessage(decimal subject, decimal expected)
         {
             try
             {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
+                decimal difference = checked(subject - expected);
+                return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
             }
             catch (OverflowException)
             {

diff --git a/Src/FluentAssertions/Numeric/DoubleAssertions.cs b/Src/FluentAssertions/Numeric/DoubleAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -15,10 +16,10 @@ internal DoubleAssertions(double value)
 
         private protected override bool IsNaN(double value) => double.IsNaN(value);
 
-        private protected override double? CalculateDifferenceForFailureMessage(double expected)
+        private protected override string CalculateDifferenceForFailureMessage(double subject, double expected)
         {
-            var difference = Subject - expected;
-            return difference != 0 ? difference : null;
+            var difference = subject - expected;
+            return difference != 0 ? difference.ToString("R", CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/Int16Assertions.cs b/Src/FluentAssertions/Numeric/Int16Assertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,15 +14,15 @@ internal Int16Assertions(short value)
         {
         }
 
-        private protected override short? CalculateDifferenceForFailureMessage(short expected)
+        private protected override string CalculateDifferenceForFailureMessage(short subject, short expected)
         {
-            if (Subject < 10 && expected < 10)
+            if (subject < 10 && expected < 10)
             {
                 return null;
             }
 
-            var difference = (short?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/Int32Assertions.cs b/Src/FluentAssertions/Numeric/Int32Assertions.cs
@@ -1,5 +1,5 @@
-using System;
-using System.Diagnostics;
+using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,22 +14,15 @@ internal Int32Assertions(int value)
         {
         }
 
-        private protected override int? CalculateDifferenceForFailureMessage(int expected)
+        private protected override string CalculateDifferenceForFailureMessage(int subject, int expected)
         {
-            if (Subject is > 0 and < 10 && expected is > 0 and < 10)
+            if (subject is > 0 and < 10 && expected is > 0 and < 10)
             {
                 return null;
             }
 
-            try
-            {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
-            }
-            catch (OverflowException)
-            {
-                return null;
-            }
+            long difference = (long)subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/Int64Assertions.cs b/Src/FluentAssertions/Numeric/Int64Assertions.cs
@@ -1,5 +1,5 @@
-using System;
-using System.Diagnostics;
+using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,22 +14,15 @@ internal Int64Assertions(long value)
         {
         }
 
-        private protected override long? CalculateDifferenceForFailureMessage(long expected)
+        private protected override string CalculateDifferenceForFailureMessage(long subject, long expected)
         {
-            if (Subject is > 0 and < 10 && expected is > 0 and < 10)
+            if (subject is > 0 and < 10 && expected is > 0 and < 10)
             {
                 return null;
             }
 
-            try
-            {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
-            }
-            catch (OverflowException)
-            {
-                return null;
-            }
+            decimal difference = (decimal)subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableByteAssertions.cs b/Src/FluentAssertions/Numeric/NullableByteAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,10 +14,10 @@ internal NullableByteAssertions(byte? value)
         {
         }
 
-        private protected override byte? CalculateDifferenceForFailureMessage(byte expected)
+        private protected override string CalculateDifferenceForFailureMessage(byte subject, byte expected)
         {
-            var difference = (byte?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableDecimalAssertions.cs b/Src/FluentAssertions/Numeric/NullableDecimalAssertions.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,12 +15,12 @@ internal NullableDecimalAssertions(decimal? value)
         {
         }
 
-        private protected override decimal? CalculateDifferenceForFailureMessage(decimal expected)
+        private protected override string CalculateDifferenceForFailureMessage(decimal subject, decimal expected)
         {
             try
             {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
+                decimal difference = checked(subject - expected);
+                return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
             }
             catch (OverflowException)
             {

diff --git a/Src/FluentAssertions/Numeric/NullableDoubleAssertions.cs b/Src/FluentAssertions/Numeric/NullableDoubleAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -15,10 +16,10 @@ internal NullableDoubleAssertions(double? value)
 
         private protected override bool IsNaN(double value) => double.IsNaN(value);
 
-        private protected override double? CalculateDifferenceForFailureMessage(double expected)
+        private protected override string CalculateDifferenceForFailureMessage(double subject, double expected)
         {
-            var difference = Subject - expected;
-            return difference != 0 ? difference : null;
+            double difference = subject - expected;
+            return difference != 0 ? difference.ToString("R", CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableInt16Assertions.cs b/Src/FluentAssertions/Numeric/NullableInt16Assertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,15 +14,15 @@ internal NullableInt16Assertions(short? value)
         {
         }
 
-        private protected override short? CalculateDifferenceForFailureMessage(short expected)
+        private protected override string CalculateDifferenceForFailureMessage(short subject, short expected)
         {
-            if (Subject < 10 && expected < 10)
+            if (subject < 10 && expected < 10)
             {
                 return null;
             }
 
-            var difference = (short?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableInt32Assertions.cs b/Src/FluentAssertions/Numeric/NullableInt32Assertions.cs
@@ -1,5 +1,5 @@
-using System;
-using System.Diagnostics;
+using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,22 +14,15 @@ internal NullableInt32Assertions(int? value)
         {
         }
 
-        private protected override int? CalculateDifferenceForFailureMessage(int expected)
+        private protected override string CalculateDifferenceForFailureMessage(int subject, int expected)
         {
-            if (Subject is > 0 and < 10 && expected is > 0 and < 10)
+            if (subject is > 0 and < 10 && expected is > 0 and < 10)
             {
                 return null;
             }
 
-            try
-            {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
-            }
-            catch (OverflowException)
-            {
-                return null;
-            }
+            long difference = (long)subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableInt64Assertions.cs b/Src/FluentAssertions/Numeric/NullableInt64Assertions.cs
@@ -1,5 +1,5 @@
-using System;
-using System.Diagnostics;
+using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -14,22 +14,15 @@ internal NullableInt64Assertions(long? value)
         {
         }
 
-        private protected override long? CalculateDifferenceForFailureMessage(long expected)
+        private protected override string CalculateDifferenceForFailureMessage(long subject, long expected)
         {
-            if (Subject is > 0 and < 10 && expected is > 0 and < 10)
+            if (subject is > 0 and < 10 && expected is > 0 and < 10)
             {
                 return null;
             }
 
-            try
-            {
-                var difference = checked(Subject - expected);
-                return difference != 0 ? difference : null;
-            }
-            catch (OverflowException)
-            {
-                return null;
-            }
+            decimal difference = (decimal)subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableSByteAssertions.cs b/Src/FluentAssertions/Numeric/NullableSByteAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,10 +14,10 @@ internal NullableSByteAssertions(sbyte? value)
         {
         }
 
-        private protected override sbyte? CalculateDifferenceForFailureMessage(sbyte expected)
+        private protected override string CalculateDifferenceForFailureMessage(sbyte subject, sbyte expected)
         {
-            var difference = (sbyte?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableSingleAssertions.cs b/Src/FluentAssertions/Numeric/NullableSingleAssertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -15,10 +16,10 @@ internal NullableSingleAssertions(float? value)
 
         private protected override bool IsNaN(float value) => float.IsNaN(value);
 
-        private protected override float? CalculateDifferenceForFailureMessage(float expected)
+        private protected override string CalculateDifferenceForFailureMessage(float subject, float expected)
         {
-            var difference = Subject - expected;
-            return difference != 0 ? difference : null;
+            float difference = subject - expected;
+            return difference != 0 ? difference.ToString("R", CultureInfo.InvariantCulture) : null;
         }
     }
 }
diff --git a/Src/FluentAssertions/Numeric/NullableUInt16Assertions.cs b/Src/FluentAssertions/Numeric/NullableUInt16Assertions.cs
@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Globalization;
 
 namespace FluentAssertions.Numeric
 {
@@ -13,15 +14,15 @@ internal NullableUInt16Assertions(ushort? value)
         {
         }
 
-        private protected override ushort? CalculateDifferenceForFailureMessage(ushort expected)
+        private protected override string CalculateDifferenceForFailureMessage(ushort subject, ushort expected)
         {
-            if (Subject < 10 && expected < 10)
+            if (subject < 10 && expected < 10)
             {
                 return null;
             }
 
-            var difference = (ushort?)(Subject - expected);
-            return difference != 0 ? difference : null;
+            int difference = subject - expected;
+            return difference != 0 ? difference.ToString(CultureInfo.InvariantCulture) : null;
         }
     }
 }