tagref 1.12.1

Tagref helps you maintain cross-references in your code.
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

use crate::directive::Directive;
use std::{collections::HashMap, fmt::Write};

// This function checks that all the vectors in `tags_map` have at most one element. It returns a
// vector of error strings.
pub fn check(tags_map: &HashMap<String, Vec<Directive>>) -> Vec<String> {
    let mut errors = Vec::<String>::new();

    for (label, directives) in tags_map {
        if directives.len() > 1 {
            let mut error = String::new();
            let _ = writeln!(error, "Duplicate tags found for label `{label}`:");
            for directive in directives {
                let _ = writeln!(error, "  {directive}");
            }
            errors.push(error);
        }
    }

    errors
}

#[cfg(test)]
mod tests {
    use crate::{
        directive::{Directive, Type},
        duplicates::check,
    };
    use std::{collections::HashMap, path::Path};

    #[test]
    fn check_empty() {
        assert!(check(&HashMap::new()).is_empty());
    }

    #[test]
    fn check_no_dupes() {
        let mut tags_map = HashMap::new();

        let tags_vec1 = vec![Directive {
            r#type: Type::Tag,
            label: "tag1".to_owned(),
            path: Path::new("file1.rs").to_owned(),
            line_number: 1,
        }];

        let tags_vec2 = vec![Directive {
            r#type: Type::Tag,
            label: "tag2".to_owned(),
            path: Path::new("file2.rs").to_owned(),
            line_number: 2,
        }];

        tags_map.insert("tag1".to_owned(), tags_vec1);
        tags_map.insert("tag2".to_owned(), tags_vec2);

        assert!(check(&tags_map).is_empty());
    }

    #[test]
    fn check_dupes() {
        let mut tags_map = HashMap::new();

        let tags_vec1 = vec![Directive {
            r#type: Type::Tag,
            label: "tag1".to_owned(),
            path: Path::new("file1.rs").to_owned(),
            line_number: 1,
        }];

        let tags_vec2 = vec![
            Directive {
                r#type: Type::Tag,
                label: "tag2".to_owned(),
                path: Path::new("file1.rs").to_owned(),
                line_number: 1,
            },
            Directive {
                r#type: Type::Tag,
                label: "tag2".to_owned(),
                path: Path::new("file2.rs").to_owned(),
                line_number: 2,
            },
        ];

        let tags_vec3 = vec![
            Directive {
                r#type: Type::Tag,
                label: "tag3".to_owned(),
                path: Path::new("file1.rs").to_owned(),
                line_number: 1,
            },
            Directive {
                r#type: Type::Tag,
                label: "tag3".to_owned(),
                path: Path::new("file2.rs").to_owned(),
                line_number: 2,
            },
            Directive {
                r#type: Type::Tag,
                label: "tag3".to_owned(),
                path: Path::new("file3.rs").to_owned(),
                line_number: 2,
            },
        ];

        tags_map.insert("tag1".to_owned(), tags_vec1.clone());
        tags_map.insert("tag2".to_owned(), tags_vec2.clone());
        tags_map.insert("tag3".to_owned(), tags_vec3.clone());

        let errors = check(&tags_map);
        assert_eq!(errors.len(), 2);
        assert!(
            (errors[0].contains(&format!("{}", tags_vec2[0]))
                && errors[0].contains(&format!("{}", tags_vec2[1]))
                && errors[1].contains(&format!("{}", tags_vec3[0]))
                && errors[1].contains(&format!("{}", tags_vec3[1]))
                && errors[1].contains(&format!("{}", tags_vec3[2])))
                || (errors[0].contains(&format!("{}", tags_vec3[0]))
                    && errors[0].contains(&format!("{}", tags_vec3[1]))
                    && errors[0].contains(&format!("{}", tags_vec3[2]))
                    && errors[1].contains(&format!("{}", tags_vec2[0]))
                    && errors[1].contains(&format!("{}", tags_vec2[1]))),
        );
    }
}