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
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
//! Date formatting utilities
//!
//! Provides date and time formatting similar to Django's dateformat module.

use chrono::{DateTime, Datelike, Timelike, Utc, Weekday};

/// Format a datetime using Django-style format string
///
/// # Format Codes
///
/// Common format codes similar to Django/PHP date format:
///
/// - Y: 4-digit year (e.g., 2025)
/// - y: 2-digit year (e.g., 25)
/// - m: Month with leading zero (01-12)
/// - n: Month without leading zero (1-12)
/// - d: Day with leading zero (01-31)
/// - j: Day without leading zero (1-31)
/// - H: Hour in 24-hour format with leading zero (00-23)
/// - i: Minutes with leading zero (00-59)
/// - s: Seconds with leading zero (00-59)
/// - A: AM/PM
/// - l: Full weekday name (e.g., Monday)
/// - F: Full month name (e.g., January)
///
/// # Examples
///
/// ```
/// use reinhardt_utils::utils_core::dateformat::format;
/// use chrono::{TimeZone, Utc};
///
/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
/// assert_eq!(format(&dt, "Y-m-d"), "2025-01-15");
/// assert_eq!(format(&dt, "H:i:s"), "14:30:45");
/// assert_eq!(format(&dt, "l, F j, Y"), "Wednesday, January 15, 2025");
/// ```
pub fn format(dt: &DateTime<Utc>, format_str: &str) -> String {
	let mut result = String::new();
	let mut chars = format_str.chars().peekable();

	while let Some(c) = chars.next() {
		if c == '\\' {
			// Escape character - output next char literally
			if let Some(next) = chars.next() {
				result.push(next);
			}
			continue;
		}

		let replacement = match c {
			// Year
			'Y' => format!("{:04}", dt.year()),
			'y' => format!("{:02}", dt.year() % 100),

			// Month
			'm' => format!("{:02}", dt.month()),
			'n' => dt.month().to_string(),
			'F' => month_name(dt.month()),
			'M' => month_abbr(dt.month()),

			// Day
			'd' => format!("{:02}", dt.day()),
			'j' => dt.day().to_string(),
			'l' => weekday_name(dt.weekday()),
			'D' => weekday_abbr(dt.weekday()),

			// Hour
			'H' => format!("{:02}", dt.hour()),
			'h' => {
				let hour12 = if dt.hour() == 0 || dt.hour() == 12 {
					12
				} else {
					dt.hour() % 12
				};
				format!("{:02}", hour12)
			}
			'G' => dt.hour().to_string(),
			'g' => {
				let hour12 = if dt.hour() == 0 || dt.hour() == 12 {
					12
				} else {
					dt.hour() % 12
				};
				hour12.to_string()
			}

			// Minute
			'i' => format!("{:02}", dt.minute()),

			// Second
			's' => format!("{:02}", dt.second()),

			// AM/PM
			'A' => if dt.hour() < 12 { "AM" } else { "PM" }.to_string(),
			'a' => if dt.hour() < 12 { "am" } else { "pm" }.to_string(),

			// Default: output character as-is
			_ => c.to_string(),
		};

		result.push_str(&replacement);
	}

	result
}

/// Get full month name
fn month_name(month: u32) -> String {
	match month {
		1 => "January",
		2 => "February",
		3 => "March",
		4 => "April",
		5 => "May",
		6 => "June",
		7 => "July",
		8 => "August",
		9 => "September",
		10 => "October",
		11 => "November",
		12 => "December",
		_ => "Unknown",
	}
	.to_string()
}

/// Get abbreviated month name
fn month_abbr(month: u32) -> String {
	match month {
		1 => "Jan",
		2 => "Feb",
		3 => "Mar",
		4 => "Apr",
		5 => "May",
		6 => "Jun",
		7 => "Jul",
		8 => "Aug",
		9 => "Sep",
		10 => "Oct",
		11 => "Nov",
		12 => "Dec",
		_ => "Unk",
	}
	.to_string()
}

/// Get full weekday name
fn weekday_name(weekday: Weekday) -> String {
	match weekday {
		Weekday::Mon => "Monday",
		Weekday::Tue => "Tuesday",
		Weekday::Wed => "Wednesday",
		Weekday::Thu => "Thursday",
		Weekday::Fri => "Friday",
		Weekday::Sat => "Saturday",
		Weekday::Sun => "Sunday",
	}
	.to_string()
}

