reinhardt-forms 0.1.0-rc.15

Form handling and validation
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
use crate::form::Form;
use std::collections::HashMap;

/// FormSet manages multiple forms
pub struct FormSet {
	forms: Vec<Form>,
	prefix: String,
	can_delete: bool,
	can_order: bool,
	extra: usize,
	max_num: Option<usize>,
	min_num: usize,
	errors: Vec<String>,
}

impl FormSet {
	/// Create a new FormSet with the given prefix
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_forms::FormSet;
	///
	/// let formset = FormSet::new("form".to_string());
	/// assert_eq!(formset.prefix(), "form");
	/// assert!(!formset.can_delete());
	/// ```
	pub fn new(prefix: String) -> Self {
		// Normalize: strip trailing delimiter so that `format!("{}-", prefix)`
		// in `process_data` never produces a double-dash (e.g. "form--")
		let prefix = prefix
			.strip_suffix('-')
			.map_or(prefix.clone(), |s| s.to_owned());
		Self {
			forms: vec![],
			prefix,
			can_delete: false,
			can_order: false,
			extra: 1,
			max_num: Some(1000),
			min_num: 0,
			errors: vec![],
		}
	}

	/// Returns the prefix used for form field naming.
	pub fn prefix(&self) -> &str {
		&self.prefix
	}

	/// Returns whether forms in this set can be deleted.
	pub fn can_delete(&self) -> bool {
		self.can_delete
	}
	/// Sets the number of extra empty forms to include.
	pub fn with_extra(mut self, extra: usize) -> Self {
		self.extra = extra;
		self
	}
	/// Enables or disables form deletion within this set.
	pub fn with_can_delete(mut self, can_delete: bool) -> Self {
		self.can_delete = can_delete;
		self
	}
	/// Enables or disables ordering of forms within this set.
	pub fn with_can_order(mut self, can_order: bool) -> Self {
		self.can_order = can_order;
		self
	}
	/// Sets the maximum number of forms allowed.
	pub fn with_max_num(mut self, max_num: Option<usize>) -> Self {
		self.max_num = max_num;
		self
	}
	/// Sets the minimum number of forms required for validation.
	pub fn with_min_num(mut self, min_num: usize) -> Self {
		self.min_num = min_num;
		self
	}
	/// Add a form to the formset.
	///
	/// Returns an error if adding the form would exceed `max_num`.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_forms::{FormSet, Form};
	///
	/// let mut formset = FormSet::new("form".to_string());
	/// let form = Form::new();
	/// assert!(formset.add_form(form).is_ok());
	/// assert_eq!(formset.forms().len(), 1);
	/// ```
	///
	/// ```
	/// use reinhardt_forms::{FormSet, Form};
	///
	/// let mut formset = FormSet::new("form".to_string()).with_max_num(Some(1));
	/// assert!(formset.add_form(Form::new()).is_ok());
	/// assert!(formset.add_form(Form::new()).is_err());
	/// ```
	pub fn add_form(&mut self, form: Form) -> Result<(), String> {
		if let Some(max) = self.max_num
			&& self.forms.len() >= max
		{
			return Err(format!(
				"Cannot add form: maximum number of forms ({}) reached",
				max
			));
		}
		self.forms.push(form);
		Ok(())
	}
	/// Returns a slice of all forms in this set.
	pub fn forms(&self) -> &[Form] {
		&self.forms
	}
	/// Returns a mutable reference to the forms vector.
	pub fn forms_mut(&mut self) -> &mut Vec<Form> {
		&mut self.forms
	}
	/// Returns the number of forms currently in this set.
	pub fn form_count(&self) -> usize {
		self.forms.len()
	}
	/// Returns the total form count including extra empty forms.
	pub fn total_form_count(&self) -> usize {
		self.forms.len() + self.extra
	}
	/// Validate all forms in the formset
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_forms::{FormSet, Form};
	///
	/// let mut formset = FormSet::new("form".to_string());
	/// formset.add_form(Form::new()).unwrap();
	// Note: is_valid() requires mutable reference
	// let is_valid = formset.is_valid();
	/// ```
	pub fn is_valid(&mut self) -> bool {
		self.errors.clear();

		// Validate individual forms
		let mut all_valid = true;
		for form in &mut self.forms {
			if !form.is_valid() {
				all_valid = false;
			}
		}

		// Check minimum number
		if self.forms.len() < self.min_num {
			self.errors
				.push(format!("Please submit at least {} forms", self.min_num));
			all_valid = false;
		}

		// Check maximum number
		if let Some(max) = self.max_num
			&& self.forms.len() > max
		{
			self.errors
				.push(format!("Please submit no more than {} forms", max));
			all_valid = false;
		}

		all_valid && self.errors.is_empty()
	}
	/// Returns the formset-level validation errors.
	pub fn errors(&self) -> &[String] {
		&self.errors
	}
	/// Returns cleaned data from all forms in the set.
	pub fn cleaned_data(&self) -> Vec<&HashMap<String, serde_json::Value>> {
		self.forms.iter().map(|f| f.cleaned_data()).collect()
	}
	/// Get management form data (for tracking forms in HTML)
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_forms::FormSet;
	///
	/// let formset = FormSet::new("form".to_string());
	/// let data = formset.management_form_data();
	/// assert!(data.contains_key("form-TOTAL_FORMS"));
	/// ```
	pub fn management_form_data(&self) -> HashMap<String, String> {
		let mut data = HashMap::new();
		data.insert(
			format!("{}-TOTAL_FORMS", self.prefix),
			self.total_form_count().to_string(),
		);
		data.insert(
			format!("{}-INITIAL_FORMS", self.prefix),
			self.forms.len().to_string(),
		);
		data.insert(
			format!("{}-MIN_NUM_FORMS", self.prefix),
			self.min_num.to_string(),
		);
		if let Some(max) = self.max_num {
			data.insert(format!("{}-MAX_NUM_FORMS", self.prefix), max.to_string());
		}
		data
	}
	/// Process bound data from HTML forms.
	///
	/// Respects `max_num` and silently stops adding forms once the limit is reached.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_forms::FormSet;
	/// use std::collections::HashMap;
	/// use serde_json::json;
	///
	/// let mut formset = FormSet::new("form".to_string());
	/// let mut data = HashMap::new();
	/// let mut form_data = HashMap::new();
	/// form_data.insert("field".to_string(), json!("value"));
	/// data.insert("form-0".to_string(), form_data);
	///
	/// formset.process_data(&data);
	/// assert_eq!(formset.form_count(), 1);
	/// ```
	pub fn process_data(&mut self, data: &HashMap<String, HashMap<String, serde_json::Value>>) {
		self.forms.clear();

		// Sort keys for deterministic ordering when max_num limit is applied
		let mut keys: Vec<&String> = data.keys().collect();
		keys.sort();

		// Each form should have a key like "form-0", "form-1", etc.
		// Use exact prefix matching with delimiter to prevent collisions
		// (e.g., prefix "item" should not match "item_extra-0")
		let prefix_with_delimiter = format!("{}-", self.prefix);
		for key in keys {
			if key.starts_with(&prefix_with_delimiter) {
				// Enforce max_num limit during data processing
				if let Some(max) = self.max_num
					&& self.forms.len() >= max
				{
					break;
				}
				if let Some(form_data) = data.get(key) {
					let mut form = Form::new();
					form.bind(form_data.clone());
					self.forms.push(form);
				}
			}
		}
	}
}

