tagref 1.11.0

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

use {crate::directive::Directive, std::collections::HashSet};

// This function checks that tag references actually point to tags. It returns a vector of error
// strings.
pub fn check(tags: &HashSet<String>, refs: &[Directive]) -> Vec<String> {
    let mut errors = Vec::<String>::new();

    for r#ref in refs {
        if !tags.contains(&r#ref.label) {
            errors.push(format!("No tag found for {ref}."));
        }
    }

    errors
}

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

    #[test]
    fn check_empty() {
        let tags = HashSet::<String>::new();
        let refs = vec![];

        assert!(check(&tags, &refs).is_empty());
    }

    #[test]
    fn check_ok() {
        let mut tags = HashSet::new();
        tags.insert("ref1".to_owned());

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

        assert!(check(&tags, &refs).is_empty());
    }

    #[test]
    fn check_missing() {
        let mut tags = HashSet::new();
        tags.insert("ref1".to_owned());

        let refs = vec![
            Directive {
                r#type: Type::Ref,
                label: "ref1".to_owned(),
                path: Path::new("file1.rs").to_owned(),
                line_number: 1,
            },
            Directive {
                r#type: Type::Ref,
                label: "ref2".to_owned(),
                path: Path::new("file2.rs").to_owned(),
                line_number: 2,
            },
            Directive {
                r#type: Type::Ref,
                label: "ref3".to_owned(),
                path: Path::new("file3.rs").to_owned(),
                line_number: 3,
            },
        ];

        let errors = check(&tags, &refs);
        assert_eq!(errors.len(), 2);
        assert!(
            (errors[0].contains(&refs[1].label) && errors[1].contains(&refs[2].label))
                || (errors[0].contains(&refs[2].label) && errors[1].contains(&refs[1].label)),
        );
    }
}