refquiem 0.2.1

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

//! Inputs the crates refquiem reads with fail on, which a scan must survive.

mod common;

use std::fmt::Write;

use common::Repo;
use refquiem::Options;

#[test]
fn deeply_nested_rust_does_not_overflow_the_stack() {
    let repo = Repo::new();
    let depth = 5000;
    repo.write(
        "src/lib.rs",
        &format!(
            "pub fn f() -> u8 {{\n    {}1{}\n}}\n",
            "(".repeat(depth),
            ")".repeat(depth)
        ),
    );
    repo.commit("deep");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    assert!(report.is_clean(), "{}", report.human());
}

#[test]
fn a_macro_expanding_into_itself_without_end_stops_at_the_recursion_limit() {
    let repo = Repo::new();
    repo.write(
        "src/lib.rs",
        "macro_rules! forever {\n    ($($t:tt)*) => {\n        pub struct Again;\n        forever!($($t)* x);\n    };\n}\nforever!();\npub struct Gone;\n",
    );
    repo.commit("start");
    repo.write(
        "src/lib.rs",
        "macro_rules! forever {\n    ($($t:tt)*) => {\n        pub struct Again;\n        forever!($($t)* x);\n    };\n}\nforever!();\n",
    );
    repo.write("README.md", "`fixture::Again` and `fixture::Gone`\n");
    repo.commit("drop Gone");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    let groups: Vec<&str> = report.groups.iter().map(|g| g.path.as_str()).collect();
    assert_eq!(groups, ["fixture::Gone"]);
}

#[test]
fn identical_invocations_inside_an_expansion_are_expanded_once() {
    let repo = Repo::new();
    let twice = "macro_rules! twice {\n    () => {\n        pub struct Bottom;\n    };\n    (x $($rest:tt)*) => {\n        twice!($($rest)*);\n        twice!($($rest)*);\n    };\n}\n";
    let xs = "x ".repeat(40);
    repo.write(
        "src/lib.rs",
        &format!("{twice}twice!({xs});\npub struct Gone;\n"),
    );
    repo.commit("start");
    repo.write("src/lib.rs", &format!("{twice}twice!({xs});\n"));
    repo.write("README.md", "`fixture::Bottom` and `fixture::Gone`\n");
    repo.commit("drop Gone");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    let groups: Vec<&str> = report.groups.iter().map(|g| g.path.as_str()).collect();
    assert_eq!(groups, ["fixture::Gone"]);
}

#[test]
fn modules_reexporting_each_other_in_a_cycle_are_indexed() {
    let repo = Repo::new();
    let chapters = 12;
    let mut tour = String::new();
    for i in 0..chapters {
        writeln!(tour, "pub mod c{i};").unwrap();
        let previous = match i {
            0 => String::new(),
            _ => format!("pub use super::c{} as previous;\n", i - 1),
        };
        let next = match i + 1 {
            n if n == chapters => String::new(),
            n => format!("pub use super::c{n} as next;\n"),
        };
        repo.write(
            &format!("src/tour/c{i}.rs"),
            &format!(
                "pub fn step{i}() {{}}\npub use crate::tour as table_of_contents;\n{previous}{next}"
            ),
        );
    }
    repo.write("src/tour/mod.rs", &tour);
    repo.write("src/lib.rs", "pub mod tour;\n");
    repo.commit("tour");
    repo.write(
        "src/tour/c0.rs",
        "pub use crate::tour as table_of_contents;\npub use super::c1 as next;\n",
    );
    repo.write("README.md", "`fixture::tour::c0::step0`\n");
    repo.commit("drop step0");

    let report = refquiem::run(&Options::new(repo.path().to_path_buf())).unwrap();
    let groups: Vec<&str> = report.groups.iter().map(|g| g.path.as_str()).collect();
    assert_eq!(groups, ["fixture::tour::c0::step0"]);
}

#[test]
fn a_markdown_reader_failure_aborts_the_scan() {
    for (file, body) in [
        ("README.md", "`fixture::Gone`\n\n- [o]:u\n    \t"),
        ("src/lib.rs", "/// - [o]:u\n///     \t\npub struct Kept;\n"),
        ("src/lib.rs", "/**- [o]:u\n    \t*/\npub struct Kept;\n"),
    ] {
        let repo = Repo::new();
        repo.write("src/lib.rs", "pub struct Gone;\n");
        repo.commit("public API");
        repo.write("src/lib.rs", "");
        repo.write(file, body);
        repo.write("NOTES.md", "`fixture::Gone`\n");
        repo.commit("remove API");
        let Err(error) = refquiem::run(&Options::new(repo.path().to_path_buf())) else {
            panic!("incomplete scan succeeded for {file}");
        };
        assert!(error.to_string().contains(file), "{error}");
    }
}