reinhardt-utils 0.1.0-rc.22

Utility functions aggregator for Reinhardt
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
//! Template integration for static files
//!
//! Provides configuration types for static file URL generation in templates.

use super::{ManifestStaticFilesStorage, StaticFilesConfig};
use std::collections::HashMap;
use std::io;

/// Configuration for static files in templates
///
/// This configuration can be used with template systems to generate URLs for static files.
/// It can be constructed from `StaticFilesConfig`.
#[derive(Debug, Clone)]
pub struct TemplateStaticConfig {
	/// Base URL for static files (e.g., "/static/")
	pub static_url: String,
	/// Whether to use hashed filenames from manifest
	pub use_manifest: bool,
	/// Manifest mapping original paths to hashed paths
	pub manifest: HashMap<String, String>,
}

impl From<&StaticFilesConfig> for TemplateStaticConfig {
	fn from(config: &StaticFilesConfig) -> Self {
		Self {
			static_url: config.static_url.clone(),
			use_manifest: false,
			manifest: HashMap::new(),
		}
	}
}

impl TemplateStaticConfig {
	/// Create a new template static configuration
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	///
	/// let config = TemplateStaticConfig::new("/static/".to_string());
	/// assert_eq!(config.static_url, "/static/");
	/// assert!(!config.use_manifest);
	/// ```
	pub fn new(static_url: String) -> Self {
		Self {
			static_url,
			use_manifest: false,
			manifest: HashMap::new(),
		}
	}

	/// Enable manifest-based hashed filenames
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	/// use std::collections::HashMap;
	///
	/// let mut manifest = HashMap::new();
	/// manifest.insert("css/style.css".to_string(), "css/style.abc123.css".to_string());
	///
	/// let config = TemplateStaticConfig::new("/static/".to_string())
	///     .with_manifest(manifest);
	///
	/// assert!(config.use_manifest);
	/// assert_eq!(config.manifest.len(), 1);
	/// ```
	pub fn with_manifest(mut self, manifest: HashMap<String, String>) -> Self {
		self.use_manifest = true;
		self.manifest = manifest;
		self
	}

