From d852a5897cc111c9f0ec9dd5f384bc9fce1d66cc Mon Sep 17 00:00:00 2001 From: Spyros Roum Date: Fri, 15 Oct 2021 14:20:49 +0300 Subject: [PATCH 1/3] Change FinalError builder pattern to take and give ownership of self This means that when you do `let e = FinalError::with_title("Foo").detail("Blah");`, `e` will be of type `FinalError` instead of `&mut FinalError`, thus you don't have to call `clone()` on it --- src/commands.rs | 9 +++------ src/error.rs | 38 ++++++++++---------------------------- 2 files changed, 13 insertions(+), 34 deletions(-) diff --git a/src/commands.rs b/src/commands.rs index 05db7a637..d41ca838b 100644 --- a/src/commands.rs +++ b/src/commands.rs @@ -50,8 +50,7 @@ pub fn run(command: Command, flags: &oof::Flags) -> crate::Result<()> { .hint("") .hint("Examples:") .hint(format!(" ouch compress ... {}.tar.gz", to_utf(&output_path))) - .hint(format!(" ouch compress ... {}.zip", to_utf(&output_path))) - .clone(); + .hint(format!(" ouch compress ... {}.zip", to_utf(&output_path))); return Err(Error::with_reason(reason)); } @@ -79,8 +78,7 @@ pub fn run(command: Command, flags: &oof::Flags) -> crate::Result<()> { .detail("The only supported formats that archive files into an archive are .tar and .zip.") .hint(format!("Try inserting '.tar' or '.zip' before '{}'.", &formats[0])) .hint(format!("From: {}", output_path)) - .hint(format!(" To : {}", suggested_output_path)) - .clone(); + .hint(format!(" To : {}", suggested_output_path)); return Err(Error::with_reason(reason)); } @@ -90,8 +88,7 @@ pub fn run(command: Command, flags: &oof::Flags) -> crate::Result<()> { .detail(format!("Found the format '{}' in an incorrect position.", format)) .detail(format!("'{}' can only be used at the start of the file extension.", format)) .hint(format!("If you wish to compress multiple files, start the extension with '{}'.", format)) - .hint(format!("Otherwise, remove the last '{}' from '{}'.", format, to_utf(&output_path))) - .clone(); + .hint(format!("Otherwise, remove the last '{}' from '{}'.", format, to_utf(&output_path))); return Err(Error::with_reason(reason)); } diff --git a/src/error.rs b/src/error.rs index caf7e6cfe..b0e313e7f 100644 --- a/src/error.rs +++ b/src/error.rs @@ -70,12 +70,12 @@ impl FinalError { Self { title: title.to_string(), details: vec![], hints: vec![] } } - pub fn detail(&mut self, detail: impl ToString) -> &mut Self { + pub fn detail(mut self, detail: impl ToString) -> Self { self.details.push(detail.to_string()); self } - pub fn hint(&mut self, hint: impl ToString) -> &mut Self { + pub fn hint(mut self, hint: impl ToString) -> Self { self.hints.push(hint.to_string()); self } @@ -85,70 +85,52 @@ impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let err = match self { Error::MissingExtensionError(filename) => { - let error = FinalError::with_title(format!("Cannot compress to {:?}", filename)) + FinalError::with_title(format!("Cannot compress to {:?}", filename)) .detail("Ouch could not detect the compression format") .hint("Use a supported format extension, like '.zip' or '.tar.gz'") .hint("Check https://github.com/vrmiguel/ouch for a full list of supported formats") - .clone(); - - error } Error::WalkdirError { reason } => FinalError::with_title(reason), Error::FileNotFound(file) => { - let error = if file == Path::new("") { + if file == Path::new("") { FinalError::with_title("file not found!") } else { FinalError::with_title(format!("file {:?} not found!", file)) - }; - - error + } } Error::CompressingRootFolder => { - let error = FinalError::with_title("It seems you're trying to compress the root folder.") + FinalError::with_title("It seems you're trying to compress the root folder.") .detail("This is unadvisable since ouch does compressions in-memory.") .hint("Use a more appropriate tool for this, such as rsync.") - .clone(); - - error } Error::MissingArgumentsForCompression => { - let error = FinalError::with_title("Could not compress") + FinalError::with_title("Could not compress") .detail("The compress command requires at least 2 arguments") .hint("You must provide:") .hint(" - At least one input argument.") .hint(" - The output argument.") .hint("") .hint("Example: `ouch compress image.png img.zip`") - .clone(); - - error } Error::MissingArgumentsForDecompression => { - let error = FinalError::with_title("Could not decompress") + FinalError::with_title("Could not decompress") .detail("The compress command requires at least one argument") .hint("You must provide:") .hint(" - At least one input argument.") .hint("") .hint("Example: `ouch decompress imgs.tar.gz`") - .clone(); - - error } Error::InternalError => { - let error = FinalError::with_title("InternalError :(") + FinalError::with_title("InternalError :(") .detail("This should not have happened") .detail("It's probably our fault") .detail("Please help us improve by reporting the issue at:") .detail(format!(" {}https://github.com/vrmiguel/ouch/issues ", cyan())) - .clone(); - - error } Error::OofError(err) => FinalError::with_title(err), Error::IoError { reason } => FinalError::with_title(reason), Error::CompressionTypo => FinalError::with_title("Possible typo detected") - .hint(format!("Did you mean '{}ouch compress{}'?", magenta(), reset())) - .clone(), + .hint(format!("Did you mean '{}ouch compress{}'?", magenta(), reset())), Error::UnknownExtensionError(_) => todo!(), Error::AlreadyExists => todo!(), Error::InvalidZipArchive(_) => todo!(), From 702e7622db61a809c9b21a501a66f904ce705558 Mon Sep 17 00:00:00 2001 From: Spyros Roum Date: Fri, 15 Oct 2021 14:49:05 +0300 Subject: [PATCH 2/3] Run `cargo fmt` removing redundant braces --- src/error.rs | 49 +++++++++++++++++++++++-------------------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/src/error.rs b/src/error.rs index b0e313e7f..62a6b55d4 100644 --- a/src/error.rs +++ b/src/error.rs @@ -103,34 +103,31 @@ impl fmt::Display for Error { .detail("This is unadvisable since ouch does compressions in-memory.") .hint("Use a more appropriate tool for this, such as rsync.") } - Error::MissingArgumentsForCompression => { - FinalError::with_title("Could not compress") - .detail("The compress command requires at least 2 arguments") - .hint("You must provide:") - .hint(" - At least one input argument.") - .hint(" - The output argument.") - .hint("") - .hint("Example: `ouch compress image.png img.zip`") - } - Error::MissingArgumentsForDecompression => { - FinalError::with_title("Could not decompress") - .detail("The compress command requires at least one argument") - .hint("You must provide:") - .hint(" - At least one input argument.") - .hint("") - .hint("Example: `ouch decompress imgs.tar.gz`") - } - Error::InternalError => { - FinalError::with_title("InternalError :(") - .detail("This should not have happened") - .detail("It's probably our fault") - .detail("Please help us improve by reporting the issue at:") - .detail(format!(" {}https://github.com/vrmiguel/ouch/issues ", cyan())) - } + Error::MissingArgumentsForCompression => FinalError::with_title("Could not compress") + .detail("The compress command requires at least 2 arguments") + .hint("You must provide:") + .hint(" - At least one input argument.") + .hint(" - The output argument.") + .hint("") + .hint("Example: `ouch compress image.png img.zip`"), + Error::MissingArgumentsForDecompression => FinalError::with_title("Could not decompress") + .detail("The compress command requires at least one argument") + .hint("You must provide:") + .hint(" - At least one input argument.") + .hint("") + .hint("Example: `ouch decompress imgs.tar.gz`"), + Error::InternalError => FinalError::with_title("InternalError :(") + .detail("This should not have happened") + .detail("It's probably our fault") + .detail("Please help us improve by reporting the issue at:") + .detail(format!(" {}https://github.com/vrmiguel/ouch/issues ", cyan())), Error::OofError(err) => FinalError::with_title(err), Error::IoError { reason } => FinalError::with_title(reason), - Error::CompressionTypo => FinalError::with_title("Possible typo detected") - .hint(format!("Did you mean '{}ouch compress{}'?", magenta(), reset())), + Error::CompressionTypo => FinalError::with_title("Possible typo detected").hint(format!( + "Did you mean '{}ouch compress{}'?", + magenta(), + reset() + )), Error::UnknownExtensionError(_) => todo!(), Error::AlreadyExists => todo!(), Error::InvalidZipArchive(_) => todo!(), From c44cdf10130d491e2277c27e6dc1c6f2980f94bd Mon Sep 17 00:00:00 2001 From: Spyros Roum Date: Fri, 15 Oct 2021 17:11:44 +0300 Subject: [PATCH 3/3] Enable nightly for unstable fmt feature and run `cargo fmt` --- rust-toolchain | 1 + rustfmt.toml | 2 ++ src/error.rs | 54 +++++++++++++++++++++++++++--------------------- src/oof/error.rs | 24 ++++++++++++--------- 4 files changed, 48 insertions(+), 33 deletions(-) create mode 100644 rust-toolchain diff --git a/rust-toolchain b/rust-toolchain new file mode 100644 index 000000000..bf867e0ae --- /dev/null +++ b/rust-toolchain @@ -0,0 +1 @@ +nightly diff --git a/rustfmt.toml b/rustfmt.toml index 7bba11e2a..2ac63bb9b 100644 --- a/rustfmt.toml +++ b/rustfmt.toml @@ -6,3 +6,5 @@ reorder_imports = true reorder_modules = true use_try_shorthand = true use_small_heuristics = "Max" +unstable_features = true +force_multiline_blocks = true diff --git a/src/error.rs b/src/error.rs index 62a6b55d4..571507e5e 100644 --- a/src/error.rs +++ b/src/error.rs @@ -103,31 +103,39 @@ impl fmt::Display for Error { .detail("This is unadvisable since ouch does compressions in-memory.") .hint("Use a more appropriate tool for this, such as rsync.") } - Error::MissingArgumentsForCompression => FinalError::with_title("Could not compress") - .detail("The compress command requires at least 2 arguments") - .hint("You must provide:") - .hint(" - At least one input argument.") - .hint(" - The output argument.") - .hint("") - .hint("Example: `ouch compress image.png img.zip`"), - Error::MissingArgumentsForDecompression => FinalError::with_title("Could not decompress") - .detail("The compress command requires at least one argument") - .hint("You must provide:") - .hint(" - At least one input argument.") - .hint("") - .hint("Example: `ouch decompress imgs.tar.gz`"), - Error::InternalError => FinalError::with_title("InternalError :(") - .detail("This should not have happened") - .detail("It's probably our fault") - .detail("Please help us improve by reporting the issue at:") - .detail(format!(" {}https://github.com/vrmiguel/ouch/issues ", cyan())), + Error::MissingArgumentsForCompression => { + FinalError::with_title("Could not compress") + .detail("The compress command requires at least 2 arguments") + .hint("You must provide:") + .hint(" - At least one input argument.") + .hint(" - The output argument.") + .hint("") + .hint("Example: `ouch compress image.png img.zip`") + } + Error::MissingArgumentsForDecompression => { + FinalError::with_title("Could not decompress") + .detail("The compress command requires at least one argument") + .hint("You must provide:") + .hint(" - At least one input argument.") + .hint("") + .hint("Example: `ouch decompress imgs.tar.gz`") + } + Error::InternalError => { + FinalError::with_title("InternalError :(") + .detail("This should not have happened") + .detail("It's probably our fault") + .detail("Please help us improve by reporting the issue at:") + .detail(format!(" {}https://github.com/vrmiguel/ouch/issues ", cyan())) + } Error::OofError(err) => FinalError::with_title(err), Error::IoError { reason } => FinalError::with_title(reason), - Error::CompressionTypo => FinalError::with_title("Possible typo detected").hint(format!( - "Did you mean '{}ouch compress{}'?", - magenta(), - reset() - )), + Error::CompressionTypo => { + FinalError::with_title("Possible typo detected").hint(format!( + "Did you mean '{}ouch compress{}'?", + magenta(), + reset() + )) + } Error::UnknownExtensionError(_) => todo!(), Error::AlreadyExists => todo!(), Error::InvalidZipArchive(_) => todo!(), diff --git a/src/oof/error.rs b/src/oof/error.rs index 6dd478352..299601a71 100644 --- a/src/oof/error.rs +++ b/src/oof/error.rs @@ -31,18 +31,22 @@ impl fmt::Display for OofError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { // TODO: implement proper debug messages match self { - OofError::FlagValueConflict { flag, previous_value, new_value } => write!( - f, - "CLI flag value conflicted for flag '--{}', previous: {:?}, new: {:?}.", - flag.long, previous_value, new_value - ), + OofError::FlagValueConflict { flag, previous_value, new_value } => { + write!( + f, + "CLI flag value conflicted for flag '--{}', previous: {:?}, new: {:?}.", + flag.long, previous_value, new_value + ) + } OofError::InvalidUnicode(flag) => write!(f, "{:?} is not valid Unicode.", flag), OofError::UnknownShortFlag(ch) => write!(f, "Unknown argument '-{}'", ch), - OofError::MisplacedShortArgFlagError(ch) => write!( - f, - "Invalid placement of `-{}`.\nOnly the last letter in a sequence of short flags can take values.", - ch - ), + OofError::MisplacedShortArgFlagError(ch) => { + write!( + f, + "Invalid placement of `-{}`.\nOnly the last letter in a sequence of short flags can take values.", + ch + ) + } OofError::MissingValueToFlag(flag) => write!(f, "Flag {} takes value but none was supplied.", flag), OofError::DuplicatedFlag(flag) => write!(f, "Duplicated usage of {}.", flag), OofError::UnknownLongFlag(flag) => write!(f, "Unknown argument '--{}'", flag),