From 98580f3a7ffc8e6880e8028dec634ec426935634 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 23 May 2023 17:31:17 +0200 Subject: [PATCH 1/4] Updates readme --- src/actions.rs | 3 ++- src/errors.rs | 18 +++++++++--------- src/main.rs | 23 +++++++++++++---------- 3 files changed, 24 insertions(+), 20 deletions(-) diff --git a/src/actions.rs b/src/actions.rs index 4066e97..5531f13 100644 --- a/src/actions.rs +++ b/src/actions.rs @@ -42,7 +42,8 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> { if let Some(e) = e.source() { println!("This error was caused by: \n\t{}", e); } - return Err(e); + // return Err(e); + return Ok(()); // Very unconvinced by this }; } Ok(()) diff --git a/src/errors.rs b/src/errors.rs index 72d62da..d1c0d41 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -31,30 +31,30 @@ pub enum SnippetError { impl fmt::Display for SnippetError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { - SnippetError::Unknown => write!(f, "An unknonw error occured"), - SnippetError::ClapError(..) => write!(f, "An error occured while parsing the input"), - SnippetError::IOError(..) => write!(f, "An error occured while editing the file"), + SnippetError::Unknown => write!(f, "An unknonw error occured."), + SnippetError::ClapError(..) => write!(f, "An error occured while parsing the input."), + SnippetError::IOError(..) => write!(f, "An error occured while editing the file."), SnippetError::YAMLError(..) => { - write!(f, "Couldn't convert the given arguments into a yaml") + write!(f, "Couldn't convert the given arguments into a yaml.") } SnippetError::NotFound(ref p) => write!( f, - "The file {:?} doesn't exists",p.file_name().unwrap(), + "The Snippet {:?} doesn't exists. Use -c to create it and/or -E to edit it.",p.file_name().unwrap(), ), SnippetError::NotFoundNoRetryError(ref p) => { write!( f, - "The config {:?} doen't exists. Use -c to create it.", + "The Snippet {:?} doen't exists. Use -c to create it.", p.file_name(), ) } SnippetError::FoundNoEraseError(ref p) => write!( f, - "The snippet {:?} already exists. Use -f/--force to overwrite it.", + "The Snippet {:?} already exists. Use -f/--force to overwrite it.", p.file_name().unwrap(), ), - SnippetError::ReparsingError => write!(f,"The snipped couldn't be re-parsed, it might be caused by a bad value in your edit. \nThe snipped was saved as a raw file instead but cant be used as is."), - SnippetError::IndexError(ref i) => write!(f,"An error occured while trying to access the index {} of the given arguments.\nThe default arguments for this command likely do not support {} arguments",i,i+1), + SnippetError::ReparsingError => write!(f,"The Snippet couldn't be re-parsed, it might be caused by a bad value in your edit. \nThe snipped was saved as a raw file instead but cant be used as is."), + SnippetError::IndexError(ref i) => write!(f,"An error occured while trying to access the index {} of the given arguments.\nThe default arguments for this command likely do not support {} arguments.",i,i+1), } } } diff --git a/src/main.rs b/src/main.rs index b07f945..652c2f2 100644 --- a/src/main.rs +++ b/src/main.rs @@ -11,23 +11,27 @@ mod snippet; mod tokenizer; mod wrapper_functions; -/// The cli arguments to give to the utility +/// SNP an utility to create and manage Snippets of code +/// +/// Use "snp -c -E snippet_name" to create a new Snippet and start editing it and "snp snippet_name argument" to use it +/// You can use "{}" or "{0}" in your Snippet to later format it to your needs as would python .format() or rust format!("",) work +/// Doing so will need as many default arguments to fill the command than the total count of {} #[derive(Parser, Debug)] -#[command(author, version, about)] +#[command(author, version, about, verbatim_doc_comment)] pub struct Cli { - /// The snippet name (and therefore his path) + /// The Snippet name (and therefore his path) #[arg()] snippet: String, - /// Wether to try to load or instead create a new one + /// Try to create a Snippet with the given name and default arguments #[arg(short, long, default_value_t = false)] create: bool, - /// Show where the snippet is located + /// Show where the Snippet is located #[arg(short, long, default_value_t = false)] locate: bool, - /// Launch the editor and edit the snippet + /// Launch the editor and edit the Snippet content #[arg(short, long, default_value_t = false)] edit: bool, @@ -37,18 +41,17 @@ pub struct Cli { /// The list of arguments to give to the snippet /// if the -c flag is used, it's used to create the default arguments - #[arg(help = "List of args to give to the snipplet")] args: Vec, - /// Wether to force the creation or save and overwrite existing data + /// Force the creation/moving/renaming of a Snippet even if it mean overwriting an existing one #[arg(short, long, default_value_t = false)] force: bool, - /// Wether to delete a snippet, takes precedence over everything + /// Delete a snippet, takes precedence over everything #[arg(short, long, default_value_t = false)] delete: bool, - /// Wether to rename the snippet + /// Try to rename the Snippet (Use -f if the destination name already exist) #[arg(short, long)] rename: Option, } -- 2.45.1 From 1ed8e65de73fe4b2f2e1aa9b34767c0be93e31fa Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 23 May 2023 18:03:10 +0200 Subject: [PATCH 2/4] Corrects the save/replace error when dest was taken --- src/actions.rs | 14 +++++------ src/wrapper_functions.rs | 50 +++++++++++----------------------------- 2 files changed, 20 insertions(+), 44 deletions(-) diff --git a/src/actions.rs b/src/actions.rs index 5531f13..f8b3165 100644 --- a/src/actions.rs +++ b/src/actions.rs @@ -1,8 +1,6 @@ //! The action module, including all the logic to jump to a specific action //! depending on the CLI arguments -use std::error::Error; - use crate::{errors, wrapper_functions, Cli}; /// List of all possible actions, some are mutually exclusive @@ -38,12 +36,12 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> { Actions::Delete => wrapper_functions::delete_snippet(&cli), Actions::Rename => wrapper_functions::rename_snippet(&cli), } { - println!("An error occured during runtime:\n\t{}", e); - if let Some(e) = e.source() { - println!("This error was caused by: \n\t{}", e); - } - // return Err(e); - return Ok(()); // Very unconvinced by this + // println!("An error occured during runtime:\n\t{}", e); + // if let Some(e) = e.source() { + // println!("This error was caused by: \n\t{}", e); + // } + _ = ""; // No op to calm clippy while I decide wether or not delete this + return Err(e); }; } Ok(()) diff --git a/src/wrapper_functions.rs b/src/wrapper_functions.rs index ac3de9a..f9375c1 100644 --- a/src/wrapper_functions.rs +++ b/src/wrapper_functions.rs @@ -125,7 +125,7 @@ pub fn edit_snippet(cli: &Cli) -> Result<(), SnippetError> { pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> { // Try loading the snippet let status = check_dir_and_open(&cli.snippet); - let (buf, mut p) = match status? { + let (buf, mut origin_p) = match status? { FileStatus::Opened((p, f)) => (read_to_string(f)?, p), FileStatus::NotFound(p) => { if cli.create { @@ -145,72 +145,50 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> { Ok(snp) => { if cli.snippet == snp.name { // No renaming has occured, the file can safely be overriten - snp.write_over(&p)?; + snp.write_over(&origin_p)?; println!( "The snippet {:?} was succesfully saved", - p.file_name().unwrap() + origin_p.file_name().unwrap() ); Ok(()) } else { - let (f, p) = match check_dir_and_open(&snp.name)? { - FileStatus::Opened((p, f)) => { + let (dest_f, dest_p) = match check_dir_and_open(&snp.name)? { + FileStatus::Opened((dest_p, _dest_f)) => { if cli.force { // Erasing will take place - (File::create(&p)?, p) + (File::create(&dest_p)?, dest_p) } else { // No erasing/overriting println!( - "Impossible to save the snippet as {:}, as it already exists. The snippet will be saved under it's old name.", - snp.name + "The snippet could not be saved as {:}.yaml, as this Snippet already exists. The Snippet will be saved under it's original name name: {}", + snp.name,origin_p.file_name().unwrap().to_str().unwrap() ); - (f, p) + (File::create(&origin_p)?, origin_p) } } FileStatus::NotFound(p) => (File::create(&p)?, p), }; - snp.save_in(&f)?; - println!("The snippet was successfuly saved in {:?}", p); + snp.save_in(&dest_f)?; + println!("The snippet was successfuly saved in {:?}", dest_p); Ok(()) } } Err(_) => { // The snippet is incorrect, however it should still be saved, just under another name ? - p.set_extension("bad.yaml"); - let mut failover = File::create(&p)?; + origin_p.set_extension("bad.yaml"); + let mut failover = File::create(&origin_p)?; write!(failover, "{}", &buf)?; println!( "The snippet was saved under {:?} in your config", - p.file_name().unwrap() + origin_p.file_name().unwrap() ); Err(SnippetError::ReparsingError) } } } -// This code is used to check if the name changed but should be moved to a separate function -// let old_name = snp.name.clone(); -// // During tests, the editor cannot be tested -// #[cfg(not(feature = "test"))] -// snp.edit()?; - -// if snp.name == old_name { -// snp.write_over(&p) -// } else { -// match check_dir_and_open(&snp.name)? { -// FileStatus::Opened((p, _f)) => { -// if cli.force { -// std::fs::remove_file(&p)?; -// snp.write_over(&p) -// } else { -// Err(SnippetError::NotFoundNoRetryError(p)) -// } -// } -// FileStatus::NotFound(p) => snp.write_over(&p), -// } -// } - /// Print the snippet to stdout pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> { // Try to load the snippet -- 2.45.1 From c4185e848af7e5392bf1b8b93484f38886d426fa Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 23 May 2023 18:56:37 +0200 Subject: [PATCH 3/4] Adds a lot of cosmetic improvement and --list --- TODO.md | 27 +++----------------- src/actions.rs | 53 ++++++++++++++++++++++++---------------- src/main.rs | 8 ++++-- src/wrapper_functions.rs | 25 +++++++++++++++++-- 4 files changed, 65 insertions(+), 48 deletions(-) diff --git a/TODO.md b/TODO.md index 0583431..67a3aac 100644 --- a/TODO.md +++ b/TODO.md @@ -3,33 +3,14 @@ [ ] Better use of file modes [ ] Document non coverage [ ] Find a solution for the .badpocalypse + [ ] Edit args only + [ ] Double backslash win + [ ] Remove last return + [ ] Remove the prerequiste of name for --list ### Currently working on ## Finished - [*] Make custom errors - [*] Transform all panic in errors - [*] Make functions into methods - [*] Remake all helper functions - [*] locate_snippet - [*] create_snippet - [*] edit_snippet - [*] edit_whole_snippet - [*] print_snippet - [*] rename_snippet - [*] Finish tests on - [*] locate_snippet - [*] create_snippet - [*] edit_snippet - [*] edit_whole_snippet - [*] print_snippet - [*] delete snippet - [*] rename snippet - [*] Have identical attributes with {0} {1} {0} (^^^^^) - [*] Add an option to delete a snippet - [*] Coverage - [*] Test populate_actions - [*] Have the the EditWhole save under a different path if name was changed (and edit too) ## Posponed or rendered useless [x] Chain the methods when possible with result ? diff --git a/src/actions.rs b/src/actions.rs index f8b3165..6295d5c 100644 --- a/src/actions.rs +++ b/src/actions.rs @@ -11,8 +11,8 @@ pub enum Actions { Edit, /// Edit the whole snippet EditAll, - /// Locate the snippet and show the position - Locate, + /// List all snippets + List, /// Show the snippet (with replacement done) Show, /// Create the snippet with the given name and arguments @@ -21,6 +21,8 @@ pub enum Actions { Delete, /// Renames the snippet Rename, + /// Find a snippet matching a name/regex + Find, } /// The main worker, execute all commands given as Args @@ -28,13 +30,14 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> { let list_actions = populate_actions(&cli); for action in list_actions.iter() { if let Err(e) = match action { - Actions::Locate => wrapper_functions::locate_snippet(&cli), + Actions::Find => wrapper_functions::locate_snippet(&cli), Actions::Create => wrapper_functions::create_snippet(&cli), Actions::Show => wrapper_functions::print_snippet(&cli), Actions::Edit => wrapper_functions::edit_snippet(&cli), Actions::EditAll => wrapper_functions::edit_whole_snippet(&cli), Actions::Delete => wrapper_functions::delete_snippet(&cli), Actions::Rename => wrapper_functions::rename_snippet(&cli), + Actions::List => wrapper_functions::list_snippets(&cli), } { // println!("An error occured during runtime:\n\t{}", e); // if let Some(e) = e.source() { @@ -52,22 +55,24 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> { fn populate_actions(cli: &Cli) -> Vec { let mut actions = Vec::new(); match ( - cli.locate, + cli.path, cli.create, cli.edit, cli.edit_all, cli.delete, &cli.rename, + cli.list, ) { - (true, _, _, _, false, _) => actions.push(Actions::Locate), - (_, false, false, true, false, _) => actions.push(Actions::EditAll), - (_, true, _, true, false, _) => actions.push(Actions::EditAll), - (_, true, false, false, false, _) => actions.push(Actions::Create), - (_, false, true, _, false, _) => actions.push(Actions::Edit), - (_, true, true, false, false, _) => actions.push(Actions::Edit), - (false, false, false, false, false, None) => actions.push(Actions::Show), - (_, _, _, _, true, _) => actions.push(Actions::Delete), - (_, _, _, _, _, Some(_)) => actions.push(Actions::Rename), + (true, _, _, _, false, _, false) => actions.push(Actions::Find), + (_, false, false, true, false, _, false) => actions.push(Actions::EditAll), + (_, true, _, true, false, _, false) => actions.push(Actions::EditAll), + (_, true, false, false, false, _, false) => actions.push(Actions::Create), + (_, false, true, _, false, _, false) => actions.push(Actions::Edit), + (_, true, true, false, false, _, false) => actions.push(Actions::Edit), + (false, false, false, false, false, None, false) => actions.push(Actions::Show), + (_, _, _, _, true, _, false) => actions.push(Actions::Delete), + (_, _, _, _, _, Some(_), false) => actions.push(Actions::Rename), + (_, _, _, _, _, _, true) => actions.push(Actions::List), } actions } @@ -91,16 +96,16 @@ mod test { #[test] fn test_populate_actions() { - // false_cli!("snp", "name", "-l"), Actions::Locate + // false_cli!("snp", "name", "-p"), Actions::Locate let group = group_actions!( ( - false_cli!("snp", "name", "-l", "-c", "-e", "-E"), - vec![Actions::Locate] + false_cli!("snp", "name", "-p", "-c", "-e", "-E"), + vec![Actions::Find] ), - (false_cli!("snp", "name", "-l"), vec![Actions::Locate]), + (false_cli!("snp", "name", "-p"), vec![Actions::Find]), (false_cli!("snp", "name", "-d"), vec![Actions::Delete]), ( - false_cli!("snp", "name", "-d", "-e", "e", "-E", "-l"), + false_cli!("snp", "name", "-d", "-e", "e", "-E", "-p"), vec![Actions::Delete] ), (false_cli!("snp", "name", "-E"), vec![Actions::EditAll]), @@ -111,12 +116,12 @@ mod test { ), (false_cli!("snp", "name", "-e"), vec![Actions::Edit]), (false_cli!("snp", "name", "-e", "-c"), vec![Actions::Edit]), - (false_cli!("snp", "name", "-l"), vec![Actions::Locate]), + (false_cli!("snp", "name", "-p"), vec![Actions::Find]), (false_cli!("snp", "name", "-c"), vec![Actions::Create]), (false_cli!("snp", "name"), vec![Actions::Show]), (false_cli!("snp", "name", "-d"), vec![Actions::Delete]), ( - false_cli!("snp", "name", "-d", "-c", "-E", "-e", "-l"), + false_cli!("snp", "name", "-d", "-c", "-E", "-e", "-p"), vec![Actions::Delete] ), ( @@ -131,6 +136,11 @@ mod test { false_cli!("snp", "name", "-c", "-r", "new_name", "-f"), vec![Actions::Create] ), + (false_cli!("snp", "name", "-l"), vec![Actions::List]), + ( + false_cli!("snp", "name", "-l", "-c", "-e", "-E"), + vec![Actions::List] + ), ); for (cli, res) in group.iter() { println!("Testing {:?}..actions expected {:?}", cli, res); @@ -150,10 +160,11 @@ mod test { false_cli!("snp", "parsed_cli", "-c"), false_cli!("snp", "parsed_cli", "-r", "new_name", "-f"), false_cli!("snp", "new_name", "-d"), + false_cli!("snp", "new_name", "-l"), ]; let bad_cli = vec![ - false_cli!("snp", "parsed_cli_bad", "-l"), + false_cli!("snp", "parsed_cli_bad", "-p"), false_cli!("snp", "-d", "parsed_cli_bad"), ]; diff --git a/src/main.rs b/src/main.rs index 652c2f2..945586e 100644 --- a/src/main.rs +++ b/src/main.rs @@ -27,9 +27,9 @@ pub struct Cli { #[arg(short, long, default_value_t = false)] create: bool, - /// Show where the Snippet is located + /// Find the path of the snippet with the given name #[arg(short, long, default_value_t = false)] - locate: bool, + path: bool, /// Launch the editor and edit the Snippet content #[arg(short, long, default_value_t = false)] @@ -54,6 +54,10 @@ pub struct Cli { /// Try to rename the Snippet (Use -f if the destination name already exist) #[arg(short, long)] rename: Option, + + /// List all snippets in the snippet folder + #[arg(short, long, default_value_t = false)] + list: bool, } /// Main entry point, everything is defered for testing and coverage diff --git a/src/wrapper_functions.rs b/src/wrapper_functions.rs index f9375c1..6d76c2d 100644 --- a/src/wrapper_functions.rs +++ b/src/wrapper_functions.rs @@ -6,7 +6,7 @@ #[allow(unused)] // Mandatory because of how test and rust-analyser work use edit::edit; -use std::fs::create_dir_all; +use std::fs::{self, create_dir_all}; use std::io::{read_to_string, Write}; use std::{env, fs::File, path::PathBuf}; @@ -188,6 +188,26 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> { } } } +/// List all snippets in the snippet config directory +pub fn list_snippets(_cli: &Cli) -> Result<(), SnippetError> { + let dirpath = config_folder()?; + let paths = fs::read_dir(&dirpath).unwrap(); + println!( + "Snippet list at {:?}:\n {:?}", + dirpath.parent().unwrap().to_str().unwrap(), + paths + .map(|p| p + .unwrap() + .path() + .file_name() + .unwrap() + .to_str() + .unwrap() + .to_owned()) + .collect::>() + ); + Ok(()) +} /// Print the snippet to stdout pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> { @@ -437,6 +457,7 @@ pub mod test { let res = edit_whole_snippet(false_cli!("snp", "resave_snippet")); println!("Failing to overwrite {:?}", res); - assert!(res.is_err()); + assert!(res.is_ok()); // The failure just means it wasn't overriten + // TODO: Check no overwrite occurs } } -- 2.45.1 From 3c7f672a55fd70c87ed8b647fb3b1223367a3dde Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 23 May 2023 19:04:04 +0200 Subject: [PATCH 4/4] Adds a little eye candy for the paths and listing --- src/errors.rs | 10 +++++----- src/wrapper_functions.rs | 5 +++-- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/errors.rs b/src/errors.rs index d1c0d41..0eacd0f 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -39,19 +39,19 @@ impl fmt::Display for SnippetError { } SnippetError::NotFound(ref p) => write!( f, - "The Snippet {:?} doesn't exists. Use -c to create it and/or -E to edit it.",p.file_name().unwrap(), + "The Snippet {} doesn't exists. Use -c to create it and/or -E to edit it.",p.file_name().unwrap().to_str().unwrap(), ), SnippetError::NotFoundNoRetryError(ref p) => { write!( f, - "The Snippet {:?} doen't exists. Use -c to create it.", - p.file_name(), + "The Snippet {} doen't exists. Use -c to create it.", + p.file_name().unwrap().to_str().unwrap(), ) } SnippetError::FoundNoEraseError(ref p) => write!( f, - "The Snippet {:?} already exists. Use -f/--force to overwrite it.", - p.file_name().unwrap(), + "The Snippet {} already exists. Use -f/--force to overwrite it.", + p.file_name().unwrap().to_str().unwrap(), ), SnippetError::ReparsingError => write!(f,"The Snippet couldn't be re-parsed, it might be caused by a bad value in your edit. \nThe snipped was saved as a raw file instead but cant be used as is."), SnippetError::IndexError(ref i) => write!(f,"An error occured while trying to access the index {} of the given arguments.\nThe default arguments for this command likely do not support {} arguments.",i,i+1), diff --git a/src/wrapper_functions.rs b/src/wrapper_functions.rs index 6d76c2d..90bea6c 100644 --- a/src/wrapper_functions.rs +++ b/src/wrapper_functions.rs @@ -160,7 +160,7 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> { } else { // No erasing/overriting println!( - "The snippet could not be saved as {:}.yaml, as this Snippet already exists. The Snippet will be saved under it's original name name: {}", + "The snippet could not be saved as {}.yaml, as this Snippet already exists. The Snippet will be saved under it's original name name: {}", snp.name,origin_p.file_name().unwrap().to_str().unwrap() ); (File::create(&origin_p)?, origin_p) @@ -193,7 +193,7 @@ pub fn list_snippets(_cli: &Cli) -> Result<(), SnippetError> { let dirpath = config_folder()?; let paths = fs::read_dir(&dirpath).unwrap(); println!( - "Snippet list at {:?}:\n {:?}", + "Snippet list at {}:\n {}", dirpath.parent().unwrap().to_str().unwrap(), paths .map(|p| p @@ -205,6 +205,7 @@ pub fn list_snippets(_cli: &Cli) -> Result<(), SnippetError> { .unwrap() .to_owned()) .collect::>() + .join(", ") ); Ok(()) } -- 2.45.1