Fix String description of the router and add tests (#93)

* fix description * refactor description * reorder description to match the strategy * add router description test * add path component description test * refactor router description
vapor · Apr 21, 2020 · 60c2a16 · 60c2a16
1 parent ee590c4
commit 60c2a16
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 16 deletions.
diff --git a/Sources/RoutingKit/TrieRouter.swift b/Sources/RoutingKit/TrieRouter.swift
@@ -209,31 +209,33 @@ extension TrieRouter {
         }
 
         var description: String {
+            self.subpathDescriptions.joined(separator: "\n")
+        }
+
+        var subpathDescriptions: [String] {
             var desc: [String] = []
-            if let (name, parameter) = self.parameter {
+            for (name, constant) in self.constants {
                 desc.append("→ \(name)")
-                desc.append(parameter.description.indented())
+                desc += constant.subpathDescriptions.indented()
             }
-            if let _ = self.catchall {
-                desc.append("→ *")
+            if let (name, parameter) = self.parameter {
+                desc.append("→ :\(name)")
+                desc += parameter.subpathDescriptions.indented()
             }
             if let anything = self.anything {
-                desc.append("→ :")
-                desc.append(anything.description.indented())
+                desc.append("→ *")
+                desc += anything.subpathDescriptions.indented()
             }
-            for (name, constant) in self.constants {
-                desc.append("→ \(name)")
-                desc.append(constant.description.indented())
+            if let _ = self.catchall {
+                desc.append("→ **")
             }
-            return desc.joined(separator: "\n")
+            return desc
         }
     }
 }
 
-private extension String {
-    func indented() -> String {
-        return self.split(separator: "\n").map { line in
-            return "  " + line
-        }.joined(separator: "\n")
+private extension Array where Element == String {
+    func indented() -> [String] {
+        return self.map { "  " + $0 }
     }
 }
diff --git a/Tests/RoutingKitTests/RouterTests.swift b/Tests/RoutingKitTests/RouterTests.swift
@@ -14,7 +14,7 @@ final class RouterTests: XCTestCase {
         let router = TrieRouter<Int>()
         router.register(42, at: [.constant("path"), .constant("TO"), .constant("fOo")])
         var params = Parameters()
-        XCTAssertEqual(router.route(path: ["PATH", "tO", "FOo"], parameters: &params), nil)
+        XCTAssertNil(router.route(path: ["PATH", "tO", "FOo"], parameters: &params))
         XCTAssertEqual(router.route(path: ["path", "TO", "fOo"], parameters: &params), 42)
     }
 
@@ -127,4 +127,46 @@ final class RouterTests: XCTestCase {
         XCTAssertEqual(router.route(path: ["v1", "test", "foo"], parameters: &params), "b")
         XCTAssertEqual(router.route(path: ["v1", "foo"], parameters: &params), "c")
     }
+
+    func testRouterDescription() throws {
+        // Use simple routing to eliminate the impact of registration order
+        let constA: PathComponent = "a"
+        let constOne: PathComponent = "1"
+        let paramOne: PathComponent = .parameter("1")
+        let anything: PathComponent = .anything
+        let catchall: PathComponent = .catchall
+        let router = TrieRouter<Int>()
+        router.register(0, at: [constA, anything])
+        router.register(1, at: [constA, constOne, catchall])
+        router.register(2, at: [constA, constOne, anything])
+        router.register(3, at: [anything, constA, paramOne])
+        router.register(4, at: [catchall])
+        // Manually build description
+        let desc = """
+        → \(constA)
+          → \(constOne)
+            → \(anything)
+            → \(catchall)
+          → \(anything)
+        → \(anything)
+          → \(constA)
+            → \(paramOne)
+        → \(catchall)
+        """
+        XCTAssertEqual(router.description, desc)
+    }
+
+    func testPathComponentDescription() throws {
+        let paths = [
+            "aaaaa/bbbb/ccc/dd",
+            "123/:45/6/789",
+            "123/**",
+            "*/*/*/**",
+            ":12/12/*"
+        ]
+        for path in paths {
+            XCTAssertEqual(path.pathComponents.string, path)
+            XCTAssertEqual(("/" + path).pathComponents.string, path)
+        }
+    }
 }