Compare commits

...

19 Commits
1.0.2 ... main

Author SHA1 Message Date
Dandaedre af8d8bba37 Merge pull request 'develop' (#7) from develop into main
Reviewed-on: Dandaedre/snp#7
2023-05-25 20:26:50 +02:00
Dandaedre ba6dd6f70a v1.0.6 2023-05-25 20:26:16 +02:00
Dandaedre 63365ee5dc Added examples 2023-05-25 20:24:59 +02:00
beffroi f62ac2fe34 Adds an extra line on the example message 2023-05-25 16:58:32 +02:00
Dandaedre 86f5226c19 Tests passing and bump version 2023-05-24 20:10:01 +02:00
Dandaedre d2f767abc8 Corrects several windows bugs and bad names 2023-05-24 20:08:01 +02:00
beffroi 88c0506f6a Updates the todo 2023-05-24 16:11:18 +02:00
beffroi cb2c711129 Adds ore messages 2023-05-24 15:19:49 +02:00
beffroi 2c48bbd4e7 Corrects bugs on no args and doc not showing fully 2023-05-24 11:56:42 +02:00
Dandaedre 628b25f00d Merge pull request '1.0.4' (#6) from develop into main
Reviewed-on: Dandaedre/snp#6
2023-05-23 21:18:02 +02:00
Dandaedre 5cd297b1da Updates coverage and version 2023-05-23 21:11:55 +02:00
Dandaedre 9efba43112 Makes -l as an alternative to <snippet>. Also changes <name> to optionnal and mandatory 2023-05-23 21:08:40 +02:00
Dandaedre 3c7f672a55 Adds a little eye candy for the paths and listing 2023-05-23 19:04:04 +02:00
Dandaedre c4185e848a Adds a lot of cosmetic improvement and --list 2023-05-23 18:56:37 +02:00
Dandaedre 1ed8e65de7 Corrects the save/replace error when dest was taken 2023-05-23 18:03:10 +02:00
Dandaedre 98580f3a7f Updates readme 2023-05-23 17:31:17 +02:00
Dandaedre 4d5b3d567c Merge pull request 'Updating to 1.0.2' (#3) from develop into main
Reviewed-on: Dandaedre/snp#3
2023-05-23 05:26:32 +02:00
Dandaedre de6a5182a1 Merge pull request 'feature_rename' (#2) from feature_rename into develop
Reviewed-on: Dandaedre/snp#2
2023-05-23 05:21:35 +02:00
Dandaedre a259c52c2a Merge pull request 'edition_and_parse' (#1) from edition_and_parse into main
Reviewed-on: Dandaedre/snp#1
2023-05-23 00:08:35 +02:00
6 changed files with 288 additions and 167 deletions

View File

@ -1,7 +1,7 @@
[package]
name = "snp"
authors = ["Dandaedre"]
version = "1.0.1"
version = "1.0.6"
edition = "2021"
[features]

37
TODO.md
View File

@ -1,38 +1,23 @@
## TODO
[ ] Benchmarks
[ ] Better use of file modes
[ ] Document non coverage
[ ] Find a solution for the .badpocalypse
[ ] Edit args only
[ ] Case sensitivity windows
[ ] Use Ok for results instead of prints
[ ] Use priority instead of a cursed match statement
[ ] Have a method to get name, path and all with a custom error on unwrap
### Currently working on
[ ] Have an actual human give feedback on the error name readability
## 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)
[*] Add some examples with --example
## Posponed or rendered useless
[x] Chain the methods when possible with result ?
[ ] Make a lib for dynamic_format and snippets (impl make a trait for have .id() and other future t)
[ ] Change all uncatchables errors to expect to be more helpful or change them to better errors
[ ] Document non coverage
[ ] Correct the newline problem (with toml ?)
[*] Error: Delete, unclear ?

View File

@ -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,10 @@ pub enum Actions {
Delete,
/// Renames the snippet
Rename,
/// Find a snippet matching a name/regex
Find,
/// Create an example snippet
Example,
}
/// The main worker, execute all commands given as Args
@ -30,18 +32,21 @@ 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),
Actions::Example => wrapper_functions::create_example(&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);
}
// 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 +58,26 @@ 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,
cli.example,
) {
(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, false) => actions.push(Actions::Find),
(_, false, false, true, false, _, false, false) => actions.push(Actions::EditAll),
(_, true, _, true, false, _, false, false) => actions.push(Actions::EditAll),
(_, true, false, false, false, _, false, false) => actions.push(Actions::Create),
(_, false, true, _, false, _, false, false) => actions.push(Actions::Edit),
(_, true, true, false, false, _, false, false) => actions.push(Actions::Edit),
(false, false, false, false, false, None, false, false) => actions.push(Actions::Show),
(_, _, _, _, true, _, false, false) => actions.push(Actions::Delete),
(_, _, _, _, _, Some(_), false, false) => actions.push(Actions::Rename),
(_, _, _, _, _, _, true, false) => actions.push(Actions::List),
(_, _, _, _, _, _, _, true) => actions.push(Actions::Example),
}
actions
}
@ -90,18 +99,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 +122,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 +142,10 @@ mod test {
false_cli!("snp", "name", "-c", "-r", "new_name", "-f"),
vec![Actions::Create]
),
(false_cli!("snp", "-l"), vec![Actions::List]),
(false_cli!("snp", "--example"), vec![Actions::Example]),
(false_cli!("snp"), vec![Actions::Show]), // It's an acceptable error
// (false_cli!("snp", "-l"), vec![Actions::List]),
);
for (cli, res) in group.iter() {
println!("Testing {:?}..actions expected {:?}", cli, res);
@ -140,8 +154,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 +167,13 @@ 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"),
false_cli!("snp"),
false_cli!("snp", "--example"),
];
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"),
];

