Alter router display to use different characters

DuskSystems · Sep 4, 2024 · 9d7ad51 · 9d7ad51
1 parent 6b7dc2a
commit 9d7ad51
Show file tree

Hide file tree

Showing 8 changed files with 860 additions and 865 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-...
+### Changed
+
+- Router display now uses different characters to represent root and matchable nodes.
 
 ## [0.2.1] - 2024-09-04
 

diff --git a/README.md b/README.md
@@ -225,7 +225,8 @@ fn main() -> Result<(), Box<dyn Error>> {
 
 Routers can print their routes as an tree diagram.
 
-`[*]` here represents nodes within the route tree that can be matched against.
+- `▼` represents the root node.
+- `●` represents nodes within the tree that can be matched against.
 
 Currenty, this doesn't handle split multi-byte characters well.
 
@@ -236,27 +237,28 @@ use std::error::Error;
 use wayfind::Router;
 
 const ROUTER_DISPLAY: &str = "
-$
-╰─ /
-   ├─ pet [*]
-   │    ╰─ /
-   │       ├─ findBy
-   │       │       ├─ Status [*]
-   │       │       ╰─ Tags [*]
-   │       ╰─ {petId} [*]
-   │                ╰─ /uploadImage [*]
-   ├─ store/
-   │       ├─ inventory [*]
-   │       ╰─ order [*]
-   │              ╰─ /
-   │                 ╰─ {orderId} [*]
-   ╰─ user [*]
-         ╰─ /
-            ├─ createWithList [*]
-            ├─ log
-            │    ├─ in [*]
-            │    ╰─ out [*]
-            ╰─ {username} [*]
+▼
+├─ /
+│  ├─ pet ●
+│  │    ╰─ /
+│  │       ├─ findBy
+│  │       │       ├─ Status ●
+│  │       │       ╰─ Tags ●
+│  │       ╰─ {petId} ●
+│  │                ╰─ /uploadImage ●
+│  ├─ store/
+│  │       ├─ inventory ●
+│  │       ╰─ order ●
+│  │              ╰─ /
+│  │                 ╰─ {orderId} ●
+│  ╰─ user ●
+│        ╰─ /
+│           ├─ createWithList ●
+│           ├─ log
+│           │    ├─ in ●
+│           │    ╰─ out ●
+│           ╰─ {username} ●
+╰─ {*catch_all} ●
 ";
 
 fn main() -> Result<(), Box<dyn Error>> {
@@ -278,7 +280,9 @@ fn main() -> Result<(), Box<dyn Error>> {
     router.insert("/user/logout", 12)?;
     router.insert("/user/{username}", 13)?;
 
-    assert_eq!(router.to_string(), ROUTER_DISPLAY.trim_end());
+    router.insert("{*catch_all}", 14)?;
+
+    assert_eq!(router.to_string(), ROUTER_DISPLAY.trim());
     Ok(())
 }
 ```

diff --git a/src/node/display.rs b/src/node/display.rs
@@ -13,7 +13,7 @@ impl<T> Display for Node<T> {
         ) -> std::fmt::Result {
             let constraint = node.constraint.as_ref().map(|c| String::from_utf8_lossy(c));
             let key = match &node.kind {
-                NodeKind::Root => "$".to_string(),
+                NodeKind::Root => "▼".to_string(),
                 NodeKind::Static => String::from_utf8_lossy(&node.prefix).to_string(),
                 NodeKind::Dynamic => {
                     let name = String::from_utf8_lossy(&node.prefix);
@@ -31,16 +31,15 @@ impl<T> Display for Node<T> {
                 }
             };
 
-            let value = node
-                .data
-                .as_ref()
-                .map_or(String::new(), |_node_data| " [*]".to_string());
-
             if is_root {
                 writeln!(output, "{key}")?;
             } else {
                 let branch = if is_last { "╰─" } else { "├─" };
-                writeln!(output, "{padding}{branch} {key}{value}")?;
+                if node.data.is_some() {
+                    writeln!(output, "{padding}{branch} {key} ●")?;
+                } else {
+                    writeln!(output, "{padding}{branch} {key}")?;
+                }
             }
 
             // Ensure we align children correctly
@@ -79,6 +78,6 @@ impl<T> Display for Node<T> {
         };
 
         debug_node(&mut output, self, &padding, true, true)?;
-        write!(f, "\n{}", output.trim_end())
+        write!(f, "{}", output.trim_end())
     }
 }
diff --git a/tests/constraints.rs b/tests/constraints.rs
@@ -76,21 +76,21 @@ fn test_multiple_constraints() -> Result<(), Box<dyn Error>> {
     router.insert("/posts/{year:even_year}/{slug:valid_slug}", 3)?;
 
     insta::assert_snapshot!(router, @r###"
-    $
+    ▼
     ╰─ /
        ├─ p
        │  ├─ osts/
        │  │      ╰─ {year:even_year}
        │  │                        ╰─ /
-       │  │                           ╰─ {slug:valid_slug} [*]
+       │  │                           ╰─ {slug:valid_slug} ●
        │  ╰─ rofile/
        │           ╰─ {username:length_3_to_10}
        │                                      ╰─ .
-       │                                         ╰─ {ext:png_or_jpg} [*]
+       │                                         ╰─ {ext:png_or_jpg} ●
        ╰─ user/
               ╰─ {name:length_3_to_10}
                                      ╰─ /
-                                        ╰─ {id:year_1000_to_10000} [*]
+                                        ╰─ {id:year_1000_to_10000} ●
     "###);
 
     assert_router_matches!(router, {