qesp 0.2.4

Tool to remove annoying characters of names in a directory.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use regex::Regex;
use std::borrow::Cow;
use std::error::Error;
use std::fs;
use std::path::Path;
use structopt::StructOpt;

fn parse_re(src: &str) -> Result<Regex, regex::Error> {
    Regex::new(src)
}

/// Remove annoying characters of names in a directory.
#[derive(StructOpt, Debug)]
#[structopt(name = "qesp")]
pub struct Config {
    /// Target directory
    #[structopt(default_value = ".")]
    pub dir: String,
    /// recursively attempts to rename whole directory tree
    #[structopt(long = "recursive", short = "r")]
    pub recursive: bool,
    /// regex annoying characters to be removed
    #[structopt(default_value = "[ ()]", long = "pattern", short = "p", parse(try_from_str = parse_re))]
    pub pattern: Regex,
}

/// Trim annoying characters from a string
fn trim<'a>(from: &'a str, pat: &Regex) -> Cow<'a, str> {
    pat.replace_all(from, "")
}

/// Process arguments and call qesp
///
/// # Examples
/// ```
/// use qesp::{Config, run};
/// use regex::Regex;
/// # use std::fs;
/// # use std::path::Path;
///
/// # fs::create_dir(Path::new("annoying name for dir(very annoying)")).unwrap();
/// let recursive = false;
/// let dir = String::from(".");
/// let pattern = Regex::new("[ ()]").unwrap();
/// run(Config {
///     dir,
///     recursive,
///     pattern,
/// })
/// .unwrap();
/// # assert!(Path::new("annoyingnamefordirveryannoying").is_dir());
/// # fs::remove_dir("annoyingnamefordirveryannoying").unwrap();
/// ```
pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    qesp(config.dir, config.recursive, &config.pattern)
}

/// Trim annoying characters of filenames in a directory.
fn qesp(dir: String, recursive: bool, pattern: &Regex) -> Result<(), Box<dyn Error>> {
    let target = fs::read_dir(dir)?;

    for file in target {
        let file = file?;
        let from = String::from(file.path().to_str().unwrap());
        let path = &*trim(&from, pattern);
        fs::rename(&from, path)?;
        if Path::new(path).is_dir() & recursive {
            let dir = String::from(path);
            qesp(dir, recursive, pattern)?;
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn trim_a_line() {
        let line = "annoying name for dir(very annoying)";
        let to = trim(line, &Regex::new("[ ()]").unwrap());
        assert_eq!("annoyingnamefordirveryannoying", to)
    }
}