Simplify CliError enum (#726)

deutsche-nationalbibliothek · Dec 8, 2023 · 5316238 · 5316238
1 parent 0eaee09
commit 5316238
Show file tree

Hide file tree

Showing 21 changed files with 60 additions and 96 deletions.
diff --git a/crates/pica-toolkit/Cargo.toml b/crates/pica-toolkit/Cargo.toml
@@ -27,6 +27,7 @@ serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 strsim = { version = "0.10" }
 termcolor = { version = "1.4" }
+thiserror = { workspace = true }
 toml = { workspace = true }
 unicode-normalization = { version = "0.1" }
 

diff --git a/crates/pica-toolkit/src/commands/cat.rs b/crates/pica-toolkit/src/commands/cat.rs
@@ -10,8 +10,8 @@ use pica_record::ByteRecord;
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/completions.rs b/crates/pica-toolkit/src/commands/completions.rs
@@ -5,7 +5,7 @@ use std::io::{self, Write};
 use clap::{Command, Parser};
 use clap_complete::{generate, Shell};
 
-use crate::util::CliResult;
+use crate::error::CliResult;
 
 #[derive(Parser, Debug)]
 pub(crate) struct Completions {

diff --git a/crates/pica-toolkit/src/commands/convert/mod.rs b/crates/pica-toolkit/src/commands/convert/mod.rs
@@ -17,8 +17,8 @@ use self::import::ImportWriter;
 use self::json::JsonWriter;
 use self::plain::PlainWriter;
 use self::xml::XmlWriter;
+use crate::error::CliError;
 use crate::progress::Progress;
-use crate::util::CliError;
 use crate::{skip_invalid_flag, CliResult, Config};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/count.rs b/crates/pica-toolkit/src/commands/count.rs
@@ -7,9 +7,9 @@ use pica_record::io::{ReaderBuilder, RecordsIterator};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
 use crate::skip_invalid_flag;
-use crate::util::CliResult;
 
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case")]

diff --git a/crates/pica-toolkit/src/commands/explode.rs b/crates/pica-toolkit/src/commands/explode.rs
@@ -11,8 +11,8 @@ use pica_utils::NormalizationForm;
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/filter.rs b/crates/pica-toolkit/src/commands/filter.rs
@@ -13,8 +13,8 @@ use pica_record::io::{ReaderBuilder, RecordsIterator, WriterBuilder};
 use pica_utils::{FilterList, NormalizationForm};
 use serde::{Deserialize, Serialize};
 
+use crate::error::{CliError, CliResult};
 use crate::progress::Progress;
-use crate::util::{CliError, CliResult};
 use crate::{gzip_flag, skip_invalid_flag, Config};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/frequency.rs b/crates/pica-toolkit/src/commands/frequency.rs
@@ -12,9 +12,9 @@ use pica_utils::NormalizationForm;
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
 use crate::skip_invalid_flag;
-use crate::util::CliResult;
 
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case")]

diff --git a/crates/pica-toolkit/src/commands/hash.rs b/crates/pica-toolkit/src/commands/hash.rs
@@ -9,9 +9,9 @@ use pica_record::io::{ReaderBuilder, RecordsIterator};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
 use crate::skip_invalid_flag;
-use crate::util::CliResult;
 
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case")]

diff --git a/crates/pica-toolkit/src/commands/invalid.rs b/crates/pica-toolkit/src/commands/invalid.rs
@@ -6,8 +6,8 @@ use pica_record::io::{ReadPicaError, ReaderBuilder, RecordsIterator};
 use pica_record::ParsePicaError;
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 
 /// Write input lines, which can't be decoded as normalized PICA+
 ///

diff --git a/crates/pica-toolkit/src/commands/partition.rs b/crates/pica-toolkit/src/commands/partition.rs
@@ -14,8 +14,8 @@ use pica_record::io::{
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag, template_opt};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/print.rs b/crates/pica-toolkit/src/commands/print.rs
@@ -13,9 +13,9 @@ use termcolor::{
 };
 
 use crate::config::Config;
+use crate::error::{CliError, CliResult};
 use crate::progress::Progress;
 use crate::skip_invalid_flag;
-use crate::util::{CliError, CliResult};
 
 #[derive(Debug, Default, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case")]

diff --git a/crates/pica-toolkit/src/commands/sample.rs b/crates/pica-toolkit/src/commands/sample.rs
@@ -8,8 +8,8 @@ use rand::{thread_rng, Rng, SeedableRng};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/select.rs b/crates/pica-toolkit/src/commands/select.rs
@@ -16,9 +16,9 @@ use pica_utils::{FilterList, NormalizationForm};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
 use crate::skip_invalid_flag;
-use crate::util::CliResult;
 
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case")]

diff --git a/crates/pica-toolkit/src/commands/slice.rs b/crates/pica-toolkit/src/commands/slice.rs
@@ -5,8 +5,8 @@ use pica_record::io::{ReaderBuilder, RecordsIterator, WriterBuilder};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/commands/split.rs b/crates/pica-toolkit/src/commands/split.rs
@@ -7,8 +7,8 @@ use pica_record::io::{ReaderBuilder, RecordsIterator, WriterBuilder};
 use serde::{Deserialize, Serialize};
 
 use crate::config::Config;
+use crate::error::CliResult;
 use crate::progress::Progress;
-use crate::util::CliResult;
 use crate::{gzip_flag, skip_invalid_flag, template_opt};
 
 #[derive(Debug, Deserialize, Serialize)]

diff --git a/crates/pica-toolkit/src/error.rs b/crates/pica-toolkit/src/error.rs
@@ -0,0 +1,30 @@
+use std::io;
+
+pub(crate) type CliResult<T> = Result<T, CliError>;
+
+#[derive(Debug, thiserror::Error)]
+pub(crate) enum CliError {
+    #[error(transparent)]
+    Io(#[from] io::Error),
+
+    #[error(transparent)]
+    Csv(#[from] csv::Error),
+
+    #[error(transparent)]
+    ParsePica(#[from] pica_record::ParsePicaError),
+
+    #[error(transparent)]
+    ReadPica(#[from] pica_record::io::ReadPicaError),
+
+    #[error(transparent)]
+    ParsePath(#[from] pica_path::ParsePathError),
+
+    #[error(transparent)]
+    ParseMatcher(#[from] pica_matcher::ParseMatcherError),
+
+    #[error(transparent)]
+    ParseQuery(#[from] pica_select::ParseQueryError),
+
+    #[error("{0}")]
+    Other(String),
+}
diff --git a/crates/pica-toolkit/src/main.rs b/crates/pica-toolkit/src/main.rs
@@ -6,9 +6,9 @@ extern crate termcolor;
 
 mod commands;
 mod config;
+mod error;
 mod macros;
 mod progress;
-mod util;
 
 use std::path::PathBuf;
 use std::{io, process};
@@ -19,7 +19,7 @@ use commands::{
     Invalid, Partition, Print, Sample, Select, Slice, Split,
 };
 use config::Config;
-use util::{CliError, CliResult};
+use error::{CliError, CliResult};
 
 #[derive(Debug, Parser)]
 #[clap(version, author, infer_subcommands = true, max_term_width = 72)]
@@ -88,27 +88,31 @@ fn main() {
             process::exit(0); // no-coverage
         }
         Err(CliError::ParsePica(err)) => {
-            eprintln!("Parse Pica Error: {err}");
+            eprintln!("error: {err}");
+            process::exit(1);
+        }
+        Err(CliError::ReadPica(err)) => {
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::ParsePath(err)) => {
-            eprintln!("Parse Path Error: {err}");
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::ParseMatcher(err)) => {
-            eprintln!("Parse Matcher Error: {err}");
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::ParseQuery(err)) => {
-            eprintln!("Parse Query Error: {err}");
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::Io(err)) => {
-            eprintln!("IO Error: {err}");
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::Csv(err)) => {
-            eprintln!("CSV Error: {err}");
+            eprintln!("error: {err}");
             process::exit(1);
         }
         Err(CliError::Other(err)) => {

diff --git a/crates/pica-toolkit/src/util.rs b/crates/pica-toolkit/src/util.rs
diff --git a/crates/pica-toolkit/tests/snapshot/frequency/022-frequency-invalid-query.toml b/crates/pica-toolkit/tests/snapshot/frequency/022-frequency-invalid-query.toml
@@ -2,4 +2,4 @@ bin.name = "pica"
 args = "frequency \"002@.!\""
 status = "failed"
 stdout = ""
-stderr = "Parse Query Error: invalid query, got `002@.!`\n"
+stderr = "error: invalid query, got `002@.!`\n"
diff --git a/crates/pica-toolkit/tests/snapshot/select/036-select-invalid-query.toml b/crates/pica-toolkit/tests/snapshot/select/036-select-invalid-query.toml
@@ -1,5 +1,5 @@
 bin.name = "pica"
 args = "select \"[email protected], 'foo, [email protected]\""
 status = "failed"
-stderr = "Parse Query Error: invalid query, got `[email protected], 'foo, [email protected]`\n"
+stderr = "error: invalid query, got `[email protected], 'foo, [email protected]`\n"
 stdout = ""