	/// Load manifest from ManifestStaticFilesStorage
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	/// use reinhardt_utils::staticfiles::ManifestStaticFilesStorage;
	/// use std::path::PathBuf;
	///
	/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
	/// let storage = ManifestStaticFilesStorage::new(
	///     PathBuf::from("/var/www/static"),
	///     "/static/"
	/// );
	///
	/// let config = TemplateStaticConfig::from_storage(&storage).await?;
	/// assert!(config.use_manifest);
	/// # Ok(())
	/// # }
	/// ```
	pub async fn from_storage(storage: &ManifestStaticFilesStorage) -> io::Result<Self> {
		let manifest_path = storage.location.join(&storage.manifest_name);

		if !manifest_path.exists() {
			return Ok(Self {
				static_url: storage.base_url.clone(),
				use_manifest: false,
				manifest: HashMap::new(),
			});
		}

		let manifest_content = tokio::fs::read_to_string(&manifest_path).await?;

		// Try parsing as structured format first: {"version": "...", "paths": {...}} or {"paths": {...}}
		let manifest =
			if let Ok(structured) = serde_json::from_str::<serde_json::Value>(&manifest_content) {
				if let Some(paths) = structured.get("paths").and_then(|v| v.as_object()) {
					paths
						.iter()
						.filter_map(|(k, v)| v.as_str().map(|s| (k.clone(), s.to_string())))
						.collect()
				} else if let Some(files) = structured.get("files").and_then(|v| v.as_object()) {
					// Legacy format with "files" key
					files
						.iter()
						.filter_map(|(k, v)| v.as_str().map(|s| (k.clone(), s.to_string())))
						.collect()
				} else {
					// Try as simple HashMap (legacy flat format)
					serde_json::from_str::<HashMap<String, String>>(&manifest_content)
						.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))?
				}
			} else {
				return Err(io::Error::new(
					io::ErrorKind::InvalidData,
					"Invalid manifest JSON",
				));
			};

		Ok(Self {
			static_url: storage.base_url.clone(),
			use_manifest: true,
			manifest,
		})
	}

	/// Resolve a static file path to a URL
	///
	/// This method generates a URL for a static file, optionally using
	/// manifest-based hashed filenames for cache busting.
	///
	/// # Arguments
	///
	/// * `name` - The file path relative to static root, optionally with query string and/or fragment
	///
	/// # Examples
	///
	/// Basic usage:
	///
	/// ```rust
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	///
	/// let config = TemplateStaticConfig::new("/static/".to_string());
	/// assert_eq!(config.resolve_url("css/style.css"), "/static/css/style.css");
	/// ```
	///
	/// With manifest:
	///
	/// ```rust
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	/// use std::collections::HashMap;
	///
	/// let mut manifest = HashMap::new();
	/// manifest.insert("css/style.css".to_string(), "css/style.abc123.css".to_string());
	///
	/// let config = TemplateStaticConfig::new("/static/".to_string())
	///     .with_manifest(manifest);
	///
	/// assert_eq!(config.resolve_url("css/style.css"), "/static/css/style.abc123.css");
	/// ```
	///
	/// With query string and fragment:
	///
	/// ```rust
	/// use reinhardt_utils::staticfiles::template_integration::TemplateStaticConfig;
	///
	/// let config = TemplateStaticConfig::new("/static/".to_string());
	/// assert_eq!(
	///     config.resolve_url("test.css?v=1#section"),
	///     "/static/test.css?v=1#section"
	/// );
	/// ```
	pub fn resolve_url(&self, name: &str) -> String {
		// 1. Split path, query string, and fragment
		let (path, query_fragment) = match name.split_once('?') {
			Some((p, qf)) => (p, Some(qf)),
			None => (name, None),
		};

		// 2. Check manifest for hashed filename
		let resolved_path = if self.use_manifest {
			self.manifest.get(path).map(|s| s.as_str()).unwrap_or(path)
		} else {
			path
		};

		// 3. Normalize and join URL
		let base = self.static_url.trim_end_matches('/');
		let path = resolved_path.trim_start_matches('/');
		let mut url = format!("{}/{}", base, path);

		// 4. Append query string and fragment
		if let Some(qf) = query_fragment {
			url.push('?');
			url.push_str(qf);
		}

		url
	}
}

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

	#[test]
	fn test_template_static_config_new() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(config.static_url, "/static/");
		assert!(!config.use_manifest);
		assert!(config.manifest.is_empty());
	}

	#[test]
	fn test_template_static_config_with_manifest() {
		let mut manifest = HashMap::new();
		manifest.insert(
			"css/style.css".to_string(),
			"css/style.abc123.css".to_string(),
		);

		let config =
			TemplateStaticConfig::new("/static/".to_string()).with_manifest(manifest.clone());

		assert_eq!(config.static_url, "/static/");
		assert!(config.use_manifest);
		assert_eq!(config.manifest.len(), 1);
		assert_eq!(
			config.manifest.get("css/style.css"),
			Some(&"css/style.abc123.css".to_string())
		);
	}

	#[test]
	fn test_template_static_config_from_static_files_config() {
		let static_config = StaticFilesConfig {
			static_root: std::path::PathBuf::from("/var/www/static"),
			static_url: "/assets/".to_string(),
			staticfiles_dirs: vec![],
			media_url: None,
		};

		let template_config = TemplateStaticConfig::from(&static_config);
		assert_eq!(template_config.static_url, "/assets/");
		assert!(!template_config.use_manifest);
		assert!(template_config.manifest.is_empty());
	}

	#[tokio::test]
	async fn test_from_storage() {
		use tempfile::tempdir;

		let temp_dir = tempdir().unwrap();
		let static_root = temp_dir.path().to_path_buf();

		// Create manifest file (canonical format with version and paths)
		let manifest_content = r#"{
  "version": "1.0",
  "paths": {
    "css/style.css": "css/style.abc123.css",
    "js/app.js": "js/app.def456.js"
  }
}"#;

		std::fs::write(static_root.join("staticfiles.json"), manifest_content).unwrap();

		let storage = ManifestStaticFilesStorage::new(static_root, "/static/");
		let config = TemplateStaticConfig::from_storage(&storage).await.unwrap();

		assert_eq!(config.static_url, "/static/");
		assert!(config.use_manifest);
		assert_eq!(config.manifest.len(), 2);
		assert_eq!(
			config.manifest.get("css/style.css"),
			Some(&"css/style.abc123.css".to_string())
		);
		assert_eq!(
			config.manifest.get("js/app.js"),
			Some(&"js/app.def456.js".to_string())
		);
	}

	#[tokio::test]
	async fn test_from_storage_with_version_and_paths() {
		use tempfile::tempdir;

		let temp_dir = tempdir().unwrap();
		let static_root = temp_dir.path().to_path_buf();

		// Canonical format: {"version": "1.0", "paths": {...}}
		let manifest_content = r#"{
  "version": "1.0",
  "paths": {
    "css/style.css": "css/style.abc123.css"
  }
}"#;

		std::fs::write(static_root.join("staticfiles.json"), manifest_content).unwrap();

		let storage = ManifestStaticFilesStorage::new(static_root, "/static/");
		let config = TemplateStaticConfig::from_storage(&storage).await.unwrap();

		assert_eq!(config.static_url, "/static/");
		assert!(config.use_manifest);
		assert_eq!(config.manifest.len(), 1);
		assert_eq!(
			config.manifest.get("css/style.css"),
			Some(&"css/style.abc123.css".to_string())
		);
	}

	#[tokio::test]
	async fn test_from_storage_with_legacy_files_key() {
		use tempfile::tempdir;

		let temp_dir = tempdir().unwrap();
		let static_root = temp_dir.path().to_path_buf();

		// Legacy format: {"version": "1.0", "files": {...}}
		let manifest_content = r#"{
  "version": "1.0",
  "files": {
    "js/app.js": "js/app.def456.js"
  }
}"#;

		std::fs::write(static_root.join("staticfiles.json"), manifest_content).unwrap();

		let storage = ManifestStaticFilesStorage::new(static_root, "/static/");
		let config = TemplateStaticConfig::from_storage(&storage).await.unwrap();

		assert_eq!(config.static_url, "/static/");
		assert!(config.use_manifest);
		assert_eq!(config.manifest.len(), 1);
		assert_eq!(
			config.manifest.get("js/app.js"),
			Some(&"js/app.def456.js".to_string())
		);
	}

	#[test]
	fn test_resolve_url_basic() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(config.resolve_url("css/style.css"), "/static/css/style.css");
	}

	#[test]
	fn test_resolve_url_with_leading_slash() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(
			config.resolve_url("/css/style.css"),
			"/static/css/style.css"
		);
	}

	#[test]
	fn test_resolve_url_with_manifest() {
		let mut manifest = HashMap::new();
		manifest.insert(
			"css/style.css".to_string(),
			"css/style.abc123.css".to_string(),
		);

		let config = TemplateStaticConfig::new("/static/".to_string()).with_manifest(manifest);

		assert_eq!(
			config.resolve_url("css/style.css"),
			"/static/css/style.abc123.css"
		);
	}

	#[test]
	fn test_resolve_url_manifest_fallback() {
		let mut manifest = HashMap::new();
		manifest.insert(
			"css/style.css".to_string(),
			"css/style.abc123.css".to_string(),
		);

		let config = TemplateStaticConfig::new("/static/".to_string()).with_manifest(manifest);

		// File not in manifest should fallback to original path
		assert_eq!(config.resolve_url("js/app.js"), "/static/js/app.js");
	}

	#[test]
	fn test_resolve_url_with_query_string() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(config.resolve_url("test.css?v=1"), "/static/test.css?v=1");
	}

	#[test]
	fn test_resolve_url_with_fragment() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(
			config.resolve_url("test.css#section"),
			"/static/test.css#section"
		);
	}

	#[test]
	fn test_resolve_url_with_query_and_fragment() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(
			config.resolve_url("test.css?v=1#section"),
			"/static/test.css?v=1#section"
		);
	}

	#[test]
	fn test_resolve_url_manifest_with_query_string() {
		let mut manifest = HashMap::new();
		manifest.insert(
			"css/style.css".to_string(),
			"css/style.abc123.css".to_string(),
		);

		let config = TemplateStaticConfig::new("/static/".to_string()).with_manifest(manifest);

		// Manifest lookup should work with query string
		assert_eq!(
			config.resolve_url("css/style.css?v=1"),
			"/static/css/style.abc123.css?v=1"
		);
	}

	#[test]
	fn test_resolve_url_different_base_urls() {
		let config1 = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(config1.resolve_url("test.txt"), "/static/test.txt");

		let config2 = TemplateStaticConfig::new("/static".to_string());
		assert_eq!(config2.resolve_url("test.txt"), "/static/test.txt");

		let config3 = TemplateStaticConfig::new("static/".to_string());
		assert_eq!(config3.resolve_url("test.txt"), "static/test.txt");
	}

	#[test]
	fn test_resolve_url_empty_path() {
		let config = TemplateStaticConfig::new("/static/".to_string());
		assert_eq!(config.resolve_url(""), "/static/");
	}

	#[test]
	fn test_resolve_url_cdn_url() {
		let config = TemplateStaticConfig::new("https://cdn.example.com/static/".to_string());
		assert_eq!(
			config.resolve_url("css/style.css"),
			"https://cdn.example.com/static/css/style.css"
		);
	}
}