tron 2.1.0

A rust based template system built for speed and simplicity.
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
//! Builder patterns for fluent template construction.
//!
//! This module provides builder patterns for [`TronTemplate`] and [`TronRef`]
//! that allow for more ergonomic and fluent template creation with method chaining.
//!
//! # Examples
//!
//! Using the template builder:
//!
//! ```
//! use tron::TronTemplateBuilder;
//! use std::collections::HashMap;
//!
//! let mut values = HashMap::new();
//! values.insert("name", "greet");
//! values.insert("body", "println!(\"Hello, World!\");");
//!
//! let template = TronTemplateBuilder::new()
//!     .content("fn @[name]@() {\n    @[body]@\n}")
//!     .set("name", "greet")
//!     .set("body", "println!(\"Hello, World!\");")
//!     .build()
//!     .unwrap();
//!
//! let result = template.render().unwrap();
//! ```
//!
//! Using the template reference builder:
//!
//! ```
//! use tron::{TronTemplateBuilder, TronRefBuilder};
//!
//! let template_ref = TronRefBuilder::new()
//!     .content("fn main() {\n    @[body]@\n}")
//!     .dependency("serde = \"1.0\"")
//!     .dependency("tokio = \"1.0\"")
//!     .set("body", "println!(\"Hello from builder!\");")
//!     .build()
//!     .unwrap();
//! ```

use std::collections::HashMap;
use std::path::Path;
use crate::error::{Result, TronError};
use crate::template::TronTemplate;
use crate::template_ref::TronRef;

/// Builder for creating [`TronTemplate`] instances with a fluent API.
///
/// This builder allows you to construct templates step by step, setting
/// content, placeholder values, and other configuration options.
///
/// # Examples
///
/// Basic template building:
///
/// ```
/// use tron::TronTemplateBuilder;
///
/// let template = TronTemplateBuilder::new()
///     .content("Hello @[name]@!")
///     .set("name", "World")
///     .build()
///     .unwrap();
///
/// assert_eq!(template.render().unwrap(), "Hello World!");
/// ```
///
/// Building from file:
///
/// ```no_run
/// use tron::TronTemplateBuilder;
///
/// let template = TronTemplateBuilder::new()
///     .from_file("template.tpl")
///     .set("name", "World")
///     .build()
///     .unwrap();
/// ```
#[derive(Debug, Default)]
pub struct TronTemplateBuilder {
    content: Option<String>,
    file_path: Option<String>,
    placeholder_values: HashMap<String, String>,
}

impl TronTemplateBuilder {
    /// Create a new template builder.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronTemplateBuilder;
    ///
    /// let builder = TronTemplateBuilder::new();
    /// ```
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the template content directly.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronTemplateBuilder;
    ///
    /// let template = TronTemplateBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn content<S: Into<String>>(mut self, content: S) -> Self {
        self.content = Some(content.into());
        self
    }

    /// Load template content from a file.
    ///
    /// This will override any previously set content.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use tron::TronTemplateBuilder;
    ///
    /// let template = TronTemplateBuilder::new()
    ///     .from_file("templates/function.tpl")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn from_file<P: AsRef<Path>>(mut self, path: P) -> Self {
        self.file_path = Some(path.as_ref().to_string_lossy().to_string());
        self
    }

    /// Set a placeholder value.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronTemplateBuilder;
    ///
    /// let template = TronTemplateBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .set("name", "World")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn set<K, V>(mut self, placeholder: K, value: V) -> Self
    where
        K: Into<String>,
        V: Into<String>,
    {
        self.placeholder_values.insert(placeholder.into(), value.into());
        self
    }

    /// Set multiple placeholder values at once.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronTemplateBuilder;
    /// use std::collections::HashMap;
    ///
    /// let mut values = HashMap::new();
    /// values.insert("greeting", "Hello");
    /// values.insert("name", "World");
    ///
    /// let template = TronTemplateBuilder::new()
    ///     .content("@[greeting]@ @[name]@!")
    ///     .set_many(values)
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn set_many<K, V, I>(mut self, values: I) -> Self
    where
        K: Into<String>,
        V: Into<String>,
        I: IntoIterator<Item = (K, V)>,
    {
        for (key, value) in values {
            self.placeholder_values.insert(key.into(), value.into());
        }
        self
    }

    /// Build the final [`TronTemplate`].
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronTemplateBuilder;
    ///
    /// let template = TronTemplateBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .set("name", "World")
    ///     .build()
    ///     .unwrap();
    /// ```
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - Neither content nor file path was provided
    /// - The file path is invalid or the file cannot be read
    /// - The template syntax is invalid
    /// - Any placeholder values reference non-existent placeholders
    pub fn build(self) -> Result<TronTemplate> {
        let mut template = match (self.content, self.file_path) {
            (Some(content), None) => TronTemplate::new(&content)?,
            (None, Some(file_path)) => TronTemplate::from_file(&file_path)?,
            (Some(content), Some(_)) => {
                // Content takes precedence over file path
                TronTemplate::new(&content)?
            },
            (None, None) => {
                return Err(TronError::InvalidSyntax(
                    "Must provide either content or file path".to_string()
                ));
            }
        };

        // Set all placeholder values
        for (key, value) in self.placeholder_values {
            template.set(&key, &value)?;
        }

        Ok(template)
    }
}

