Add functionality to Paratext project settings parser (#163)

- add ParatextProjectSettings.GetBookFileName() - add ZipParatextProjectSettingsParserBase class
sillsdev · Feb 1, 2024 · 19f5789 · 19f5789
1 parent 2063815
commit 19f5789
Show file tree

Hide file tree

Showing 4 changed files with 161 additions and 35 deletions.
diff --git a/src/SIL.Machine/Corpora/ParatextProjectSettings.cs b/src/SIL.Machine/Corpora/ParatextProjectSettings.cs
@@ -1,4 +1,5 @@
-using System.Text;
+using System.Globalization;
+using System.Text;
 using SIL.Scripture;
 
 namespace SIL.Machine.Corpora
@@ -43,5 +44,34 @@ string biblicalTermsFileName
         public string BiblicalTermsListType { get; }
         public string BiblicalTermsProjectName { get; }
         public string BiblicalTermsFileName { get; }
+
+        public string GetBookFileName(string bookId)
+        {
+            string bookPart;
+            if (FileNameForm == "MAT")
+                bookPart = bookId;
+            else if (FileNameForm == "40" || FileNameForm == "41")
+                bookPart = GetBookFileNameDigits(bookId);
+            else
+                bookPart = GetBookFileNameDigits(bookId) + bookId;
+            return FileNamePrefix + bookPart + FileNameSuffix;
+        }
+
+        private static string GetBookFileNameDigits(string bookId)
+        {
+            int bookNum = Canon.BookIdToNumber(bookId);
+
+            if (bookNum < 10)
+                return "0" + bookNum;
+            if (bookNum < 40)
+                return bookNum.ToString(CultureInfo.InvariantCulture);
+            if (bookNum < 100)
+                return (bookNum + 1).ToString(CultureInfo.InvariantCulture);
+            if (bookNum < 110)
+                return "A" + (bookNum - 100);
+            if (bookNum < 120)
+                return "B" + (bookNum - 110);
+            return "C" + (bookNum - 120);
+        }
     }
 }
