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
//! Minimal CSV writer — RFC 4180 compliant, zero deps.
//!
//! ## Quick start
//!
//! ```ignore
//! use rustango::csv::CsvWriter;
//!
//! let mut w = CsvWriter::new();
//! w.headers(&["id", "name", "email"]);
//! w.row(&["1", "Alice", "alice@example.com"]);
//! w.row(&["2", "Bob", "bob, jr.@example.com"]); // commas auto-quoted
//! let csv = w.into_string();
//! ```
//!
//! ## Quoting rules (RFC 4180)
//!
//! - Wrap a field in `"..."` if it contains `,`, `"`, `\r`, or `\n`
//! - Inside a quoted field, `"` is doubled (`""`)
//! - Plain ASCII without special chars goes unquoted
//!
//! ## Common use cases
//!
//! - Admin "Export to CSV" buttons (large querysets)
//! - Logs / audit trail dumps
//! - Bulk data download endpoints
/// Build a [`CsvWriter`] from a slice of [`serde_json::Value`] rows
/// + a list of column names. Each row is expected to be an object;
/// missing keys render as empty cells. Useful for piping a list
/// endpoint's JSON output into a CSV download with no extra glue.
///
/// ```
/// use rustango::csv::csv_from_json_rows;
/// use serde_json::json;
///
/// let rows = vec![
/// json!({"id": 1, "name": "Alice"}),
/// json!({"id": 2, "name": "Bob, Jr."}),
/// ];
/// let s = csv_from_json_rows(&["id", "name"], &rows).into_string();
/// assert!(s.contains("\"Bob, Jr.\""));
/// ```
#[must_use]
pub fn csv_from_json_rows(columns: &[&str], rows: &[serde_json::Value]) -> CsvWriter {
let mut w = CsvWriter::new();
w.headers(columns);
for row in rows {
let cells: Vec<String> = columns
.iter()
.map(|c| json_cell_to_string(row.get(*c)))
.collect();
let cell_refs: Vec<&str> = cells.iter().map(String::as_str).collect();
w.row(&cell_refs);
}
w
}
/// Render a single JSON value into a flat CSV cell. Strings unwrap;
/// numbers / bools stringify; null + missing fields become empty;
/// objects + arrays serialize back to JSON so the cell carries
/// readable structure rather than `[object Object]`.
fn json_cell_to_string(v: Option<&serde_json::Value>) -> String {
match v {
None | Some(serde_json::Value::Null) => String::new(),
Some(serde_json::Value::String(s)) => s.clone(),
Some(serde_json::Value::Bool(b)) => b.to_string(),
Some(serde_json::Value::Number(n)) => n.to_string(),
Some(other) => serde_json::to_string(other).unwrap_or_default(),
}
}
/// CSV writer that builds output into an in-memory `String`.
///
/// For very large exports, write rows in batches and flush — but the typical
/// admin-export-button pattern fits comfortably in memory.
#[derive(Default)]
pub struct CsvWriter {
out: String,
column_count: Option<usize>,
}
impl CsvWriter {
/// New empty writer.
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Write the header row. Pins the column count — subsequent `row()`
/// calls must match (extra fields truncated, short rows padded).
pub fn headers<I, S>(&mut self, headers: I)
where
I: IntoIterator<Item = S>,
S: AsRef<str>,
{
let headers: Vec<String> = headers.into_iter().map(|s| s.as_ref().to_owned()).collect();
self.column_count = Some(headers.len());
self.write_row(&headers);
}
/// Write a data row. If `headers()` was called, the row is padded
/// (with empty strings) or truncated to match the column count.
pub fn row<I, S>(&mut self, row: I)
where
I: IntoIterator<Item = S>,
S: AsRef<str>,
{
let mut row: Vec<String> = row.into_iter().map(|s| s.as_ref().to_owned()).collect();
if let Some(n) = self.column_count {
row.resize(n, String::new());
}
self.write_row(&row);
}
/// Take the buffered CSV output, consuming the writer.
#[must_use]
pub fn into_string(self) -> String {
self.out
}
/// View the current buffered CSV output without consuming the writer.
#[must_use]
pub fn as_str(&self) -> &str {
&self.out
}
fn write_row(&mut self, row: &[String]) {
for (i, field) in row.iter().enumerate() {
if i > 0 {
self.out.push(',');
}
self.out.push_str(&escape_field(field));
}
self.out.push_str("\r\n");
}
}
/// Escape one CSV field per RFC 4180.
fn escape_field(s: &str) -> String {
let needs_quoting = s.bytes().any(|b| matches!(b, b',' | b'"' | b'\r' | b'\n'));
if !needs_quoting {
return s.to_owned();
}
let mut out = String::with_capacity(s.len() + 2);
out.push('"');
for ch in s.chars() {
if ch == '"' {
out.push_str("\"\"");
} else {
out.push(ch);
}
}
out.push('"');
out
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn plain_fields_unquoted() {
let mut w = CsvWriter::new();
w.row(&["a", "b", "c"]);
assert_eq!(w.as_str(), "a,b,c\r\n");
}
#[test]
fn comma_in_field_gets_quoted() {
let mut w = CsvWriter::new();
w.row(&["a", "b, c", "d"]);
assert_eq!(w.as_str(), "a,\"b, c\",d\r\n");
}
#[test]
fn quote_in_field_doubled_and_quoted() {
let mut w = CsvWriter::new();
w.row(&["a", r#"say "hi""#, "b"]);
assert_eq!(w.as_str(), "a,\"say \"\"hi\"\"\",b\r\n");
}
#[test]
fn newline_in_field_gets_quoted() {
let mut w = CsvWriter::new();
w.row(&["a", "line1\nline2", "b"]);
assert_eq!(w.as_str(), "a,\"line1\nline2\",b\r\n");
}
#[test]
fn carriage_return_in_field_gets_quoted() {
let mut w = CsvWriter::new();
w.row(&["a", "line1\rline2", "b"]);
assert!(w.as_str().contains("\"line1\rline2\""));
}
#[test]
fn empty_field_unquoted() {
let mut w = CsvWriter::new();
w.row(&["", "x", ""]);
assert_eq!(w.as_str(), ",x,\r\n");
}
#[test]
fn headers_then_rows() {
let mut w = CsvWriter::new();
w.headers(&["id", "name"]);
w.row(&["1", "Alice"]);
w.row(&["2", "Bob"]);
assert_eq!(w.into_string(), "id,name\r\n1,Alice\r\n2,Bob\r\n");
}
#[test]
fn row_padded_to_column_count_after_headers() {
let mut w = CsvWriter::new();
w.headers(&["a", "b", "c"]);
w.row(&["1"]); // short
assert_eq!(w.into_string(), "a,b,c\r\n1,,\r\n");
}
#[test]
fn row_truncated_to_column_count_after_headers() {
let mut w = CsvWriter::new();
w.headers(&["a", "b"]);
w.row(&["1", "2", "3", "4"]); // long
assert_eq!(w.into_string(), "a,b\r\n1,2\r\n");
}
#[test]
fn escape_field_simple() {
assert_eq!(escape_field("plain"), "plain");
assert_eq!(escape_field("a,b"), "\"a,b\"");
assert_eq!(escape_field("say \"x\""), "\"say \"\"x\"\"\"");
}
}