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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use expect_test::expect;

use crate::markdown::format_link_destination;

use super::{find_section, find_subsections};

fn replace_section(markdown: &str, replacement: &str) -> String {
    let section = find_section(markdown, "section").unwrap();
    let mut out = markdown.to_string();
    out.replace_range(section.content_span, replacement);
    out
}

#[test]
fn test_find_section() {
    let markdown = r#"
before section
<!-- my section start -->
inside section
<!-- my section end -->
after section
    "#;

    let section = find_section(markdown, "my section").unwrap();

    expect![[r#"
        (
            "<!-- my section start -->\ninside section\n<!-- my section end -->",
            "\ninside section\n",
        )
    "#]]
    .assert_debug_eq(&(&markdown[section.span], &markdown[section.content_span]));
}

#[test]
fn test_find_subsections() {
    let markdown = r#"
before sections
<!-- my section start -->
will be ignored
<!-- my section end -->
<!-- my section foo start -->
foo
<!-- my section foo end -->
<!-- my section ignore this -->
<!-- my section bar start -->
bar
<!-- my section bar end -->
after sections
    "#;

    let result = find_subsections(markdown, "my section")
        .unwrap()
        .into_iter()
        .map(|(range, name)| (name, &markdown[range.span], &markdown[range.content_span]))
        .collect::<Vec<_>>();

    expect![[r#"
        [
            (
                "foo",
                "<!-- my section foo start -->\nfoo\n<!-- my section foo end -->",
                "\nfoo\n",
            ),
            (
                "bar",
                "<!-- my section bar start -->\nbar\n<!-- my section bar end -->",
                "\nbar\n",
            ),
        ]
    "#]]
    .assert_debug_eq(&result);
}

#[test]
fn test_find_subsections_multiple_in_flow() {
    // this doesn't really make sense for our use case, but
    // its better to just handle these as subsections
    // rather than ignoring them
    let markdown = r#"
<div>
<!-- my section foo start -->
<!-- my section foo end -->
<!-- my section bar start -->
<!-- my section bar end -->
</div>
"#;

    let foo = find_section(markdown, "my section foo").unwrap();
    expect![[r#"
        (
            "foo",
            "<!-- my section foo start -->\n<!-- my section foo end -->",
            "\n",
        )
    "#]]
    .assert_debug_eq(&("foo", &markdown[foo.span], &markdown[foo.content_span]));

    let bar = find_section(markdown, "my section bar").unwrap();
    expect![[r#"
        (
            "bar",
            "<!-- my section bar start -->\n<!-- my section bar end -->",
            "\n",
        )
    "#]]
    .assert_debug_eq(&("bar", &markdown[bar.span], &markdown[bar.content_span]));

    let result = find_subsections(markdown, "my section")
        .unwrap()
        .into_iter()
        .map(|(range, name)| (name, &markdown[range.span], &markdown[range.content_span]))
        .collect::<Vec<_>>();

    expect![[r#"
        [
            (
                "foo",
                "<!-- my section foo start -->\n<!-- my section foo end -->",
                "\n",
            ),
            (
                "bar",
                "<!-- my section bar start -->\n<!-- my section bar end -->",
                "\n",
            ),
        ]
    "#]]
    .assert_debug_eq(&result);
}

#[test]
fn test_replace_section_html() {
    expect![[r#"

        prefix
        <!-- section start -->
        NEW CONTENT
        <!-- section end -->
        suffix
    "#]]
    .assert_eq(&replace_section(
        r#"
prefix
<!-- section start -->
old content
<!-- section end -->
suffix
"#,
        "\nNEW CONTENT\n",
    ));
}

#[test]
fn test_replace_section_inline_html() {
    expect!["prefix <!-- section start -->NEW CONTENT<!-- section end --> suffix"].assert_eq(
        &replace_section(
            "prefix <!-- section start --> old content <!-- section end --> suffix",
            "NEW CONTENT",
        ),
    );
}

#[test]
fn test_format_link_destination() {
    assert_eq!(format_link_destination("foobar"), "foobar");
    assert_eq!(format_link_destination("foo<bar>baz"), "foo<bar>baz");

    assert_eq!(format_link_destination(""), "<>");
    assert_eq!(format_link_destination("<foo"), "<%3Cfoo>");
    assert_eq!(format_link_destination("foo bar"), "<foo bar>");
    assert_eq!(format_link_destination("foo()bar"), "<foo()bar>");
}