use null instead of empty string when formatting

pwelter34 · pwelter34 · commit b1d40f516311 · 2025-02-19T10:46:29.000-06:00
diff --git a/src/EntityChange/EntityComparer.cs b/src/EntityChange/EntityComparer.cs
@@ -406,14 +406,14 @@ private void CreateChange(
         _changes.Add(changeRecord);
     }
 
-    private static string FormatValue(object? value, Func<object?, string?>? formatter)
+    private static string? FormatValue(object? value, Func<object?, string?>? formatter)
     {
         if (value is null)
-            return string.Empty;
+            return null;
 
         if (formatter is not null)
-            return formatter(value) ?? string.Empty;
+            return formatter(value);
 
-        return value?.ToString() ?? string.Empty;
+        return value?.ToString();
     }
 }
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionAddItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionAddItemTest.verified.txt
@@ -28,7 +28,6 @@
       Quanity: 1,
       UnitPrice: 5000.0
     },
-    OriginalFormatted: ,
     CurrentFormatted: EntityChange.Tests.Models.OrderLine
   },
   {
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionRemoveItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionRemoveItemTest.verified.txt
@@ -29,8 +29,7 @@
       Quanity: 1,
       UnitPrice: 5000.0
     },
-    OriginalFormatted: EntityChange.Tests.Models.OrderLine,
-    CurrentFormatted: 
+    OriginalFormatted: EntityChange.Tests.Models.OrderLine
   },
   {
     PropertyName: Total,
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionRemoveTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionRemoveTest.verified.txt
@@ -19,8 +19,7 @@
       Quanity: 1,
       UnitPrice: 5000.0
     },
-    OriginalFormatted: abc-123,
-    CurrentFormatted: 
+    OriginalFormatted: abc-123
   },
   {
     PropertyName: Total,
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionReplaceTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareCollectionReplaceTest.verified.txt
@@ -18,7 +18,6 @@
       Quanity: 1,
       UnitPrice: 5000.0
     },
-    OriginalFormatted: ,
     CurrentFormatted: abc-123
   },
   {
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareComplexCompareTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareComplexCompareTest.verified.txt
@@ -5,8 +5,7 @@
     Path: Roles,
     Operation: Remove,
     OriginalValue: Administrator,
-    OriginalFormatted: Administrator,
-    CurrentFormatted: 
+    OriginalFormatted: Administrator
   },
   {
     PropertyName: Address,
@@ -25,7 +24,6 @@
     CurrentValue: {
       Address: user@home.com
     },
-    OriginalFormatted: ,
     CurrentFormatted: user@home.com
   },
   {
@@ -73,7 +71,6 @@
     DisplayName: Categories,
     Path: Categories[2],
     CurrentValue: Blah,
-    OriginalFormatted: ,
     CurrentFormatted: Blah
   },
   {
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryAddItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryAddItemTest.verified.txt
@@ -4,7 +4,6 @@
     DisplayName: Data,
     Path: Data[Path],
     CurrentValue: ./home,
-    OriginalFormatted: ,
     CurrentFormatted: ./home
   }
 ]
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryRemoveItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryRemoveItemTest.verified.txt
@@ -5,7 +5,6 @@
     Path: Data[Path],
     Operation: Remove,
     OriginalValue: ./home,
-    OriginalFormatted: ./home,
-    CurrentFormatted: 
+    OriginalFormatted: ./home
   }
 ]
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryRemoveTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryRemoveTest.verified.txt
@@ -5,7 +5,6 @@
     Path: Data[Boost],
     Operation: Remove,
     OriginalValue: 1,
-    OriginalFormatted: 1,
-    CurrentFormatted: 
+    OriginalFormatted: 1
   }
 ]
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryReplaceTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareDictionaryReplaceTest.verified.txt
@@ -4,7 +4,6 @@
     DisplayName: Data,
     Path: Data[Boost],
     CurrentValue: 1,
-    OriginalFormatted: ,
     CurrentFormatted: 1
   }
 ]
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectNewObjectTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectNewObjectTest.verified.txt
@@ -20,7 +20,6 @@
       State: NY,
       Zip: 10026
     },