/// Builder for creating [`TronRef`] instances with a fluent API.
///
/// This builder allows you to construct template references step by step,
/// setting content, dependencies, placeholder values, and other configuration options.
///
/// # Examples
///
/// Basic template reference building:
///
/// ```
/// use tron::TronRefBuilder;
///
/// let template_ref = TronRefBuilder::new()
///     .content("fn @[name]@() { @[body]@ }")
///     .dependency("serde = \"1.0\"")
///     .set("name", "example")
///     .set("body", "println!(\"Hello!\");")
///     .build()
///     .unwrap();
/// ```
#[derive(Debug, Default)]
pub struct TronRefBuilder {
    template_builder: TronTemplateBuilder,
    dependencies: Vec<String>,
}

impl TronRefBuilder {
    /// Create a new template reference builder.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let builder = TronRefBuilder::new();
    /// ```
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the template content directly.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn content<S: Into<String>>(mut self, content: S) -> Self {
        self.template_builder = self.template_builder.content(content);
        self
    }

    /// Load template content from a file.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .from_file("templates/function.tpl")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn from_file<P: AsRef<Path>>(mut self, path: P) -> Self {
        self.template_builder = self.template_builder.from_file(path);
        self
    }

    /// Set a placeholder value.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .set("name", "World")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn set<K, V>(mut self, placeholder: K, value: V) -> Self
    where
        K: Into<String>,
        V: Into<String>,
    {
        self.template_builder = self.template_builder.set(placeholder, value);
        self
    }

    /// Set multiple placeholder values at once.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    /// use std::collections::HashMap;
    ///
    /// let mut values = HashMap::new();
    /// values.insert("greeting", "Hello");
    /// values.insert("name", "World");
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("@[greeting]@ @[name]@!")
    ///     .set_many(values)
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn set_many<K, V, I>(mut self, values: I) -> Self
    where
        K: Into<String>,
        V: Into<String>,
        I: IntoIterator<Item = (K, V)>,
    {
        self.template_builder = self.template_builder.set_many(values);
        self
    }

    /// Add a dependency that will be included in rust-script execution.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("fn main() {}")
    ///     .dependency("serde = \"1.0\"")
    ///     .dependency("tokio = \"1.0\"")
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn dependency<S: Into<String>>(mut self, dependency: S) -> Self {
        self.dependencies.push(dependency.into());
        self
    }

    /// Add multiple dependencies at once.
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("fn main() {}")
    ///     .dependencies(&["serde = \"1.0\"", "tokio = \"1.0\""])
    ///     .build()
    ///     .unwrap();
    /// ```
    pub fn dependencies<I, S>(mut self, dependencies: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: AsRef<str>,
    {
        for dep in dependencies {
            self.dependencies.push(dep.as_ref().to_string());
        }
        self
    }

    /// Build the final [`TronRef`].
    ///
    /// # Examples
    ///
    /// ```
    /// use tron::TronRefBuilder;
    ///
    /// let template_ref = TronRefBuilder::new()
    ///     .content("Hello @[name]@!")
    ///     .dependency("serde = \"1.0\"")
    ///     .set("name", "World")
    ///     .build()
    ///     .unwrap();
    /// ```
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying template cannot be built.
    pub fn build(self) -> Result<TronRef> {
        let template = self.template_builder.build()?;
        let mut template_ref = TronRef::new(template);
        
        for dependency in self.dependencies {
            template_ref.add_dependency(&dependency);
        }

        Ok(template_ref)
    }
}

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

    #[test]
    fn test_template_builder_basic() -> Result<()> {
        let template = TronTemplateBuilder::new()
            .content("Hello @[name]@!")
            .set("name", "World")
            .build()?;

        assert_eq!(template.render()?, "Hello World!");
        Ok(())
    }

    #[test]
    fn test_template_builder_multiple_placeholders() -> Result<()> {
        let template = TronTemplateBuilder::new()
            .content("@[greeting]@ @[name]@!")
            .set("greeting", "Hello")
            .set("name", "World")
            .build()?;

        assert_eq!(template.render()?, "Hello World!");
        Ok(())
    }

    #[test]
    fn test_template_builder_set_many() -> Result<()> {
        let mut values = HashMap::new();
        values.insert("greeting", "Hello");
        values.insert("name", "World");

        let template = TronTemplateBuilder::new()
            .content("@[greeting]@ @[name]@!")
            .set_many(values)
            .build()?;

        assert_eq!(template.render()?, "Hello World!");
        Ok(())
    }

    #[test]
    fn test_template_builder_no_content_error() {
        let result = TronTemplateBuilder::new().build();
        assert!(matches!(result, Err(TronError::InvalidSyntax(_))));
    }

    #[test]
    fn test_template_builder_invalid_placeholder() {
        let result = TronTemplateBuilder::new()
            .content("Hello @[name]@!")
            .set("nonexistent", "value")
            .build();
        assert!(matches!(result, Err(TronError::MissingPlaceholder(_))));
    }

    #[test]
    fn test_template_ref_builder_basic() -> Result<()> {
        let template_ref = TronRefBuilder::new()
            .content("Hello @[name]@!")
            .set("name", "World")
            .build()?;

        assert_eq!(template_ref.render()?, "Hello World!");
        Ok(())
    }

    #[test]
    fn test_template_ref_builder_with_dependencies() -> Result<()> {
        let template_ref = TronRefBuilder::new()
            .content("fn main() {}")
            .dependency("serde = \"1.0\"")
            .dependency("tokio = \"1.0\"")
            .build()?;

        assert_eq!(template_ref.dependencies().len(), 2);
        assert!(template_ref.dependencies().contains(&"serde = \"1.0\"".to_string()));
        assert!(template_ref.dependencies().contains(&"tokio = \"1.0\"".to_string()));
        Ok(())
    }

    #[test]
    fn test_template_ref_builder_dependencies_method() -> Result<()> {
        let template_ref = TronRefBuilder::new()
            .content("fn main() {}")
            .dependencies(&["serde = \"1.0\"", "tokio = \"1.0\""])
            .build()?;

        assert_eq!(template_ref.dependencies().len(), 2);
        Ok(())
    }

    #[test]
    fn test_template_ref_builder_complex() -> Result<()> {
        let mut values = HashMap::new();
        values.insert("name", "greet");
        values.insert("body", "println!(\"Hello!\");");

        let template_ref = TronRefBuilder::new()
            .content("fn @[name]@() {\n    @[body]@\n}")
            .dependencies(&["serde = \"1.0\"", "tokio = \"1.0\""])
            .set_many(values)
            .build()?;

        let result = template_ref.render()?;
        assert!(result.contains("fn greet()"));
        assert!(result.contains("println!(\"Hello!\");"));
        assert_eq!(template_ref.dependencies().len(), 2);
        Ok(())
    }
}