impl Default for FormSet {
	fn default() -> Self {
		Self::new("form".to_string())
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::fields::CharField;
	use rstest::rstest;

	#[test]
	fn test_formset_basic() {
		let mut formset = FormSet::new("person".to_string());

		let mut form1 = Form::new();
		form1.add_field(Box::new(CharField::new("name".to_string())));

		let mut form2 = Form::new();
		form2.add_field(Box::new(CharField::new("name".to_string())));

		formset.add_form(form1).unwrap();
		formset.add_form(form2).unwrap();

		assert_eq!(formset.form_count(), 2);
	}

	#[test]
	fn test_formset_min_num_validation() {
		let mut formset = FormSet::new("person".to_string()).with_min_num(2);

		let mut form1 = Form::new();
		form1.add_field(Box::new(CharField::new("name".to_string())));
		formset.add_form(form1).unwrap();

		assert!(!formset.is_valid());
		assert!(!formset.errors().is_empty());
	}

	#[test]
	fn test_formset_max_num_enforced_on_add() {
		let mut formset = FormSet::new("person".to_string()).with_max_num(Some(2));

		let mut form1 = Form::new();
		form1.add_field(Box::new(CharField::new("name".to_string())));
		assert!(formset.add_form(form1).is_ok());

		let mut form2 = Form::new();
		form2.add_field(Box::new(CharField::new("name".to_string())));
		assert!(formset.add_form(form2).is_ok());

		// Third form should be rejected
		let mut form3 = Form::new();
		form3.add_field(Box::new(CharField::new("name".to_string())));
		assert!(formset.add_form(form3).is_err());

		assert_eq!(formset.form_count(), 2);
	}

	#[rstest]
	fn test_process_data_basic_two_forms() {
		// Arrange
		let mut formset = FormSet::new("form".to_string());
		let mut data = HashMap::new();

		let mut form0_data = HashMap::new();
		form0_data.insert("name".to_string(), serde_json::json!("Alice"));
		data.insert("form-0".to_string(), form0_data);

		let mut form1_data = HashMap::new();
		form1_data.insert("name".to_string(), serde_json::json!("Bob"));
		data.insert("form-1".to_string(), form1_data);

		// Act
		formset.process_data(&data);

		// Assert
		assert_eq!(formset.form_count(), 2);
	}

	#[rstest]
	fn test_process_data_deterministic_ordering() {
		// Arrange
		let mut formset = FormSet::new("form".to_string());
		let mut data = HashMap::new();

		// Insert in reverse order to verify sorting
		let mut form2_data = HashMap::new();
		form2_data.insert("name".to_string(), serde_json::json!("Charlie"));
		data.insert("form-2".to_string(), form2_data);

		let mut form0_data = HashMap::new();
		form0_data.insert("name".to_string(), serde_json::json!("Alice"));
		data.insert("form-0".to_string(), form0_data);

		let mut form1_data = HashMap::new();
		form1_data.insert("name".to_string(), serde_json::json!("Bob"));
		data.insert("form-1".to_string(), form1_data);

		// Act
		formset.process_data(&data);

		// Assert
		assert_eq!(formset.form_count(), 3);
		let cleaned: Vec<_> = formset.cleaned_data();
		assert_eq!(cleaned[0].get("name"), Some(&serde_json::json!("Alice")));
		assert_eq!(cleaned[1].get("name"), Some(&serde_json::json!("Bob")));
		assert_eq!(cleaned[2].get("name"), Some(&serde_json::json!("Charlie")));
	}

	#[rstest]
	fn test_process_data_max_num_constraint() {
		// Arrange
		let mut formset = FormSet::new("form".to_string()).with_max_num(Some(2));
		let mut data = HashMap::new();

		for i in 0..5 {
			let mut form_data = HashMap::new();
			form_data.insert("name".to_string(), serde_json::json!(format!("User{}", i)));
			data.insert(format!("form-{}", i), form_data);
		}

		// Act
		formset.process_data(&data);

		// Assert
		assert_eq!(formset.form_count(), 2);
	}

	#[rstest]
	fn test_process_data_prefix_mismatch_keys_ignored() {
		// Arrange
		let mut formset = FormSet::new("person".to_string());
		let mut data = HashMap::new();

		let mut matching = HashMap::new();
		matching.insert("name".to_string(), serde_json::json!("Alice"));
		data.insert("person-0".to_string(), matching);

		let mut mismatched = HashMap::new();
		mismatched.insert("name".to_string(), serde_json::json!("Bob"));
		data.insert("form-0".to_string(), mismatched);

		// Act
		formset.process_data(&data);

		// Assert
		assert_eq!(formset.form_count(), 1);
		let cleaned = formset.cleaned_data();
		assert_eq!(cleaned[0].get("name"), Some(&serde_json::json!("Alice")));
	}

	#[rstest]
	fn test_process_data_prefix_collision_prevented() {
		// Arrange: prefix "item" should NOT match "item_extra-0"
		let mut formset = FormSet::new("item".to_string());
		let mut data = HashMap::new();

		let mut matching = HashMap::new();
		matching.insert("name".to_string(), serde_json::json!("Apple"));
		data.insert("item-0".to_string(), matching);

		let mut colliding = HashMap::new();
		colliding.insert("name".to_string(), serde_json::json!("Banana"));
		data.insert("item_extra-0".to_string(), colliding);

		// Act
		formset.process_data(&data);

		// Assert: only "item-0" should be processed, not "item_extra-0"
		assert_eq!(formset.form_count(), 1);
		let cleaned = formset.cleaned_data();
		assert_eq!(cleaned[0].get("name"), Some(&serde_json::json!("Apple")));
	}

	#[rstest]
	fn test_process_data_similar_prefix_no_collision() {
		// Arrange: prefix "form" should NOT match "formset-0" or "form2-0"
		let mut formset = FormSet::new("form".to_string());
		let mut data = HashMap::new();

		let mut matching = HashMap::new();
		matching.insert("name".to_string(), serde_json::json!("Valid"));
		data.insert("form-0".to_string(), matching);

		let mut similar1 = HashMap::new();
		similar1.insert("name".to_string(), serde_json::json!("Invalid1"));
		data.insert("formset-0".to_string(), similar1);

		let mut similar2 = HashMap::new();
		similar2.insert("name".to_string(), serde_json::json!("Invalid2"));
		data.insert("form2-0".to_string(), similar2);

		// Act
		formset.process_data(&data);

		// Assert: only "form-0" should be processed
		assert_eq!(formset.form_count(), 1);
		let cleaned = formset.cleaned_data();
		assert_eq!(cleaned[0].get("name"), Some(&serde_json::json!("Valid")));
	}

	#[test]
	fn test_forms_formset_management_data() {
		let formset = FormSet::new("person".to_string())
			.with_extra(3)
			.with_min_num(1)
			.with_max_num(Some(10));

		let mgmt_data = formset.management_form_data();

		assert_eq!(mgmt_data.get("person-TOTAL_FORMS"), Some(&"3".to_string()));
		assert_eq!(
			mgmt_data.get("person-INITIAL_FORMS"),
			Some(&"0".to_string())
		);
		assert_eq!(
			mgmt_data.get("person-MIN_NUM_FORMS"),
			Some(&"1".to_string())
		);
		assert_eq!(
			mgmt_data.get("person-MAX_NUM_FORMS"),
			Some(&"10".to_string())
		);
	}
}