imp - doc - Names and word generators are no longer online

--- A very important change has been made to Textify that allows you to use the name generator and the word generator without requiring an active Internet connection. Starting from this commit, we require cloning this repo and its submodules in order for Textify to build successfully. Our own forks (spoiler: non-fork forks, just like what we did to ReadLine.Reboot) are maintained to ensure that you only get the content that you need. This commit also increments the version to 1.1.0 just for this change. --- Type: imp Breaking: False Doc Required: True Part: 1/1
Aptivi · Dec 5, 2023 · 86f959c · 86f959c
1 parent 53cf241
commit 86f959c
Show file tree

Hide file tree

Showing 22 changed files with 529 additions and 90 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "assets/NamesList"]
+	path = assets/NamesList
+	url = https://github.com/Aptivi/NamesList.git
+[submodule "assets/WordsList"]
+	path = assets/WordsList
+	url = https://github.com/Aptivi/WordsList.git
diff --git a/...fy.Demos.Online/Fixtures/Cases/NameGen.cs → ...s.Offline/Fixtures/Cases/NameGenerator.cs b/...fy.Demos.Online/Fixtures/Cases/NameGen.cs → ...s.Offline/Fixtures/Cases/NameGenerator.cs
@@ -17,18 +17,17 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 using System;
-using Textify.Online.NameGen;
 
-namespace Textify.Demos.Online.Fixtures.Cases
+namespace Textify.Demos.Offline.Fixtures.Cases
 {
-    internal class NameGen : IFixture
+    internal class NameGenerator : IFixture
     {
-        public string FixtureID => "NameGen";
+        public string FixtureID => "NameGenerator";
         public void RunFixture()
         {
-            string[] names = NameGenerator.GenerateNames(10);
-            string[] firstNames = NameGenerator.GenerateFirstNames(10);
-            string[] surnames = NameGenerator.GenerateLastNames(10);
+            string[] names = NameGen.NameGenerator.GenerateNames(10);
+            string[] firstNames = NameGen.NameGenerator.GenerateFirstNames(10);
+            string[] surnames = NameGen.NameGenerator.GenerateLastNames(10);
 
             Console.WriteLine($"10 names: {string.Join(", ", names)}");
             Console.WriteLine($"10 first names: {string.Join(", ", firstNames)}");

diff --git a/...fy.Demos.Online/Fixtures/Cases/WordGet.cs → ...y.Demos.Offline/Fixtures/Cases/WordGet.cs b/...fy.Demos.Online/Fixtures/Cases/WordGet.cs → ...y.Demos.Offline/Fixtures/Cases/WordGet.cs
@@ -17,9 +17,9 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 using System;
-using Textify.Online.Words;
+using Textify.Words;
 
-namespace Textify.Demos.Online.Fixtures.Cases
+namespace Textify.Demos.Offline.Fixtures.Cases
 {
     internal class WordGet : IFixture
     {

diff --git a/Textify.Demos.Offline/Fixtures/FixtureManager.cs b/Textify.Demos.Offline/Fixtures/FixtureManager.cs
@@ -36,6 +36,12 @@ internal static class FixtureManager
             // Versioning
             new VersionInfo(),
             new VersionInfoRev(),
+
+            // NameGen
+            new NameGenerator(),
+
+            // Words
+            new WordGet(),
         ];
 
         internal static IFixture GetFixtureFromName(string name)

diff --git a/Textify.Demos.Offline/Properties/launchSettings.json b/Textify.Demos.Offline/Properties/launchSettings.json
@@ -23,6 +23,14 @@
     "Textify - Offline - VersionInfoRev": {
       "commandName": "Project",
       "commandLineArgs": "VersionInfoRev"
+    },
+    "Textify - Offline - WordGet": {
+      "commandName": "Project",
+      "commandLineArgs": "WordGet"
+    },
+    "Textify - Offline - NameGenerator": {
+      "commandName": "Project",
+      "commandLineArgs": "NameGenerator"
     }
   }
 }
diff --git a/Textify.Demos.Online/Fixtures/FixtureManager.cs b/Textify.Demos.Online/Fixtures/FixtureManager.cs
@@ -31,12 +31,6 @@ internal static class FixtureManager
 
             // MailAddress
             new Addresstigation(),
-
-            // NameGen
-            new NameGen(),
-
-            // Words
-            new WordGet(),
         ];
 
         internal static IFixture GetFixtureFromName(string name)

diff --git a/Textify.Demos.Online/Properties/launchSettings.json b/Textify.Demos.Online/Properties/launchSettings.json
@@ -11,14 +11,6 @@
     "Textify - Online - Addresstigation": {
       "commandName": "Project",
       "commandLineArgs": "Addresstigation"
-    },
-    "Textify - Online - NameGen": {
-      "commandName": "Project",
-      "commandLineArgs": "NameGen"
-    },
-    "Textify - Online - WordGet": {
-      "commandName": "Project",
-      "commandLineArgs": "WordGet"
     }
   }
