switchback-traits 0.0.1-0.dev.4

Core traits of the switchback framework.
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

//! Format-agnostic path helpers for entity output layout.

/// Relative output directory segment for a stored entity category slug.
pub fn entity_category_dir(category: &str) -> &str {
    match category {
        "schema" => "schemas",
        "operation" => "operations",
        "parameter" => "parameters",
        "response" => "responses",
        "request-body" => "request-bodies",
        "security-scheme" => "security-schemes",
        "service" => "services",
        other => other,
    }
}

/// Relative output path for an entity page under a group's markdown tree.
///
/// Shape: `{group_dir}/{category_dir}/{name}.md` using forward slashes.
/// Does not include [`Options::markdown_root`](crate::Options::markdown_root).
///
/// Full slug parity with protobuf-mdbook is deferred; this strips path
/// separators from `name` only.
pub fn entity_rel_path(group_dir: &str, category_dir: &str, name: &str) -> String {
    let group = group_dir.trim_matches('/');
    let category = category_dir.trim_matches('/');
    let safe_name = sanitize_entity_name(name);
    if group.is_empty() {
        format!("{category}/{safe_name}.md")
    } else {
        format!("{group}/{category}/{safe_name}.md")
    }
}

fn sanitize_entity_name(name: &str) -> String {
    name.replace(['/', '\\'], "-")
}

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

    #[test]
    fn empty_group_dir() {
        assert_eq!(entity_rel_path("", "schemas", "Pet"), "schemas/Pet.md");
    }

    #[test]
    fn nested_group_dir() {
        assert_eq!(
            entity_rel_path("v1/pets", "operations", "listPets"),
            "v1/pets/operations/listPets.md"
        );
    }

    #[test]
    fn hyphenated_category_dir() {
        assert_eq!(
            entity_rel_path("default", "request-bodies", "CreatePet"),
            "default/request-bodies/CreatePet.md"
        );
    }

    #[test]
    fn strips_path_separators_in_name() {
        assert_eq!(
            entity_rel_path("g", "schemas", "foo/bar"),
            "g/schemas/foo-bar.md"
        );
    }
}