Switch to System.Text.Json (#89)

Co-authored-by: Dan Rigby <[email protected]>

Author: drasticactions

JsonFeedNet.Tests/JsonFeedTests.cs

@@ -11,8 +11,9 @@ public void RoundtripSimple()
         string inputJsonFeed = TestExtensions.GetResourceAsString("Simple.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
 
-        Assert.Equal(inputJsonFeed, outputJsonFeed);
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -21,8 +22,9 @@ public void RoundtripDaringFireballBlog()
         string inputJsonFeed = TestExtensions.GetResourceAsString("DaringFireballBlog.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
-
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -31,8 +33,9 @@ public void RoundtripHyperCriticalBlog()
         string inputJsonFeed = TestExtensions.GetResourceAsString("HyperCriticalBlog.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
-
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -41,8 +44,9 @@ public void RoundtripMaybePizzaBlog()
         string inputJsonFeed = TestExtensions.GetResourceAsString("MaybePizzaBlog.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
-
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -51,8 +55,9 @@ public void RoundtripTheRecordPodcast()
         string inputJsonFeed = TestExtensions.GetResourceAsString("TheRecordPodcast.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
-
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -61,8 +66,9 @@ public void RoundtripTimeTablePodcast()
         string inputJsonFeed = TestExtensions.GetResourceAsString("TimeTablePodcast.json").NormalizeEndings();
         JsonFeed jsonFeed = JsonFeed.Parse(inputJsonFeed);
         string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
-
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -79,8 +85,9 @@ public void VersionOneDotOne()
         Assert.Single(jsonFeed.Items[0].Authors);
         Assert.Equal("John Gruber", jsonFeed.Items[0].Authors[0].Name);
 
-        Assert.Equal(inputJsonFeed, outputJsonFeed);
-        Assert.Equal(inputJsonFeed.Length, outputJsonFeed.Length);
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -107,8 +114,11 @@ public async Task ParseFromUriAsyncMakesNetworkRequestAndDeserializesOutput()
         //When
         JsonFeed? jsonFeed = await JsonFeed.ParseFromUriAsync(contentUri, handler);
 
+        string outputJsonFeed = jsonFeed.Write().NormalizeEndings();
+        JsonFeed jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        
         //Then
-        Assert.Equal(inputJsonFeed.NormalizeEndings(), jsonFeed.Write().NormalizeEndings());
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 
     [Fact]
@@ -161,6 +171,7 @@ public void WriteFeedToStream()
         using StreamReader reader = new(memoryStream);
         string outputJsonFeed = reader.ReadToEnd().NormalizeEndings();
 
-        Assert.Equal(inputJsonFeed, outputJsonFeed);
+        var jsonFeed2 = JsonFeed.Parse(outputJsonFeed);
+        Assert.Equivalent(jsonFeed, jsonFeed2);
     }
 }

JsonFeedNet/JsonFeed.cs

@@ -1,58 +1,53 @@
-namespace JsonFeedNet;
+using System.Text.Json;
+
+namespace JsonFeedNet;
 
 using System.Text;
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 // ReSharper disable MemberCanBePrivate.Global
 // ReSharper disable UnusedMember.Global
 public class JsonFeed
 {
-    private static readonly JsonSerializerSettings s_serializerSettings = new()
-    {
-        Formatting = Formatting.Indented,
-        NullValueHandling = NullValueHandling.Ignore,
-        DateFormatHandling = DateFormatHandling.IsoDateFormat
-    };
-
     /// <summary>
     ///     The URL of the version of the format the feed uses.
     /// </summary>
-    [JsonProperty("version")]
+    [JsonPropertyName("version")]
     public string Version { get; set; } = "https://jsonfeed.org/version/1.1"; //required
 
     /// <summary>
     ///     The name of the feed.
     ///     This will often correspond to the name of the website(blog, for instance).
     /// </summary>
-    [JsonProperty("title")]
+    [JsonPropertyName("title")]
     public string Title { get; set; } //required
 
     /// <summary>
     ///     The URL of the resource that the feed describes.
     ///     This resource may or may not actually be a “home” page, but it should be an HTML page.
     /// </summary>
-    [JsonProperty("home_page_url")]
+    [JsonPropertyName("home_page_url")]
     public string HomePageUrl { get; set; } //optional
 
     /// <summary>
     ///     The URL of the feed.
     ///     Serves as the unique identifier for the feed.
     /// </summary>
-    [JsonProperty("feed_url")]
+    [JsonPropertyName("feed_url")]
     public string FeedUrl { get; set; } //optional
 
     /// <summary>
     ///     More detail, beyond the title, on what the feed is about.
     ///     A feed reader may display this text.
     /// </summary>
-    [JsonProperty("description")]
+    [JsonPropertyName("description")]
     public string Description { get; set; } //optional
 
     /// <summary>
     ///     Description of the purpose of the feed.
     ///     This is for the use of people looking at the raw JSON, and should be ignored by feed readers.
     /// </summary>
-    [JsonProperty("user_comment")]
+    [JsonPropertyName("user_comment")]
     public string UserComment { get; set; } //optional
 
     /// <summary>
@@ -61,64 +56,64 @@ public class JsonFeed
     ///     won’t use it very often.
     ///     Must not be the same as FeedUrl, and it must not be the same as a previous NextUrl (to avoid infinite loops).
     /// </summary>
-    [JsonProperty("next_url")]
+    [JsonPropertyName("next_url")]
     public string NextUrl { get; set; } //optional
 
     /// <summary>
     ///     The URL of an image for the feed suitable to be used in a timeline, much the way an avatar might be used.
     ///     It should be square and relatively large — such as 512 x 512 — so that it can be scaled-down.
     ///     It should use transparency where appropriate, since it may be rendered on a non-white background.
     /// </summary>
-    [JsonProperty("icon")]
+    [JsonPropertyName("icon")]
     public string Icon { get; set; } //optional
 
     /// <summary>
     ///     The URL of an image for the feed suitable to be used in a source list.
     ///     It should be square and relatively small, but not smaller than 64 x 64.
     ///     It should use transparency where appropriate, since it may be rendered on a non-white background.
     /// </summary>
-    [JsonProperty("favicon")]
+    [JsonPropertyName("favicon")]
     public string FavIcon { get; set; } //optional
 
     /// <summary>
     ///     The feed author.
     /// </summary>
-    [JsonProperty("author")]
+    [JsonPropertyName("author")]
     [Obsolete("obsolete by specification version 1.1. Use `Authors`")]
     public JsonFeedAuthor Author { get; set; } //optional
 
     /// <summary>
     ///     Specifies one or more feed authors.
     /// </summary>
-    [JsonProperty("authors")]
+    [JsonPropertyName("authors")]
     public List<JsonFeedAuthor> Authors { get; set; } //optional
 
     /// <summary>
     ///     Primary language for the feed in the format specified in RFC 5646.
     ///     The value is usually a 2-letter language tag from ISO 639-1, optionally followed by a region tag.
     ///     (Examples: en or en-US.)
     /// </summary>
-    [JsonProperty("language")]
+    [JsonPropertyName("language")]
     public string Language { get; set; } //optional
 
     /// <summary>
     ///     Indicates whether or not the feed is finished — that is, whether or not it will ever update again.
     ///     If the value is true, then it’s expired. Any other value, or the absence of expired, means the feed may continue to
     ///     update.
     /// </summary>
-    [JsonProperty("expired")]
+    [JsonPropertyName("expired")]
     public bool? Expired { get; set; } //optional
 
     /// <summary>
     ///     Endpoints that can be used to subscribe to real-time notifications of changes to this feed.
     /// </summary>
-    [JsonProperty("hubs")]
+    [JsonPropertyName("hubs")]
     public List<JsonFeedHub> Hubs { get; set; } //optional
 
     /// <summary>
     ///     The individual items in the feed.
     /// </summary>
-    [JsonProperty("items")]
+    [JsonPropertyName("items")]
     public List<JsonFeedItem> Items { get; set; } //required
 
     /// <summary>
@@ -128,7 +123,7 @@ public class JsonFeed
     /// <returns>A JsonFeed object representing the parsed feed.</returns>
     public static JsonFeed Parse(string jsonFeedString)
     {
-        return JsonConvert.DeserializeObject<JsonFeed>(jsonFeedString);
+        return JsonSerializer.Deserialize<JsonFeed>(jsonFeedString, SourceGenerationContext.Default.JsonFeed);
     }
 
     /// <summary>
@@ -142,7 +137,14 @@ public static async Task<JsonFeed> ParseFromUriAsync(Uri jsonFeedUri, HttpMessag
         HttpClient client = new(httpMessageHandler ?? new HttpClientHandler());
         string jsonDocument = await client.GetStringAsync(jsonFeedUri);
 
-        return Parse(jsonDocument);
+        try
+        {
+            return Parse(jsonDocument);
+        }
+        finally
+        {
+            client.Dispose();
+        }
     }
 
     /// <summary>
@@ -172,6 +174,6 @@ public void Write(Stream stream)
     /// <returns>A string containing the generated feed JSON.</returns>
     public override string ToString()
     {
-        return JsonConvert.SerializeObject(this, s_serializerSettings);
+        return JsonSerializer.Serialize(this, SourceGenerationContext.Default.JsonFeed);
     }
 }

JsonFeedNet/JsonFeedAttachment.cs

@@ -1,6 +1,6 @@
 namespace JsonFeedNet;
 
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 /// <summary>
 ///     A related resource to a feed.
@@ -10,13 +10,13 @@ public class JsonFeedAttachment
     /// <summary>
     ///     The location of the attachment.
     /// </summary>
-    [JsonProperty("url")]
+    [JsonPropertyName("url")]
     public string Url { get; set; } //required
 
     /// <summary>
     ///     The mime type of the attachment, such as “audio/mpeg.”
     /// </summary>
-    [JsonProperty("mime_type")]
+    [JsonPropertyName("mime_type")]
     public string MimeType { get; set; } //required
 
     /// <summary>
@@ -25,18 +25,18 @@ public class JsonFeedAttachment
     ///     of the same thing.
     ///     In this way a podcaster, for instance, might provide an audio recording in different formats.
     /// </summary>
-    [JsonProperty("title")]
+    [JsonPropertyName("title")]
     public string Title { get; set; } //optional
 
     /// <summary>
     ///     How large the file is.
     /// </summary>
-    [JsonProperty("size_in_bytes")]
+    [JsonPropertyName("size_in_bytes")]
     public long? SizeInBytes { get; set; } //optional
 
     /// <summary>
     ///     How long the attachment takes to listen to or watch.
     /// </summary>
-    [JsonProperty("duration_in_seconds")]
+    [JsonPropertyName("duration_in_seconds")]
     public long? DurationInSeconds { get; set; } //optional
 }

JsonFeedNet/JsonFeedAuthor.cs

@@ -1,6 +1,6 @@
 namespace JsonFeedNet;
 
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 /// <summary>
 ///     A feed author.
@@ -10,21 +10,21 @@ public class JsonFeedAuthor
     /// <summary>
     ///     The author's name.
     /// </summary>
-    [JsonProperty("name")]
+    [JsonPropertyName("name")]
     public string Name { get; set; } //optional
 
     /// <summary>
     ///     The URL of a site owned by the author.
     ///     It could be a blog, micro-blog, Twitter account, and so on.
     /// </summary>
-    [JsonProperty("url")]
+    [JsonPropertyName("url")]
     public string Url { get; set; } //optional
 
     /// <summary>
     ///     The URL for an image for the author.
     ///     It should be square and relatively large — such as 512 x 512.
     ///     It should use transparency where appropriate, since it may be rendered on a non-white background.
     /// </summary>
-    [JsonProperty("avatar")]
+    [JsonPropertyName("avatar")]
     public string Avatar { get; set; } //optional
 }

JsonFeedNet/JsonFeedHub.cs

@@ -1,6 +1,6 @@
 namespace JsonFeedNet;
 
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 /// <summary>
 ///     Endpoint that can be used to subscribe to real-time notifications of changes to a feed.
@@ -10,12 +10,12 @@ public class JsonFeedHub
     /// <summary>
     ///     The type field describes the protocol used to talk with the hub, such as “rssCloud” or “WebSub.”
     /// </summary>
-    [JsonProperty("type")]
+    [JsonPropertyName("type")]
     public string Type { get; set; } //required
 
     /// <summary>
     ///     Url of the hub endpoint.
     /// </summary>
-    [JsonProperty("url")]
+    [JsonPropertyName("url")]
     public string Url { get; set; } //required
 }