aspero 0.1.0

Find, resolve and verify scholarly literature from the command line
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

//! Exit codes: one per [`ErrorCategory`], documented in `--help`.

use std::process::ExitCode;

use aspero_core::ErrorCategory;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum Exit {
    Ok = 0,
    Internal = 1,
    Usage = 2,
    NotFound = 3,
    Unavailable = 4,
    Throttled = 5,
    Auth = 6,
    Unsupported = 7,
    Protocol = 8,
    /// A citation doesn't check out: mismatched identifier, or only a
    /// partial match.
    Unverified = 9,
}

impl Exit {
    pub fn from_category(category: ErrorCategory) -> Exit {
        match category {
            ErrorCategory::Unavailable => Exit::Unavailable,
            ErrorCategory::Throttled => Exit::Throttled,
            ErrorCategory::Auth => Exit::Auth,
            ErrorCategory::NotFound => Exit::NotFound,
            ErrorCategory::Usage => Exit::Usage,
            ErrorCategory::Unsupported => Exit::Unsupported,
            ErrorCategory::Protocol => Exit::Protocol,
            _ => Exit::Internal,
        }
    }

    /// The more severe of two outcomes, for commands with several results.
    /// Problems the caller can act on (usage, credentials, budget) outrank
    /// "not found".
    pub fn worst(self, other: Exit) -> Exit {
        let rank = |e: Exit| match e {
            Exit::Ok => 0,
            Exit::NotFound => 1,
            Exit::Unverified => 2,
            Exit::Unsupported => 3,
            Exit::Unavailable | Exit::Protocol | Exit::Internal => 4,
            Exit::Throttled => 5,
            Exit::Auth => 6,
            Exit::Usage => 7,
        };
        if rank(other) > rank(self) {
            other
        } else {
            self
        }
    }

    pub fn code(self) -> ExitCode {
        ExitCode::from(self as u8)
    }
}

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

    #[test]
    fn worst_prefers_actionable_problems() {
        assert_eq!(Exit::Ok.worst(Exit::NotFound), Exit::NotFound);
        assert_eq!(Exit::NotFound.worst(Exit::Throttled), Exit::Throttled);
        assert_eq!(Exit::Usage.worst(Exit::Unavailable), Exit::Usage);
    }
}