Решение на CSV Filter от Георги Бърнев
Резултати
- 14 точки от тестове
- 0 бонус точки
- 14 точки общо
- 14 успешни тест(а)
- 1 неуспешни тест(а)
Код
use std::io::Write;
use std::io::{BufRead, BufReader};
use std::str;
use std::collections::{HashMap, HashSet};
// // Бележка: името на проекта трябва да се казва "solution". Ако не се казва така, променете го
// // на този ред:
// use solution::*;
// use std::io::{self, BufRead, BufReader, Read};
type Row = HashMap<String, String>;
#[derive(Debug)]
pub enum CsvError {
IO(std::io::Error),
ParseError(String),
InvalidHeader(String),
InvalidRow(String),
InvalidColumn(String),
}
pub struct Csv<R: BufRead> {
pub columns: Vec<String>,
reader: R,
selection: Option<Box<dyn Fn(&Row) -> Result<bool, CsvError>>>,
}
/// Проверява че следващия символ във входния низ `input` е точно `target`.
///
/// Ако низа наистина започва с този символ, връща остатъка от низа без него, пакетиран във
/// `Some`. Иначе, връща `None`. Примерно:
///
/// skip_next("(foo", '(') //=> Some("foo")
/// skip_next("(foo", ')') //=> None
/// skip_next("", ')') //=> None
///
pub fn skip_next(input: &str, target: char) -> Option<&str> {
let mut chars = input.chars();
let first = chars.next()?;
if first == target {
return Some(chars.as_str());
}
None
}
/// Търси следващото срещане на символа `target` в низа `input`. Връща низа до този символ и низа
/// от този символ нататък, в двойка.
///
/// Ако не намери `target`, връща оригиналния низ и празен низ като втори елемент в двойката.
///
/// take_until(" foo/bar ", '/') //=> (" foo", "/bar ")
/// take_until("foobar", '/') //=> ("foobar", "")
///
pub fn take_until(input: &str, target: char) -> (&str, &str) {
for (idx, c) in input.char_indices() {
if c == target {
return input.split_at(idx);
}
}
(input, "")
}
/// Комбинация от горните две функции -- взема символите до `target` символа, и връща частта преди
/// символа и частта след, без самия символ. Ако символа го няма, връща `None`.
///
/// take_and_skip(" foo/bar ", '/') //=> Some((" foo", "bar "))
/// take_and_skip("foobar", '/') //=> None
///
pub fn take_and_skip(input: &str, target: char) -> Option<(&str, &str)> {
let (str1, str2) = take_until(&input, target);
if str2.is_empty() {
return None;
}
Some((
str1,
skip_next(str2, target).expect("Unable to find target in second string!"),
))
}
fn validate_line(line: &str) -> Result<&str, CsvError> {
let mut line_chars = line.trim().chars();
//Should start with "
let first = match line_chars.next() {
Some(first) => first,
None => {
return Err(CsvError::InvalidRow(String::from(
"Unable to parse line rows",
)))
}
};
//Should end with "
let last = match line_chars.last() {
Some(last) => last,
None => {
return Err(CsvError::InvalidRow(String::from(
"Unable to parse line rows",
)))
}
};
if first != '"' || last != '"' {
return Err(CsvError::InvalidRow(String::from(
"Unable to parse line rows",
)));
}
Ok(line)
}
fn write_header(cols: &Vec<String>) -> String {
let mut str_header = String::from("");
for key in cols {
str_header.push_str(key);
if (*key) != cols[cols.len() - 1] {
str_header.push_str(", ");
}
}
str_header.push_str("\n");
str_header
}
fn write_row(cols: &Vec<String>, row: &Row) -> String {
let mut row_str = String::from("");
for key in cols {
row_str.push_str("\"");
row_str.push_str(&row[key]);
row_str.push_str("\"");
if (*key) != cols[cols.len() - 1] {
row_str.push_str(", ");
}
}
row_str.push_str("\n");
row_str
}
impl<R: BufRead> Csv<R> {
/// Конструира нова стойност от подадения вход. Третира се като "нещо, от което може да се чете
/// ред по ред".
///
/// Очакваме да прочетете първия ред от входа и да го обработите като заглавна част ("header").
/// Това означава, че първия ред би трябвало да включва имена на колони, разделени със
/// запетайки и може би празни места. Примерно:
///
/// - name, age
/// - name,age,birth date
///
/// В случай, че има грешка от викане на методи на `reader`, тя би трябвало да е `io::Error`.
/// върнете `CsvError::IO`, което опакова въпросната грешка.
///
/// Ако първия ред е празен, прочитането ще ви върне 0 байта. Примерно, `read_line` връща
/// `Ok(0)` в такъв случай. Това означава, че нямаме валиден header -- нито една колона няма,
/// очакваме грешка `CsvError::InvalidHeader`.
///
/// Ако има дублиране на колони -- две колони с едно и също име -- също върнете
/// `CsvError::InvalidHeader`.
///
/// Ако всичко е наред, върнете конструирана стойност, на която `columns` е списък с колоните,
/// в същия ред, в който са подадени, без заобикалящите ги празни символи (използвайте
/// `.trim()`).
pub fn new(mut reader: R) -> Result<Self, CsvError> {
let mut header = String::new();
match reader.read_line(&mut header) {
Ok(rd_size) => {
if rd_size == 0 {
return Err(CsvError::InvalidHeader(String::from("Header is empty")));
}
}
Err(err) => return Err(CsvError::IO(err as std::io::Error)),
}
let columns: Vec<String> = header.split(',').map(|x| String::from(x.trim())).collect();
if columns.is_empty() {
return Err(CsvError::InvalidHeader(String::from("Header is empty")));
}
let mut uniq = HashSet::new();
if !columns.iter().all(move |x| uniq.insert(x)) {
return Err(CsvError::InvalidHeader(String::from(
"Header columns contain duplicates",
)));
}
Ok(Csv {
columns,
reader,
selection: None,
})
}
/// Функцията приема следващия ред за обработка и конструира `Row` стойност
/// (`HashMap<String, String>`) със колоните и съответсващите им стойности на този ред.
///
/// Алгоритъма е горе-долу:
///
/// 1. Изчистете реда с `.trim()`.
/// 2. Очаквате, че реда ще започне със `"`, иначе връщате грешка.
/// 3. Прочитате съдържанието от отварящата кавичка до следващата. Това е съдържанието на
/// стойността на текущата колона на този ред. Не го чистите от whitespace, просто го
/// приемате както е.
/// 4. Ако не намерите затваряща кавичка, това е грешка.
/// 5. Запазвате си стойността в един `Row` (`HashMap`) -- ключа е името на текущата колона,
/// до която сте стигнали, стойността е това, което току-що изпарсихте.
/// 6. Ако нямате оставащи колони за обработка и нямате оставащо съдържание от реда, всичко
/// е ок. Връщате реда.
/// 7. Ако нямате оставащи колони, но имате още от реда, или обратното, това е грешка.
///
/// За този процес, помощните функции, които дефинирахме по-горе може да ви свършат работа.
/// *Може* да използвате вместо тях `.split` по запетайки, но ще имаме поне няколко теста със
/// вложени запетайки. Бихте могли и с това да се справите иначе, разбира се -- ваш избор.
///
/// Внимавайте с празното пространство преди и след запетайки -- викайте `.trim()` на ключови
/// места. Всичко в кавички се взема както е, всичко извън тях се чисти от whitespace.
///
/// Всички грешки, които ще връщате, се очаква да бъдат `CsvError::InvalidRow`.
///
pub fn parse_line(&mut self, line: &str) -> Result<Row, CsvError> {
validate_line(line)?;
let line_entries: Vec<&str> = line
.split('"')
.map(|x| x.trim())
.filter(|&x| !x.is_empty() && x != ",")
.collect();
if line_entries.len() != self.columns.len() {
return Err(CsvError::InvalidRow(String::from(
"Unable to parse line rows",
)));
}
let mut res = Row::new();
self.columns
.iter()
.zip(line_entries.iter())
.for_each(|(key, val)| {
res.insert(key.clone(), String::from(*val));
});
Ok(res)
}
/// Подадената функция, "callback", се очаква да се запази и да се използва по-късно за
/// филтриране -- при итерация, само редове, за които се връща `true` се очаква да се извадят.
///
/// Би трябвало `callback` да се вика от `.next()` и от `.write_to()`, вижте описанията на тези
/// методи за детайли.
///
pub fn apply_selection<F>(&mut self, callback: F)
where
F: Fn(&Row) -> Result<bool, CsvError> + 'static,
{
self.selection = Some(Box::new(callback));
}
/// Извикването на този метод консумира CSV-то и записва филтрираното съдържание в подадената
/// `Write` стойност. Вижте по-долу за пример и детайли.
///
/// Грешките, които се връщат са грешките, които идват от използваните други методи, плюс
/// грешките от писане във `writer`-а, опаковани в `CsvError::IO`.
///
/// В зависимост от това как си имплементирате метода, `mut` може би няма да ви трябва за
/// `self` -- ако имате warning-и, просто го махнете.
///
pub fn write_to<W: Write>(self, mut writer: W) -> Result<(), CsvError> {
let cols = self.columns.clone();
let str_header = write_header(&cols);
match writer.write_all(str_header.as_bytes()) {
Ok(_) => {}
Err(error) => return Err(CsvError::IO(error)),
};
for cur_row in self {
let row = cur_row?;
let row_str = write_row(&cols, &row);
match writer.write_all(row_str.as_bytes()) {
Ok(_) => {}
Err(error) => return Err(CsvError::IO(error)),
};
}
Ok(())
}
}
impl<R: BufRead> Iterator for Csv<R> {
type Item = Result<Row, CsvError>;
/// Итерацията се състои от няколко стъпки:
///
/// 1. Прочитаме следващия ред от входа:
/// -> Ако има грешка при четене, връщаме Some(CsvError::IO(...))
/// -> Ако успешно се прочетат 0 байта, значи сме на края на входа, и няма какво повече да
/// четем -- връщаме `None`
/// -> Иначе, имаме успешно прочетен ред, продължаваме напред
/// 2. Опитваме се да обработим прочетения ред със `parse_line`:
/// -> Ако има грешка при парсене, връщаме Some(CsvError-а, който се връща от `parse_line`)
/// -> Ако успешно извикаме `parse_line`, вече имаме `Row` стойност.
/// 3. Проверяваме дали този ред изпълнява условието, запазено от `apply_selection`:
/// -> Ако условието върне грешка, връщаме тази грешка опакована във `Some`.
/// -> Ако условието върне Ok(false), *не* връщаме този ред, а пробваме следващия (обратно
/// към стъпка 1)
/// -> При Ok(true), връщаме този ред, опакован във `Some`
///
/// Да, тази функция връща `Option<Result<...>>` :). `Option` защото може да има, може да няма
/// следващ ред, `Result` защото четенето на реда (от примерно файл) може да не сработи.
///
fn next(&mut self) -> Option<Self::Item> {
loop {
let mut line = String::new();
match self.reader.read_line(&mut line) {
Ok(rd_size) => {
if rd_size == 0 {
return None;
}
}
Err(err) => return Some(Err(CsvError::IO(err))),
}
let row: Row;
match self.parse_line(&line) {
Ok(res) => row = res,
Err(error) => return Some(Err(error)),
};
match self.selection {
Some(ref func) => {
let selected = (*func)(&row);
match selected {
Ok(res) => {
if res {
return Some(Ok(row));
} else {
continue;
}
}
Err(error) => return Some(Err(error)),
}
}
None => return Some(Ok(row)),
}
}
}
}
Лог от изпълнението
Compiling solution v0.1.0 (/tmp/d20210111-1538662-1elignj/solution)
warning: unused import: `BufReader`
--> src/lib.rs:2:24
|
2 | use std::io::{BufRead, BufReader};
| ^^^^^^^^^
|
= note: `#[warn(unused_imports)]` on by default
warning: 1 warning emitted
Finished test [unoptimized + debuginfo] target(s) in 5.05s
Running target/debug/deps/solution_test-8916805fc40a2dab
running 15 tests
test solution_test::test_csv_basic ... ok
test solution_test::test_csv_duplicate_columns ... ok
test solution_test::test_csv_empty ... ok
test solution_test::test_csv_iterating_with_a_selection ... ok
test solution_test::test_csv_iterating_with_no_selection ... ok
test solution_test::test_csv_parse_line ... FAILED
test solution_test::test_csv_parse_line_with_commas ... ok
test solution_test::test_csv_selection_and_writing ... ok
test solution_test::test_csv_single_column_no_data ... ok
test solution_test::test_csv_writing_without_a_selection ... ok
test solution_test::test_csv_writing_without_any_rows ... ok
test solution_test::test_parsing_helpers_for_unicode ... ok
test solution_test::test_skip_next ... ok
test solution_test::test_take_and_skip ... ok
test solution_test::test_take_until ... ok
failures:
---- solution_test::test_csv_parse_line stdout ----
thread 'main' panicked at 'assertion failed: `(left == right)`
left: `("Name With Spaces", "13", "0-0-0")`,
right: `(" Name With Spaces ", " 13 ", "0-0-0")`', tests/solution_test.rs:151:5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
solution_test::test_csv_parse_line
test result: FAILED. 14 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out
error: test failed, to rerun pass '--test solution_test'