/// Get abbreviated weekday name
fn weekday_abbr(weekday: Weekday) -> String {
	match weekday {
		Weekday::Mon => "Mon",
		Weekday::Tue => "Tue",
		Weekday::Wed => "Wed",
		Weekday::Thu => "Thu",
		Weekday::Fri => "Fri",
		Weekday::Sat => "Sat",
		Weekday::Sun => "Sun",
	}
	.to_string()
}

/// Common date format shortcuts
pub mod shortcuts {
	use super::*;
	/// ISO 8601 format: YYYY-MM-DD
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::iso_date;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(iso_date(&dt), "2025-01-15");
	/// ```
	pub fn iso_date(dt: &DateTime<Utc>) -> String {
		format(dt, "Y-m-d")
	}
	/// ISO 8601 datetime: YYYY-MM-DD HH:MM:SS
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::iso_datetime;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(iso_datetime(&dt), "2025-01-15 14:30:45");
	/// ```
	pub fn iso_datetime(dt: &DateTime<Utc>) -> String {
		format(dt, "Y-m-d H:i:s")
	}
	/// US date format: MM/DD/YYYY
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::us_date;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(us_date(&dt), "01/15/2025");
	/// ```
	pub fn us_date(dt: &DateTime<Utc>) -> String {
		format(dt, "m/d/Y")
	}
	/// European date format: DD/MM/YYYY
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::eu_date;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(eu_date(&dt), "15/01/2025");
	/// ```
	pub fn eu_date(dt: &DateTime<Utc>) -> String {
		format(dt, "d/m/Y")
	}
	/// Full text date: Monday, January 1, 2025
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::full_date;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// let full = full_date(&dt);
	/// assert!(full.contains("Wednesday"));
	/// assert!(full.contains("January"));
	/// assert!(full.contains("15"));
	/// assert!(full.contains("2025"));
	/// ```
	pub fn full_date(dt: &DateTime<Utc>) -> String {
		format(dt, "l, F j, Y")
	}
	/// Short text date: Jan 1, 2025
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::short_date;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// let short = short_date(&dt);
	/// assert!(short.contains("Jan"));
	/// assert!(short.contains("15"));
	/// assert!(short.contains("2025"));
	/// ```
	pub fn short_date(dt: &DateTime<Utc>) -> String {
		format(dt, "M j, Y")
	}
	/// Time 24-hour: 14:30:00
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::time_24;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(time_24(&dt), "14:30:45");
	/// ```
	pub fn time_24(dt: &DateTime<Utc>) -> String {
		format(dt, "H:i:s")
	}
	/// Time 12-hour: 2:30:00 PM
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_utils::utils_core::dateformat::shortcuts::time_12;
	/// use chrono::{TimeZone, Utc};
	///
	/// let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
	/// assert_eq!(time_12(&dt), "2:30:45 PM");
	/// ```
	pub fn time_12(dt: &DateTime<Utc>) -> String {
		format(dt, "g:i:s A")
	}
}

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

	#[test]
	fn test_year_formats() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();

		assert_eq!(format(&dt, "Y"), "2025");
		assert_eq!(format(&dt, "y"), "25");
	}

	#[test]
	fn test_month_formats() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();

		assert_eq!(format(&dt, "m"), "01");
		assert_eq!(format(&dt, "n"), "1");
		assert_eq!(format(&dt, "F"), "January");
		assert_eq!(format(&dt, "M"), "Jan");
	}

	#[test]
	fn test_day_formats() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 5, 14, 30, 45).unwrap();

		assert_eq!(format(&dt, "d"), "05");
		assert_eq!(format(&dt, "j"), "5");
	}

	#[test]
	fn test_time_formats() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 5, 9).unwrap();

		assert_eq!(format(&dt, "H:i:s"), "14:05:09");
		assert_eq!(format(&dt, "g:i:s A"), "2:05:09 PM");
	}

	#[test]
	fn test_shortcuts() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();

		assert_eq!(shortcuts::iso_date(&dt), "2025-01-15");
		assert_eq!(shortcuts::iso_datetime(&dt), "2025-01-15 14:30:45");
		assert_eq!(shortcuts::us_date(&dt), "01/15/2025");
		assert_eq!(shortcuts::eu_date(&dt), "15/01/2025");
	}

	#[test]
	fn test_escape_character() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();

		assert_eq!(format(&dt, "Y\\Y"), "2025Y");
		assert_eq!(format(&dt, "\\d\\a\\y"), "day");
	}

	#[test]
	fn test_12_hour_formats() {
		let dt_afternoon = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
		let dt_midnight = Utc.with_ymd_and_hms(2025, 1, 15, 0, 30, 45).unwrap();
		let dt_noon = Utc.with_ymd_and_hms(2025, 1, 15, 12, 30, 45).unwrap();

		// h format (01-12 with leading zero)
		assert_eq!(format(&dt_afternoon, "h"), "02");
		assert_eq!(format(&dt_midnight, "h"), "12");
		assert_eq!(format(&dt_noon, "h"), "12");

		// g format (1-12 without leading zero)
		assert_eq!(format(&dt_afternoon, "g"), "2");
		assert_eq!(format(&dt_midnight, "g"), "12");
		assert_eq!(format(&dt_noon, "g"), "12");

		// G format (0-23 without leading zero)
		assert_eq!(format(&dt_afternoon, "G"), "14");
		assert_eq!(format(&dt_midnight, "G"), "0");
		assert_eq!(format(&dt_noon, "G"), "12");
	}

	#[test]
	fn test_weekday_formats() {
		let monday = Utc.with_ymd_and_hms(2025, 1, 13, 14, 30, 45).unwrap(); // Monday
		let friday = Utc.with_ymd_and_hms(2025, 1, 17, 14, 30, 45).unwrap(); // Friday
		let sunday = Utc.with_ymd_and_hms(2025, 1, 19, 14, 30, 45).unwrap(); // Sunday

		// l format (full weekday name)
		assert_eq!(format(&monday, "l"), "Monday");
		assert_eq!(format(&friday, "l"), "Friday");
		assert_eq!(format(&sunday, "l"), "Sunday");

		// D format (abbreviated weekday name)
		assert_eq!(format(&monday, "D"), "Mon");
		assert_eq!(format(&friday, "D"), "Fri");
		assert_eq!(format(&sunday, "D"), "Sun");
	}

	#[test]
	fn test_all_month_names() {
		for month in 1..=12 {
			let dt = Utc.with_ymd_and_hms(2025, month, 15, 14, 30, 45).unwrap();
			let full_name = format(&dt, "F");
			let abbr_name = format(&dt, "M");

			// Verify they are not empty
			assert!(!full_name.is_empty());
			assert!(!abbr_name.is_empty());
			assert_ne!(full_name, "Unknown");
			assert_ne!(abbr_name, "Unk");
		}
	}

	#[test]
	fn test_all_weekday_names() {
		// Test a full week (Jan 13-19, 2025 is Mon-Sun)
		for day in 13..=19 {
			let dt = Utc.with_ymd_and_hms(2025, 1, day, 14, 30, 45).unwrap();
			let full_name = format(&dt, "l");
			let abbr_name = format(&dt, "D");

			// Verify they are not empty
			assert!(!full_name.is_empty());
			assert!(!abbr_name.is_empty());
		}
	}

	#[test]
	fn test_am_pm_formats() {
		let morning = Utc.with_ymd_and_hms(2025, 1, 15, 9, 30, 45).unwrap();
		let evening = Utc.with_ymd_and_hms(2025, 1, 15, 21, 30, 45).unwrap();

		// A format (uppercase AM/PM)
		assert_eq!(format(&morning, "A"), "AM");
		assert_eq!(format(&evening, "A"), "PM");

		// a format (lowercase am/pm)
		assert_eq!(format(&morning, "a"), "am");
		assert_eq!(format(&evening, "a"), "pm");
	}

	#[test]
	fn test_shortcuts_full_date() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
		let full = shortcuts::full_date(&dt);
		assert!(full.contains("Wednesday"));
		assert!(full.contains("January"));
		assert!(full.contains("15"));
		assert!(full.contains("2025"));
	}

	#[test]
	fn test_shortcuts_short_date() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
		let short = shortcuts::short_date(&dt);
		assert!(short.contains("Jan"));
		assert!(short.contains("15"));
		assert!(short.contains("2025"));
	}

	#[test]
	fn test_shortcuts_time_formats() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();

		assert_eq!(shortcuts::time_24(&dt), "14:30:45");
		assert_eq!(shortcuts::time_12(&dt), "2:30:45 PM");
	}

	#[test]
	fn test_combined_format() {
		let dt = Utc.with_ymd_and_hms(2025, 1, 15, 14, 30, 45).unwrap();
		let result = format(&dt, "l, F j, Y - g:i A");
		assert!(result.contains("Wednesday"));
		assert!(result.contains("January"));
		assert!(result.contains("15"));
		assert!(result.contains("2025"));
		assert!(result.contains("2:30"));
		assert!(result.contains("PM"));
	}
}