-    OriginalFormatted: ,
     CurrentFormatted: 123 Main St, New York, NY 10026
   },
   {
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectNewPropertyTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectNewPropertyTest.verified.txt
@@ -15,7 +15,6 @@
     Path: BillingAddress.Address2,
     Operation: Replace,
     CurrentValue: Suite 101,
-    OriginalFormatted: ,
     CurrentFormatted: Suite 101
   },
   {
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectRemoveObjectTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectRemoveObjectTest.verified.txt
@@ -20,8 +20,7 @@
       State: NY,
       Zip: 10026
     },
-    OriginalFormatted: 123 Main St, New York, NY 10026,
-    CurrentFormatted: 
+    OriginalFormatted: 123 Main St, New York, NY 10026
   },
   {
     PropertyName: Total,
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectRemovePropertyTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareObjectRemovePropertyTest.verified.txt
@@ -15,8 +15,7 @@
     Path: BillingAddress.Address2,
     Operation: Replace,
     OriginalValue: Suite 101,
-    OriginalFormatted: Suite 101,
-    CurrentFormatted: 
+    OriginalFormatted: Suite 101
   },
   {
     PropertyName: Zip,
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareSetAddItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareSetAddItemTest.verified.txt
@@ -4,7 +4,6 @@
     DisplayName: Categories,
     Path: Categories[2],
     CurrentValue: Blah,
-    OriginalFormatted: ,
     CurrentFormatted: Blah
   }
 ]
diff --git a/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareSetRemoveItemTest.verified.txt b/test/EntityChange.Tests/Snapshots/EntityCompareTests.CompareSetRemoveItemTest.verified.txt
@@ -5,7 +5,6 @@
     Path: Categories[2],
     Operation: Remove,
     OriginalValue: Blah,
-    OriginalFormatted: Blah,
-    CurrentFormatted: 
+    OriginalFormatted: Blah
   }
 ]

Original file line number	Diff line number	Diff line change
`@@ -406,14 +406,14 @@ private void CreateChange(`
`406`	`406`	`_changes.Add(changeRecord);`
`407`	`407`	`}`
`408`	`408`
`409`		`- private static string FormatValue(object? value, Func<object?, string?>? formatter)`
	`409`	`+ private static string? FormatValue(object? value, Func<object?, string?>? formatter)`
`410`	`410`	`{`
`411`	`411`	`if (value is null)`
`412`		`- return string.Empty;`
	`412`	`+ return null;`
`413`	`413`
`414`	`414`	`if (formatter is not null)`
`415`		`- return formatter(value) ?? string.Empty;`
	`415`	`+ return formatter(value);`
`416`	`416`
`417`		`- return value?.ToString() ?? string.Empty;`
	`417`	`+ return value?.ToString();`
`418`	`418`	`}`
`419`	`419`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@`
`28`	`28`	`Quanity: 1,`
`29`	`29`	`UnitPrice: 5000.0`
`30`	`30`	`},`
`31`		`- OriginalFormatted: ,`
`32`	`31`	`CurrentFormatted: EntityChange.Tests.Models.OrderLine`
`33`	`32`	`},`
`34`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@`
`18`	`18`	`Quanity: 1,`
`19`	`19`	`UnitPrice: 5000.0`
`20`	`20`	`},`
`21`		`- OriginalFormatted: ,`
`22`	`21`	`CurrentFormatted: abc-123`
`23`	`22`	`},`
`24`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`DisplayName: Data,`
`5`	`5`	`Path: Data[Path],`
`6`	`6`	`CurrentValue: ./home,`
`7`		`- OriginalFormatted: ,`
`8`	`7`	`CurrentFormatted: ./home`
`9`	`8`	`}`
`10`	`9`	`]`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`Path: Data[Path],`
`6`	`6`	`Operation: Remove,`
`7`	`7`	`OriginalValue: ./home,`
`8`		`- OriginalFormatted: ./home,`
`9`		`- CurrentFormatted:`
	`8`	`+ OriginalFormatted: ./home`
`10`	`9`	`}`
`11`	`10`	`]`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`Path: Data[Boost],`
`6`	`6`	`Operation: Remove,`
`7`	`7`	`OriginalValue: 1,`
`8`		`- OriginalFormatted: 1,`
`9`		`- CurrentFormatted:`
	`8`	`+ OriginalFormatted: 1`
`10`	`9`	`}`
`11`	`10`	`]`