refquiem 0.3.3

A cargo requiem for the refs your Rust code left behind
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
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

//! `refquiem: allow(...)` suppression markers and the markers that suppress nothing.

mod common;

use common::Repo;
use refquiem::{Options, UnusedMarker};

/// A repository whose `fixture::Gone` and `fixture::Other` were removed.
fn removed() -> Repo {
    let repo = Repo::new();
    repo.write("src/lib.rs", "pub struct Gone;\npub struct Other;\n");
    repo.commit("start");
    repo.write("src/lib.rs", "");
    repo
}

/// `(file, line)` of every mention still reported, sorted.
fn reported(report: &refquiem::Report) -> Vec<(String, usize)> {
    let mut out: Vec<(String, usize)> = report
        .groups
        .iter()
        .flat_map(|g| g.mentions.iter().map(|m| (m.file.clone(), m.line)))
        .collect();
    out.sort();
    out
}

fn unused(file: &str, line: usize, column: usize, name: &str) -> UnusedMarker {
    UnusedMarker {
        file: file.to_owned(),
        line,
        column,
        name: name.to_owned(),
    }
}

#[test]
fn a_marker_covers_its_own_line_and_the_next() {
    let repo = removed();
    repo.write(
        "src/notes.rs",
        "// refquiem: allow(Gone)\n// `fixture::Gone`\n// `fixture::Gone`\n/// `fixture::Gone` refquiem: allow(fixture::Gone)\npub struct Kept;\n",
    );
    repo.write(
        "README.md",
        "<!-- refquiem: allow(Gone, Other) -->\n`Gone` and `fixture::Other`\n\n`fixture::Gone`\n\n<!-- refquiem: allow(Gone) -->\n`fixture::Gone`\n",
    );
    repo.commit("drop them");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(
        reported(&report),
        [("README.md".to_owned(), 4), ("src/notes.rs".to_owned(), 3)]
    );
    assert_eq!(report.unused_markers, []);
}

#[test]
fn a_marker_name_that_suppresses_nothing_is_reported() {
    let repo = removed();
    repo.write(
        "src/notes.rs",
        "// refquiem: allow(Gone, Missing)\n// `fixture::Gone`\n\n// refquiem: allow(Other)\npub struct Kept;\n",
    );
    repo.commit("drop them");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(reported(&report), []);
    assert_eq!(
        report.unused_markers,
        [
            unused("src/notes.rs", 1, 26, "Missing"),
            unused("src/notes.rs", 4, 20, "Other")
        ]
    );
    assert!(!report.is_clean());
    assert!(
        report
            .human()
            .contains("src/notes.rs:4:20  refquiem: allow(Other) suppresses nothing"),
        "{}",
        report.human()
    );
}

#[test]
fn a_marker_in_a_string_literal_or_plain_markdown_text_is_not_a_marker() {
    let repo = removed();
    repo.write(
        "src/lib.rs",
        "pub const NOTE: &str = \"refquiem: allow(Gone)\";\n// `fixture::Gone`\n",
    );
    repo.write("README.md", "refquiem: allow(Gone)\n`fixture::Gone`\n");
    repo.commit("drop them");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(
        reported(&report),
        [("README.md".to_owned(), 2), ("src/lib.rs".to_owned(), 2)]
    );
    assert_eq!(report.unused_markers, []);
}

#[test]
fn a_marker_holding_anything_but_names_or_paths_is_not_a_marker() {
    let repo = removed();
    repo.write(
        "src/lib.rs",
        "//! Writes `refquiem: allow(...)` markers.\n// refquiem: allow(Gone, the rest)\n// `fixture::Gone`\n",
    );
    repo.write(
        "README.md",
        "<!-- refquiem: allow(...) -->\n`fixture::Gone`\n",
    );
    repo.commit("drop them");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(
        reported(&report),
        [("README.md".to_owned(), 2), ("src/lib.rs".to_owned(), 3)]
    );
    assert_eq!(report.unused_markers, []);
}

#[test]
fn marker_text_inside_markdown_code_is_not_a_suppression() {
    let repo = removed();
    repo.write(
        "README.md",
        "`<!-- refquiem: allow(Gone) -->`\n`fixture::Gone`\n\n```markdown\n<!-- refquiem: allow(Other) -->\nfixture::Other\n```\n",
    );
    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(
        reported(&report),
        [("README.md".to_owned(), 2), ("README.md".to_owned(), 6)]
    );
    assert_eq!(report.unused_markers, []);
}

#[test]
fn a_nested_html_comment_preserves_mentions_after_the_comment() {
    let repo = removed();
    repo.write("README.md", "<!-- a <!-- b -->\n\nUse `fixture::Gone`.\n");
    repo.commit("drop the structures");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert_eq!(reported(&report), [("README.md".to_owned(), 3)]);
    assert_eq!(report.groups[0].path, "fixture::Gone");
    assert_eq!(report.unused_markers, []);
}