Refactoring. DRY in parsers logic

Author: skuill

LyricsScraperNET/Extensions/HtmlExtensions.cs

@@ -10,5 +10,38 @@ public static class HtmlExtensions
             htmlDoc.LoadHtml(htmlBody);
             return htmlDoc.DocumentNode.SelectSingleNode(xPath);
         }
+
+        public static string RemoveAllHtmlTags(this string html)
+        {
+            html = html.RemoveHtmlTags();
+
+            // fix recursive white-spaces
+            while (html.Contains("  "))
+            {
+                html = html.Replace("  ", " ");
+            }
+
+            // fix recursive line-break
+            while (html.Contains("\r\n\r\n\r\n"))
+            {
+                html = html.Replace("\r\n\r\n\r\n", "\r\n\r\n");
+            }
+
+            return html;
+        }
+
+        public static string UnescapeString(this string html)
+        {
+            if (!string.IsNullOrEmpty(html))
+            {
+                // replace entities with literal values
+                html = html.Replace("'", "'");
+                html = html.Replace(""", "\"");
+                html = html.Replace(">", ">");
+                html = html.Replace("&lt;", "<");
+                html = html.Replace("&amp;", "&");
+            }
+            return html;
+        }
     }
 }

LyricsScraperNET/Providers/AZLyrics/AZLyricsParser.cs

@@ -7,40 +7,10 @@ internal sealed class AZLyricsParser : IExternalProviderLyricParser
     {
         public string Parse(string lyric)
         {
-            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim() ?? string.Empty;
-        }
-
-        private string RemoveAllHtmlTags(string html)
-        {
-            html = html.RemoveHtmlTags();
-
-            // fix recursive white-spaces
-            while (html.Contains("  "))
-            {
-                html = html.Replace("  ", " ");
-            }
-
-            // fix recursive line-break
-            while (html.Contains("\r\n\r\n\r\n"))
-            {
-                html = html.Replace("\r\n\r\n\r\n", "\r\n\r\n");
-            }
-
-            return html;
-        }
-
-        private string UnescapeString(string lyric)
-        {
-            if (!string.IsNullOrEmpty(lyric))
-            {
-                // replace entities with literal values
-                lyric = lyric.Replace("'", "'");
-                lyric = lyric.Replace(""", "\"");
-                lyric = lyric.Replace(">", ">");
-                lyric = lyric.Replace("&lt;", "<");
-                lyric = lyric.Replace("&amp;", "&");
-            }
-            return lyric;
+            return lyric.RemoveAllHtmlTags()
+                .UnescapeString()?
+                .Trim()
+                    ?? string.Empty;
         }
     }
 }

LyricsScraperNET/Providers/KPopLyrics/KPopLyricsOptions.cs

