Misc · Export and import: export, field mapping and a CSV importer
misc::ExportDialog offers the owner's formats as cards and hands the chosen one over for the owner to write. misc::ImportDialog maps the file's columns to the app's fields, matched by name to start, over a preview, and asks for each required field's column. misc::CsvImporter reads CSV as RFC 4180, lets the first row name the columns or not, and maps it through the ImportDialog into records; text that does not read says why.
This commit is contained in:
ZacharyZhang-NY committed
1 parent
cbba4ddeec
commit
79fe78cefd
9 files changed
+1023
-4
No files matched your search
+258
@@ -0,0 +1,258 @@
|
||||
use std::rc::Rc;
|
||||
|
||||
use gpui::{
|
||||
App, ElementId, InteractiveElement, IntoElement, ParentElement, RenderOnce, SharedString,
|
||||
Window, div,
|
||||
};
|
||||
|
||||
use super::{ImportDialog, ImportField};
|
||||
use crate::{
|
||||
buttons::{Button, ButtonVariant},
|
||||
feedback::InlineMessage,
|
||||
forms::{Checkbox, Run},
|
||||
overlays::Dialog,
|
||||
primitives::Severity,
|
||||
};
|
||||
|
||||
type OnRecords = Rc<dyn Fn(&[Vec<SharedString>], &mut Window, &mut App)>;
|
||||
|
||||
/// Rows of fields from CSV text, as RFC 4180 has it: commas between fields, quotes around a field that holds a comma, a quote or a line break, a doubled quote for a quote inside, and CRLF or LF between rows. A last line break adds no row. Fails on a quote that never closes, text after a closing quote, or a row whose field count differs from the first's.
|
||||
pub fn read_csv(text: &str) -> Result<Vec<Vec<String>>, String> {
|
||||
let (mut rows, mut row, mut field) = (Vec::new(), Vec::new(), String::new());
|
||||
let (mut quoted, mut closed, mut line) = (false, false, 1);
|
||||
let mut chars = text.chars().peekable();
|
||||
while let Some(ch) = chars.next() {
|
||||
match (quoted, ch) {
|
||||
(true, '"') if chars.peek() == Some(&'"') => {
|
||||
chars.next();
|
||||
field.push('"');
|
||||
}
|
||||
(true, '"') => (quoted, closed) = (false, true),
|
||||
(true, ch) => {
|
||||
line += usize::from(ch == '\n');
|
||||
field.push(ch);
|
||||
}
|
||||
(false, '"') if field.is_empty() && !closed => quoted = true,
|
||||
(false, '"') => {
|
||||
return Err(format!(
|
||||
"line {line}: a quote inside a field it did not open"
|
||||
));
|
||||
}
|
||||
(false, ',') => {
|
||||
row.push(std::mem::take(&mut field));
|
||||
closed = false;
|
||||
}
|
||||
(false, '\r') if chars.peek() == Some(&'\n') => {}
|
||||
(false, '\n') => {
|
||||
row.push(std::mem::take(&mut field));
|
||||
rows.push(std::mem::take(&mut row));
|
||||
(closed, line) = (false, line + 1);
|
||||
}
|
||||
(false, _) if closed => return Err(format!("line {line}: text after a closing quote")),
|
||||
(false, ch) => field.push(ch),
|
||||
}
|
||||
}
|
||||
if quoted {
|
||||
return Err(format!("line {line}: a quote never closes"));
|
||||
}
|
||||
if !field.is_empty() || !row.is_empty() || closed {
|
||||
row.push(field);
|
||||
rows.push(row);
|
||||
}
|
||||
if let Some(first) = rows.first() {
|
||||
let width = first.len();
|
||||
if let Some((ix, ragged)) = rows.iter().enumerate().find(|(_, row)| row.len() != width) {
|
||||
return Err(format!(
|
||||
"row {} has {} fields; the first has {width}",
|
||||
ix + 1,
|
||||
ragged.len()
|
||||
));
|
||||
}
|
||||
}
|
||||
Ok(rows)
|
||||
}
|
||||
|
||||
/// What the importer read: the text, and its rows or why it does not read as CSV.
|
||||
struct Reading {
|
||||
text: SharedString,
|
||||
rows: Result<Vec<Vec<String>>, String>,
|
||||
}
|
||||
|
||||
/// CSV text into records: read as RFC 4180, its first row naming the columns unless the box says otherwise, then mapped to the owner's fields through an `ImportDialog`. Text that does not read as CSV, or holds no rows, says why, with only Cancel. Each way out answers once. Render it while open.
|
||||
#[derive(IntoElement)]
|
||||
pub struct CsvImporter {
|
||||
id: ElementId,
|
||||
title: SharedString,
|
||||
text: SharedString,
|
||||
fields: Vec<ImportField>,
|
||||
on_import: OnRecords,
|
||||
on_cancel: Run,
|
||||
}
|
||||
|
||||
impl CsvImporter {
|
||||
/// `on_import` gets a record per row, its fields in field order, empty where a field was left empty.
|
||||
pub fn new(
|
||||
id: impl Into<ElementId>,
|
||||
title: impl Into<SharedString>,
|
||||
text: impl Into<SharedString>,
|
||||
fields: impl IntoIterator<Item = ImportField>,
|
||||
on_import: impl Fn(&[Vec<SharedString>], &mut Window, &mut App) + 'static,
|
||||
on_cancel: impl Fn(&mut Window, &mut App) + 'static,
|
||||
) -> Self {
|
||||
Self {
|
||||
id: id.into(),
|
||||
title: title.into(),
|
||||
text: text.into(),
|
||||
fields: fields.into_iter().collect(),
|
||||
on_import: Rc::new(on_import),
|
||||
on_cancel: Rc::new(on_cancel),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl RenderOnce for CsvImporter {
|
||||
fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement {
|
||||
let id = self.id;
|
||||
let reading = window.use_keyed_state((id.clone(), "reading"), cx, {
|
||||
let text = self.text.clone();
|
||||
move |_, _| Reading {
|
||||
rows: read_csv(&text),
|
||||
text,
|
||||
}
|
||||
});
|
||||
if reading.read(cx).text != self.text {
|
||||
let rows = read_csv(&self.text);
|
||||
reading.update(cx, |reading, _| {
|
||||
*reading = Reading {
|
||||
text: self.text.clone(),
|
||||
rows,
|
||||
}
|
||||
});
|
||||
}
|
||||
let headed = window.use_keyed_state((id.clone(), "headed"), cx, |_, _| true);
|
||||
let rows = match &reading.read(cx).rows {
|
||||
Ok(rows) if rows.is_empty() => Err("it holds no rows".to_string()),
|
||||
Ok(rows) => Ok(rows.clone()),
|
||||
Err(why) => Err(why.clone()),
|
||||
};
|
||||
let cancel = self.on_cancel;
|
||||
let rows = match rows {
|
||||
Ok(rows) => rows,
|
||||
Err(why) => {
|
||||
log::warn!("csv importer {id:?}: {why}");
|
||||
return Dialog::new(id.clone(), self.title, move |window, cx| cancel(window, cx))
|
||||
.child(
|
||||
div()
|
||||
.debug_selector(|| "csv-unread".into())
|
||||
.child(InlineMessage::new(
|
||||
Severity::Danger,
|
||||
format!("This file does not read as CSV: {why}."),
|
||||
)),
|
||||
)
|
||||
.action(move |close| {
|
||||
Button::new((id, "cancel"), "Cancel")
|
||||
.variant(ButtonVariant::Ghost)
|
||||
.on_click(move |_, window, cx| close(window, cx))
|
||||
})
|
||||
.into_any_element();
|
||||
}
|
||||
};
|
||||
let first_names = *headed.read(cx);
|
||||
let width = rows[0].len();
|
||||
let (columns, data): (Vec<SharedString>, Vec<Vec<SharedString>>) = {
|
||||
let shared = |row: &Vec<String>| {
|
||||
row.iter()
|
||||
.map(|field| SharedString::from(field.clone()))
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
match first_names {
|
||||
true => (shared(&rows[0]), rows[1..].iter().map(shared).collect()),
|
||||
false => (
|
||||
(1..=width).map(|n| format!("Column {n}").into()).collect(),
|
||||
rows.iter().map(shared).collect(),
|
||||
),
|
||||
}
|
||||
};
|
||||
let (import, turned) = (self.on_import, headed);
|
||||
let records = Rc::new(data);
|
||||
let given = records.clone();
|
||||
ImportDialog::new(
|
||||
id.clone(),
|
||||
self.title,
|
||||
columns,
|
||||
self.fields,
|
||||
move |mapping, window, cx| {
|
||||
let rows: Vec<Vec<SharedString>> = given
|
||||
.iter()
|
||||
.map(|row| {
|
||||
mapping
|
||||
.iter()
|
||||
.map(|column| {
|
||||
column.map(|column| row[column].clone()).unwrap_or_default()
|
||||
})
|
||||
.collect()
|
||||
})
|
||||
.collect();
|
||||
log::info!("csv importer: {} records", rows.len());
|
||||
import(&rows, window, cx)
|
||||
},
|
||||
move |window, cx| cancel(window, cx),
|
||||
)
|
||||
.preview(records.iter().cloned())
|
||||
.child(
|
||||
Checkbox::new((id, "headed"), first_names)
|
||||
.label("The first row names the columns")
|
||||
.on_change(move |on, _, cx| {
|
||||
turned.update(cx, |headed, cx| {
|
||||
*headed = on;
|
||||
cx.notify();
|
||||
})
|
||||
}),
|
||||
)
|
||||
.into_any_element()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::read_csv;
|
||||
|
||||
#[test]
|
||||
fn csv_reads_quotes_commas_and_line_breaks() {
|
||||
let rows = read_csv("name,note\r\n\"Doe, Jane\",\"says \"\"hi\"\"\"\nAda,\"two\nlines\"\n")
|
||||
.expect("valid CSV");
|
||||
assert_eq!(
|
||||
rows,
|
||||
[
|
||||
vec!["name".to_string(), "note".to_string()],
|
||||
vec!["Doe, Jane".into(), "says \"hi\"".into()],
|
||||
vec!["Ada".into(), "two\nlines".into()],
|
||||
]
|
||||
);
|
||||
assert_eq!(
|
||||
read_csv("a,,b").expect("empty middle"),
|
||||
[vec!["a".to_string(), String::new(), "b".into()]]
|
||||
);
|
||||
assert_eq!(read_csv("").expect("nothing"), Vec::<Vec<String>>::new());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn csv_names_what_breaks_it() {
|
||||
assert_eq!(
|
||||
read_csv("a,\"open"),
|
||||
Err("line 1: a quote never closes".into())
|
||||
);
|
||||
assert_eq!(
|
||||
read_csv("\"a\"b,c"),
|
||||
Err("line 1: text after a closing quote".into())
|
||||
);
|
||||
assert_eq!(
|
||||
read_csv("ab\"c"),
|
||||
Err("line 1: a quote inside a field it did not open".into())
|
||||
);
|
||||
assert_eq!(
|
||||
read_csv("a,b\nc"),
|
||||
Err("row 2 has 1 fields; the first has 2".into())
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user