tide-handlebars 0.5.0

A crate to simplify working with Tide and Handlebars
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

//! # Tide-Handlebars integration This crate exposes [an extension
//! trait](TideHandlebarsExt) that adds two methods to [`handlebars::Handlebars`]:
//! [`render_response`](TideHandlebarsExt::render_response) and
//! [`render_body`](TideHandlebarsExt::render_body).
//! [`Handlebars`](handlebars::Handlebars)s.
use handlebars::Handlebars;
use serde::Serialize;
use std::path::PathBuf;
use tide::{http::Mime, Body, Response, Result};

/// This extension trait adds two methods to [`handlebars::Handlebars`]:
/// [`render_response`](TideHandlebarsExt::render_response) and
/// [`render_body`](TideHandlebarsExt::render_body)
pub trait TideHandlebarsExt {
    /// `render_body` returns a fully-rendered [`tide::Body`] with mime
    /// type set based on the template name file extension using the
    /// logic at [`tide::http::Mime::from_extension`]. This will
    /// return an `Err` variant if the render was unsuccessful.
    ///
    /// ```rust
    /// use handlebars::Handlebars;
    /// use tide_handlebars::prelude::*;
    /// use std::collections::BTreeMap;
    /// let mut handlebars = Handlebars::new();
    ///     handlebars
    ///     .register_template_file("simple.html", "./tests/templates/simple.html")
    ///     .unwrap();
    ///
    /// let mut data0 = BTreeMap::new();
    /// data0.insert("title".to_string(), "hello tide!".to_string());
    /// let mut body = handlebars.render_body("simple.html", &data0).unwrap();
    /// assert_eq!(body.mime(), &tide::http::mime::HTML);
    ///```
    fn render_body<T>(&self, template_name: &str, context: &T) -> Result<Body>
    where
        T: Serialize;
    /// `render_body_ext` returns a fully-rendered [`tide::Body`] with mime
    /// type set based on the extension using the
    /// logic at [`tide::http::Mime::from_extension`]. This will
    /// return an `Err` variant if the render was unsuccessful.
    ///
    /// ```rust
    /// use handlebars::Handlebars;
    /// use tide_handlebars::prelude::*;
    /// use std::collections::BTreeMap;
    /// let mut handlebars = Handlebars::new();
    ///     handlebars
    ///     .register_template_file("simple.hbs", "./tests/templates/simple.hbs")
    ///     .unwrap();
    ///
    /// let mut data0 = BTreeMap::new();
    /// data0.insert("title".to_string(), "hello tide!".to_string());
    /// let mut body = handlebars.render_body_ext("simple.hbs", &data0, "html").unwrap();
    /// assert_eq!(body.mime(), &tide::http::mime::HTML);
    ///```
    fn render_body_ext<T>(&self, template_name: &str, context: &T, extension: &str) -> Result<Body>
    where
        T: Serialize;
    /// `render_response` returns a tide Response with a body rendered
    /// with [`render_body`](TideHandlebarsExt::render_body). This will
    /// return an `Err` variant if the render was unsuccessful.
    ///
    /// ```rust
    /// use handlebars::Handlebars;
    /// use tide_handlebars::prelude::*;
    /// use std::collections::BTreeMap;
    /// let mut handlebars = Handlebars::new();
    /// handlebars
    ///     .register_template_file("simple.html", "./tests/templates/simple.html")
    ///     .unwrap();
    /// let mut data0 = BTreeMap::new();
    /// data0.insert("title".to_string(), "hello tide!".to_string());
    /// let mut response = handlebars.render_response("simple.html", &data0).unwrap();
    /// assert_eq!(response.content_type(), Some(tide::http::mime::HTML));
    ///```
    fn render_response<T>(&self, template_name: &str, context: &T) -> Result
    where
        T: Serialize;
    /// `render_response_ext` returns a tide Response with a body rendered
    /// with [`render_body`](TideHandlebarsExt::render_body). This will
    /// return an `Err` variant if the render was unsuccessful.
    ///
    /// ```rust
    /// use handlebars::Handlebars;
    /// use tide_handlebars::prelude::*;
    /// use std::collections::BTreeMap;
    /// let mut handlebars = Handlebars::new();
    /// handlebars
    ///     .register_template_file("simple.hbs", "./tests/templates/simple.hbs")
    ///     .unwrap();
    /// let mut data0 = BTreeMap::new();
    /// data0.insert("title".to_string(), "hello tide!".to_string());
    /// let mut response = handlebars.render_response_ext("simple.hbs", &data0, "html").unwrap();
    /// assert_eq!(response.content_type(), Some(tide::http::mime::HTML));
    ///```
    fn render_response_ext<T>(&self, template_name: &str, context: &T, extension: &str) -> Result
    where
        T: Serialize;
}

