gotpl 0.2.6

A Rust library providing full Go template (text/template and html/template) support via FFI.
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use serde::Serialize;
use std::error::Error;
use std::ffi::{CStr, CString, NulError};
use std::fmt::{self, Display, Formatter};
use std::marker::PhantomData;
// use std::os::raw::c_char; // 添加这个导入

#[cfg(not(docsrs))]
mod goffi {
    #![allow(non_snake_case)]
    #![allow(non_camel_case_types)]
    #![allow(non_upper_case_globals)]
    #![allow(unused)]
    // include rust bindings generated by bindgen
    include!(concat!(env!("OUT_DIR"), "/api_bindings.rs"));
}

#[cfg(docsrs)]
mod goffi {
    use std::os::raw::c_char;

    #[repr(C)]
    pub struct RenderResult {
        pub output: *mut c_char, // 改为 c_char
        pub error: *mut c_char,  // 改为 c_char
    }

    extern "C" {
        pub fn RenderTemplate(
            template_content: *mut c_char, // 改为 c_char
            json_data: *mut c_char,        // 改为 c_char
            escape_html: bool,
            use_missing_key_zero: bool,
        ) -> RenderResult;
        pub fn FreeResultString(s: *mut c_char); // 改为 c_char
    }
}

#[derive(Debug)]
pub enum RenderError {
    InvalidCString(NulError),
    JsonSerialization(serde_json::Error),
    GoExecution(String),
}

impl Display for RenderError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            RenderError::InvalidCString(e) => {
                write!(f, "Failed to convert string to C-compatible string: {}", e)
            }
            RenderError::JsonSerialization(e) => {
                write!(f, "Failed to serialize data to JSON: {}", e)
            }
            RenderError::GoExecution(e) => write!(f, "Go template execution error: {}", e),
        }
    }
}

impl Error for RenderError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            RenderError::InvalidCString(e) => Some(e),
            RenderError::JsonSerialization(e) => Some(e),
            RenderError::GoExecution(_) => None,
        }
    }
}

impl From<NulError> for RenderError {
    fn from(err: NulError) -> Self {
        RenderError::InvalidCString(err)
    }
}

impl From<serde_json::Error> for RenderError {
    fn from(err: serde_json::Error) -> Self {
        RenderError::JsonSerialization(err)
    }
}

struct OwnedGoResult(goffi::RenderResult);

impl Drop for OwnedGoResult {
    fn drop(&mut self) {
        unsafe {
            goffi::FreeResultString(self.0.output);
            goffi::FreeResultString(self.0.error);
        }
    }
}

/// Go Template Renderer
pub struct TemplateRenderer<'a, T: Serialize> {
    template_content: &'a str,
    data: &'a T,
    escape_html: bool,
    use_missing_key_zero: bool,
    _marker: PhantomData<&'a T>,
}

impl<'a, T: Serialize> TemplateRenderer<'a, T> {
    /// Creates a new template renderer.
    ///
    /// # Arguments
    /// * `template_content` - Go template content as a string slice.
    /// * `data` - Data to be injected into the template, must implement `Serialize`.
    pub fn new(template_content: &'a str, data: &'a T) -> Self {
        Self {
            template_content,
            data,
            escape_html: false,
            use_missing_key_zero: false,
            _marker: PhantomData,
        }
    }

    /// Sets whether to escape HTML in the output.
    ///
    /// Defaults to `false`.
    pub fn escape_html(mut self, escape: bool) -> Self {
        self.escape_html = escape;
        self
    }

    /// Sets whether to treat missing keys as zero values.
    ///
    /// Go Template's `missingkey=zero` option.
    pub fn use_missing_key_zero(mut self, use_zero: bool) -> Self {
        self.use_missing_key_zero = use_zero;
        self
    }

