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
|
use std::{
io::{Read, Write},
path::Path,
};
#[derive(Debug)]
pub struct Renderer<W: Write> {
output: W,
}
impl<W: Write> Renderer<W> {
pub fn new(output: W) -> Self {
Self { output }
}
pub fn render_header(&mut self, project_name: &str) -> std::io::Result<()> {
writeln!(self.output, "# {}", project_name)
}
pub fn render_file<R: Read>(&mut self, filename: &Path, mut reader: R) -> std::io::Result<()> {
let mut bytes = Vec::new();
reader.read_to_end(&mut bytes)?;
let contents = if let Ok(utf8string) = std::str::from_utf8(&bytes) {
utf8string
} else {
return self.render_binary_file(filename);
};
let name = render_filename(filename);
let fence = outer_backticks(contents);
writeln!(self.output)?;
writeln!(self.output, "## File: {}", name)?;
writeln!(self.output, "{}", fence)?;
writeln!(self.output, "{}", contents)?;
writeln!(self.output, "{}", fence)
}
fn render_binary_file(&mut self, filename: &Path) -> std::io::Result<()> {
let name = render_filename(filename);
writeln!(self.output)?;
writeln!(self.output, "## File: {}", name)?;
writeln!(self.output, "[BINARY FILE]")
}
}
fn outer_backticks(contents: &str) -> String {
let mut max_ticks = 0;
let mut current_count = 0;
for char in contents.chars() {
if char == '`' {
current_count += 1;
if current_count > max_ticks {
max_ticks = current_count;
}
} else {
current_count = 0;
}
}
let fence_len = std::cmp::max(3, max_ticks + 1);
"`".repeat(fence_len)
}
fn render_filename(path: &Path) -> String {
let s = format!("{:?}", path);
s.strip_prefix('"')
.and_then(|s| s.strip_suffix('"'))
.unwrap_or(&s)
.to_string()
}
#[cfg(test)]
mod tests {
use std::{ffi::OsStr, io::Cursor, os::unix::ffi::OsStrExt, path::Path};
use super::Renderer;
#[test]
fn renderer_writes_header() {
let mut output = Vec::new();
let mut renderer = Renderer::new(&mut output);
renderer.render_header("Project name").unwrap();
assert_eq!(String::from_utf8(output).unwrap(), "# Project name\n");
}
#[test]
fn renderer_renders_single_file() {
let mut output = Vec::new();
let mut renderer = Renderer::new(&mut output);
let input = Cursor::new("fn main() {}");
renderer.render_file(Path::new("main.rs"), input).unwrap();
let expected = "\n## File: main.rs\n```\nfn main() {}\n```\n";
assert_eq!(String::from_utf8(output).unwrap(), expected);
}
#[test]
fn renderer_places_a_placeholder_for_binary_files_by_default() {
let mut output = Vec::new();
let mut renderer = Renderer::new(&mut output);
let input = Cursor::new(&[0x00, 0x01, 0x02, 0xc3]);
renderer.render_file(Path::new("image.png"), input).unwrap();
let expected = "\n## File: image.png\n[BINARY FILE]\n";
assert_eq!(String::from_utf8(output).unwrap(), expected);
}
#[test]
fn filename_with_linebreaks_and_invalid_chars_handled_properly() {
let mut output = Vec::new();
let mut renderer = Renderer::new(&mut output);
let input = Cursor::new("fn main() {}");
let filename = Path::new(OsStr::from_bytes(b"jap\xE3\x81\x82dir/some\nma\xc3in.rs"));
renderer.render_file(filename, input).unwrap();
let expected = "\n## File: japあdir/some\\nma\\xC3in.rs\n```\nfn main() {}\n```\n";
assert_eq!(String::from_utf8(output).unwrap(), expected);
}
#[test]
fn file_with_backticks_is_handled_safely() {
let mut output = Vec::new();
let mut renderer = Renderer::new(&mut output);
let input = Cursor::new("fn main() { println!(\"``` inside\"); }");
renderer
.render_file(Path::new("example.rs"), input)
.unwrap();
let expected = "\n## File: example.rs\n````\n\
fn main() { println!(\"``` inside\"); }\n````\n";
assert_eq!(String::from_utf8(output).unwrap(), expected);
}
}
|
