mantra 0.2.14

Tool to trace requirements down to implementation and tests.
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

//! Contains the status overview for a specific branch.
//!
//! [req:status.branch]

use crate::wiki::Wiki;

use super::StatusParameter;

/// Creates an overview for a specific branch in the wiki.
///
/// [req:status.branch]
pub fn status_branch(wiki: &Wiki, param: &StatusParameter) -> String {
    let mut ready_cnt = 0;
    let mut ready_details = Vec::new();

    let mut active_cnt = 0;
    let mut active_details = Vec::new();

    let mut deprecated_cnt = 0;
    let mut deprecated_details = Vec::new();

    let mut manual_cnt = 0;
    let mut manual_details = Vec::new();

    for req in wiki.reqs() {
        match req.ref_list.iter().find(|entry| {
            entry.proj_line.branch_name.as_ref() == &param.branch
                && entry.proj_line.repo_name.as_deref() == param.repo_name.as_ref()
        }) {
            Some(entry) => {
                if entry.is_deprecated {
                    deprecated_cnt += 1;

                    if param.detail_deprecated {
                        deprecated_details.push((req.head.id.clone(), req.head.title.clone()));
                    }
                } else {
                    active_cnt += 1;

                    if param.detail_active {
                        active_details.push((req.head.id.clone(), req.head.title.clone()));
                    }
                }

                if entry.is_manual {
                    manual_cnt += 1;

                    if param.detail_manual {
                        manual_details.push((req.head.id.clone(), req.head.title.clone()));
                    }
                }
            }
            None => {
                ready_cnt += 1;

                if param.detail_ready {
                    ready_details.push((req.head.id.clone(), req.head.title.clone()));
                }
            }
        }
    }

    let mut overview = format!(
        "**Wiki status for {}branch `{}`:**\n\n",
        if let Some(repo) = &param.repo_name {
            format!("repository '{}' with ", repo)
        } else {
            String::new()
        },
        param.branch
    );

    overview.push_str(&format!(
        "- {} requirement{} *ready* to be implemented\n",
        ready_cnt,
        if ready_cnt == 1 { " is" } else { "s are" },
    ));

    overview.push_str(&format!(
        "- {} requirement{} *active*\n",
        active_cnt,
        if active_cnt == 1 { " is" } else { "s are" },
    ));

    overview.push_str(&format!(
        "- {} requirement{} *deprecated*\n",
        deprecated_cnt,
        if deprecated_cnt == 1 { " is" } else { "s are" },
    ));

    overview.push_str(&format!(
        "- {} requirement{} *manual* verification\n",
        manual_cnt,
        if manual_cnt == 1 { " needs" } else { "s need" },
    ));

    if !ready_details.is_empty() {
        overview.push_str("\n***Ready* requirements:**\n\n");

        ready_details.sort_by(|a, b| a.0.cmp(&b.0));

        overview.push_str(&create_req_details(ready_details));
    }

    if !active_details.is_empty() {
        overview.push_str("\n***Active* requirements:**\n\n");

        active_details.sort_by(|a, b| a.0.cmp(&b.0));

        overview.push_str(&create_req_details(active_details));
    }

    if !deprecated_details.is_empty() {
        overview.push_str("\n***Deprecated* requirements:**\n\n");

        deprecated_details.sort_by(|a, b| a.0.cmp(&b.0));

        overview.push_str(&create_req_details(deprecated_details));
    }

    if !manual_details.is_empty() {
        overview.push_str("\n***Manual* flagged requirements:**\n\n");

        manual_details.sort_by(|a, b| a.0.cmp(&b.0));

        overview.push_str(&create_req_details(manual_details));
    }

    overview
}

/// Creates list of requirement details.
///
/// Format: `- <req-id>: <req-title>`
fn create_req_details(details: Vec<(String, String)>) -> String {
    let mut req_list = String::new();

    for (req_id, title) in details {
        req_list.push_str(&format!("- {}: {}\n", req_id, title,));
    }

    req_list
}