    /// Executes the template rendering.
    ///
    /// # Returns
    /// Ok(String) if rendering was successful, Err(RenderError) otherwise.
    pub fn render(self) -> Result<String, RenderError> {
        // Prepare inputs
        let c_template = CString::new(self.template_content)?;
        let json_data_string = serde_json::to_string(self.data)?;
        let c_json_data = CString::new(json_data_string)?;

        // Call Go function - 注意这里的转换
        let result = unsafe {
            OwnedGoResult(goffi::RenderTemplate(
                c_template.into_raw(),  // 使用 into_raw() 而不是 as_ptr() as *mut i8
                c_json_data.into_raw(), // 使用 into_raw() 而不是 as_ptr() as *mut i8
                self.escape_html,
                self.use_missing_key_zero,
            ))
        };

        // Process result
        let output = unsafe {
            let output_str = CStr::from_ptr(result.0.output)
                .to_string_lossy()
                .into_owned();
            // 重新获取所有权以便后续正确释放
            let _ = CString::from_raw(result.0.output);
            output_str
        };

        let error = unsafe {
            let error_str = CStr::from_ptr(result.0.error)
                .to_string_lossy()
                .into_owned();
            // 重新获取所有权以便后续正确释放
            let _ = CString::from_raw(result.0.error);
            error_str
        };

        if !error.is_empty() {
            Err(RenderError::GoExecution(error))
        } else {
            Ok(output)
        }
    }
}

// 为方便使用添加的便捷函数
impl<'a, T: Serialize> TemplateRenderer<'a, T> {
    /// 快速渲染模板的便捷方法
    pub fn render_quick(template: &'a str, data: &'a T) -> Result<String, RenderError> {
        Self::new(template, data).render()
    }

