32943-Sugar for HierarchyId path generation (#33062)

Rezakazemi890 · web-flow · commit 13ee42c9bfc7 · 2024-02-28T13:07:44.000Z
* feat: add Parse method with parent parameter overload to HierarchyId abstraction * refactor: refactor and clean new parse overload * test: add test for parse overloads * test: separate and refactor parse tests * fix: #32943-resolve [review comment](#33062 (comment)) * fix: #32943 - resolve [review comment](#33062 (comment)) * fix: #32943 - resolve [review comment](#33062 (comment)) * refactor: #32943 - replace IReadOnlyList to params for easier use * fix: #32943 - resolve [review comment](#33062 (comment))
diff --git a/src/EFCore.SqlServer.Abstractions/HierarchyId.cs b/src/EFCore.SqlServer.Abstractions/HierarchyId.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics.CodeAnalysis;
+using System.Text;
 using System.Text.Json.Serialization;
 using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.SqlServer.Types;
@@ -25,7 +26,7 @@ public HierarchyId()
     }
 
     /// <summary>
-    ///     Initializes a new instance of the<see cref="HierarchyId" /> class. Equivalent to <see cref="Parse" />.
+    ///     Initializes a new instance of the<see cref="HierarchyId" /> class. Equivalent to <see cref="Parse(string?)" />.
     /// </summary>
     /// <param name="value">The string representation of the node.</param>
     public HierarchyId(string value)
@@ -63,6 +64,35 @@ public static HierarchyId GetRoot()
     public static HierarchyId? Parse(string? input)
         => (HierarchyId?)SqlHierarchyId.Parse(input);
 
+    /// <summary>
+    /// Converts the <paramref name= "parentHierarchyId" /> and <paramref name= "parentId" /> of a node to a <see cref="HierarchyId" /> value.
+    /// </summary>
+    /// <param name="parentHierarchyId">The parent HierarchyId of node.</param>
+    /// <param name="parentId">The parent Id of current node. It can be more than one element if want have path like: "/1/2/3.1/", otherwise one element for have path like: "/1/2/3/".</param>
+    /// <returns>A <see cref="HierarchyId" /> value.</returns>
+    public static HierarchyId Parse(HierarchyId parentHierarchyId , params int[] parentId)
+        => GenerateHierarchyIdBasedOnParent(parentHierarchyId, parentId);
+
+    //This Method can move to "SqlHierarchyId in Microsoft.SqlServer.Types", if we don't want put it in this abstraction.
+    private static HierarchyId GenerateHierarchyIdBasedOnParent(HierarchyId parent, params int[] parentId)
+    {
+        if (parent is null)
+        {
+            return HierarchyId.GetRoot();
+        }
+
+        if (parentId.Length < 1)
+        {
+            return parent;
+        }
+
+        var specificPath = new StringBuilder(parent.ToString());
+        specificPath.Append(string.Join(".", parentId));
+        specificPath.Append('/');
+
+        return HierarchyId.Parse(specificPath.ToString());
+    }
+
     /// <inheritdoc />
     public virtual int CompareTo(HierarchyId? other)
         => _value.CompareTo((SqlHierarchyId)other);
diff --git a/test/EFCore.SqlServer.HierarchyId.Tests/WrapperTests.cs b/test/EFCore.SqlServer.HierarchyId.Tests/WrapperTests.cs
@@ -35,4 +35,30 @@ public void GetReparentedValue_returns_null_when_newRoot_is_null()
     [ConditionalFact]
     public void IsDescendantOf_returns_false_when_parent_is_null()
         => Assert.False(HierarchyId.Parse("/1/").IsDescendantOf(null));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentId_is_simpleId()
+        => Assert.Equal(HierarchyId.Parse(_parent, 2), HierarchyId.Parse("/1/2/"));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentId_is_dottedString()
+        => Assert.Equal(HierarchyId.Parse(_parent, 2,1), HierarchyId.Parse("/1/2.1/"));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentId_is_empty()
+        => Assert.Equal(HierarchyId.Parse(_parent), HierarchyId.Parse("/1/"));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentHierarchy_is_root_and_parentId_is_simple()
+        => Assert.Equal(HierarchyId.Parse(HierarchyId.GetRoot(),1), HierarchyId.Parse("/1/"));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentHierarchy_is_root_and_parentId_is_empty()
+        => Assert.Equal(HierarchyId.Parse(HierarchyId.GetRoot()), HierarchyId.Parse("/"));
+
+    [ConditionalFact]
+    public void Parse_overloads_works_when_parentHierarchy_is_null_and_parentId_is_empty()
+        => Assert.Equal(HierarchyId.Parse(null,[]), HierarchyId.Parse("/"));
+
+    private readonly HierarchyId _parent = HierarchyId.Parse("/1/");
 }
