nils-markdown 1.0.7

Shared Tera-backed Markdown template layer for the nils-cli workspace.
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

use thiserror::Error;

#[derive(Debug, Error)]
pub enum RenderError {
    #[error("template parse failed for `{name}`: {source}")]
    TemplateParse {
        name: String,
        #[source]
        source: tera::Error,
    },

    #[error("template not registered: `{name}`")]
    MissingTemplate { name: String },

    #[error(
        "template `{name}` references the non-deterministic `now()` function; \
         nils-markdown rejects templates that depend on wall-clock time"
    )]
    NonDeterministicTemplate { name: String },

    #[error("view serialization failed: {source}")]
    Serialize {
        #[source]
        source: serde_json::Error,
    },

    #[error("tera render failed for `{name}`: {source}")]
    Render {
        name: String,
        #[source]
        source: tera::Error,
    },
}

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

    fn assert_send_sync_static<T: Send + Sync + 'static>() {}

    #[test]
    fn render_error_is_send_sync_static() {
        assert_send_sync_static::<RenderError>();
    }

    #[test]
    fn render_error_round_trips_through_anyhow() {
        let err = RenderError::MissingTemplate {
            name: "issue_body".into(),
        };
        let any: anyhow::Error = err.into();
        let printed = format!("{any}");
        assert!(printed.contains("issue_body"), "{printed}");
    }

    #[test]
    fn template_parse_error_renders_name_and_source() {
        let tera_err = tera::Error::msg("syntax error at line 3");
        let err = RenderError::TemplateParse {
            name: "dashboard".into(),
            source: tera_err,
        };
        let printed = format!("{err}");
        assert!(printed.contains("dashboard"), "{printed}");
        assert!(printed.contains("syntax error"), "{printed}");
    }

    #[test]
    fn missing_template_renders_name() {
        let err = RenderError::MissingTemplate {
            name: "absent".into(),
        };
        assert_eq!(format!("{err}"), "template not registered: `absent`");
    }

    #[test]
    fn non_deterministic_template_renders_name() {
        let err = RenderError::NonDeterministicTemplate {
            name: "time_based".into(),
        };
        let printed = format!("{err}");
        assert!(printed.contains("time_based"), "{printed}");
        assert!(printed.contains("non-deterministic"), "{printed}");
    }

    #[test]
    fn serialize_error_renders_source() {
        let source =
            serde_json::from_str::<serde_json::Value>("{ not json").expect_err("invalid json");
        let err = RenderError::Serialize { source };
        let printed = format!("{err}");
        assert!(
            printed.starts_with("view serialization failed"),
            "{printed}"
        );
    }

    #[test]
    fn render_runtime_error_renders_name() {
        let err = RenderError::Render {
            name: "lifecycle".into(),
            source: tera::Error::msg("missing variable"),
        };
        let printed = format!("{err}");
        assert!(printed.contains("lifecycle"), "{printed}");
        assert!(printed.contains("missing variable"), "{printed}");
    }
}