ferro-rs 0.2.14

A Laravel-inspired web framework for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! Path combination helper for route groups.
//!
//! Centralizes the (prefix, route_path) -> (canonical, alternate) rule used
//! by both the macro-based `group!` (via `macros.rs::GroupDef::register_with_inherited`)
//! and the builder-based `Router::group(...)` (via `group.rs::GroupBuilder::finalize`).
//!
//! Keeping the rule in a single function prevents the two implementations
//! from drifting apart again.

/// Resolve a group prefix combined with a nested route path into a canonical
/// registration path plus an optional alternate that differs only by a
/// trailing slash.
///
/// # Rules
///
/// - One trailing `/` is stripped from `prefix` before concatenation.
/// - If `route_path` is `"/"` and the stripped prefix is non-empty, the
///   canonical form is the stripped prefix and the alternate form is the
///   stripped prefix with a trailing `/` appended. Both must be registered
///   so `group!("/prefix", { get!("/", h) })` reaches `h` at both
///   `/prefix` and `/prefix/`.
/// - If `route_path` is `"/"` and the stripped prefix is empty, the
///   canonical form is `"/"` and no alternate is emitted (the root-in-root
///   `group!("/", { get!("/", h) })` degenerate case).
/// - Otherwise, the canonical form is `stripped_prefix + route_path` and no
///   alternate is emitted.
///
/// Returns `(canonical, alternate)`; the caller inserts both into the
/// router, bypassing `register_route` for the alternate so the
/// introspection registry stays canonical.
pub(crate) fn combine_group_path(prefix: &str, route_path: &str) -> (String, Option<String>) {
    // `strip_suffix('/')` removes at most one trailing slash. Callers in
    // `macros.rs` and `group.rs` receive user-supplied prefixes that should
    // have already passed `validate_route_path`, so a prefix ending in `//`
    // indicates a contract violation upstream. Surface it in debug builds
    // rather than silently producing a canonical form with a stray slash.
    debug_assert!(
        !prefix.ends_with("//"),
        "combine_group_path: prefix must not end with multiple slashes (got {prefix:?})"
    );
    let stripped = prefix.strip_suffix('/').unwrap_or(prefix);

    if route_path == "/" {
        if stripped.is_empty() {
            return ("/".to_string(), None);
        }
        let canonical = stripped.to_string();
        let alternate = format!("{canonical}/");
        return (canonical, Some(alternate));
    }

    if stripped.is_empty() {
        return (route_path.to_string(), None);
    }

    (format!("{stripped}{route_path}"), None)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn combine_group_path_matrix() {
        // (prefix, route_path, expected_canonical, expected_alternate)
        let cases: &[(&str, &str, &str, Option<&str>)] = &[
            ("", "/", "/", None),
            ("/", "/", "/", None),
            ("/", "/x", "/x", None),
            ("/api", "/", "/api", Some("/api/")),
            ("/api", "/x", "/api/x", None),
            ("/api/", "/x", "/api/x", None),
            ("/api/", "/", "/api", Some("/api/")),
            ("/s/{slug}", "/", "/s/{slug}", Some("/s/{slug}/")),
        ];

        for (prefix, route, want_canon, want_alt) in cases {
            let (canon, alt) = combine_group_path(prefix, route);
            assert_eq!(&canon, want_canon, "prefix={prefix:?} route={route:?}");
            assert_eq!(
                alt.as_deref(),
                *want_alt,
                "prefix={prefix:?} route={route:?}"
            );
        }
    }
}