Introduce CData for Content

Daniel Mueller · Daniel Mueller · commit b987c2e403a7 · 2022-03-16T12:23:30.000+01:00
diff --git a/build.cake b/build.cake
@@ -106,7 +106,7 @@ Task("Test")
 });
 
 Task("Pack")
-    .IsDependentOn("Test")
+    .IsDependentOn("Build")
     .Does(() => 
 {
     DotNetCorePack("./src/dng.Syndication.csproj", new DotNetCorePackSettings
diff --git a/dng.Syndication.sln b/dng.Syndication.sln
@@ -15,6 +15,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.travis.yml = .travis.yml
 		appveyor.yml = appveyor.yml
 		build.cake = build.cake
+		global.json = global.json
 		README.md = README.md
 		version.json = version.json
 	EndProjectSection
diff --git a/global.json b/global.json
@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "3.1.201"
+    "version": "3.1.400"
   }
 }
diff --git a/src/Generators/AtomGenerator.cs b/src/Generators/AtomGenerator.cs
@@ -3,6 +3,8 @@
 using System.Xml.Linq;
 
 using dng.Syndication.Models;
+using System.Web;
+using System.Text;
 
 namespace dng.Syndication.Generators
 {
@@ -68,13 +70,15 @@ public string Process()
                 var itemElement = new XElement(ns + "entry");
                 itemElement.Add(new XElement(ns + "title", feedEntry.Title));
 
-                itemElement.Add(new XElement(ns + "link", new XAttribute("href", feedEntry.Link)));
+                itemElement.Add(new XElement(ns + "link", 
+                    new XAttribute("href", 
+                    HttpUtility.UrlDecode(feedEntry.Link.ToString(), Encoding.UTF8))));
 
                 if (!string.IsNullOrWhiteSpace(feedEntry.Summary))
                     itemElement.Add(new XElement(ns + "summary", feedEntry.Summary));
 
                 if (!string.IsNullOrWhiteSpace(feedEntry.Content))
-                    itemElement.Add(new XElement(ns + "content", feedEntry.Content));
+                    itemElement.Add(new XElement(ns + "content", new XCData(feedEntry.Content)));
 
                 if (feedEntry.Author != null)
                 {
diff --git a/src/Generators/PodcastRssGenerator.cs b/src/Generators/PodcastRssGenerator.cs
@@ -106,13 +106,13 @@ private void AppendItems(
                  new XElement("item",
                     new XElement("title", episode.Title),
                     new XElement(itunesNamespace + "title", episode.Title),
-                    new XElement("description", new XCData(episode.Description)),
-                    new XElement(itunesNamespace + "summary", new XCData(episode.Description)),
+                    new XElement("description", episode.Description),
+                    new XElement(itunesNamespace + "summary", episode.Description),
                     new XElement("pubDate", FormatDateRfc2822(episode.Date)),
                     episode.Link != null ? new XElement("link", episode.Link) : null,
                     episode.Image != null ? new XElement(itunesNamespace + "image", new XAttribute("href", episode.Image)) : null,
                     new XElement("guid", new XAttribute("isPermaLink", false), episode.Guid),
-                    new XElement(contentNamespace + "encoded", new XCData(episode.Description)),
+                    !IsNullOrWhiteSpace(episode.Content) ? new XElement(contentNamespace + "encoded", new XCData(episode.Content)) : null,
                     episode.EpisodeNumber > 0 ? new XElement(itunesNamespace + "episode", episode.EpisodeNumber) : null,
                     new XElement(itunesNamespace + "episodeType", episode.EpisodeType.ToString().ToLower()),
                     episode.SeasonNumber > 0 ? new XElement(itunesNamespace + "season", episode.SeasonNumber) : null,
diff --git a/src/Generators/Rss20Generator.cs b/src/Generators/Rss20Generator.cs
@@ -1,6 +1,9 @@
 ﻿using System;
+using System.Text;
+using System.Web;
 using System.Xml.Linq;
 using dng.Syndication.Models;
+
 using static System.String;
 
 namespace dng.Syndication.Generators
@@ -38,7 +41,7 @@ public string Process()
 
             channel.Add(new XElement("link", _feed.Link));
 
-            channel.Add(new XElement("description", _feed.Description));
+            channel.Add(new XElement("description", new XCData(_feed.Description)));
 
             if (!IsNullOrWhiteSpace(_feed.Copyright))
                 channel.Add(new XElement("copyright", _feed.Copyright));
@@ -67,9 +70,9 @@ public string Process()
                 if (feedEntry.Author != null)
                     itemElement.Add(new XElement("author", $"{feedEntry.Author.Email} ({feedEntry.Author.Name})"));
 
-                itemElement.Add(new XElement("guid", feedEntry.Link));
+                itemElement.Add(new XElement("guid", HttpUtility.UrlDecode(feedEntry.Link.ToString(), Encoding.UTF8)));
 
-                itemElement.Add(new XElement("link", feedEntry.Link));
+                itemElement.Add(new XElement("link", HttpUtility.UrlDecode(feedEntry.Link.ToString(), Encoding.UTF8)));
 
                 if (feedEntry.PublishDate != DateTime.MinValue)
                     itemElement.Add(new XElement("pubDate", FormatDateRfc2822(feedEntry.PublishDate)));
diff --git a/src/Models/Podcasts/Episode.cs b/src/Models/Podcasts/Episode.cs
@@ -31,6 +31,11 @@ public Episode()
         /// </summary>
         public string Description{ get; set; }
 
+        /// <summary>
+        /// An episode description allows html tags.
+        /// </summary>
+        public string Content { get; set; }
+
         public string Author { get; set; }
 
         /// <summary>
diff --git a/tests/Examples/SimplePodcastRssFeed.xml b/tests/Examples/SimplePodcastRssFeed.xml
@@ -28,8 +28,8 @@
     <item>
       <title>At vero eos et accusam et justo duo</title>
       <itunes:title>At vero eos et accusam et justo duo</itunes:title>
-      <description><![CDATA[<p>Lorem ipsum dolor sit amet, <a href="https://www.apple.com/itunes/podcasts/">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>]]></description>
-      <itunes:summary><![CDATA[<p>Lorem ipsum dolor sit amet, <a href="https://www.apple.com/itunes/podcasts/">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>]]></itunes:summary>
+      <description>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</description>
+      <itunes:summary>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.cleanupDescription</itunes:summary>
       <pubDate>Thu, 9 Apr 2020 14:45:00 +0200</pubDate>
       <link>https://www.example.com/podcasts/At-vero-eos-et-accusam-et-justo-duo</link>
       <guid isPermaLink="false">20f0fc4c7c404</guid>
@@ -44,12 +44,11 @@
     <item>
       <title>Et accusam et justo duo</title>
       <itunes:title>Et accusam et justo duo</itunes:title>
-      <description><![CDATA[<p>Lorem ipsum dolor sit amet, <a href="https://www.apple.com/itunes/podcasts/">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>]]></description>
-      <itunes:summary><![CDATA[<p>Lorem ipsum dolor sit amet, <a href="https://www.apple.com/itunes/podcasts/">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>]]></itunes:summary>
+      <description>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat</description>
+      <itunes:summary>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat</itunes:summary>
       <pubDate>Wed, 8 Apr 2020 12:45:00 +0200</pubDate>
       <itunes:image href="https://www.example.com/podcasts/img/episode2.jpg" />
       <guid isPermaLink="false">40f0fc5c7c404</guid>
-      <content:encoded><![CDATA[<p>Lorem ipsum dolor sit amet, <a href="https://www.apple.com/itunes/podcasts/">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>]]></content:encoded>
       <itunes:episodeType>full</itunes:episodeType>
       <itunes:explicit>false</itunes:explicit>
       <googleplay:explicit>no</googleplay:explicit>
diff --git a/tests/PodcastRssGeneratorTests.cs b/tests/PodcastRssGeneratorTests.cs
@@ -44,7 +44,7 @@ public void when_creating_a_podcast_rss_feed_with_one_items()
                     .Build())
                 .WithEpisode(new PodcastRssEpisodeBuilder()
                     .WithTitle("Et accusam et justo duo")
-                    .WithDescription(@"<p>Lorem ipsum dolor sit amet, <a href=""https://www.apple.com/itunes/podcasts/"">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>")
+                    .WithDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat")
                     .WithDuration(TimeSpan.FromSeconds(1102))
                     .WithId("40f0fc5c7c404")
                     .WithEpisodeType(EpisodeType.Full)
diff --git a/tests/TestdataBuilder/Podcasts/PodcastRssEpisodeBuilder.cs b/tests/TestdataBuilder/Podcasts/PodcastRssEpisodeBuilder.cs
@@ -18,6 +18,7 @@ public class PodcastRssEpisodeBuilder
         private Uri _link;
         private Enclosure _enclosure;
         private Uri _image;
+        private string _content;
 
         public PodcastRssEpisodeBuilder WithEpisodeType(
             EpisodeType episodeType)
@@ -47,6 +48,13 @@ public PodcastRssEpisodeBuilder WithDescription(
             return this;
         }
 
+        public PodcastRssEpisodeBuilder WithContent(
+            string content)
+        {
+            _content = content;
+            return this;
+        }
+
         public PodcastRssEpisodeBuilder WithAuthor(
             string author)
         {
@@ -107,7 +115,8 @@ public PodcastRssEpisodeBuilder WithDefault()
         {
             return WithEpisodeType(EpisodeType.Full)
                 .WithId("20f0fc4c7c404").WithTitle("At vero eos et accusam et justo duo")
-                .WithDescription(@"<p>Lorem ipsum dolor sit amet, <a href=""https://www.apple.com/itunes/podcasts/"">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>")
+                .WithDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.")
+                .WithContent(@"<p>Lorem ipsum dolor sit amet, <a href=""https://www.apple.com/itunes/podcasts/"">consetetur sadipscing</a> elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.</p><p>At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.<br />Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>")
                 .WithAuthor("Lorem")
                 .WithDate(new DateTime(2020, 4, 9, 14, 45, 00))
                 .WithDuration(TimeSpan.FromSeconds(1079))
@@ -129,6 +138,7 @@ public Episode Build()
                 Guid = _id,
                 Title = _title,
                 Description = _description,
+                Content = _content,
                 Author = _author,
                 Date = _date,
                 EpisodeNumber = _episodeNumber,
diff --git a/version.json b/version.json
@@ -1,4 +1,4 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "1.5.2"
+  "version": "1.6.0"
 }

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ Task("Test")`
`106`	`106`	`});`
`107`	`107`
`108`	`108`	`Task("Pack")`
`109`		`- .IsDependentOn("Test")`
	`109`	`+ .IsDependentOn("Build")`
`110`	`110`	`.Does(() =>`
`111`	`111`	`{`
`112`	`112`	`DotNetCorePack("./src/dng.Syndication.csproj", new DotNetCorePackSettings`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "3.1.201"`
	`3`	`+ "version": "3.1.400"`
`4`	`4`	`}`
`5`	`5`	`}`