cargo-insert-docs 1.6.0

Inserts feature docs into crate docs, and crate docs into README.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::{collections::HashMap, fmt};

use expect_test::expect;
use rustdoc_types::Id;

use crate::tests::TreeFormatter;

use super::{Tree, Value};

macro_rules! paths {
    ($(
        $id:literal: $kind:ident {
            $($path:ident)*
        }
    )*) => {
        super::Paths::from_iter(vec![
            $((
                rustdoc_types::Id($id),
                rustdoc_types::ItemSummary {
                    crate_id: 0,
                    path: vec![$(stringify!($path).to_string()),*],
                    kind: rustdoc_types::ItemKind::$kind,
                }
            ),)*
        ])
    };
}

#[test]
fn test_simple() {
    let paths = paths! {
        0: Function { std io Write write }
        1: Trait { std io Write }
        2: Module { std io }
        2: Module { std }
    };

    let tree = Tree::new_simple(&paths);
    let path = tree.path_to(Id(0)).unwrap();

    expect![[r#"
        [
            PathItem {
                name: "write",
                kind: Function,
            },
            PathItem {
                name: "Write",
                kind: Trait,
            },
            PathItem {
                name: "io",
                kind: Module,
            },
            PathItem {
                name: "std",
                kind: Module,
            },
        ]
    "#]]
    .assert_debug_eq(&path);
}

#[test]
fn test_partially_dangling() {
    let paths = paths! {
        0: Trait { std io Write }
    };

    let tree = Tree::new_simple(&paths);
    let path = tree.path_to(Id(0)).unwrap();

    expect![[r#"
        [
            PathItem {
                name: "Write",
                kind: Trait,
            },
            PathItem {
                name: "io",
                kind: Module,
            },
            PathItem {
                name: "std",
                kind: Module,
            },
        ]
    "#]]
    .assert_debug_eq(&path);
}

impl fmt::Display for Tree<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&format_tree(self))
    }
}

fn format_tree(tree: &Tree) -> String {
    let mut branches: HashMap<Id, Branch> = HashMap::new();

    for (&id, value) in &tree.inv_tree {
        branches.entry(id).or_insert(Branch { value, children: vec![] });

        if let Some(parent_id) = value.parent {
            let value = &tree.inv_tree[&parent_id];
            let branch = branches.entry(parent_id).or_insert(Branch { value, children: vec![] });
            branch.children.push(id);
        }
    }

    for branch in branches.values_mut() {
        branch.children.sort_by_key(|id| tree.inv_tree[id].name);
    }

    let mut roots = tree
        .inv_tree
        .iter()
        .filter_map(|(&i, v)| v.parent.is_none().then_some(i))
        .collect::<Vec<_>>();

    roots.sort_by_key(|id| tree.inv_tree[id].name);

    let mut out = String::new();

    for root in roots {
        out.push_str(&format_branch(&branches, root));
    }

    out
}

fn format_branch(branches: &HashMap<Id, Branch>, id: Id) -> String {
    let mut fmt = TreeFormatter::default();
    let Branch { value: Value { kind, name, .. }, children } = &branches[&id];

    let space = if name.is_empty() { "" } else { " " };
    fmt.label(format_args!("{name}{space}{kind:?}"));
    fmt.children(children.iter().map(|&id| format_branch(branches, id)));
    fmt.finish()
}

struct Branch<'a> {
    value: &'a Value<'a>,
    children: Vec<Id>,
}