keyset 0.2.0

A Rust tool to create pretty keyset layout diagrams using correct fonts and icons.
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use std::fmt;

use crate::kle::InvalidKleLayout;

#[derive(Debug)]
pub struct Error {
    inner: Box<ErrorImpl>,
}

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug)]
pub(crate) enum ErrorImpl {
    JsonParseError(serde_json::Error),
    TomlParseError(toml::de::Error),
    FontParseError(ttf_parser::FaceParsingError),
    InvalidKleLayout(InvalidKleLayout),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &*self.inner {
            ErrorImpl::JsonParseError(error) => write!(f, "error parsing JSON: {error}"),
            ErrorImpl::TomlParseError(error) => write!(f, "error parsing TOML: {error}"),
            ErrorImpl::FontParseError(error) => write!(f, "error parsing font: {error}"),
            ErrorImpl::InvalidKleLayout(error) => write!(f, "error parsing KLE layout: {error}"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &*self.inner {
            ErrorImpl::JsonParseError(error) => Some(error),
            ErrorImpl::TomlParseError(error) => Some(error),
            ErrorImpl::FontParseError(error) => Some(error),
            ErrorImpl::InvalidKleLayout(_) => None,
        }
    }
}

impl From<serde_json::Error> for Error {
    fn from(error: serde_json::Error) -> Self {
        Self {
            inner: Box::new(ErrorImpl::JsonParseError(error)),
        }
    }
}

impl From<toml::de::Error> for Error {
    fn from(error: toml::de::Error) -> Self {
        Self {
            inner: Box::new(ErrorImpl::TomlParseError(error)),
        }
    }
}

impl From<ttf_parser::FaceParsingError> for Error {
    fn from(error: ttf_parser::FaceParsingError) -> Self {
        Self {
            inner: Box::new(ErrorImpl::FontParseError(error)),
        }
    }
}

impl From<InvalidKleLayout> for Error {
    fn from(error: InvalidKleLayout) -> Self {
        Self {
            inner: Box::new(ErrorImpl::InvalidKleLayout(error)),
        }
    }
}

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

    use unindent::unindent;

    use crate::kle;

    fn json_parse_error() -> Error {
        serde_json::from_str::<serde_json::Value>("invalid")
            .unwrap_err()
            .into()
    }

    fn toml_parse_error() -> Error {
        toml::from_str::<toml::Value>("invalid").unwrap_err().into()
    }

    fn font_parse_error() -> Error {
        ttf_parser::Face::parse(b"invalid", 0).unwrap_err().into()
    }

    fn invalid_key_size() -> Error {
        let kle = r#"[[{"w": 1, "h": 1, "x2": 1, "y2": 1, "w2": 1, "h2": 1}, "A"]]"#;
        kle::from_json(kle).unwrap_err()
    }

    #[test]
    fn test_display_error() {
        let config = vec![
            (
                json_parse_error(),
                "error parsing JSON: expected value at line 1 column 1".to_owned(),
            ),
            (
                toml_parse_error(),
                unindent(
                    r#"error parsing TOML: TOML parse error at line 1, column 8
                      |
                    1 | invalid
                      |        ^
                    expected `.`, `=`
                    "#,
                ),
            ),
            (
                font_parse_error(),
                "error parsing font: unknown magic".to_owned(),
            ),
            (
                invalid_key_size(),
                "error parsing KLE layout: Unsupported non-standard key size \
                (w: 1.00, h: 1.00, x2: 1.00, y2: 1.00, w2: 1.00, h2: 1.00). \
                Note only ISO enter and stepped caps are supported as special cases"
                    .to_owned(),
            ),
        ];

        for (err, fmt) in config {
            assert_eq!(format!("{err}"), fmt);
        }
    }

    #[test]
    fn test_error_source() {
        use std::error::Error;

        let config = vec![
            (json_parse_error(), true),
            (toml_parse_error(), true),
            (font_parse_error(), true),
            (invalid_key_size(), false),
        ];

        for (err, has_source) in config {
            assert_eq!(err.source().is_some(), has_source);
        }
    }
}