genfile_core 0.5.0

File generation tools for code generation and template materialization.
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

/// Example demonstrating external content sources
///
/// This example shows how to use the content source abstraction to:
/// 1. Reference templates from external files
/// 2. Fetch content from URLs (with custom resolver)
/// 3. Mix inline and external content sources
/// 4. Implement custom content resolvers for databases, cloud storage, etc.

use genfile_core::
{
  TemplateArchive,
  ContentSource,
  ContentResolver,
  FileContent,
  WriteMode,
  Value,
  HandlebarsRenderer,
  MemoryFileSystem,
  FileSystem,
  Error,
  FileRef,
  UrlRef,
};
use std::path::{ Path, PathBuf };
use std::collections::HashMap;

/// Example: Custom HTTP resolver that simulates fetching templates from a web service
struct HttpResolver
{
  /// Cached responses (in real impl, would make HTTP requests)
  cache: HashMap< String, String >,
}

impl HttpResolver
{
  fn new() -> Self
  {
    let mut cache = HashMap::new();

    // Simulate some "fetched" templates
    cache.insert(
      "https://templates.example.com/header.hbs".to_string(),
      "=== {{title}} ===".to_string(),
    );

    cache.insert(
      "https://templates.example.com/footer.hbs".to_string(),
      "Copyright {{year}} {{company}}".to_string(),
    );

    Self { cache }
  }
}

impl ContentResolver for HttpResolver
{
  fn resolve( &self, source: &ContentSource ) -> Result< FileContent, Error >
  {
    match source
    {
      ContentSource::Inline { content } =>
      {
        Ok( content.clone() )
      }

      ContentSource::File { path } =>
      {
        // Read from filesystem
        match std::fs::read_to_string( path )
        {
          Ok( text ) => Ok( FileContent::Text( text ) ),
          Err( e ) => Err( Error::Fs( e ) ),
        }
      }

      ContentSource::Url { url } =>
      {
        // Simulate HTTP fetch from cache
        match self.cache.get( url )
        {
          Some( content ) => Ok( FileContent::Text( content.clone() ) ),
          None => Err( Error::Render( format!( "URL not found: {}", url ) ) ),
        }
      }
    }
  }
}

#[ test ]
fn example_external_content_sources()
{
  // Create archive
  let mut archive = TemplateArchive::new( "website-template" );
  archive.set_version( "1.0.0" );
  archive.set_description( "Website template with external sources" );

  // 1. Inline content (traditional approach)
  archive.add_text_file(
    PathBuf::from( "index.html" ),
    r#"<html>
  <body>{{content}}</body>
</html>"#,
    WriteMode::Rewrite
  );

  // 2. Reference template from URL
  archive.add_file_from(
    PathBuf::from( "header.txt" ),
    UrlRef::new( "https://templates.example.com/header.hbs" ),
    WriteMode::Rewrite
  );

  // 3. Reference template from URL
  archive.add_file_from(
    PathBuf::from( "footer.txt" ),
    UrlRef::new( "https://templates.example.com/footer.hbs" ),
    WriteMode::Rewrite
  );

  // Set parameter values
  archive.set_value( "content", Value::String( "Welcome!".into() ) );
  archive.set_value( "title", Value::String( "My Website".into() ) );
  archive.set_value( "year", Value::Number( 2024 ) );
  archive.set_value( "company", Value::String( "Acme Corp".into() ) );

  // Create custom HTTP resolver
  let resolver = HttpResolver::new();

  // Materialize with resolver
  let renderer = HandlebarsRenderer::new();
  let mut filesystem = MemoryFileSystem::new();

  let report = archive.materialize_with_resolver(
    Path::new( "/output" ),
    &renderer,
    &mut filesystem,
    &resolver
  ).unwrap();

  // Verify results
  assert_eq!( report.files_created.len(), 3 );

  let index = filesystem.read( &PathBuf::from( "/output/index.html" ) ).unwrap();
  assert!( index.contains( "<body>Welcome!</body>" ) );

  let header = filesystem.read( &PathBuf::from( "/output/header.txt" ) ).unwrap();
  assert_eq!( header, "=== My Website ===" );

  let footer = filesystem.read( &PathBuf::from( "/output/footer.txt" ) ).unwrap();
  assert_eq!( footer, "Copyright 2024 Acme Corp" );
}

