tagref 0.0.2

Tagref helps you refer to other locations in your codebase.
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

use std::collections::HashMap;

// This function checks that references actually point to tags. If a missing
// tag is encountered, an error message is returned.
pub fn check(
  tags: &HashMap<String, super::label::Label>,
  references: &Vec<super::label::Label>
) -> Option<String> {
  let mut error = String::new();
  let mut missing_tags = false;

  for reference in references {
    if !tags.contains_key(&reference.label) {
      missing_tags = true;
      error.push_str(
        &format!("No tag found for {}.\n", reference)
      );
    }
  }

  if missing_tags {
    Some(error.trim().to_string())
  } else {
    None
  }
}

#[cfg(test)]
mod tests {
  use citations::check;
  use label::{Label, LabelType};
  use std::collections::HashMap;

  #[test]
  fn check_empty() {
    let tags = HashMap::new();
    let references = vec![];

    match check(&tags, &references) {
      None => (),
      Some(error) => {
        panic!(error);
      },
    };
  }

  #[test]
  fn check_ok() {
    let mut tags = HashMap::new();
    tags.insert(
      "label1".to_string(),
      Label {
        label_type: LabelType::Tag,
        label: "label1".to_string(),
        path: "file1.rs".to_string(),
        line_number: 1,
      }
    );

    let references = vec![
      Label {
        label_type: LabelType::Ref,
        label: "label1".to_string(),
        path: "file1.rs".to_string(),
        line_number: 1,
      },
    ];

    match check(&tags, &references) {
      None => (),
      Some(error) => {
        panic!(error);
      },
    };
  }

  #[test]
  fn check_missing() {
    let mut tags = HashMap::new();
    tags.insert(
      "label1".to_string(),
      Label {
        label_type: LabelType::Tag,
        label: "label1".to_string(),
        path: "file1.rs".to_string(),
        line_number: 1,
      }
    );

    let references = vec![
      Label {
        label_type: LabelType::Ref,
        label: "label1".to_string(),
        path: "file1.rs".to_string(),
        line_number: 1,
      },
      Label {
        label_type: LabelType::Ref,
        label: "label2".to_string(),
        path: "file2.rs".to_string(),
        line_number: 2,
      },
    ];

    match check(&tags, &references) {
      None => {
        panic!("The check(...) call should have failed.");
      },
      Some(error) => {
        assert!(error.contains(&format!("{}", references[1].label)));
      },
    };
  }
}