domainstack 1.1.1

Write validation once, use everywhere: Rust rules auto-generate JSON Schema + OpenAPI + TypeScript/Zod. WASM browser validation. Axum/Actix/Rocket adapters.
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
use crate::{Path, RuleContext, ValidationError};
use std::sync::Arc;

type RuleFn<T> = Arc<dyn Fn(&T, &RuleContext) -> ValidationError + Send + Sync>;

/// A composable validation rule for values of type `T`.
///
/// Rules are the building blocks of domainstack's validation system. They can be composed
/// using `and()`, `or()`, `not()`, and `when()` to create complex validation logic.
///
/// Rules now receive a `RuleContext` providing field information for better error messages.
///
/// # Examples
///
/// ## Basic Rule
///
/// ```
/// use domainstack::prelude::*;
///
/// let rule = rules::min_len(3);
/// let ctx = RuleContext::root("username");
/// assert!(rule.apply_with_context("alice", &ctx).is_empty());
/// assert!(!rule.apply_with_context("ab", &ctx).is_empty());
/// ```
///
/// ## Composing Rules
///
/// ```
/// use domainstack::prelude::*;
///
/// // Username must be 3-20 characters and alphanumeric
/// let rule = rules::min_len(3)
///     .and(rules::max_len(20))
///     .and(rules::alphanumeric());
///
/// let ctx = RuleContext::root("username");
/// assert!(rule.apply_with_context("alice123", &ctx).is_empty());
/// assert!(!rule.apply_with_context("ab", &ctx).is_empty());  // too short
/// ```
///
/// ## Custom Rules with Context
///
/// ```
/// use domainstack::{Rule, RuleContext, ValidationError, Path};
///
/// fn lowercase_only() -> Rule<str> {
///     Rule::new(|value: &str, ctx: &RuleContext| {
///         if value.chars().all(|c| c.is_lowercase() || !c.is_alphabetic()) {
///             ValidationError::default()
///         } else {
///             ValidationError::single(
///                 ctx.full_path(),
///                 "not_lowercase",
///                 "Must contain only lowercase letters"
///             )
///         }
///     })
/// }
///
/// let rule = lowercase_only();
/// let ctx = RuleContext::root("username");
/// assert!(rule.apply_with_context("hello", &ctx).is_empty());
/// assert!(!rule.apply_with_context("Hello", &ctx).is_empty());
/// ```
pub struct Rule<T: ?Sized> {
    inner: RuleFn<T>,
}

impl<T: ?Sized> Clone for Rule<T> {
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

impl<T: ?Sized> std::fmt::Debug for Rule<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("Rule { <validation closure> }")
    }
}

