rusty-detox 0.1.0

Sanitize messy filenames — a Rust port of Doug Harple's `detox(1)` with the filter pipeline (uncgi, iso8859_1, utf_8, safe, wipeup, max_length), `detoxrc` config grammar, recursive collision-safe batch rename, EXDEV cross-device fallback, and a typed library API.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! US1 (Default sanitization + dry-run preview) integration tests.

mod common;

use std::fs;
use tempfile::TempDir;

#[test]
fn dry_run_emits_arrow_separated_line() {
    let dir = TempDir::new().unwrap();
    let src = dir.path().join("hello world.txt");
    fs::write(&src, b"x").unwrap();

    let assert = common::rusty_detox_cmd()
        .arg("-n")
        .arg(&src)
        .assert()
        .success();

    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(
        stdout.contains("hello world.txt")
            && stdout.contains("hello_world.txt")
            && stdout.contains(" -> "),
        "stdout was: {stdout:?}"
    );

    // File on disk is unchanged.
    assert!(src.exists(), "dry-run must not rename");
}

#[test]
fn verbose_no_dry_run_renames_and_prints() {
    let dir = TempDir::new().unwrap();
    let src = dir.path().join("hello world.txt");
    let tgt = dir.path().join("hello_world.txt");
    fs::write(&src, b"x").unwrap();

    let assert = common::rusty_detox_cmd()
        .arg("-v")
        .arg(&src)
        .assert()
        .success();

    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(stdout.contains(" -> "), "verbose stdout: {stdout:?}");
    assert!(!src.exists(), "source should be renamed");
    assert!(tgt.exists(), "target should exist");
}

#[test]
fn clean_filename_silent() {
    let dir = TempDir::new().unwrap();
    let src = dir.path().join("clean_already.txt");
    fs::write(&src, b"x").unwrap();

    let assert = common::rusty_detox_cmd()
        .arg("-n")
        .arg(&src)
        .assert()
        .success();
    let stdout = assert.get_output().stdout.clone();
    assert!(stdout.is_empty(), "clean name produces no output");
}

#[test]
fn empty_argv_usage_error() {
    common::rusty_detox_cmd().assert().failure();
}

#[test]
fn utf8_sequence_french_resume_dry_run() {
    let dir = TempDir::new().unwrap();
    let src = dir.path().join("Résumé.pdf");
    fs::write(&src, b"x").unwrap();

    let assert = common::rusty_detox_cmd()
        .arg("-n")
        .arg("-s")
        .arg("utf_8")
        .arg(&src)
        .assert()
        .success();

    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(
        stdout.contains("Resume.pdf"),
        "utf_8 stdout should contain transliterated target; got: {stdout:?}"
    );
}

#[test]
fn list_sequences_prints_all_three() {
    let assert = common::rusty_detox_cmd().arg("-L").assert().success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(stdout.contains("default"));
    assert!(stdout.contains("iso8859_1"));
    assert!(stdout.contains("utf_8"));
}

#[test]
fn unknown_sequence_errors() {
    let dir = TempDir::new().unwrap();
    let src = dir.path().join("foo.txt");
    fs::write(&src, b"x").unwrap();

    common::rusty_detox_cmd()
        .arg("-s")
        .arg("nosuchsequence")
        .arg(&src)
        .assert()
        .failure();
}

#[test]
fn version_flag_prints_version() {
    let assert = common::rusty_detox_cmd()
        .arg("--version")
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(stdout.contains("rusty-detox"), "got: {stdout:?}");
}