snapbox 1.2.0

Snapshot testing toolbox
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

/// Describes the structure of [`Data`][crate::Data]
#[derive(Clone, Debug, PartialEq, Eq, Copy, Hash, Default)]
#[non_exhaustive]
pub enum DataFormat {
    /// Processing of the [`Data`][crate::Data] failed
    Error,
    /// Non-textual, opaque data
    Binary,
    #[default]
    Text,
    #[cfg(feature = "json")]
    Json,
    /// Streamed JSON output according to <https://jsonlines.org/>
    #[cfg(feature = "json")]
    JsonLines,
    /// [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#DOS_and_Windows)
    /// rendered as [svg](https://docs.rs/anstyle-svg)
    #[cfg(feature = "term-svg")]
    TermSvg,
}

impl DataFormat {
    /// Assumed file extension for the format
    pub fn ext(self) -> &'static str {
        match self {
            Self::Error => "txt",
            Self::Binary => "bin",
            Self::Text => "txt",
            #[cfg(feature = "json")]
            Self::Json => "json",
            #[cfg(feature = "json")]
            Self::JsonLines => "jsonl",
            #[cfg(feature = "term-svg")]
            Self::TermSvg => "term.svg",
        }
    }
}

impl From<&std::path::Path> for DataFormat {
    fn from(path: &std::path::Path) -> Self {
        let file_name = path
            .file_name()
            .and_then(|e| e.to_str())
            .unwrap_or_default();
        let mut ext = file_name.strip_prefix('.').unwrap_or(file_name);
        while let Some((_, new_ext)) = ext.split_once('.') {
            ext = new_ext;
            match ext {
                #[cfg(feature = "json")]
                "json" => {
                    return DataFormat::Json;
                }
                #[cfg(feature = "json")]
                "jsonl" => {
                    return DataFormat::JsonLines;
                }
                #[cfg(feature = "term-svg")]
                "term.svg" => {
                    return Self::TermSvg;
                }
                _ => {}
            }
        }
        DataFormat::Text
    }
}

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

    #[test]
    fn combos() {
        #[cfg(feature = "json")]
        let json = DataFormat::Json;
        #[cfg(not(feature = "json"))]
        let json = DataFormat::Text;
        #[cfg(feature = "json")]
        let jsonl = DataFormat::JsonLines;
        #[cfg(not(feature = "json"))]
        let jsonl = DataFormat::Text;
        #[cfg(feature = "term-svg")]
        let term_svg = DataFormat::TermSvg;
        #[cfg(not(feature = "term-svg"))]
        let term_svg = DataFormat::Text;
        let cases = [
            ("foo", DataFormat::Text),
            (".foo", DataFormat::Text),
            ("foo.txt", DataFormat::Text),
            (".foo.txt", DataFormat::Text),
            ("foo.stdout.txt", DataFormat::Text),
            ("foo.json", json),
            ("foo.stdout.json", json),
            (".foo.json", json),
            ("foo.jsonl", jsonl),
            ("foo.stdout.jsonl", jsonl),
            (".foo.jsonl", jsonl),
            ("foo.term.svg", term_svg),
            ("foo.stdout.term.svg", term_svg),
            (".foo.term.svg", term_svg),
        ];
        for (input, output) in cases {
            let input = std::path::Path::new(input);
            assert_eq!(DataFormat::from(input), output, "for `{}`", input.display());
        }
    }
}