/// Example: Custom database resolver
struct DatabaseResolver
{
  templates: HashMap< String, String >,
}

impl DatabaseResolver
{
  fn new() -> Self
  {
    let mut templates = HashMap::new();

    // Simulate database records
    templates.insert(
      "email_welcome".to_string(),
      "Hello {{username}}, welcome to {{app_name}}!".to_string(),
    );

    templates.insert(
      "email_reset".to_string(),
      "Reset your password: {{reset_link}}".to_string(),
    );

    Self { templates }
  }

  fn get_template( &self, id: &str ) -> Option< String >
  {
    self.templates.get( id ).cloned()
  }
}

impl ContentResolver for DatabaseResolver
{
  fn resolve( &self, source: &ContentSource ) -> Result< FileContent, Error >
  {
    match source
    {
      ContentSource::Inline { content } =>
      {
        Ok( content.clone() )
      }

      ContentSource::File { path } =>
      {
        // Interpret path as database template ID
        let template_id = path.file_stem()
          .and_then( | s | s.to_str() )
          .unwrap_or( "" );

        match self.get_template( template_id )
        {
          Some( content ) => Ok( FileContent::Text( content ) ),
          None => Err( Error::Render( format!( "Template not found in DB: {}", template_id ) ) ),
        }
      }

      ContentSource::Url { url } =>
      {
        Err( Error::Render( format!( "URLs not supported: {}", url ) ) )
      }
    }
  }
}

#[ test ]
fn example_database_templates()
{
  // Create archive with database template references
  let mut archive = TemplateArchive::new( "email-templates" );

  // Use "file" source type to reference database template IDs
  archive.add_file_from(
    PathBuf::from( "welcome.txt" ),
    FileRef::new( PathBuf::from( "email_welcome" ) ),  // Template ID in database
    WriteMode::Rewrite
  );

  archive.add_file_from(
    PathBuf::from( "reset.txt" ),
    FileRef::new( PathBuf::from( "email_reset" ) ),
    WriteMode::Rewrite
  );

  // Set values
  archive.set_value( "username", Value::String( "Alice".into() ) );
  archive.set_value( "app_name", Value::String( "MyApp".into() ) );
  archive.set_value( "reset_link", Value::String( "https://example.com/reset?token=xyz".into() ) );

  // Use database resolver
  let resolver = DatabaseResolver::new();
  let renderer = HandlebarsRenderer::new();
  let mut filesystem = MemoryFileSystem::new();

  archive.materialize_with_resolver(
    Path::new( "/emails" ),
    &renderer,
    &mut filesystem,
    &resolver
  ).unwrap();

  // Verify
  let welcome = filesystem.read( &PathBuf::from( "/emails/welcome.txt" ) ).unwrap();
  assert_eq!( welcome, "Hello Alice, welcome to MyApp!" );

  let reset = filesystem.read( &PathBuf::from( "/emails/reset.txt" ) ).unwrap();
  assert_eq!( reset, "Reset your password: https://example.com/reset?token=xyz" );
}

#[ test ]
fn example_serialization_with_external_sources()
{
  // Create archive with external sources
  let mut archive = TemplateArchive::new( "config-template" );

  archive.add_file_from(
    PathBuf::from( "settings.json" ),
    UrlRef::new( "https://config.example.com/settings.json" ),
    WriteMode::Rewrite
  );

  archive.add_file_from(
    PathBuf::from( "rules.yaml" ),
    FileRef::new( PathBuf::from( "/etc/templates/rules.yaml" ) ),
    WriteMode::Rewrite
  );

  // Serialize to JSON
  let json = archive.to_json_pretty().unwrap();

  println!( "Archive JSON:\n{}", json );

  // Verify it contains source references
  assert!( json.contains( "content_source" ) );
  assert!( json.contains( "https://config.example.com/settings.json" ) );
  assert!( json.contains( "/etc/templates/rules.yaml" ) );

  // Deserialize and verify
  let restored = TemplateArchive::from_json( &json ).unwrap();
  assert_eq!( restored.file_count(), 2 );

  // Verify sources are preserved
  let settings_file = restored.get_file( Path::new( "settings.json" ) ).unwrap();
  assert!( settings_file.content_source.as_ref().unwrap().is_url() );

  let rules_file = restored.get_file( Path::new( "rules.yaml" ) ).unwrap();
  assert!( rules_file.content_source.as_ref().unwrap().is_file() );
}