PR comments

Author: josephmyers

src/SIL.XForge.Scripture/Models/ParatextNote.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 
 namespace SIL.XForge.Scripture.Models;
@@ -8,33 +7,33 @@ namespace SIL.XForge.Scripture.Models;
 /// </summary>
 public class ParatextNote
 {
-    public string Id { get; set; } = string.Empty;
+    public required string Id { get; init; }
 
-    public string VerseRef { get; set; } = string.Empty;
+    public required string VerseRef { get; init; }
 
-    public IReadOnlyList<ParatextNoteComment> Comments { get; set; } = Array.Empty<ParatextNoteComment>();
+    public required IReadOnlyList<ParatextNoteComment> Comments { get; init; }
 }
 
 /// <summary>
 /// Represents a single comment that belongs to a Paratext note thread.
 /// </summary>
 public class ParatextNoteComment
 {
-    public string VerseRef { get; set; } = string.Empty;
+    public required string VerseRef { get; init; }
 
-    public string Content { get; set; } = string.Empty;
+    public required string Content { get; init; }
 
-    public ParatextNoteTag? Tag { get; set; }
+    public ParatextNoteTag? Tag { get; init; }
 }
 
 /// <summary>
 /// Represents a Paratext comment tag that has been applied to a comment.
 /// </summary>
 public class ParatextNoteTag
 {
-    public int Id { get; set; }
+    public int Id { get; init; }
 
-    public string Name { get; set; } = string.Empty;
+    public required string Name { get; init; }
 
-    public string Icon { get; set; } = string.Empty;
+    public required string Icon { get; init; }
 }

src/SIL.XForge.Scripture/Models/Question.cs

@@ -15,6 +15,6 @@ public class Question : ProjectData
     public DateTime? DateArchived { get; set; }
     public DateTime DateModified { get; set; }
     public DateTime DateCreated { get; set; }
-    public string TransceleratorQuestionId { get; set; }
-    public string ParatextNoteId { get; set; }
+    public string? TransceleratorQuestionId { get; set; }
+    public string? ParatextNoteId { get; set; }
 }

src/SIL.XForge.Scripture/Services/INotesService.cs

@@ -1,8 +1,19 @@
+using System;
+using System.Collections.Generic;
 using Paratext.Data;
+using Paratext.Data.ProjectComments;
+using SIL.XForge.Scripture.Models;
 
 namespace SIL.XForge.Scripture.Services;
 
 public interface IParatextDataHelper
 {
     void CommitVersionedText(ScrText scrText, string comment);
+
+    IReadOnlyList<ParatextNote> GetNotes(
+        CommentManager? commentManager,
+        CommentTags? commentTags,
+        Func<CommentThread, bool>? predicate = null,
+        bool includeInactiveThreads = true
+    );
 }

src/SIL.XForge.Scripture/Services/IParatextDataHelper.cs

@@ -3,7 +3,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using System.Xml.Linq;
-using Paratext.Data.ProjectComments;
 using SIL.Converters.Usj;
 using SIL.XForge.Models;
 using SIL.XForge.Realtime;
@@ -54,9 +53,8 @@ Task<int> PutBookText(
         Dictionary<int, string> chapterAuthors = null
     );
     string GetNotes(UserSecret userSecret, string paratextId, int bookNum);
-    IReadOnlyList<ParatextNote> GetNoteThreads(UserSecret userSecret, string paratextId);
+    IReadOnlyList<ParatextNote>? GetNoteThreads(UserSecret userSecret, string paratextId);
     SyncMetricInfo PutNotes(UserSecret userSecret, string paratextId, XElement notesElement);
