Merge pull request '1.0.4' (#6) from develop into main
Reviewed-on: Dandaedre/snp#6
This commit is contained in:
commit
628b25f00d
|
|
@ -1,7 +1,7 @@
|
|||
[package]
|
||||
name = "snp"
|
||||
authors = ["Dandaedre"]
|
||||
version = "1.0.1"
|
||||
version = "1.0.4"
|
||||
edition = "2021"
|
||||
|
||||
[features]
|
||||
|
|
|
|||
27
TODO.md
27
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 ?
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,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
|
||||
|
|
@ -23,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
|
||||
|
|
@ -30,18 +30,20 @@ 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() {
|
||||
println!("This error was caused by: \n\t{}", e);
|
||||
}
|
||||
// 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);
|
||||
};
|
||||
}
|
||||
|
|
@ -53,22 +55,24 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> {
|
|||
fn populate_actions(cli: &Cli) -> Vec<Actions> {
|
||||
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
|
||||
}
|
||||
|
|
@ -90,18 +94,19 @@ mod test {
|
|||
};
|
||||
}
|
||||
|
||||
// #[ignore]
|
||||
#[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]),
|
||||
|
|
@ -112,12 +117,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]
|
||||
),
|
||||
(
|
||||
|
|
@ -132,6 +137,8 @@ mod test {
|
|||
false_cli!("snp", "name", "-c", "-r", "new_name", "-f"),
|
||||
vec![Actions::Create]
|
||||
),
|
||||
(false_cli!("snp", "-l"), vec![Actions::List]),
|
||||
// (false_cli!("snp", "-l"), vec![Actions::List]),
|
||||
);
|
||||
for (cli, res) in group.iter() {
|
||||
println!("Testing {:?}..actions expected {:?}", cli, res);
|
||||
|
|
@ -140,8 +147,10 @@ mod test {
|
|||
assert!(res.iter().zip(fnd).all(|(a, b)| *a == b));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_execute_parsed_cli() {
|
||||
// println!("Executing test for cli");
|
||||
let list_cli = vec![
|
||||
false_cli!("snp", "parsed_cli", "-e", "-c"),
|
||||
false_cli!("snp", "parsed_cli", "-c", "-f"),
|
||||
|
|
@ -151,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", "-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"),
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -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().to_str().unwrap(),
|
||||
),
|
||||
SnippetError::NotFoundNoRetryError(ref p) => {
|
||||
write!(
|
||||
f,
|
||||
"The config {:?} 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 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),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
66
src/main.rs
66
src/main.rs
|
|
@ -11,46 +11,59 @@ 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)
|
||||
#[arg()]
|
||||
snippet: String,
|
||||
/// The Snippet name (and therefore his path)
|
||||
#[arg(group = "mandatory", group = "mutex")]
|
||||
snippet: Option<String>,
|
||||
|
||||
/// Wether to try to load or instead create a new one
|
||||
#[arg(short, long, default_value_t = false)]
|
||||
/// Try to create a Snippet with the given name and default arguments
|
||||
#[arg(short, long, default_value_t = false, requires = "mandatory")]
|
||||
create: bool,
|
||||
|
||||
/// Show where the snippet is located
|
||||
#[arg(short, long, default_value_t = false)]
|
||||
locate: bool,
|
||||
/// Find the path of the snippet with the given name
|
||||
#[arg(short, long, default_value_t = false, requires = "mandatory")]
|
||||
path: bool,
|
||||
|
||||
/// Launch the editor and edit the snippet
|
||||
#[arg(short, long, default_value_t = false)]
|
||||
/// Launch the editor and edit the Snippet content
|
||||
#[arg(short, long, default_value_t = false, requires = "mandatory")]
|
||||
edit: bool,
|
||||
|
||||
/// Launch the editor and edit the whole snippet
|
||||
#[arg(short = 'E', long = "Edit", default_value_t = false)]
|
||||
#[arg(
|
||||
short = 'E',
|
||||
long = "Edit",
|
||||
default_value_t = false,
|
||||
requires = "mandatory"
|
||||
)]
|
||||
edit_all: bool,
|
||||
|
||||
/// 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")]
|
||||
#[arg(requires = "mandatory")]
|
||||
args: Vec<String>,
|
||||
|
||||
/// Wether to force the creation or save and overwrite existing data
|
||||
#[arg(short, long, default_value_t = false)]
|
||||
/// Force the creation/moving/renaming of a Snippet even if it mean overwriting an existing one
|
||||
#[arg(short, long, default_value_t = false, requires = "mandatory")]
|
||||
force: bool,
|
||||
|
||||
/// Wether to delete a snippet, takes precedence over everything
|
||||
#[arg(short, long, default_value_t = false)]
|
||||
/// Delete a snippet, takes precedence over everything
|
||||
#[arg(short, long, default_value_t = false, requires = "mandatory")]
|
||||
delete: bool,
|
||||
|
||||
/// Wether to rename the snippet
|
||||
#[arg(short, long)]
|
||||
/// Try to rename the Snippet (Use -f if the destination name already exist)
|
||||
#[arg(short, long, requires = "mandatory")]
|
||||
rename: Option<String>,
|
||||
|
||||
/// List all snippets in the snippet folder
|
||||
#[arg(short, long, default_value_t = false, group = "mutex")]
|
||||
list: bool,
|
||||
}
|
||||
|
||||
/// Main entry point, everything is defered for testing and coverage
|
||||
|
|
@ -58,3 +71,16 @@ fn main() -> Result<(), errors::SnippetError> {
|
|||
let cli = Cli::parse();
|
||||
actions::execute_parsed_cli(cli)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use clap::CommandFactory;
|
||||
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_cli_main() {
|
||||
let cmd = Cli::command_for_update();
|
||||
cmd.debug_assert();
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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};
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ use crate::{dynamic_formatter, Cli};
|
|||
///
|
||||
/// Will error on snippet not existing
|
||||
pub fn locate_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
let status = check_dir_and_open(&cli.snippet)?;
|
||||
let status = check_dir_and_open(cli.snippet.as_ref().unwrap())?;
|
||||
match status {
|
||||
FileStatus::Opened((p, _)) => {
|
||||
println!("{:?}", p.as_os_str());
|
||||
|
|
@ -31,8 +31,12 @@ pub fn locate_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
/// Create a new snippet with the given cli args
|
||||
pub fn create_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
// Create a snippet with the given data
|
||||
let snp = Snippet::new(cli.snippet.clone(), cli.args.clone(), String::from(""));
|
||||
let status = check_dir_and_open(&cli.snippet)?;
|
||||
let snp = Snippet::new(
|
||||
cli.snippet.as_ref().unwrap().clone(),
|
||||
cli.args.clone(),
|
||||
String::from(""),
|
||||
);
|
||||
let status = check_dir_and_open(cli.snippet.as_ref().unwrap())?;
|
||||
let (f, p) = match status {
|
||||
FileStatus::Opened((p, _)) => {
|
||||
if cli.force {
|
||||
|
|
@ -54,10 +58,10 @@ pub fn create_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
pub fn rename_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
// Check wether the snippet exitsts
|
||||
let new_name = cli.rename.as_ref().unwrap();
|
||||
if new_name == &cli.snippet {
|
||||
if new_name == cli.snippet.as_ref().unwrap() {
|
||||
return Ok(()); // The noop is a success ?
|
||||
}
|
||||
let (f, oldpath) = match check_dir_and_open(&cli.snippet)? {
|
||||
let (f, oldpath) = match check_dir_and_open(cli.snippet.as_ref().unwrap())? {
|
||||
FileStatus::Opened((p, f)) => (f, p),
|
||||
FileStatus::NotFound(e) => return Err(SnippetError::NotFound(e)),
|
||||
};
|
||||
|
|
@ -83,7 +87,8 @@ pub fn rename_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
// Save snippet
|
||||
println!(
|
||||
"The snippet {} was sucessfuly renamed as {}",
|
||||
cli.snippet, new_name
|
||||
cli.snippet.as_ref().unwrap(),
|
||||
new_name
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -91,13 +96,17 @@ pub fn rename_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
/// Open and load snippet and edit it
|
||||
pub fn edit_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
// Try loading, if not existant check if create or error
|
||||
let status = check_dir_and_open(&cli.snippet)?;
|
||||
let status = check_dir_and_open(cli.snippet.as_ref().unwrap())?;
|
||||
let (mut snp, _, p) = match status {
|
||||
FileStatus::Opened((p, f)) => (Snippet::from_file(&f)?, f, p),
|
||||
FileStatus::NotFound(p) => {
|
||||
if cli.create {
|
||||
(
|
||||
Snippet::new(cli.snippet.clone(), cli.args.clone(), String::from("")),
|
||||
Snippet::new(
|
||||
cli.snippet.as_ref().unwrap().clone(),
|
||||
cli.args.clone(),
|
||||
String::from(""),
|
||||
),
|
||||
File::create(&p)?,
|
||||
p,
|
||||
)
|
||||
|
|
@ -124,13 +133,16 @@ pub fn edit_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
/// a creation or an override
|
||||
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 status = check_dir_and_open(cli.snippet.as_ref().unwrap());
|
||||
let (buf, mut origin_p) = match status? {
|
||||
FileStatus::Opened((p, f)) => (read_to_string(f)?, p),
|
||||
FileStatus::NotFound(p) => {
|
||||
if cli.create {
|
||||
File::create(&p)?;
|
||||
(Snippet::empty(cli.snippet.clone(), cli.args.clone()), p)
|
||||
(
|
||||
Snippet::empty(cli.snippet.clone().unwrap(), cli.args.clone()),
|
||||
p,
|
||||
)
|
||||
} else {
|
||||
return Err(SnippetError::NotFoundNoRetryError(p));
|
||||
}
|
||||
|
|
@ -143,78 +155,77 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
// Try reparsing, on error no modifications will be made
|
||||
match Snippet::from_string(&buf) {
|
||||
Ok(snp) => {
|
||||
if cli.snippet == snp.name {
|
||||
if cli.snippet.as_ref().unwrap() == &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),
|
||||
// }
|
||||
// }
|
||||
/// 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::<Vec<String>>()
|
||||
.join(", ")
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Print the snippet to stdout
|
||||
pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
// Try to load the snippet <name>
|
||||
let (_, f) = match check_dir_and_open(&cli.snippet)? {
|
||||
let (_, f) = match check_dir_and_open(cli.snippet.as_ref().unwrap())? {
|
||||
FileStatus::Opened((p, f)) => (p, f),
|
||||
FileStatus::NotFound(p) => return Err(SnippetError::NotFound(p)),
|
||||
};
|
||||
|
|
@ -234,7 +245,7 @@ pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
|||
/// Delete a given snippet, errors if the snippet doesn't exists
|
||||
pub fn delete_snippet(cli: &Cli) -> Result<(), SnippetError> {
|
||||
let mut path = config_folder()?;
|
||||
path.push(format!("{}.yaml", cli.snippet));
|
||||
path.push(format!("{}.yaml", cli.snippet.as_ref().unwrap()));
|
||||
std::fs::remove_file(path)?;
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -309,6 +320,7 @@ pub mod test {
|
|||
assert!(delete_snippet(false_cli!("snp", "-d", "delete_snippet")).is_ok());
|
||||
}
|
||||
|
||||
// #[ignore]
|
||||
#[test]
|
||||
fn test_locate() {
|
||||
// Try to locate an unexisting snippet
|
||||
|
|
@ -316,14 +328,14 @@ pub mod test {
|
|||
_ = std::fs::remove_file(&theorical_path);
|
||||
|
||||
// Locating the snippet should fail
|
||||
assert!(locate_snippet(false_cli!("-l", "test_locate")).is_err());
|
||||
assert!(locate_snippet(false_cli!("snp", "-f", "test_locate")).is_err());
|
||||
|
||||
let mut f = File::create(&theorical_path).expect("Couldn't create file");
|
||||
write!(f, "N").expect("Couldn't write on the new file");
|
||||
f.sync_data().expect("Can't sync file");
|
||||
|
||||
// Locating the snippet should now suceed
|
||||
assert!(locate_snippet(false_cli!("-l", "test_locate")).is_ok());
|
||||
assert!(locate_snippet(false_cli!("-f", "test_locate")).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
|
@ -335,57 +347,59 @@ pub mod test {
|
|||
assert!(print_snippet(false_cli!("snp", "test_print")).is_err());
|
||||
|
||||
// Create snippet
|
||||
assert!(create_snippet(false_cli!("-c", "test_print")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "test_print")).is_ok());
|
||||
assert!(print_snippet(false_cli!("snp", "test_print")).is_ok());
|
||||
// assert!(print_snippet(false_cli!("-l", "test_print")).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_create() {
|
||||
_ = std::fs::remove_file(snippet_path("create_snippet").unwrap());
|
||||
// Test to create empty
|
||||
assert!(create_snippet(false_cli!("-c", "create_snippet")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "create_snippet")).is_ok());
|
||||
|
||||
// Test to create again
|
||||
assert!(create_snippet(false_cli!("-c", "create_snippet")).is_err());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "create_snippet")).is_err());
|
||||
|
||||
// Test to create with force
|
||||
assert!(create_snippet(false_cli!("-c", "-f", "create_snippet")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "-f", "create_snippet")).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_edit() {
|
||||
_ = std::fs::remove_file(snippet_path("edit_content").unwrap());
|
||||
// Open unnexitant
|
||||
assert!(edit_snippet(false_cli!("-e", "edit_content")).is_err());
|
||||
assert!(edit_snippet(false_cli!("snp", "-e", "edit_content")).is_err());
|
||||
|
||||
// Force creation
|
||||
assert!(edit_snippet(false_cli!("-e", "-c", "edit_content")).is_ok());
|
||||
assert!(edit_snippet(false_cli!("snp", "-e", "-c", "edit_content")).is_ok());
|
||||
|
||||
// Edit when created
|
||||
|
||||
println!("{:?}", edit_snippet(false_cli!("-e", "edit_content")));
|
||||
assert!(edit_snippet(false_cli!("-e", "edit_content")).is_ok());
|
||||
println!(
|
||||
"{:?}",
|
||||
edit_snippet(false_cli!("snp", "-e", "edit_content"))
|
||||
);
|
||||
assert!(edit_snippet(false_cli!("snp", "-e", "edit_content")).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_edit_whole() {
|
||||
_ = std::fs::remove_file(snippet_path("edit_whole").unwrap());
|
||||
// Open unnexitant
|
||||
assert!(edit_whole_snippet(false_cli!("-E", "edit_whole")).is_err());
|
||||
assert!(edit_whole_snippet(false_cli!("snp", "-E", "edit_whole")).is_err());
|
||||
|
||||
// Force creation
|
||||
assert!(edit_whole_snippet(false_cli!("-E", "-c", "edit_whole")).is_ok());
|
||||
assert!(edit_whole_snippet(false_cli!("snp", "-E", "-c", "edit_whole")).is_ok());
|
||||
|
||||
// Edit when created
|
||||
assert!(edit_whole_snippet(false_cli!("-E", "edit_whole")).is_ok());
|
||||
assert!(edit_whole_snippet(false_cli!("snp", "-E", "edit_whole")).is_ok());
|
||||
|
||||
// Create a badly formatted file
|
||||
if let FileStatus::Opened((p, _)) = check_dir_and_open("edit_whole").unwrap() {
|
||||
let mut f = File::create(p).unwrap();
|
||||
write!(f, "badly formatter yaml").unwrap();
|
||||
|
||||
assert!(edit_whole_snippet(false_cli!("-E", "edit_whole")).is_err());
|
||||
assert!(edit_whole_snippet(false_cli!("snp", "-E", "edit_whole")).is_err());
|
||||
assert!(matches!(
|
||||
check_dir_and_open("edit_whole.bad").unwrap(),
|
||||
FileStatus::Opened(_)
|
||||
|
|
@ -401,7 +415,7 @@ pub mod test {
|
|||
_ = std::fs::remove_file(&oldpath);
|
||||
_ = std::fs::remove_file(&newpath);
|
||||
_ = std::fs::remove_file(filledpath);
|
||||
assert!(create_snippet(false_cli!("-c", "rename_snippet", "-f")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "rename_snippet", "-f")).is_ok());
|
||||
assert!(
|
||||
rename_snippet(false_cli!("snp", "-r", "renamed_snippet", "rename_snippet")).is_ok()
|
||||
);
|
||||
|
|
@ -411,8 +425,8 @@ pub mod test {
|
|||
|
||||
assert!(rename_snippet(false_cli!("snp", "-r", "non_ex", "non_ex")).is_ok());
|
||||
assert!(rename_snippet(false_cli!("snp", "-r", "non_ex", "renamed_snippet")).is_err());
|
||||
assert!(create_snippet(false_cli!("-c", "filled_destination", "-f")).is_ok());
|
||||
assert!(create_snippet(false_cli!("-c", "rename_snippet", "-f")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "filled_destination", "-f")).is_ok());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "rename_snippet", "-f")).is_ok());
|
||||
assert!(matches!(
|
||||
rename_snippet(false_cli!(
|
||||
"snp",
|
||||
|
|
@ -450,8 +464,8 @@ pub mod test {
|
|||
println!("Trying to resave without destination {:?}", res);
|
||||
assert!(res.is_ok());
|
||||
|
||||
assert!(create_snippet(false_cli!("-c", "new_snippet")).is_err());
|
||||
assert!(create_snippet(false_cli!("-c", "resave_snippet")).is_err());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "new_snippet")).is_err());
|
||||
assert!(create_snippet(false_cli!("snp", "-c", "resave_snippet")).is_err());
|
||||
|
||||
let res = edit_whole_snippet(false_cli!("snp", "resave_snippet", "-f"));
|
||||
println!("Sucessfully erasing {:?}", res);
|
||||
|
|
@ -459,6 +473,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
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Reference in New Issue