View File

@ -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),
}
}
}

View File

@ -11,46 +11,68 @@ 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
/// directly start editing it, then use"snp snippet_name" 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 {}
/// -
/// You can get a working example with --example witch will guide you
/// through all the basic steps for snippet creation and edition
#[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-all",
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")]
/// The list of arguments to give to the snippet or the snippet creator
#[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,
/// Create an example snippet named example with some basic documentation
#[arg(long, default_value_t = false, group = "mutex")]
example: bool,
}
/// Main entry point, everything is defered for testing and coverage
@ -58,3 +80,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();
}
}

View File

@ -3,11 +3,12 @@
//! All functions included should either take a Cli object and return a SnippetError
//! or be a helper function for such a function
use clap::CommandFactory;
#[allow(unused)] // Mandatory because of how test and rust-analyser work
use edit::edit;
use std::fs::create_dir_all;
use std::io::{read_to_string, Write};
use std::fs::{self, create_dir_all};
use std::io::{self, read_to_string, Write};
use std::{env, fs::File, path::PathBuf};
use crate::errors::SnippetError;
@ -18,10 +19,14 @@ 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());
println!(
"The snippet {} is located at \"{}\"",
cli.snippet.as_ref().unwrap(),
p.as_os_str().to_str().unwrap()
);
Ok(())
}
FileStatus::NotFound(p) => Err(SnippetError::NotFoundNoRetryError(p)),
@ -31,8 +36,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 {
@ -46,7 +55,10 @@ pub fn create_snippet(cli: &Cli) -> Result<(), SnippetError> {
FileStatus::NotFound(p) => (File::create(&p)?, p), // Create a new snippet
};
snp.save_in(&f)?;
println!("The snippet {:?} was created successfully", p);
println!(
"The snippet {} was created successfully",
p.as_os_str().to_str().unwrap()
);
Ok(())
}
@ -54,10 +66,11 @@ 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() {
println!("The original and new snippet name are the same, skipping...");
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 +96,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 +105,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,
)
@ -113,8 +131,8 @@ pub fn edit_snippet(cli: &Cli) -> Result<(), SnippetError> {
snp.write_over(&p)?;
println!(
"The snippet {:?} was succesfully saved",
p.file_name().unwrap()
"The snippet {} was succesfully saved",
p.file_name().unwrap().to_str().unwrap()
);
Ok(())
}
@ -124,13 +142,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 +164,87 @@ 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()
"The snippet {} was succesfully saved",
origin_p.file_name().unwrap().to_str().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.into_os_string().to_str().unwrap()
);
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()
"The snippet was saved under {} in your config",
origin_p.file_name().unwrap().to_str().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)? {
// Try to load the snippet <name>i
if cli.snippet.is_none() {
// This wonky hack exists because of subcommands
// It could also be checked when populating, but is way easier this
#[cfg(not(feature = "test"))]
Cli::command().print_long_help()?;
return Ok(());
}
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)),
};
@ -227,15 +257,63 @@ pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> {
// Print the snippet
let f_str = dynamic_formatter::dynamic_format(&snp.content, final_args)?;
println!("{}", f_str);
print!("{}", f_str);
io::stdout().flush()?;
Ok(())
}
/// 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));
std::fs::remove_file(path)?;
path.push(format!("{}.yaml", cli.snippet.as_ref().unwrap()));
std::fs::remove_file(&path)?;
println!(
"The snippet \"{}\" was successfully deleted.",
// path.file_name().unwrap().to_str().unwrap()
cli.snippet.as_ref().unwrap()
);
Ok(())
}
/// Create an example snippet with a small guide and the next step printed out
pub fn create_example(_cli: &Cli) -> Result<(), SnippetError> {
let mut path = config_folder()?;
path.push("unique_example.yaml");
println!(
"The snippet unique_example was created. You can use the following command to launch an editor and begin editing the content of the example:
$ snp unique_example -e
Note that only the content of the text is editable in this mode, to edit the whole snippet use:
$ snp unique_example -E
Once you are done with the editing, you can try using the snippet with:
$ snp unique_example
or
$ snp unique_example random parameters separated by spaces
If you wish to delete the snippet, you can use the following command:
$ snp -d unique_example"
);
let arguments = vec!["Argument 1", "Argument 2", "Foo", "Bar"];
let text = "This is a snippet created as an example.
You can type several lines of code to help you in your daily coding process.
This snippet manager accepts either {} as a argument placeholder
and will fill it with every subsequent argument provided.
You can also write {0}, {3}, etc. to use a specific argument
instead of using them in order.
To edit only this text and not the whole code, you can use
`snp unique_example -e` and to edit all parameters
(name, default arguments and content) use -E or --edit-all.
Please consult the --help for the full list of commands !";
let snp = Snippet::new(
"unique_example".to_string(),
arguments.iter().map(|s| s.to_string()).collect(),
text.to_string(),
);
_ = std::fs::remove_file(&path);
let f = File::create(path)?;
snp.save_in(&f)?;
Ok(())
}
/// The status of the request after the path was attempted to be opened
@ -309,6 +387,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 +395,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 +414,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 +482,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 +492,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 +531,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 +540,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
}
}