-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathoutput.rs
More file actions
275 lines (243 loc) · 8.45 KB
/
output.rs
File metadata and controls
275 lines (243 loc) · 8.45 KB
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
use std::fmt::Write;
use crate::audit::{RepoAudit, summarize};
pub fn render_table(audits: &[RepoAudit], org: &str, min_score: u8) -> String {
let summary = summarize(audits, min_score);
let mut output = String::new();
let _ = writeln!(output, "Organization: {org}");
let _ = writeln!(output, "Repositories scanned: {}", summary.total);
let _ = writeln!(output, "READMEs found: {}", summary.with_readme);
let _ = writeln!(output, "Average score: {:.1}", summary.average_score);
let _ = writeln!(
output,
"Below target ({}): {}",
min_score, summary.below_threshold
);
let _ = writeln!(output);
let rows = build_rows(audits);
if rows.is_empty() {
return output;
}
let repo_width = max_width("Repo", rows.iter().map(|row| row.repo.as_str()));
let score_width = max_width("Score", rows.iter().map(|row| row.score.as_str()));
let status_width = max_width("Status", rows.iter().map(|row| row.status.as_str()));
let required_width = max_width(
"Missing Required",
rows.iter().map(|row| row.missing_required.as_str()),
);
let _ = writeln!(
output,
"{:<repo_width$} {:>score_width$} {:<status_width$} {:<required_width$} Notes",
"Repo", "Score", "Status", "Missing Required",
);
let _ = writeln!(
output,
"{} {} {} {} -----",
"-".repeat(repo_width),
"-".repeat(score_width),
"-".repeat(status_width),
"-".repeat(required_width),
);
for row in rows {
let _ = writeln!(
output,
"{:<repo_width$} {:>score_width$} {:<status_width$} {:<required_width$} {}",
row.repo, row.score, row.status, row.missing_required, row.notes,
);
}
output
}
pub fn render_markdown(audits: &[RepoAudit], org: &str, min_score: u8) -> String {
let summary = summarize(audits, min_score);
let mut output = String::new();
let _ = writeln!(output, "## Documentation Audit Report");
let _ = writeln!(output);
let _ = writeln!(output, "- Organization: `{org}`");
let _ = writeln!(output, "- Repositories scanned: {}", summary.total);
let _ = writeln!(output, "- READMEs found: {}", summary.with_readme);
let _ = writeln!(output, "- Average score: {:.1}", summary.average_score);
let _ = writeln!(
output,
"- Below target (`{min_score}`): {}",
summary.below_threshold
);
let _ = writeln!(output);
let _ = writeln!(
output,
"| Repo | Score | Status | Missing Required | Missing Recommended | Notes |"
);
let _ = writeln!(output, "| --- | ---: | --- | --- | --- | --- |");
for audit in audits {
let _ = writeln!(
output,
"| `{}` | {} | {} | {} | {} | {} |",
audit.repo.name,
audit.score,
audit.status.as_str(),
format_missing(&audit.missing_required),
format_missing(&audit.missing_recommended),
format_notes(&audit.notes),
);
}
output
}
pub fn render_json(audits: &[RepoAudit], org: &str, min_score: u8) -> String {
let summary = summarize(audits, min_score);
let mut output = String::new();
let _ = writeln!(output, "{{");
let _ = writeln!(output, " \"organization\": \"{}\",", escape_json(org));
let _ = writeln!(output, " \"repositories_scanned\": {},", summary.total);
let _ = writeln!(output, " \"readmes_found\": {},", summary.with_readme);
let _ = writeln!(output, " \"average_score\": {:.2},", summary.average_score);
let _ = writeln!(output, " \"below_target\": {},", summary.below_threshold);
let _ = writeln!(output, " \"repos\": [");
for (index, audit) in audits.iter().enumerate() {
let comma = if index + 1 == audits.len() { "" } else { "," };
let _ = writeln!(output, " {{");
let _ = writeln!(
output,
" \"name\": \"{}\",",
escape_json(&audit.repo.name)
);
let _ = writeln!(output, " \"score\": {},", audit.score);
let _ = writeln!(
output,
" \"status\": \"{}\",",
escape_json(audit.status.as_str())
);
let _ = writeln!(
output,
" \"missing_required\": {},",
render_json_string_list(&audit.missing_required)
);
let _ = writeln!(
output,
" \"missing_recommended\": {},",
render_json_string_list(&audit.missing_recommended)
);
let _ = writeln!(
output,
" \"notes\": {}",
render_json_note_list(&audit.notes)
);
let _ = writeln!(output, " }}{comma}");
}
let _ = writeln!(output, " ]");
let _ = writeln!(output, "}}");
output
}
#[derive(Debug)]
struct Row {
repo: String,
score: String,
status: String,
missing_required: String,
notes: String,
}
fn build_rows(audits: &[RepoAudit]) -> Vec<Row> {
audits
.iter()
.map(|audit| Row {
repo: audit.repo.name.clone(),
score: audit.score.to_string(),
status: audit.status.as_str().to_string(),
missing_required: format_missing(&audit.missing_required),
notes: format_notes(&audit.notes),
})
.collect()
}
fn max_width<'a>(header: &'a str, values: impl Iterator<Item = &'a str>) -> usize {
values
.map(str::len)
.fold(header.len(), |current_max, next| current_max.max(next))
}
fn format_missing(items: &[&str]) -> String {
if items.is_empty() {
"-".to_string()
} else {
items.join(", ")
}
}
fn format_notes(notes: &[String]) -> String {
if notes.is_empty() {
"-".to_string()
} else {
notes.join(" | ")
}
}
fn render_json_string_list(items: &[&str]) -> String {
let values: Vec<String> = items
.iter()
.map(|item| format!("\"{}\"", escape_json(item)))
.collect();
format!("[{}]", values.join(", "))
}
fn render_json_note_list(items: &[String]) -> String {
let values: Vec<String> = items
.iter()
.map(|item| format!("\"{}\"", escape_json(item)))
.collect();
format!("[{}]", values.join(", "))
}
fn escape_json(value: &str) -> String {
let mut escaped = String::new();
for character in value.chars() {
match character {
'"' => escaped.push_str("\\\""),
'\\' => escaped.push_str("\\\\"),
'\n' => escaped.push_str("\\n"),
'\r' => escaped.push_str("\\r"),
'\t' => escaped.push_str("\\t"),
c if c.is_control() => {
let _ = write!(escaped, "\\u{:04x}", c as u32);
}
_ => escaped.push(character),
}
}
escaped
}
#[cfg(test)]
mod tests {
use super::{render_json, render_markdown, render_table};
use crate::audit::{AuditStatus, RepoAudit};
use crate::github::RepoMetadata;
#[test]
fn table_contains_headers() {
let reports = sample_reports();
let output = render_table(&reports, "Open330", 70);
assert!(output.contains("Organization: Open330"));
assert!(output.contains("Missing Required"));
assert!(output.contains("docs-sentry"));
}
#[test]
fn markdown_contains_table() {
let reports = sample_reports();
let output = render_markdown(&reports, "Open330", 70);
assert!(output.contains("## Documentation Audit Report"));
assert!(output.contains("| Repo | Score | Status |"));
assert!(output.contains("`docs-sentry`"));
}
#[test]
fn json_contains_expected_fields() {
let reports = sample_reports();
let output = render_json(&reports, "Open330", 70);
assert!(output.contains("\"organization\": \"Open330\""));
assert!(output.contains("\"repos\": ["));
assert!(output.contains("\"name\": \"docs-sentry\""));
assert!(output.contains("\"status\": \"strong\""));
}
fn sample_reports() -> Vec<RepoAudit> {
vec![RepoAudit {
repo: RepoMetadata {
name: "docs-sentry".to_string(),
is_private: false,
description: "README audit tool".to_string(),
},
score: 96,
status: AuditStatus::Strong,
has_readme: true,
missing_required: Vec::new(),
missing_recommended: vec!["Deploy"],
notes: Vec::new(),
}]
}
}