change project structure

nager · Feb 12, 2024 · 70400bd · 70400bd
1 parent 6634e56
commit 70400bd
Show file tree

Hide file tree

Showing 13 changed files with 49 additions and 120 deletions.
diff --git a/...PublicSuffix.UnitTest/DomainParserTest.cs → ...ix.UnitTest/DemoRules/DomainParserTest.cs b/...PublicSuffix.UnitTest/DomainParserTest.cs → ...ix.UnitTest/DemoRules/DomainParserTest.cs
@@ -3,7 +3,7 @@
 using Nager.PublicSuffix.Models;
 using System.Collections.Generic;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.DemoRules
 {
     public abstract class DomainParserTest
     {

diff --git a/...nParserTestWithIdnMappingNormalization.cs → ...nParserTestWithIdnMappingNormalization.cs b/...nParserTestWithIdnMappingNormalization.cs → ...nParserTestWithIdnMappingNormalization.cs
@@ -3,14 +3,15 @@
 using Nager.PublicSuffix.Models;
 using System.Collections.Generic;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.DemoRules
 {
     [TestClass]
     public class DomainParserTestWithIdnMappingNormalization : DomainParserTest
     {
         protected override IDomainParser GetDomainParser(List<TldRule> rules)
         {
-            return new DomainParser(rules, new IdnMappingDomainNormalizer());
+            var domainNormalizer = new IdnMappingDomainNormalizer();
+            return new DomainParser(rules, domainNormalizer);
         }
     }
 }
diff --git a/...mainParserTestWithInitializedStructure.cs → ...mainParserTestWithInitializedStructure.cs b/...mainParserTestWithInitializedStructure.cs → ...mainParserTestWithInitializedStructure.cs
@@ -3,7 +3,7 @@
 using Nager.PublicSuffix.Models;
 using System.Collections.Generic;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.DemoRules
 {
     [TestClass]
     public class DomainParserTestWithInitializedStructure : DomainParserTest
@@ -12,6 +12,7 @@ protected override IDomainParser GetDomainParser(List<TldRule> rules)
         {
             var structure = new DomainDataStructure("*", new TldRule("*"));
             structure.AddRules(rules);
+
             return new DomainParser(structure);
         }
     }

diff --git a/...t/DomainParserTestWithUriNormalization.cs → ...s/DomainParserTestWithUriNormalization.cs b/...t/DomainParserTestWithUriNormalization.cs → ...s/DomainParserTestWithUriNormalization.cs
@@ -3,14 +3,16 @@
 using Nager.PublicSuffix.Models;
 using System.Collections.Generic;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.DemoRules
 {
     [TestClass]
     public class DomainParserTestWithUriNormalization : DomainParserTest
     {
         protected override IDomainParser GetDomainParser(List<TldRule> rules)
         {
-            return new DomainParser(rules, new UriDomainNormalizer());
+            var domainNormalizer = new UriDomainNormalizer();
+
+            return new DomainParser(rules, domainNormalizer);
         }
     }
 }
diff --git a/...PublicSuffix.UnitTest/PublicSuffixTest.cs → ...ix.UnitTest/RealRules/PublicSuffixTest.cs b/...PublicSuffix.UnitTest/PublicSuffixTest.cs → ...ix.UnitTest/RealRules/PublicSuffixTest.cs
@@ -1,7 +1,7 @@
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Nager.PublicSuffix.Exceptions;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.RealRules
 {
     public abstract class PublicSuffixTest
     {

diff --git a/...SuffixTestsWithIdnMappingNormalization.cs → ...SuffixTestsWithIdnMappingNormalization.cs b/...SuffixTestsWithIdnMappingNormalization.cs → ...SuffixTestsWithIdnMappingNormalization.cs
@@ -2,7 +2,7 @@
 using Nager.PublicSuffix.DomainNormalizers;
 using Nager.PublicSuffix.RuleProviders;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.RealRules
 {
     [TestClass]
     public class PublicSuffixTestsWithIdnMappingNormalization : PublicSuffixTest

diff --git a/.../PublicSuffixTestsWithUriNormalization.cs → .../PublicSuffixTestsWithUriNormalization.cs b/.../PublicSuffixTestsWithUriNormalization.cs → .../PublicSuffixTestsWithUriNormalization.cs
@@ -2,7 +2,7 @@
 using Nager.PublicSuffix.DomainNormalizers;
 using Nager.PublicSuffix.RuleProviders;
 
-namespace Nager.PublicSuffix.UnitTest
+namespace Nager.PublicSuffix.UnitTest.RealRules
 {
     [TestClass]
     public class PublicSuffixTestsWithUriNormalization : PublicSuffixTest

diff --git a/...licSuffix.UnitTest/TldRuleProviderTest.cs → ...PublicSuffix.UnitTest/RuleProviderTest.cs b/...licSuffix.UnitTest/TldRuleProviderTest.cs → ...PublicSuffix.UnitTest/RuleProviderTest.cs
@@ -6,21 +6,21 @@
 namespace Nager.PublicSuffix.UnitTest
 {
     [TestClass]
-    public class TldRuleProviderTest
+    public class RuleProviderTest
     {
         [TestMethod]
         public async Task WebTldRuleProviderTest()
         {
-            var tldRuleProvider = new WebTldRuleProvider();
-            var rules = await tldRuleProvider.BuildAsync();
+            var webRuleProvider = new WebRuleProvider();
+            var rules = await webRuleProvider.BuildAsync();
             Assert.IsNotNull(rules);
         }
 
         [TestMethod]
         public async Task FileTldRuleProviderTest()
         {
-            var tldRuleProvider = new FileTldRuleProvider("public_suffix_list.dat");
-            var rules = await tldRuleProvider.BuildAsync();
+            var localFileRuleProvider = new LocalFileRuleProvider("public_suffix_list.dat");
+            var rules = await localFileRuleProvider.BuildAsync();
             Assert.AreEqual(9609, rules.Count());
             Assert.IsNotNull(rules);
         }

diff --git a/src/Nager.PublicSuffix/DomainParser.cs b/src/Nager.PublicSuffix/DomainParser.cs
@@ -37,9 +37,9 @@ public DomainParser(IEnumerable<TldRule> rules, IDomainNormalizer domainNormaliz
         /// <summary>
         /// Creates and initializes a DomainParser
         /// </summary>
-        /// <param name="ruleProvider">A rule provider from interface <see cref="ITopLevelDomainRuleProvider"/>.</param>
+        /// <param name="ruleProvider">A rule provider from interface <see cref="IRuleProvider"/>.</param>
         /// <param name="domainNormalizer">An <see cref="IDomainNormalizer"/>.</param>
-        public DomainParser(ITopLevelDomainRuleProvider ruleProvider, IDomainNormalizer domainNormalizer = null)
+        public DomainParser(IRuleProvider ruleProvider, IDomainNormalizer domainNormalizer = null)
             : this(domainNormalizer)
         {
             var rules = ruleProvider.BuildAsync().GetAwaiter().GetResult();

diff --git a/...eProviders/ITopLevelDomainRuleProvider.cs → ...blicSuffix/RuleProviders/IRuleProvider.cs b/...eProviders/ITopLevelDomainRuleProvider.cs → ...blicSuffix/RuleProviders/IRuleProvider.cs
@@ -1,18 +1,20 @@
 using Nager.PublicSuffix.Models;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Nager.PublicSuffix.RuleProviders
 {
     /// <summary>
-    /// ITopLevelDomainRuleProvider
+    /// Interface RuleProvider
     /// </summary>
-    public interface ITopLevelDomainRuleProvider
+    public interface IRuleProvider
     {
         /// <summary>
         /// Loads the plain text data from a source and parse the public suffix rules
         /// </summary>
+        /// <param name="cancellationToken"></param>
         /// <returns>Returns the TldRules</returns>
-        Task<IEnumerable<TldRule>> BuildAsync();
+        Task<IEnumerable<TldRule>> BuildAsync(CancellationToken cancellationToken = default);
     }
 }
diff --git a/...ffix/RuleProviders/FileTldRuleProvider.cs → ...ix/RuleProviders/LocalFileRuleProvider.cs b/...ffix/RuleProviders/FileTldRuleProvider.cs → ...ix/RuleProviders/LocalFileRuleProvider.cs
@@ -2,28 +2,29 @@
 using Nager.PublicSuffix.RuleParsers;
 using System.Collections.Generic;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Nager.PublicSuffix.RuleProviders
 {
     /// <summary>
-    /// FileTldRuleProvider
+    /// LocalFileRuleProvider
     /// </summary>
-    public class FileTldRuleProvider : ITopLevelDomainRuleProvider
+    public class LocalFileRuleProvider : IRuleProvider
     {
-        private readonly string _fileName;
+        private readonly string _filePath;
 
         /// <summary>
-        /// FileTldRuleProvider
+        /// LocalFileRuleProvider
         /// </summary>
-        /// <param name="fileName"></param>
-        public FileTldRuleProvider(string fileName)
+        /// <param name="filePath"></param>
+        public LocalFileRuleProvider(string filePath)
         {
-            this._fileName = fileName;
+            this._filePath = filePath;
         }
 
         ///<inheritdoc/>
-        public async Task<IEnumerable<TldRule>> BuildAsync()
+        public async Task<IEnumerable<TldRule>> BuildAsync(CancellationToken cancellationToken = default)
         {
             var ruleData = await this.LoadFromFile().ConfigureAwait(false);
 
@@ -34,12 +35,12 @@ public async Task<IEnumerable<TldRule>> BuildAsync()
 
         private async Task<string> LoadFromFile()
         {
-            if (!File.Exists(this._fileName))
+            if (!File.Exists(this._filePath))
             {
-                throw new FileNotFoundException("Rule file does not exist");
+                throw new FileNotFoundException($"Rule file does not exist {this._filePath}");
             }
 
-            using var reader = File.OpenText(this._fileName);
+            using var reader = File.OpenText(this._filePath);
             return await reader.ReadToEndAsync().ConfigureAwait(false);
         }
     }

diff --git a/...ffix/RuleProviders/Web2TldRuleProvider.cs → ...icSuffix/RuleProviders/WebRuleProvider.cs b/...ffix/RuleProviders/Web2TldRuleProvider.cs → ...icSuffix/RuleProviders/WebRuleProvider.cs
@@ -4,14 +4,15 @@
 using Nager.PublicSuffix.RuleParsers;
 using System.Collections.Generic;
 using System.Net.Http;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Nager.PublicSuffix.RuleProviders
 {
     /// <summary>
-    /// Web2TldRuleProvider
+    /// WebRuleProvider
     /// </summary>
-    public class Web2TldRuleProvider : ITopLevelDomainRuleProvider
+    public class WebRuleProvider : IRuleProvider
     {
         private readonly string _fileUrl;
         private readonly ICacheProvider _cacheProvider;
@@ -23,13 +24,13 @@ public class Web2TldRuleProvider : ITopLevelDomainRuleProvider
         public ICacheProvider CacheProvider { get { return this._cacheProvider; } }
 
         /// <summary>
-        /// Web2TldRuleProvider<br/>
+        /// WebRuleProvider<br/>
         /// Loads the public suffix definition file from a given url
         /// </summary>
         /// <param name="httpClient"></param>
         /// <param name="url"></param>
         /// <param name="cacheProvider">default is <see cref="FileCacheProvider"/></param>
-        public Web2TldRuleProvider(
+        public WebRuleProvider(
             HttpClient httpClient,
             string url = "https://publicsuffix.org/list/public_suffix_list.dat",
             ICacheProvider cacheProvider = null)
@@ -47,7 +48,7 @@ public Web2TldRuleProvider(
         }
 
         ///<inheritdoc/>
-        public async Task<IEnumerable<TldRule>> BuildAsync()
+        public async Task<IEnumerable<TldRule>> BuildAsync(CancellationToken cancellationToken = default)
         {
             var ruleParser = new TldRuleParser();
 
@@ -58,7 +59,7 @@ public async Task<IEnumerable<TldRule>> BuildAsync()
             }
             else
             {
-                ruleData = await this.LoadFromUrlAsync(this._fileUrl).ConfigureAwait(false);
+                ruleData = await this.LoadFromUrlAsync(this._fileUrl, cancellationToken).ConfigureAwait(false);
                 await this._cacheProvider.SetAsync(ruleData).ConfigureAwait(false);
             }
 
@@ -70,10 +71,13 @@ public async Task<IEnumerable<TldRule>> BuildAsync()
         /// Load the public suffix data from the given url
         /// </summary>
         /// <param name="url"></param>
+        /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        public async Task<string> LoadFromUrlAsync(string url)
+        public async Task<string> LoadFromUrlAsync(
+            string url,
+            CancellationToken cancellationToken)
         {
-            using var response = await this._httpClient.GetAsync(url).ConfigureAwait(false);
+            using var response = await this._httpClient.GetAsync(url, cancellationToken).ConfigureAwait(false);
 
             if (!response.IsSuccessStatusCode)
             {

diff --git a/src/Nager.PublicSuffix/RuleProviders/WebTldRuleProvider.cs b/src/Nager.PublicSuffix/RuleProviders/WebTldRuleProvider.cs