hemplate-runtime 0.3.0

Parser-free rendering contract for Hemplate templates
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
//! Codegen dispatch helpers for `{+ expr +}` and `{+= expr =+}`.
//!
//! Uses the autoref specialization pattern so the derive macro can emit
//! a single call site that does the right thing for both `Hemplate`
//! types (call `render_into` — output is already HTML) and `Display`
//! types (HTML-escape via `HtmlEscape`).
//!
//! **Users never call these directly.** The derive macro generates all
//! call sites.

use crate::Hemplate;
use crate::error::RenderError;
use crate::escape::HtmlEscape;
use alloc::{boxed::Box, sync::Arc, vec::Vec};
use core::fmt;

struct RenderBuffer<'a>(&'a mut dyn fmt::Write);

impl fmt::Write for RenderBuffer<'_> {
    fn write_str(&mut self, text: &str) -> fmt::Result {
        self.0.write_str(text)
    }
}

// ---------------------------------------------------------------------------
// Escaped interpolation: {+ expr +}
// ---------------------------------------------------------------------------

/// Wrapper emitted by codegen for `{+ expr +}`.
#[doc(hidden)]
pub struct Escaped<'a, T: ?Sized>(pub &'a T);

// Priority 1 (inherent): Hemplate types render directly — output is safe HTML.
impl<T: Hemplate + ?Sized> Escaped<'_, T> {
    /// Render a Hemplate component into the buffer (no escaping).
    #[doc(hidden)]
    pub fn render_to(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        self.0.render_into(buf)
    }
}

/// Fallback for `Display` types in escaped context.
#[doc(hidden)]
pub trait EscapedFallback {
    /// Render a Display value into the buffer with HTML escaping.
    fn render_to(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError>;
}

// Priority 2 (trait): Display types get HTML-escaped.
impl<T: fmt::Display + ?Sized> EscapedFallback for Escaped<'_, T> {
    fn render_to(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        use fmt::Write as _;
        write!(RenderBuffer(buf), "{}", HtmlEscape(self.0))?;
        Ok(())
    }
}

// ---------------------------------------------------------------------------
// Raw interpolation: {+= expr =+}
// ---------------------------------------------------------------------------

/// Wrapper emitted by codegen for `{+= expr =+}`.
#[doc(hidden)]
pub struct Raw<'a, T: ?Sized>(pub &'a T);

// Priority 1 (inherent): Hemplate types should NOT use raw interpolation.
// The autoref dispatch means `{+ +}` already calls `render_into` for
// Hemplate types.  Using `{+= =+}` with a Hemplate type is always a
// mistake — it bypasses the safe dispatch for no benefit.
impl<T: Hemplate + ?Sized> Raw<'_, T> {
    /// Compile-time guard: raw interpolation is not allowed for Hemplate types.
    #[doc(hidden)]
    pub fn render_to(&self, _buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        panic!(
            "hemplate: raw interpolation must not be used with Hemplate types. \
             Use escaped interpolation instead. \
             This should have been caught at compile time via RawGuard."
        );
    }
}

/// Fallback for `Display` types in raw context.
#[doc(hidden)]
pub trait RawFallback {
    /// Render a Display value into the buffer without escaping.
    fn render_to(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError>;
}

// Priority 2 (trait): Display types output verbatim (no escaping).
impl<T: fmt::Display + ?Sized> RawFallback for Raw<'_, T> {
    fn render_to(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        use fmt::Write as _;
        write!(RenderBuffer(buf), "{}", self.0)?;
        Ok(())
    }
}

// ---------------------------------------------------------------------------
// Raw interpolation guard: compile error for Hemplate types in {+= =+}
// ---------------------------------------------------------------------------

/// Emitted by codegen before `Raw::render_to` to catch Hemplate types at
/// compile time.  The inherent impl returns a distinct type that fails the
/// `let _: () = ...` assignment, producing a clear type-mismatch error
/// whose type name IS the error message.
#[doc(hidden)]
pub struct RawGuard<'a, T: ?Sized>(pub &'a T);

/// Appears in the compiler error when `{+= =+}` is used with a Hemplate type.
#[doc(hidden)]
pub struct RawInterpolationNotAllowedForHemplateTypes;

// Priority 1 (inherent): Hemplate types → return the "error message" type.
impl<T: Hemplate + ?Sized> RawGuard<'_, T> {
    #[doc(hidden)]
    pub fn check(&self) -> RawInterpolationNotAllowedForHemplateTypes {
        RawInterpolationNotAllowedForHemplateTypes
    }
}