impl<T: ?Sized + 'static> Rule<T> {
    /// Creates a new validation rule.
    ///
    /// Rules receive both the value to validate and a `RuleContext` providing
    /// field information for better error messages.
    pub fn new<F>(f: F) -> Self
    where
        F: Fn(&T, &RuleContext) -> ValidationError + Send + Sync + 'static,
    {
        Self { inner: Arc::new(f) }
    }

    /// Applies the rule with an anonymous context.
    ///
    /// For better error messages, use `apply_with_context()` instead.
    pub fn apply(&self, value: &T) -> ValidationError {
        self.apply_with_context(value, &RuleContext::anonymous())
    }

    /// Applies the rule with a specific context for field-aware error messages.
    pub fn apply_with_context(&self, value: &T, ctx: &RuleContext) -> ValidationError {
        (self.inner)(value, ctx)
    }

    /// Customize the error code for validation failures.
    ///
    /// # Examples
    ///
    /// ```
    /// use domainstack::prelude::*;
    ///
    /// let rule = rules::min_len(5).code("email_too_short");
    /// let err = rule.apply("hi");
    /// assert_eq!(err.violations[0].code, "email_too_short");
    /// ```
    pub fn code(self, code: &'static str) -> Rule<T> {
        Rule::new(move |value: &T, ctx: &RuleContext| {
            let mut err = self.apply_with_context(value, ctx);
            for violation in &mut err.violations {
                violation.code = code;
            }
            err
        })
    }

    /// Customize the error message for validation failures.
    ///
    /// # Examples
    ///
    /// ```
    /// use domainstack::prelude::*;
    ///
    /// let rule = rules::min_len(5).message("Email too short");
    /// let err = rule.apply("hi");
    /// assert_eq!(err.violations[0].message, "Email too short");
    /// ```
    pub fn message(self, msg: impl Into<String> + Clone + Send + Sync + 'static) -> Rule<T> {
        Rule::new(move |value: &T, ctx: &RuleContext| {
            let mut err = self.apply_with_context(value, ctx);
            let message = msg.clone().into();
            for violation in &mut err.violations {
                violation.message = message.clone();
            }
            err
        })
    }

    /// Add metadata to validation errors.
    ///
    /// # Examples
    ///
    /// ```
    /// use domainstack::prelude::*;
    ///
    /// let rule = rules::min_len(5)
    ///     .meta("hint", "Use at least 5 characters");
    ///
    /// let err = rule.apply("hi");
    /// assert_eq!(err.violations[0].meta.get("hint"), Some("Use at least 5 characters"));
    /// ```
    pub fn meta(
        self,
        key: &'static str,
        value: impl Into<String> + Clone + Send + Sync + 'static,
    ) -> Rule<T> {
        Rule::new(move |val: &T, ctx: &RuleContext| {
            let mut err = self.apply_with_context(val, ctx);
            let v = value.clone().into();
            for violation in &mut err.violations {
                violation.meta.insert(key, v.clone());
            }
            err
        })
    }

    pub fn and(self, other: Rule<T>) -> Rule<T> {
        Rule::new(move |value, ctx| {
            let mut err = self.apply_with_context(value, ctx);
            err.extend(other.apply_with_context(value, ctx));
            err
        })
    }

    pub fn or(self, other: Rule<T>) -> Rule<T> {
        Rule::new(move |value, ctx| {
            let err1 = self.apply_with_context(value, ctx);
            if err1.is_empty() {
                return err1;
            }
            let err2 = other.apply_with_context(value, ctx);
            if err2.is_empty() {
                return err2;
            }
            let mut combined = err1;
            combined.extend(err2);
            combined
        })
    }

    pub fn not(self, code: &'static str, message: &'static str) -> Rule<T> {
        Rule::new(move |value, ctx| {
            let err = self.apply_with_context(value, ctx);
            if err.is_empty() {
                ValidationError::single(ctx.full_path(), code, message)
            } else {
                ValidationError::default()
            }
        })
    }

    pub fn map_path(self, prefix: impl Into<Path> + Clone + Send + Sync + 'static) -> Rule<T> {
        Rule::new(move |value, ctx| {
            let err = self.apply_with_context(value, ctx);
            if err.is_empty() {
                return err;
            }
            let mut prefixed = ValidationError::default();
            prefixed.merge_prefixed(prefix.clone(), err);
            prefixed
        })
    }

    pub fn when<F>(self, predicate: F) -> Rule<T>
    where
        F: Fn() -> bool + Send + Sync + 'static,
    {
        Rule::new(move |value, ctx| {
            if predicate() {
                self.apply_with_context(value, ctx)
            } else {
                ValidationError::default()
            }
        })
    }
}

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

    fn positive_rule() -> Rule<i32> {
        Rule::new(|value: &i32, ctx: &RuleContext| {
            if *value >= 0 {
                ValidationError::default()
            } else {
                ValidationError::single(ctx.full_path(), "negative", "Must be positive")
            }
        })
    }

    fn even_rule() -> Rule<i32> {
        Rule::new(|value: &i32, ctx: &RuleContext| {
            if *value % 2 == 0 {
                ValidationError::default()
            } else {
                ValidationError::single(ctx.full_path(), "odd", "Must be even")
            }
        })
    }

    #[test]
    fn test_rule_new_and_apply() {
        let rule = positive_rule();

        let result = rule.apply(&5);
        assert!(result.is_empty());

        let result = rule.apply(&-5);
        assert!(!result.is_empty());
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].code, "negative");
    }

    #[test]
    fn test_rule_and_both_pass() {
        let rule = positive_rule().and(even_rule());

        let result = rule.apply(&4);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_and_first_fails() {
        let rule = positive_rule().and(even_rule());

        let result = rule.apply(&-2);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].code, "negative");
    }

    #[test]
    fn test_rule_and_second_fails() {
        let rule = positive_rule().and(even_rule());

        let result = rule.apply(&3);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].code, "odd");
    }

    #[test]
    fn test_rule_and_both_fail() {
        let rule = positive_rule().and(even_rule());

        let result = rule.apply(&-3);
        assert_eq!(result.violations.len(), 2);
    }

    #[test]
    fn test_rule_or_both_pass() {
        let rule = positive_rule().or(even_rule());

        let result = rule.apply(&4);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_or_first_passes() {
        let rule = positive_rule().or(even_rule());

        let result = rule.apply(&3);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_or_second_passes() {
        let rule = positive_rule().or(even_rule());

        let result = rule.apply(&-2);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_or_both_fail() {
        let rule = positive_rule().or(even_rule());

        let result = rule.apply(&-3);
        assert_eq!(result.violations.len(), 2);
    }

    #[test]
    fn test_rule_not() {
        let rule = positive_rule().not("not_positive", "Must not be positive");

        let result = rule.apply(&-5);
        assert!(result.is_empty());

        let result = rule.apply(&5);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].code, "not_positive");
    }

    #[test]
    fn test_rule_map_path() {
        let rule = positive_rule().map_path("value");

        let result = rule.apply(&-5);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].path.to_string(), "value");
    }

    #[test]
    fn test_rule_when_true() {
        let rule = positive_rule().when(|| true);

        let result = rule.apply(&-5);
        assert!(!result.is_empty());
    }

    #[test]
    fn test_rule_when_false() {
        let rule = positive_rule().when(|| false);

        let result = rule.apply(&-5);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_clone() {
        let rule1 = positive_rule();
        let rule2 = rule1.clone();

        let result1 = rule1.apply(&5);
        let result2 = rule2.apply(&5);

        assert_eq!(result1.is_empty(), result2.is_empty());
    }

    #[test]
    fn test_rule_code_customization() {
        let rule = positive_rule().code("custom_code");

        let result = rule.apply(&-5);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].code, "custom_code");
    }

    #[test]
    fn test_rule_message_customization() {
        let rule = positive_rule().message("Custom error message");

        let result = rule.apply(&-5);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].message, "Custom error message");
    }

    #[test]
    fn test_rule_meta_customization() {
        let rule = positive_rule().meta("hint", "Try a positive number");

        let result = rule.apply(&-5);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(
            result.violations[0].meta.get("hint"),
            Some("Try a positive number")
        );
    }

    #[test]
    fn test_rule_apply_with_context() {
        let rule = positive_rule();
        let ctx = RuleContext::root("age");

        let result = rule.apply_with_context(&-5, &ctx);
        assert_eq!(result.violations.len(), 1);
        assert_eq!(result.violations[0].path.to_string(), "age");
    }

    #[test]
    fn test_rule_map_path_with_valid_value() {
        let rule = positive_rule().map_path("field");

        let result = rule.apply(&5);
        assert!(result.is_empty());
    }

    #[test]
    fn test_rule_chaining_customizations() {
        let rule = positive_rule()
            .code("custom")
            .message("Custom msg")
            .meta("hint", "Use positive");

        let result = rule.apply(&-5);
        assert_eq!(result.violations[0].code, "custom");
        assert_eq!(result.violations[0].message, "Custom msg");
        assert_eq!(result.violations[0].meta.get("hint"), Some("Use positive"));
    }

    #[test]
    fn test_rule_debug() {
        let rule = positive_rule();
        let debug_str = format!("{:?}", rule);
        assert_eq!(debug_str, "Rule { <validation closure> }");
    }
}