caesura 0.31.0

An all-in-one command line tool to transcode FLAC audio files and upload to gazelle based indexers/trackers
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

use crate::prelude::*;
use std::fs::canonicalize;

/// Options for the `audit` command.
#[derive(Options, Clone, Debug, Deserialize, Serialize)]
pub struct AuditArgs {
    /// A tracker torrent id, a single `.torrent` file, or a directory of `.torrent` files.
    ///
    /// Examples:
    /// - `12345`
    /// - `/srv/qBittorrent/BT_backup`
    /// - `path/to/file.torrent`
    #[arg(value_name = "PATH | ID")]
    #[options(required)]
    pub audit_arg: String,
}

/// Input to the `audit` command.
pub enum AuditMode {
    /// A tracker torrent id to download and audit.
    Id(u32),
    /// A torrent file path.
    File(PathBuf),
    /// A directory path.
    Directory(PathBuf),
}

impl AuditArgs {
    /// Classify [`AuditArgs::input`] as a [`AuditMode`]
    pub fn to_mode(&self) -> Result<AuditMode, OptionIssue> {
        if let Ok(id) = self.audit_arg.parse::<u32>() {
            return Ok(AuditMode::Id(id));
        }
        let path = PathBuf::from(&self.audit_arg);
        if !path.exists() {
            return Err(OptionIssue::path_not_found("audit_arg", &path));
        }
        let path = canonicalize(path).expect("should be able to canonicalize path");
        if path.is_file() {
            Ok(AuditMode::File(path))
        } else if path.is_dir() {
            Ok(AuditMode::Directory(path))
        } else {
            Err(OptionIssue::path_not_found("audit_arg", &path))
        }
    }
}

impl OptionsContract for AuditArgs {
    type Partial = AuditArgsPartial;

    fn validate(&self, validator: &mut OptionsValidator) {
        if let Err(issue) = self.to_mode() {
            validator.push(issue);
        }
    }
}

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

    #[test]
    fn audit_args_to_mode_id() {
        let args = AuditArgs {
            audit_arg: "12345".to_owned(),
        };
        assert!(matches!(args.to_mode(), Ok(AuditMode::Id(12345))));
    }

    /// An existing file path resolves to [`AuditMode::File`].
    #[test]
    fn audit_args_to_mode_file() {
        // Arrange
        let dir = TempDirectory::create("audit_args_to_mode_file");
        let file = dir.join("file.torrent");
        write(&file, b"data").expect("write file");
        let args = AuditArgs {
            audit_arg: file.to_string_lossy().into_owned(),
        };
        // Act
        let mode = args.to_mode();
        // Assert
        assert!(matches!(mode, Ok(AuditMode::File(_))));
    }

    /// An existing directory path resolves to [`AuditMode::Directory`].
    #[test]
    fn audit_args_to_mode_directory() {
        // Arrange
        let dir = TempDirectory::create("audit_args_to_mode_directory");
        let args = AuditArgs {
            audit_arg: dir.to_string_lossy().into_owned(),
        };
        // Act
        let mode = args.to_mode();
        // Assert
        assert!(matches!(mode, Ok(AuditMode::Directory(_))));
    }

    /// A numeric id skips the path-exists check even though no such file exists.
    #[test]
    fn audit_args_validate_id() {
        let args = AuditArgs {
            audit_arg: "12345".to_owned(),
        };
        let mut validator = OptionsValidator::new();
        args.validate(&mut validator);
        assert!(validator.into_issues().is_empty());
    }

    /// A non-numeric input pointing at a missing path reports one issue.
    #[test]
    fn audit_args_validate_path() {
        let args = AuditArgs {
            audit_arg: "/no/such/path/at/all".to_owned(),
        };
        let mut validator = OptionsValidator::new();
        args.validate(&mut validator);
        let issues = validator.into_issues();
        assert_eq!(issues.len(), 1);
    }
}