    /// 渲染HTML转义的模板
    pub fn render_html(template: &'a str, data: &'a T) -> Result<String, RenderError> {
        Self::new(template, data).escape_html(true).render()
    }
}

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

    #[derive(Serialize, Debug)]
    struct SimpleData {
        name: String,
        age: u32,
        active: bool,
    }

    #[derive(Serialize)]
    struct NestedData {
        user: SimpleData,
        website: String,
    }

    #[derive(Serialize)]
    struct EmptyData {}

    // 基础功能测试
    #[test]
    fn test_basic_template_rendering() {
        let data = SimpleData {
            name: "Alice".to_string(),
            age: 30,
            active: true,
        };

        let template = "Hello, {{.name}}! You are {{.age}} years old.";
        let result = TemplateRenderer::render_quick(template, &data).unwrap();

        assert_eq!(result, "Hello, Alice! You are 30 years old.");
    }

    // HTML 转义测试
    #[test]
    fn test_html_escaping() {
        let data = SimpleData {
            name: "<script>alert('xss')</script>".to_string(),
            age: 25,
            active: false,
        };

        let template = "Welcome, {{.name}}";

        // 不转义 HTML
        let result_no_escape = TemplateRenderer::new(template, &data)
            .escape_html(false)
            .render()
            .unwrap();
        assert_eq!(result_no_escape, "Welcome, <script>alert('xss')</script>");

        // 转义 HTML
        let result_escape = TemplateRenderer::new(template, &data)
            .escape_html(true)
            .render()
            .unwrap();
        assert!(result_escape.contains("&lt;script&gt;"));
        assert!(result_escape.contains("&lt;/script&gt;"));
    }

    // 嵌套数据结构测试
    #[test]
    fn test_nested_data() {
        let user_data = SimpleData {
            name: "Bob".to_string(),
            age: 35,
            active: true,
        };

        let data = NestedData {
            user: user_data,
            website: "example.com".to_string(),
        };

        let template = "User: {{.user.name}}, Website: {{.website}}";
        let result = TemplateRenderer::render_quick(template, &data).unwrap();

        assert_eq!(result, "User: Bob, Website: example.com");
    }

    // 布尔值和条件测试
    #[test]
    fn test_boolean_conditional() {
        let data = SimpleData {
            name: "Charlie".to_string(),
            age: 40,
            active: true,
        };

        let template = "{{.name}} is {{if .active}}active{{else}}inactive{{end}}";
        let result = TemplateRenderer::render_quick(template, &data).unwrap();

        assert_eq!(result, "Charlie is active");
    }

    // 缺失键处理测试
    #[test]
    fn test_missing_key_handling() {
        let data = SimpleData {
            name: "David".to_string(),
            age: 28,
            active: false,
        };

        // 测试访问不存在的字段
        let template = "Name: {{.name}}, Missing: {{.nonexistent}}";

        // 使用 zero 行为
        let result_zero = TemplateRenderer::new(template, &data)
            .use_missing_key_zero(true)
            .render()
            .unwrap();

        // 在 missingkey=zero 模式下,不存在的字段应该为空
        assert_eq!(result_zero, "Name: David, Missing: ");

        // 默认模式下可能会出错(取决于 Go 模板的默认行为)
        // 这里我们只测试 zero 模式,因为默认模式的行为可能因配置而异
    }

    // 空数据测试
    #[test]
    fn test_empty_data() {
        let data = EmptyData {};
        let template = "Static content";
        let result = TemplateRenderer::render_quick(template, &data).unwrap();

        assert_eq!(result, "Static content");
    }

    // 复杂模板语法测试
    #[test]
    fn test_complex_template() {
        let data = SimpleData {
            name: "Eve".to_string(),
            age: 32,
            active: true,
        };

        let template = r#"
User Profile:
-----------
Name: {{.name}}
Age: {{.age}}
Status: {{if .active}}Active{{else}}Inactive{{end}}

{{range $i, $e := .}}
Field {{$i}}: {{$e}}
{{end}}
"#;

        let result = TemplateRenderer::render_quick(template, &data).unwrap();
        assert!(result.contains("Name: Eve"));
        assert!(result.contains("Age: 32"));
        assert!(result.contains("Status: Active"));
    }

    // 错误处理测试
    #[test]
    fn test_error_handling() {
        let data = SimpleData {
            name: "Frank".to_string(),
            age: 45,
            active: false,
        };

        // 无效的模板语法
        let invalid_template = "Hello, {{.name}"; // 缺少闭合括号
        let result = TemplateRenderer::render_quick(invalid_template, &data);

        assert!(result.is_err());
        if let Err(RenderError::GoExecution(err)) = result {
            assert!(err.contains("template") || err.contains("parse") || err.contains("execute"));
        } else {
            panic!("Expected GoExecution error");
        }
    }

    // 便捷方法测试
    #[test]
    fn test_convenience_methods() {
        let data = SimpleData {
            name: "Grace".to_string(),
            age: 29,
            active: true,
        };

        let template = "Hello, {{.name}}";

        // 测试 render_quick
        let quick_result = TemplateRenderer::render_quick(template, &data).unwrap();
        assert_eq!(quick_result, "Hello, Grace");

        // 测试 render_html
        let html_result = TemplateRenderer::render_html(template, &data).unwrap();
        assert_eq!(html_result, "Hello, Grace"); // 没有特殊字符时应该相同
    }

    // 特殊字符测试
    #[test]
    fn test_special_characters() {
        let data = SimpleData {
            name: "O'Reilly".to_string(),
            age: 50,
            active: false,
        };

        let template = "Name: {{.name}}, Quote: \"test\"";
        let result = TemplateRenderer::render_quick(template, &data).unwrap();

        assert!(result.contains("O'Reilly"));
        assert!(result.contains("Quote: \"test\""));
    }

    // 边界值测试
    #[test]
    fn test_edge_cases() {
        // 空字符串
        let empty_data = SimpleData {
            name: "".to_string(),
            age: 0,
            active: false,
        };

        let template = "Empty name: '{{.name}}'";
        let result = TemplateRenderer::render_quick(template, &empty_data).unwrap();
        assert_eq!(result, "Empty name: ''");

        // 很长的字符串
        let long_name = "A".repeat(1000);
        let long_data = SimpleData {
            name: long_name.clone(),
            age: 99,
            active: true,
        };

        let template = "Long: {{.name}}";
        let result = TemplateRenderer::render_quick(template, &long_data).unwrap();
        assert_eq!(result, format!("Long: {}", long_name));
    }

    // 序列化错误测试
    #[test]
    fn test_serialization_error() {
        // 创建一个无法序列化的数据类型
        struct UnserializableData;

        impl Serialize for UnserializableData {
            fn serialize<S>(&self, _serializer: S) -> Result<S::Ok, S::Error>
            where
                S: serde::Serializer,
            {
                use serde::ser::Error;
                Err(S::Error::custom("Intentionally failed serialization"))
            }
        }

        let data = UnserializableData;
        let template = "Test {{.field}}";
        let result = TemplateRenderer::render_quick(template, &data);

        assert!(result.is_err());
        if let Err(RenderError::JsonSerialization(_)) = result {
            // 期望的序列化错误
        } else {
            panic!("Expected JsonSerialization error");
        }
    }
}