#[cfg(test)]
mod proptests {
	use super::*;
	use chrono::TimeZone;
	use proptest::prelude::*;

	proptest! {
		#[test]
		fn prop_year_format_4_digits(year in 1000i32..9999i32, month in 1u32..=12, day in 1u32..=28) {
			let dt = Utc.with_ymd_and_hms(year, month, day, 12, 0, 0).unwrap();
			let result = format(&dt, "Y");
			assert_eq!(result.len(), 4);
			assert!(result.chars().all(|c| c.is_ascii_digit()));
			assert_eq!(result.parse::<i32>().unwrap(), year);
		}

		#[test]
		fn prop_month_format_range(year in 2000i32..2100, month in 1u32..=12, day in 1u32..=28) {
			let dt = Utc.with_ymd_and_hms(year, month, day, 12, 0, 0).unwrap();
		let result = format(&dt, "m");
		assert_eq!(result.len(), 2);
		let month_val = result.parse::<u32>().unwrap();
		assert!((1..=12).contains(&month_val));
		assert_eq!(month_val, month);
		}

		#[test]
		fn prop_day_format_range(year in 2000i32..2100, month in 1u32..=12, day in 1u32..=28) {
			let dt = Utc.with_ymd_and_hms(year, month, day, 12, 0, 0).unwrap();
		let result = format(&dt, "d");
		assert_eq!(result.len(), 2);
		let day_val = result.parse::<u32>().unwrap();
		assert!((1..=31).contains(&day_val));
		assert_eq!(day_val, day);
		}

		#[test]
		fn prop_hour_format_range(year in 2000i32..2100, hour in 0u32..=23) {
			let dt = Utc.with_ymd_and_hms(year, 1, 1, hour, 0, 0).unwrap();
			let result = format(&dt, "H");
			assert_eq!(result.len(), 2);
			let hour_val = result.parse::<u32>().unwrap();
			assert!(hour_val <= 23);
			assert_eq!(hour_val, hour);
		}

		#[test]
		fn prop_minute_format_range(year in 2000i32..2100, minute in 0u32..=59) {
			let dt = Utc.with_ymd_and_hms(year, 1, 1, 12, minute, 0).unwrap();
			let result = format(&dt, "i");
			assert_eq!(result.len(), 2);
			let minute_val = result.parse::<u32>().unwrap();
			assert!(minute_val <= 59);
			assert_eq!(minute_val, minute);
		}

		#[test]
		fn prop_second_format_range(year in 2000i32..2100, second in 0u32..=59) {
			let dt = Utc.with_ymd_and_hms(year, 1, 1, 12, 0, second).unwrap();
			let result = format(&dt, "s");
			assert_eq!(result.len(), 2);
			let second_val = result.parse::<u32>().unwrap();
			assert!(second_val <= 59);
			assert_eq!(second_val, second);
		}

		#[test]
		fn prop_escape_character(year in 2000i32..2100, c in "\\PC") {
			let dt = Utc.with_ymd_and_hms(year, 1, 1, 12, 0, 0).unwrap();
			let format_str = format!("\\{}", c);
			let result = format(&dt, &format_str);
			assert_eq!(result, c.to_string());
		}

		#[test]
		fn prop_shortcuts_valid_lengths(year in 2000i32..2100, month in 1u32..=12, day in 1u32..=28, hour in 0u32..=23, minute in 0u32..=59, second in 0u32..=59) {
			let dt = Utc.with_ymd_and_hms(year, month, day, hour, minute, second).unwrap();

			// ISO date is always 10 chars: YYYY-MM-DD
			assert_eq!(shortcuts::iso_date(&dt).len(), 10);

			// ISO datetime is always 19 chars: YYYY-MM-DD HH:MM:SS
			assert_eq!(shortcuts::iso_datetime(&dt).len(), 19);

			// US date is always 10 chars: MM/DD/YYYY
			assert_eq!(shortcuts::us_date(&dt).len(), 10);

			// EU date is always 10 chars: DD/MM/YYYY
			assert_eq!(shortcuts::eu_date(&dt).len(), 10);

			// Time 24 is always 8 chars: HH:MM:SS
			assert_eq!(shortcuts::time_24(&dt).len(), 8);

			// Time 12 format has variable length due to AM/PM and hour without leading zero
			let time_12 = shortcuts::time_12(&dt);
			assert!(time_12.len() >= 10 && time_12.len() <= 11);
		}
	}
}