@@ -4,7 +4,7 @@
 
 namespace LyricsScraperNET.Providers.KPopLyrics
 {
-    public class KPopLyricsOptions : IExternalProviderOptions
+    public sealed class KPopLyricsOptions : IExternalProviderOptions
     {
         public ExternalProviderType ExternalProviderType => ExternalProviderType.KPopLyrics;
 

LyricsScraperNET/Providers/KPopLyrics/KPopLyricsParser.cs

@@ -5,7 +5,7 @@
 
 namespace LyricsScraperNET.Providers.KPopLyrics
 {
-    public class KPopLyricsParser : IExternalProviderLyricParser
+    internal sealed class KPopLyricsParser : IExternalProviderLyricParser
     {
         public string Parse(string lyric)
         {

LyricsScraperNET/Providers/KPopLyrics/KPopLyricsUriConverter.cs

@@ -4,7 +4,7 @@
 
 namespace LyricsScraperNET.Providers.KPopLyrics
 {
-    public class KPopLyricsUriConverter : IExternalUriConverter
+    internal sealed class KPopLyricsUriConverter : IExternalUriConverter
     {
         private Uri _baseUri => new Uri("https://www.kpoplyrics.net/");
 

LyricsScraperNET/Providers/LyricFind/LyricFindParser.cs

@@ -7,41 +7,11 @@ internal sealed class LyricFindParser : IExternalProviderLyricParser
     {
         public string Parse(string lyric)
         {
-            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim()?.Replace("\\n", "\r\n")
-                ?? string.Empty;
-        }
-
-        private string RemoveAllHtmlTags(string html)
-        {
-            html = html.RemoveHtmlTags();
-
-            // fix recursive white-spaces
-            while (html.Contains("  "))
-            {
-                html = html.Replace("  ", " ");
-            }
-
-            // fix recursive line-break
-            while (html.Contains("\r\n\r\n\r\n"))
-            {
-                html = html.Replace("\r\n\r\n\r\n", "\r\n\r\n");
-            }
-
-            return html;
-        }
-
-        private string UnescapeString(string lyric)
-        {
-            if (!string.IsNullOrEmpty(lyric))
-            {
-                // replace entities with literal values
-                lyric = lyric.Replace("'", "'");
-                lyric = lyric.Replace(""", "\"");
-                lyric = lyric.Replace(">", ">");
-                lyric = lyric.Replace("&lt;", "<");
-                lyric = lyric.Replace("&amp;", "&");
-            }
-            return lyric;
+            return lyric.RemoveAllHtmlTags()
+                .UnescapeString()?
+                .Trim()?
+                .Replace("\\n", "\r\n")
+                    ?? string.Empty;
         }
     }
 }

LyricsScraperNET/Providers/LyricsFreak/LyricsFreakProvider.cs

@@ -3,6 +3,7 @@
 using LyricsScraperNET.Models.Responses;
 using LyricsScraperNET.Network;
 using LyricsScraperNET.Providers.Abstract;
+using LyricsScraperNET.Providers.Models;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
@@ -12,7 +13,7 @@
 
 namespace LyricsScraperNET.Providers.LyricsFreak
 {
-    internal class LyricsFreakProvider : ExternalProviderBase
+    public sealed class LyricsFreakProvider : ExternalProviderBase
     {
         private ILogger<LyricsFreakProvider>? _logger;
         private readonly IExternalUriConverter _uriConverter;
@@ -83,7 +84,7 @@ protected override async Task<SearchResult> SearchLyricAsync(string artist, stri
             if (WebClient == null || Parser == null)
             {
                 _logger?.LogWarning($"LyricsFreak. Please set up WebClient and Parser first");
-                return new SearchResult(Models.ExternalProviderType.LyricsFreak);
+                return new SearchResult(ExternalProviderType.LyricsFreak);
             }
 
             // 1. Open the artist's page.
@@ -96,15 +97,15 @@ protected override async Task<SearchResult> SearchLyricAsync(string artist, stri
             if (htmlResponse.Contains(PageNotFoundText))
             {
                 _logger?.LogWarning($"LyricsFreak. Artist's page not found (404). [{artist}]. Song name: [{song}]");
-                return new SearchResult(Models.ExternalProviderType.LyricsFreak);
+                return new SearchResult(ExternalProviderType.LyricsFreak);
             }
 
             // 2. Find song on the artist page and get link to the web page.
             var songHref = GetSongHrefFromHtmlBody(htmlResponse, song);
             if (string.IsNullOrEmpty(songHref))
             {
                 _logger?.LogWarning($"LyricsFreak. Can't find song Uri for artist: [{artist}]. Song name: [{song}]");
-                return new SearchResult(Models.ExternalProviderType.LyricsFreak);
+                return new SearchResult(ExternalProviderType.LyricsFreak);
             }
             var songUri = new Uri(LyricsFreakUriConverter.BaseUrl + songHref);
 
@@ -121,12 +122,12 @@ protected async override Task<SearchResult> SearchLyricAsync(Uri uri, Cancellati
             if (string.IsNullOrEmpty(songLyrics))
             {
                 _logger?.LogWarning($"LyricsFreak. Can't find lyrics for song's uri: [{uri}]");
-                return new SearchResult(Models.ExternalProviderType.LyricsFreak);
+                return new SearchResult(ExternalProviderType.LyricsFreak);
             }
 
             var lyricsText = Parser.Parse(songLyrics);
 
-            return new SearchResult(lyricsText, Models.ExternalProviderType.LyricsFreak);
+            return new SearchResult(lyricsText, ExternalProviderType.LyricsFreak);
         }
 
         #endregion

LyricsScraperNET/Validations/RequestValidator.cs

@@ -6,7 +6,7 @@
 
 namespace LyricsScraperNET.Validations
 {
-    public class RequestValidator : IRequestValidator
+    public sealed class RequestValidator : IRequestValidator
     {
         public bool IsValidSearchRequest(
             IProviderService providerService,