-}
+}
diff --git a/Textify.Online/Textify.Online.csproj b/Textify.Online/Textify.Online.csproj
@@ -5,7 +5,7 @@
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <IncludeSymbols>True</IncludeSymbols>
-    <Version>1.0.1</Version>
+    <Version>1.1.0</Version>
     <Authors>Aptivi</Authors>
     <Company>Aptivi Corp.</Company>
     <Description>Text tools (online)</Description>
@@ -16,7 +16,7 @@
     <PackageTags>dictionary;api;free;csharp;visualbasic;word;meaning;definition;text;tools;library</PackageTags>
     <PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
-    <PackageVersion>1.0.1</PackageVersion>
+    <PackageVersion>1.1.0</PackageVersion>
     <PackageIcon>OfficialAppIcon-Textify-512.png</PackageIcon>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <LangVersion>latest</LangVersion>

diff --git a/Textify.Tests/Sequences/VtSequenceToolsTests.cs b/Textify.Tests/Sequences/VtSequenceToolsTests.cs
@@ -17,7 +17,6 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 using Shouldly;
-using System;
 using System.Text.RegularExpressions;
 using Textify.Sequences.Tools;
 

diff --git a/Textify.Tests/Versioning/SemVerParseTests.cs b/Textify.Tests/Versioning/SemVerParseTests.cs
@@ -70,7 +70,7 @@ public bool TestSemVerEquality(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0", "1.0.0", ExpectedResult = true)]
         [TestCase("0.9.0-alpha1", "1.0.0", ExpectedResult = true)]
-        [TestCase("1.0.1", "1.0.0", ExpectedResult = false)]
+        [TestCase("1.1.0", "1.0.0", ExpectedResult = false)]
         [TestCase("1.1.0-alpha1", "1.0.0", ExpectedResult = false)]
         [TestCase("1.0.0", "1.0.0", ExpectedResult = false)]
         [TestCase("1.0.0-alpha1", "1.0.0", ExpectedResult = true)]
@@ -92,7 +92,7 @@ public bool TestSemVerIsOlderThan(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0", "1.0.0", ExpectedResult = true)]
         [TestCase("0.9.0-alpha1", "1.0.0", ExpectedResult = true)]
-        [TestCase("1.0.1", "1.0.0", ExpectedResult = false)]
+        [TestCase("1.1.0", "1.0.0", ExpectedResult = false)]
         [TestCase("1.1.0-alpha1", "1.0.0", ExpectedResult = false)]
         [TestCase("1.0.0", "1.0.0", ExpectedResult = true)]
         [TestCase("1.0.0-alpha1", "1.0.0", ExpectedResult = true)]
@@ -114,7 +114,7 @@ public bool TestSemVerIsOlderOrEqualTo(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0", "1.0.0", ExpectedResult = false)]
         [TestCase("0.9.0-alpha1", "1.0.0", ExpectedResult = false)]
-        [TestCase("1.0.1", "1.0.0", ExpectedResult = true)]
+        [TestCase("1.1.0", "1.0.0", ExpectedResult = true)]
         [TestCase("1.1.0-alpha1", "1.0.0", ExpectedResult = true)]
         [TestCase("1.0.0-alpha1", "1.0.0", ExpectedResult = false)]
         [TestCase("1.0.0", "1.0.0-alpha1", ExpectedResult = true)]
@@ -135,7 +135,7 @@ public bool TestSemVerIsNewerThan(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0", "1.0.0", ExpectedResult = false)]
         [TestCase("0.9.0-alpha1", "1.0.0", ExpectedResult = false)]
-        [TestCase("1.0.1", "1.0.0", ExpectedResult = true)]
+        [TestCase("1.1.0", "1.0.0", ExpectedResult = true)]
         [TestCase("1.1.0-alpha1", "1.0.0", ExpectedResult = true)]
         [TestCase("1.0.0", "1.0.0", ExpectedResult = true)]
         [TestCase("1.0.0-alpha1", "1.0.0", ExpectedResult = false)]

diff --git a/Textify.Tests/Versioning/SemVerWithRevParseTests.cs b/Textify.Tests/Versioning/SemVerWithRevParseTests.cs
@@ -71,7 +71,7 @@ public bool TestSemVerEquality(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0.5", "1.0.0.5", ExpectedResult = true)]
         [TestCase("0.9.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
-        [TestCase("1.0.1.0", "1.0.0.5", ExpectedResult = false)]
+        [TestCase("1.1.0.0", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.1.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.0.0.5", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.0.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
@@ -93,7 +93,7 @@ public bool TestSemVerIsOlderThan(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0.5", "1.0.0.5", ExpectedResult = true)]
         [TestCase("0.9.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
-        [TestCase("1.0.1.0", "1.0.0.5", ExpectedResult = false)]
+        [TestCase("1.1.0.0", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.1.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.0.0.5", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.0.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
@@ -115,7 +115,7 @@ public bool TestSemVerIsOlderOrEqualTo(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0.5", "1.0.0.5", ExpectedResult = false)]
         [TestCase("0.9.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]
-        [TestCase("1.0.1.0", "1.0.0.5", ExpectedResult = true)]
+        [TestCase("1.1.0.0", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.1.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.0.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]
         [TestCase("1.0.0.5", "1.0.0.5-alpha1", ExpectedResult = true)]
@@ -136,7 +136,7 @@ public bool TestSemVerIsNewerThan(string version, string otherVersion)
         [Test]
         [TestCase("0.9.0.5", "1.0.0.5", ExpectedResult = false)]
         [TestCase("0.9.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]
-        [TestCase("1.0.1.0", "1.0.0.5", ExpectedResult = true)]
+        [TestCase("1.1.0.0", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.1.0.5-alpha1", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.0.0.5", "1.0.0.5", ExpectedResult = true)]
         [TestCase("1.0.0.5-alpha1", "1.0.0.5", ExpectedResult = false)]

diff --git a/Textify.Online/NameGen/NameGenderType.cs → Textify/NameGen/NameGenderType.cs b/Textify.Online/NameGen/NameGenderType.cs → Textify/NameGen/NameGenderType.cs
@@ -17,7 +17,7 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //
 
-namespace Textify.Online.NameGen
+namespace Textify.NameGen
 {
     /// <summary>
     /// Name gender type

diff --git a/Textify.Online/NameGen/NameGenerator.cs → Textify/NameGen/NameGenerator.cs b/Textify.Online/NameGen/NameGenerator.cs → Textify/NameGen/NameGenerator.cs
@@ -21,10 +21,11 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Net.Http;
 using System.Threading.Tasks;
+using Textify.General;
+using Textify.NameGen.Resources;
 
-namespace Textify.Online.NameGen
+namespace Textify.NameGen
 {
     /// <summary>
     /// Name generator class
@@ -34,12 +35,6 @@ public static class NameGenerator
         internal static string[] Names = [];
         internal static string[] Surnames = [];
         private static NameGenderType lastGenderType = NameGenderType.Unified;
-        private static readonly HttpClient NameClient = new();
-        private static readonly string nameAddressPart = "https://cdn.jsdelivr.net/gh/Aptivi/NamesList@latest/Processed/";
-        private static readonly string unifiedNameListFileName = "FirstNames.txt";
-        private static readonly string femaleNameListFileName = "FirstNames_Female.txt";
-        private static readonly string maleNameListFileName = "FirstNames_Male.txt";
-        private static readonly string surnameListFileName = "Surnames.txt";
 
         /// <summary>
         /// Populates the names and the surnames for the purpose of initialization
@@ -56,17 +51,20 @@ public static async Task PopulateNamesAsync(NameGenderType genderType = NameGend
         {
             try
             {
-                string surnameAddress = $"{nameAddressPart}{surnameListFileName}";
-                string namesFileName =
-                    genderType == NameGenderType.Female ? femaleNameListFileName :
-                    genderType == NameGenderType.Male ? maleNameListFileName :
-                    unifiedNameListFileName;
-                string nameAddress = $"{nameAddressPart}{namesFileName}";
-
                 if (Names.Length == 0 || genderType != lastGenderType)
-                    Names = await PopulateInternalAsync(nameAddress);
+                {
+                    var namesBytes =
+                        genderType == NameGenderType.Female ? NamesData.FirstNames_Female :
+                        genderType == NameGenderType.Male ? NamesData.FirstNames_Male :
+                        NamesData.FirstNames;
+                    var namesByteStream = new MemoryStream(namesBytes);
+                    Names = (await new StreamReader(namesByteStream).ReadToEndAsync()).SplitNewLines();
+                }
                 if (Surnames.Length == 0)
-                    Surnames = await PopulateInternalAsync(surnameAddress);
+                {
+                    var lastsByteStream = new MemoryStream(NamesData.Surnames);
+                    Surnames = (await new StreamReader(lastsByteStream).ReadToEndAsync()).SplitNewLines();
+                }
                 lastGenderType = genderType;
             }
             catch (Exception ex)
@@ -491,22 +489,5 @@ internal static string[] GenerateNameArray(int Count, string NamePrefix, string
             }
             return [.. namesList];
         }
-
-        internal static async Task<string[]> PopulateInternalAsync(string nameLink)
-        {
-            HttpResponseMessage Response = await NameClient.GetAsync(nameLink);
-            Response.EnsureSuccessStatusCode();
-            Stream SurnamesStream = await Response.Content.ReadAsStreamAsync();
-            string SurnamesString = new StreamReader(SurnamesStream).ReadToEnd();
-            return SurnamesString.SplitNewLines();
-        }
-
-        /// <summary>
-        /// Makes a string array with new line as delimiter
-        /// </summary>
-        /// <param name="Str">Target string</param>
-        /// <returns></returns>
-        internal static string[] SplitNewLines(this string Str) =>
-            Str.Replace(Convert.ToChar(13), default).Split(Convert.ToChar(10));
     }
 }
diff --git a/Textify/NameGen/Resources/NamesData.Designer.cs b/Textify/NameGen/Resources/NamesData.Designer.cs