impl TideHandlebarsExt for Handlebars<'_> {
    fn render_body_ext<T>(&self, template_name: &str, context: &T, extension: &str) -> Result<Body>
    where
        T: Serialize,
    {
        let string = self.render(template_name, context)?;
        let mut body = Body::from_string(string);
        if let Some(mime) = Mime::from_extension(extension) {
            body.set_mime(mime);
        }
        Ok(body)
    }
    fn render_body<T>(&self, template_name: &str, context: &T) -> Result<Body>
    where
        T: Serialize,
    {
        let string = self.render(template_name, context)?;

        let path = PathBuf::from(template_name);
        let mut body = Body::from_string(string);
        if let Some(extension) = path.extension() {
            if let Some(mime) = Mime::from_extension(extension.to_string_lossy()) {
                body.set_mime(mime);
            }
        }
        Ok(body)
    }
    fn render_response<T>(&self, template_name: &str, context: &T) -> Result
    where
        T: Serialize,
    {
        let mut response = Response::new(200);
        response.set_body(self.render_body(template_name, context)?);
        Ok(response)
    }
    fn render_response_ext<T>(&self, template_name: &str, context: &T, extension: &str) -> Result
    where
        T: Serialize,
    {
        let mut response = Response::new(200);
        response.set_body(self.render_body_ext(template_name, context, extension)?);
        Ok(response)
    }
}

pub mod prelude {
    pub use super::TideHandlebarsExt;
}

#[cfg(test)]
mod tests {

    use super::*;
    use async_std::prelude::*;
    use std::collections::BTreeMap;

    #[async_std::test]
    async fn test_body() {
        let mut handlebars = Handlebars::new();

        handlebars
            .register_template_file("simple.html", "./tests/templates/simple.html")
            .unwrap();

        let mut data0 = BTreeMap::new();
        data0.insert("title".to_string(), "hello tide!".to_string());
        let mut body = handlebars.render_body("simple.html", &data0).unwrap();

        assert_eq!(body.mime(), &tide::http::mime::HTML);

        let mut body_string = String::new();
        body.read_to_string(&mut body_string).await.unwrap();
        assert_eq!(body_string, "<h1>hello tide!</h1>\n");
    }

    #[async_std::test]
    async fn response() {
        let mut handlebars = Handlebars::new();
        handlebars
            .register_template_file("simple.html", "./tests/templates/simple.html")
            .unwrap();
        let mut data0 = BTreeMap::new();
        data0.insert("title".to_string(), "hello tide!".to_string());

        let mut response = handlebars.render_response("simple.html", &data0).unwrap();

        assert_eq!(response.content_type(), Some(tide::http::mime::HTML));

        let http_response: &mut tide::http::Response = response.as_mut();
        let body_string = http_response.body_string().await.unwrap();
        assert_eq!(body_string, "<h1>hello tide!</h1>\n");
    }

    #[test]
    fn unknown_content_type() {
        let mut handlebars = Handlebars::new();
        handlebars
            .register_templates_directory(".hbs", "./tests/templates")
            .unwrap();

        let mut data0 = BTreeMap::new();
        data0.insert("title".to_string(), "hello tide!".to_string());
        let body = handlebars.render_body("simple", &data0).unwrap();

        assert_eq!(body.mime(), &tide::http::mime::PLAIN);
    }
    #[test]
    fn body_with_extension() {
        let mut handlebars = Handlebars::new();
        handlebars
            .register_templates_directory(".hbs", "./tests/templates")
            .unwrap();

        let mut data0 = BTreeMap::new();
        data0.insert("title".to_string(), "hello tide!".to_string());
        let body = handlebars
            .render_body_ext("simple", &data0, "html")
            .unwrap();

        assert_eq!(body.mime(), &tide::http::mime::HTML);
    }
    #[async_std::test]
    async fn response_with_extension() {
        let mut handlebars = Handlebars::new();
        handlebars
            .register_templates_directory(".hbs", "./tests/templates")
            .unwrap();
        let mut data0 = BTreeMap::new();
        data0.insert("title".to_string(), "hello tide!".to_string());

        let mut response = handlebars
            .render_response_ext("simple", &data0, "html")
            .unwrap();

        assert_eq!(response.content_type(), Some(tide::http::mime::HTML));

        let http_response: &mut tide::http::Response = response.as_mut();
        let body_string = http_response.body_string().await.unwrap();
        assert_eq!(body_string, "<h1>hello tide!</h1>\n");
    }
    // Templates are validate on load in handlebars -- need to work into the component
    // #[test]
    // fn bad_template() {
    //     let mut handlebars = Handlebars::new();
    //     handlebars
    //         .register_templates_directory(".broken", "./tests/templates")
    //         .unwrap();

    //     let mut data0 = BTreeMap::new();
    //     data0.insert("title".to_string(), "hello tide!".to_string());
    //     let result = handlebars.render_body("simple", &data0);

    //     assert!(result.is_err());
    // }
}