Change class name; remove unnecessary methods and properties

Author: irvinesunday

src/Microsoft.OpenApi/Services/OpenApiUrlSpaceNode.cs renamed to src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs

@@ -1,24 +1,21 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using System.Collections.Generic;
 using System.Linq;
-using System.Security.Cryptography;
-using System.Text;
-using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Services
 {
     /// <summary>
     /// A directory structure representing the paths of an OpenAPI document.
     /// </summary>
-    public class OpenApiUrlSpaceNode
+    public class OpenApiUrlTreeNode
     {
         /// <summary>
         /// All the subdirectories of a node.
         /// </summary>
-        public IDictionary<string, OpenApiUrlSpaceNode> Children { get; } = new Dictionary<string, OpenApiUrlSpaceNode>();
+        public IDictionary<string, OpenApiUrlTreeNode> Children { get; } = new Dictionary<string, OpenApiUrlTreeNode>();
 
         /// <summary>
         /// The name tag for a group of nodes.
@@ -40,41 +37,11 @@ public class OpenApiUrlSpaceNode
         /// </summary>
         public bool IsParameter => Segment.StartsWith("{");
 
-        /// <summary>
-        /// Flag indicating whether a node segment is a path function.
-        /// </summary>
-        public bool IsFunction => Segment.Contains("(");
-
         /// <summary>
         /// The subdirectory of a relative path.
         /// </summary>
         public string Segment { get; private set; }
 
-        /// <summary>
-        /// The Pascal-cased alphabet name of a segment.
-        /// </summary>
-        public string Identifier
-        {
-            get
-            {
-                string identifier;
-                if (IsParameter)
-                {
-                    identifier = Segment.Substring(1, Segment.Length - 2).ToPascalCase();
-                }
-                else
-                {
-                    identifier = Segment.ToPascalCase().Replace("()", "");
-                    var openParen = identifier.IndexOf("(");
-                    if (openParen >= 0)
-                    {
-                        identifier = identifier.Substring(0, openParen);
-                    }
-                }
-                return identifier;
-            }
-        }
-
         /// <summary>
         /// Flag indicating whether a PathItem has operations.
         /// </summary>
@@ -88,78 +55,39 @@ public bool HasOperations()
         /// Constructor.
         /// </summary>
         /// <param name="segment">The subdirectory of a relative path.</param>
-        public OpenApiUrlSpaceNode(string segment)
+        private OpenApiUrlTreeNode(string segment)
         {
             Segment = segment;
         }
 
         /// <summary>
-        /// Uses SHA256 hash algorithm to hash the Path value.
-        /// </summary>
-        /// <returns>The hashed value.</returns>
-        public string Hash()
-        {
-            using (SHA256 sha256Hash = SHA256.Create())
-            {
-                return GetHash(sha256Hash, Path);
-            }
-        }
-
-        /// <summary>
-        /// Hashes a string value using a specified hash algorithm.
-        /// </summary>
-        /// <param name="hashAlgorithm">The hash algorithm to use for hashing.</param>
-        /// <param name="input">The string to hash.</param>
-        /// <returns>The hashed value.</returns>
-        private static string GetHash(HashAlgorithm hashAlgorithm, string input)
-        {
-            // Convert the input string to a byte array and compute the hash.
-            byte[] data = hashAlgorithm.ComputeHash(Encoding.UTF8.GetBytes(input));
-
-            // Create a new Stringbuilder to collect the bytes
-            // and create a string.
-            var sBuilder = new StringBuilder();
-
-            // Loop through each byte of the hashed data
-            // and format each one as a hexadecimal string.
-            for (int i = 0; i < 2; i++)  // data.Length  Limit to 4 chars
-            {
-                sBuilder.Append(data[i].ToString("x2"));
-            }
-
-            // Return the hexadecimal string.
-            return sBuilder.ToString();
-        }
-
-        /// <summary>
-        /// Creates a structured directory of <see cref="OpenApiUrlSpaceNode"/> nodes from the paths of an OpenAPI document.
+        /// Creates a structured directory of <see cref="OpenApiUrlTreeNode"/> nodes from the paths of an OpenAPI document.
         /// </summary>
         /// <param name="doc">The OpenAPI document.</param>
-        /// <param name="label">Name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> nodes
+        /// <param name="label">Name tag for labelling the <see cref="OpenApiUrlTreeNode"/> nodes
         /// in the directory structure.</param>
-        /// <returns>The root node of the created <see cref="OpenApiUrlSpaceNode"/> directory structure.</returns>
-        public static OpenApiUrlSpaceNode Create(OpenApiDocument doc, string label = "")
+        /// <returns>The root node of the created <see cref="OpenApiUrlTreeNode"/> directory structure.</returns>
+        public static OpenApiUrlTreeNode Create(OpenApiDocument doc, string label = "")
         {
-            OpenApiUrlSpaceNode root = null;
+            OpenApiUrlTreeNode root = new OpenApiUrlTreeNode(string.Empty);
 
             var paths = doc?.Paths;
             if (paths != null)
             {
-                root = new OpenApiUrlSpaceNode(string.Empty);
-
                 foreach (var path in paths)
                 {
                     root.Attach(path.Key, path.Value, label);
                 }
             }
+
             return root;
         }
 
         /// <summary>
-        /// Retrieves the paths from an OpenAPI document and appends the items to an <see cref="OpenApiUrlSpaceNode"/> node.
+        /// Retrieves the paths from an OpenAPI document and appends the items to an <see cref="OpenApiUrlTreeNode"/> node.
         /// </summary>
         /// <param name="doc">The OpenAPI document.</param>
-        /// <param name="label">Name tag for labelling related <see cref="OpenApiUrlSpaceNode"/>
+        /// <param name="label">Name tag for labelling related <see cref="OpenApiUrlTreeNode"/>
         /// nodes in the directory structure.</param>
         public void Attach(OpenApiDocument doc, string label)
         {
@@ -174,13 +102,13 @@ public void Attach(OpenApiDocument doc, string label)
         }
 
         /// <summary>
-        /// Appends an OpenAPI path and the PathItems to an <see cref="OpenApiUrlSpaceNode"/> node.
+        /// Appends an OpenAPI path and the PathItems to an <see cref="OpenApiUrlTreeNode"/> node.
         /// </summary>
         /// <param name="path">An OpenAPI path.</param>
         /// <param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
-        /// <param name="label">A name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> node.</param>
-        /// <returns>An <see cref="OpenApiUrlSpaceNode"/> node describing an OpenAPI path.</returns>
-        public OpenApiUrlSpaceNode Attach(string path, OpenApiPathItem pathItem, string label)
+        /// <param name="label">A name tag for labelling the <see cref="OpenApiUrlTreeNode"/> node.</param>
+        /// <returns>An <see cref="OpenApiUrlTreeNode"/> node describing an OpenAPI path.</returns>
+        public OpenApiUrlTreeNode Attach(string path, OpenApiPathItem pathItem, string label)
         {
             if (path.StartsWith("/"))
             {
@@ -192,14 +120,14 @@ public OpenApiUrlSpaceNode Attach(string path, OpenApiPathItem pathItem, string
         }
 
         /// <summary>
-        /// Assembles the constituent properties of an <see cref="OpenApiUrlSpaceNode"/> node.
+        /// Assembles the constituent properties of an <see cref="OpenApiUrlTreeNode"/> node.
         /// </summary>
         /// <param name="segments">IEnumerable subdirectories of a relative path.</param>
         /// <param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
-        /// <param name="label">A name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> node.</param>
+        /// <param name="label">A name tag for labelling the <see cref="OpenApiUrlTreeNode"/> node.</param>
         /// <param name="currentPath">The relative path of a node.</param>
-        /// <returns>An <see cref="OpenApiUrlSpaceNode"/> node with all constituent properties assembled.</returns>
-        private OpenApiUrlSpaceNode Attach(IEnumerable<string> segments, OpenApiPathItem pathItem, string label, string currentPath)
+        /// <returns>An <see cref="OpenApiUrlTreeNode"/> node with all constituent properties assembled.</returns>
+        private OpenApiUrlTreeNode Attach(IEnumerable<string> segments, OpenApiPathItem pathItem, string label, string currentPath)
         {
             var segment = segments.FirstOrDefault();
             if (string.IsNullOrEmpty(segment))
@@ -220,7 +148,7 @@ private OpenApiUrlSpaceNode Attach(IEnumerable<string> segments, OpenApiPathItem
             }
             else
             {
-                var node = new OpenApiUrlSpaceNode(segment)
+                var node = new OpenApiUrlTreeNode(segment)
                 {
                     Path = currentPath + "\\" + segment
                 };

test/Microsoft.OpenApi.Tests/Services/OpenApiUrlSpaceTests.cs renamed to test/Microsoft.OpenApi.Tests/Services/OpenApiUrlTreeNodeTests.cs

@@ -8,16 +8,18 @@
 
 namespace Microsoft.OpenApi.Tests.Services
 {
-    public class OpenApiUrlSpaceTests
+    public class OpenApiUrlTreeNodeTests
     {
         [Fact]
-        public void CreateEmptyUrlSpace()
+        public void CreateEmptyUrlTreeNode()
         {
             var doc = new OpenApiDocument() { };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
+            var rootNode1 = OpenApiUrlTreeNode.Create(null);
 
-            Assert.Null(rootNode);
+            Assert.NotNull(rootNode);
+            Assert.NotNull(rootNode1);
         }
 
         [Fact]
@@ -31,7 +33,7 @@ public void CreateSingleRootWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
 
             Assert.NotNull(rootNode);
             Assert.NotNull(rootNode.PathItem);
@@ -49,7 +51,7 @@ public void CreatePathWithoutRootWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
 
             Assert.NotNull(rootNode);
             Assert.Null(rootNode.PathItem);
@@ -71,7 +73,7 @@ public void CreateMultiplePathsWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc, "Ensuite");
+            var rootNode = OpenApiUrlTreeNode.Create(doc, "Ensuite");
 
             Assert.NotNull(rootNode);
             Assert.Equal(2, rootNode.Children.Count);
@@ -105,7 +107,7 @@ public void AttachDocumentWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc1, "Penthouse");
+            var rootNode = OpenApiUrlTreeNode.Create(doc1, "Penthouse");
             rootNode.Attach(doc2, "Five-star");
 
             Assert.NotNull(rootNode);
@@ -127,7 +129,7 @@ public void CreatePathsWithMultipleSegmentsWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
 
             Assert.NotNull(rootNode);
             Assert.Equal(2, rootNode.Children.Count);
@@ -168,34 +170,12 @@ public void HasOperationsWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
             Assert.NotNull(rootNode);
             Assert.False(rootNode.Children["home"].HasOperations());
             Assert.True(rootNode.Children["car"].HasOperations());
         }
 
-        [Fact]
-        public void SegmentIsFunctionWorks()
-        {
-            var doc = new OpenApiDocument()
-            {
-                Paths = new OpenApiPaths()
-                {
-                    ["/"] = new OpenApiPathItem(),
-                    ["/home/gate/open()"] = new OpenApiPathItem()
-                }
-            };
-
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
-
-            Assert.NotNull(rootNode);
-            Assert.Equal(1, rootNode.Children.Count);
-            Assert.NotNull(rootNode.Children["home"].Children["gate"].Children["open()"].PathItem);
-            Assert.True(rootNode.Children["home"].Children["gate"].Children["open()"].IsFunction);
-            Assert.Equal("Open", rootNode.Children["home"].Children["gate"].Children["open()"].Identifier);
-            Assert.Equal("open()", rootNode.Children["home"].Children["gate"].Children["open()"].Segment);
-        }
-
         [Fact]
         public void SegmentIsParameterWorks()
         {
@@ -208,13 +188,12 @@ public void SegmentIsParameterWorks()
                 }
             };
 
-            var rootNode = OpenApiUrlSpaceNode.Create(doc);
+            var rootNode = OpenApiUrlTreeNode.Create(doc);
 
             Assert.NotNull(rootNode);
             Assert.Equal(1, rootNode.Children.Count);
             Assert.NotNull(rootNode.Children["home"].Children["bedroom"].Children["{bedroom-id}"].PathItem);
             Assert.True(rootNode.Children["home"].Children["bedroom"].Children["{bedroom-id}"].IsParameter);
-            Assert.Equal("BedroomId", rootNode.Children["home"].Children["bedroom"].Children["{bedroom-id}"].Identifier);
             Assert.Equal("{bedroom-id}", rootNode.Children["home"].Children["bedroom"].Children["{bedroom-id}"].Segment);
         }
     }