/// Fallback: Display types pass the guard (no-op).
#[doc(hidden)]
pub trait RawGuardFallback {
    fn check(&self);
}

impl<T: fmt::Display + ?Sized> RawGuardFallback for RawGuard<'_, T> {
    #[inline(always)]
    fn check(&self) {}
}

// ---------------------------------------------------------------------------
// Blanket Hemplate impls
// ---------------------------------------------------------------------------

impl<T: Hemplate + ?Sized> Hemplate for &T {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        (*self).render_into(buf)
    }
}

impl<T: Hemplate + ?Sized> Hemplate for Box<T> {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        (**self).render_into(buf)
    }
}

impl<T: Hemplate + ?Sized> Hemplate for Arc<T> {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        (**self).render_into(buf)
    }
}

impl<T: Hemplate> Hemplate for Option<T> {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        if let Some(inner) = self {
            inner.render_into(buf)?;
        }
        Ok(())
    }
}

impl<T: Hemplate> Hemplate for Vec<T> {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        for item in self {
            item.render_into(buf)?;
        }
        Ok(())
    }
}

impl<T: Hemplate> Hemplate for [T] {
    fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
        for item in self {
            item.render_into(buf)?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::{string::String, vec};

    // A minimal Hemplate type for testing dispatch
    struct TestComponent(String);

    impl Hemplate for TestComponent {
        fn render_into(&self, buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
            buf.write_str("<b>")?;
            buf.write_str(&self.0)?;
            buf.write_str("</b>")?;
            Ok(())
        }
    }

    struct FailingComponent;

    impl Hemplate for FailingComponent {
        fn render_into(&self, _buf: &mut dyn core::fmt::Write) -> Result<(), RenderError> {
            Err(fmt::Error.into())
        }
    }

    struct FailingDisplay;

    impl fmt::Display for FailingDisplay {
        fn fmt(&self, _formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
            Err(fmt::Error)
        }
    }

    fn render_to_string(value: &(impl Hemplate + ?Sized)) -> Result<String, RenderError> {
        let mut buf = String::new();
        value.render_into(&mut buf)?;
        Ok(buf)
    }

    #[test]
    fn render_into_accepts_custom_writer() -> Result<(), RenderError> {
        struct Writer(String);
        impl fmt::Write for Writer {
            fn write_str(&mut self, value: &str) -> fmt::Result {
                self.0.push_str(value);
                Ok(())
            }
        }
        let mut writer = Writer(String::new());
        TestComponent("caller-owned".into()).render_into(&mut writer)?;
        assert_eq!(writer.0, "<b>caller-owned</b>");
        Ok(())
    }

    #[test]
    fn escaped_hemplate_renders_directly() -> Result<(), RenderError> {
        let comp = TestComponent("hello".into());
        let mut buf = String::new();
        Escaped(&comp).render_to(&mut buf)?;
        assert_eq!(buf, "<b>hello</b>");
        Ok(())
    }

    #[test]
    fn escaped_display_html_escapes() -> Result<(), RenderError> {
        let text = "<script>alert('xss')</script>";
        let mut buf = String::new();
        EscapedFallback::render_to(&Escaped(text), &mut buf)?;
        assert_eq!(buf, "&lt;script&gt;alert(&#x27;xss&#x27;)&lt;/script&gt;");
        Ok(())
    }

    #[test]
    #[should_panic(expected = "must not be used with Hemplate types")]
    fn raw_hemplate_panics() {
        let comp = TestComponent("world".into());
        let mut buf = String::new();
        let _ = Raw(&comp).render_to(&mut buf);
    }

    #[test]
    fn raw_guard_hemplate_returns_marker_type() {
        let comp = TestComponent("test".into());
        // Inherent impl is selected for Hemplate types, returning the marker type.
        // In codegen, `let _: () = RawGuard(&expr).check()` causes a type mismatch
        // that prevents compilation of {+= =+} with Hemplate types.
        let _marker = RawGuard(&comp).check();
        // If this compiles, the inherent impl was selected (returns marker, not ()).
        assert_eq!(
            core::any::type_name_of_val(&_marker),
            core::any::type_name::<RawInterpolationNotAllowedForHemplateTypes>()
        );
    }

    #[test]
    fn raw_guard_display_is_noop() {
        let text = "hello";
        // Trait fallback is selected for Display-only types, returning ().
        let result: () = RawGuardFallback::check(&RawGuard(text));
        assert_eq!(result, ());
    }

    #[test]
    fn raw_display_no_escaping() -> Result<(), RenderError> {
        let text = "<b>bold</b>";
        let mut buf = String::new();
        RawFallback::render_to(&Raw(text), &mut buf)?;
        assert_eq!(buf, "<b>bold</b>");
        Ok(())
    }

    #[test]
    fn interpolation_fallbacks_propagate_display_failure() {
        let mut escaped = String::new();
        assert!(EscapedFallback::render_to(&Escaped(&FailingDisplay), &mut escaped).is_err());
        let mut raw = String::new();
        assert!(RawFallback::render_to(&Raw(&FailingDisplay), &mut raw).is_err());
    }

    // Blanket Hemplate impls preserve child render order and emptiness.

    #[test]
    fn option_some_renders() -> Result<(), RenderError> {
        let comp = Some(TestComponent("yes".into()));
        assert_eq!(render_to_string(&comp)?, "<b>yes</b>");
        Ok(())
    }

    #[test]
    fn option_none_renders_empty() -> Result<(), RenderError> {
        let comp: Option<TestComponent> = None;
        assert_eq!(render_to_string(&comp)?, "");
        Ok(())
    }

    #[test]
    fn vec_renders_all() -> Result<(), RenderError> {
        let comps = vec![TestComponent("a".into()), TestComponent("b".into())];
        assert_eq!(render_to_string(&comps)?, "<b>a</b><b>b</b>");
        Ok(())
    }

    #[test]
    fn vec_empty_renders_empty() -> Result<(), RenderError> {
        let comps: Vec<TestComponent> = vec![];
        assert_eq!(render_to_string(&comps)?, "");
        Ok(())
    }

    #[test]
    fn box_renders() -> Result<(), RenderError> {
        let comp: Box<TestComponent> = Box::new(TestComponent("boxed".into()));
        assert_eq!(render_to_string(&comp)?, "<b>boxed</b>");
        Ok(())
    }

    #[test]
    fn arc_renders() -> Result<(), RenderError> {
        let comp: Arc<TestComponent> = Arc::new(TestComponent("shared".into()));
        assert_eq!(render_to_string(&comp)?, "<b>shared</b>");
        Ok(())
    }

    #[test]
    fn ref_renders() -> Result<(), RenderError> {
        let comp = TestComponent("ref".into());
        let r: &TestComponent = &comp;
        assert_eq!(render_to_string(&r)?, "<b>ref</b>");
        Ok(())
    }

    #[test]
    fn slice_renders() -> Result<(), RenderError> {
        let comps = vec![TestComponent("x".into()), TestComponent("y".into())];
        assert_eq!(render_to_string(comps.as_slice())?, "<b>x</b><b>y</b>");
        Ok(())
    }

    #[test]
    fn box_dyn_hemplate_renders() -> Result<(), RenderError> {
        let comp: Box<dyn Hemplate> = Box::new(TestComponent("dyn".into()));
        assert_eq!(render_to_string(comp.as_ref())?, "<b>dyn</b>");
        Ok(())
    }

    #[test]
    fn references_box_arc_option_vec_and_slices_render() -> Result<(), RenderError> {
        let value = TestComponent("one".into());
        assert_eq!(render_to_string(&&value)?, "<b>one</b>");
        assert_eq!(
            render_to_string(&Box::new(TestComponent("two".into())))?,
            "<b>two</b>"
        );
        assert_eq!(
            render_to_string(&Arc::new(TestComponent("three".into())))?,
            "<b>three</b>"
        );
        assert_eq!(
            render_to_string(&Some(TestComponent("four".into())))?,
            "<b>four</b>"
        );
        assert_eq!(
            render_to_string(&vec![TestComponent("five".into())])?,
            "<b>five</b>"
        );
        let slice = [TestComponent("six".into())];
        assert_eq!(render_to_string(&slice[..])?, "<b>six</b>");
        let dynamic: Box<dyn Hemplate> = Box::new(TestComponent("seven".into()));
        assert_eq!(render_to_string(dynamic.as_ref())?, "<b>seven</b>");
        Ok(())
    }

    #[test]
    fn blanket_implementations_propagate_child_failure() {
        let by_ref = &FailingComponent;
        assert!(render_to_string(&by_ref).is_err());
        assert!(render_to_string(&Box::new(FailingComponent)).is_err());
        assert!(render_to_string(&Arc::new(FailingComponent)).is_err());
        assert!(render_to_string(&Some(FailingComponent)).is_err());
        assert!(render_to_string(&vec![FailingComponent]).is_err());
        assert!(render_to_string([FailingComponent].as_slice()).is_err());
    }
}