-    CommentTags? GetCommentTags(UserSecret userSecret, string paratextId);
     Task<SyncMetricInfo> UpdateParatextCommentsAsync(
         UserSecret userSecret,
         string paratextId,

src/SIL.XForge.Scripture/Services/IParatextService.cs

@@ -1,8 +1,5 @@
-using System;
 using System.Collections.Generic;
-using System.Globalization;
 using System.Linq;
-using System.Reflection;
 using System.Text;
 using System.Text.RegularExpressions;
 using System.Xml;
@@ -23,18 +20,16 @@ namespace SIL.XForge.Scripture.Services;
 ///  * Additional null checking
 ///  * Code reformatting
 /// </remarks>
-public static class NotesFormatter
+public static partial class NotesFormatter
 {
     private const string NotesSchemaVersion = "1.1";
 
     /// <summary>
     /// The regular expression for finding whitespace before XML tags.
     /// </summary>
     /// <remarks>This is used by <see cref="ParseNotesToXElement"/>.</remarks>
-    private static readonly Regex WhitespaceBeforeTagsRegex = new Regex(
-        @"\n\s*<",
-        RegexOptions.CultureInvariant | RegexOptions.Compiled
-    );
+    [GeneratedRegex(@"\n\s*<", RegexOptions.CultureInvariant)]
+    private static partial Regex WhitespaceBeforeTagsRegex();
 
     #region Public methods
     /// <summary>
@@ -71,33 +66,10 @@ public static List<List<Comment>> ParseNotes(XElement noteXml, ParatextUser ptUs
     public static XElement ParseNotesToXElement(string text)
     {
         text = text.Trim().Replace("\r\n", "\n");
-        text = WhitespaceBeforeTagsRegex.Replace(text, "<");
+        text = WhitespaceBeforeTagsRegex().Replace(text, "<");
         return XElement.Parse(text, LoadOptions.PreserveWhitespace);
     }
 
-    /// <summary>
-    /// Replaces numeric tag identifiers in note XML with the corresponding Paratext comment tag data.
-    /// </summary>
-    /// <param name="notesElement">The notes XML element.</param>
-    /// <param name="commentTags">The Paratext comment tag collection.</param>
-    public static void ReplaceTagIdentifiersWithCommentTags(XElement notesElement, CommentTags commentTags)
-    {
-        if (notesElement == null || commentTags == null)
-            return;
-
-        List<XElement> tagElements = [.. notesElement.Descendants("tagAdded")];
-        foreach (XElement tagElement in tagElements)
-        {
-            string elementValue = tagElement.Value;
-            if (!int.TryParse(elementValue, NumberStyles.Integer, CultureInfo.InvariantCulture, out int tagId))
-                continue;
-
-            CommentTag mappedTag = commentTags.Get(tagId);
-            XElement replacement = CreateTagElement(tagElement.Name, mappedTag);
-            tagElement.ReplaceWith(replacement);
-        }
-    }
-
     #endregion
 
     #region Private helper methods for formatting
@@ -199,48 +171,6 @@ private static XElement FormatSelection(ScriptureSelection selection)
         return selElem;
     }
 
-    private static XElement CreateTagElement(XName elementName, CommentTag commentTag)
-    {
-        XElement element = new XElement(elementName);
-        if (commentTag == null)
-            return element;
-
-        PropertyInfo[] properties = typeof(CommentTag).GetProperties(BindingFlags.Instance | BindingFlags.Public);
-        foreach (PropertyInfo property in properties.Where(property => property.CanRead))
-        {
-            object value = property.GetValue(commentTag);
-            if (value == null)
-                continue;
-
-            string propertyValue;
-            if (value is string stringValue)
-            {
-                if (string.IsNullOrEmpty(stringValue))
-                    continue;
-                propertyValue = stringValue;
-            }
-            else if (value is int intValue)
-            {
-                propertyValue = intValue.ToString(CultureInfo.InvariantCulture);
-            }
-            else if (value is bool boolValue)
-            {
-                propertyValue = boolValue ? bool.TrueString : bool.FalseString;
-            }
-            else if (value is Enum enumValue)
-            {
-                propertyValue = enumValue.ToString();
-            }
-            else
-            {
-                continue;
-            }
-
-            element.Add(new XElement(property.Name, propertyValue));
-        }
-
-        return element;
-    }
     #endregion
 
     #region Private helper methods for parsing