diff --git a/src/SIL.Machine/Corpora/ZipParatextProjectSettingsParser.cs b/src/SIL.Machine/Corpora/ZipParatextProjectSettingsParser.cs
@@ -1,11 +1,10 @@
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
-using SIL.IO;
 
 namespace SIL.Machine.Corpora
 {
-    public class ZipParatextProjectSettingsParser : ParatextProjectSettingsParserBase
+    public class ZipParatextProjectSettingsParser : ZipParatextProjectSettingsParserBase
     {
         private readonly ZipArchive _archive;
 
@@ -14,38 +13,6 @@ public ZipParatextProjectSettingsParser(ZipArchive archive)
             _archive = archive;
         }
 
-        protected override UsfmStylesheet CreateStylesheet(string fileName)
-        {
-            TempFile stylesheetTempFile = null;
-            TempFile customStylesheetTempFile = null;
-            try
-            {
-                string stylesheetPath = fileName;
-                ZipArchiveEntry stylesheetEntry = _archive.GetEntry(fileName);
-                if (stylesheetEntry != null)
-                {
-                    stylesheetTempFile = TempFile.CreateAndGetPathButDontMakeTheFile();
-                    stylesheetEntry.ExtractToFile(stylesheetTempFile.Path);
-                    stylesheetPath = stylesheetTempFile.Path;
-                }
-
-                string customStylesheetPath = null;
-                ZipArchiveEntry customStylesheetEntry = _archive.GetEntry("custom.sty");
-                if (customStylesheetEntry != null)
-                {
-                    customStylesheetTempFile = TempFile.CreateAndGetPathButDontMakeTheFile();
-                    customStylesheetEntry.ExtractToFile(customStylesheetTempFile.Path);
-                    customStylesheetPath = customStylesheetTempFile.Path;
-                }
-                return new UsfmStylesheet(stylesheetPath, customStylesheetPath);
-            }
-            finally
-            {
-                stylesheetTempFile?.Dispose();
-                customStylesheetTempFile?.Dispose();
-            }
-        }
-
         protected override bool Exists(string fileName)
         {
             return _archive.GetEntry(fileName) != null;

diff --git a/src/SIL.Machine/Corpora/ZipParatextProjectSettingsParserBase.cs b/src/SIL.Machine/Corpora/ZipParatextProjectSettingsParserBase.cs
@@ -0,0 +1,46 @@
+using System.IO;
+using SIL.IO;
+
+namespace SIL.Machine.Corpora
+{
+    public abstract class ZipParatextProjectSettingsParserBase : ParatextProjectSettingsParserBase
+    {
+        protected override UsfmStylesheet CreateStylesheet(string fileName)
+        {
+            TempFile stylesheetTempFile = null;
+            TempFile customStylesheetTempFile = null;
+            try
+            {
+                string stylesheetPath = fileName;
+                if (Exists(fileName))
+                {
+                    stylesheetTempFile = TempFile.CreateAndGetPathButDontMakeTheFile();
+                    using (Stream source = Open(fileName))
+                    using (Stream target = File.OpenWrite(stylesheetTempFile.Path))
+                    {
+                        source.CopyTo(target);
+                    }
+                    stylesheetPath = stylesheetTempFile.Path;
+                }
+
+                string customStylesheetPath = null;
+                if (Exists("custom.sty"))
+                {
+                    customStylesheetTempFile = TempFile.CreateAndGetPathButDontMakeTheFile();
+                    using (Stream source = Open("custom.sty"))
+                    using (Stream target = File.OpenWrite(customStylesheetTempFile.Path))
+                    {
+                        source.CopyTo(target);
+                    }
+                    customStylesheetPath = customStylesheetTempFile.Path;
+                }
+                return new UsfmStylesheet(stylesheetPath, customStylesheetPath);
+            }
+            finally
+            {
+                stylesheetTempFile?.Dispose();
+                customStylesheetTempFile?.Dispose();
+            }
+        }
+    }
+}
diff --git a/tests/SIL.Machine.Tests/Corpora/ParatextProjectSettingsTests.cs b/tests/SIL.Machine.Tests/Corpora/ParatextProjectSettingsTests.cs
@@ -0,0 +1,83 @@
+using System.Text;
+using NUnit.Framework;
+using SIL.Scripture;
+
+namespace SIL.Machine.Corpora
+{
+    [TestFixture]
+    public class ParatextProjectSettingsTests
+    {
+        [Test]
+        public void GetBookFileName_BookNum()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("MRK"), Is.EqualTo("PROJ42.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumBookId()
+        {
+            ParatextProjectSettings settings = CreateSettings("41MAT");
+            Assert.That(settings.GetBookFileName("MRK"), Is.EqualTo("PROJ42MRK.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookId()
+        {
+            ParatextProjectSettings settings = CreateSettings("MAT");
+            Assert.That(settings.GetBookFileName("MRK"), Is.EqualTo("PROJMRK.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumDoubleDigit()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("GEN"), Is.EqualTo("PROJ01.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumXXG()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("XXG"), Is.EqualTo("PROJ100.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumPrefixA()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("FRT"), Is.EqualTo("PROJA0.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumPrefixB()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("TDX"), Is.EqualTo("PROJB0.SFM"));
+        }
+
+        [Test]
+        public void GetBookFileName_BookNumPrefixC()
+        {
+            ParatextProjectSettings settings = CreateSettings("41");
+            Assert.That(settings.GetBookFileName("3MQ"), Is.EqualTo("PROJC0.SFM"));
+        }
+
+        private static ParatextProjectSettings CreateSettings(string fileNameForm)
+        {
+            return new ParatextProjectSettings(
+                "Name",
+                "Name",
+                Encoding.UTF8,
+                ScrVers.English,
+                new UsfmStylesheet("usfm.sty"),
+                "PROJ",
+                fileNameForm,
+                ".SFM",
+                "Major",
+                "",
+                "BiblicalTerms.xml"
+            );
+        }
+    }
+}