validatable 0.1.0

Define validated data types once and share them between the frontend and backend of isomorphic Rust web applications, with plain, input, and form representations
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
//! Core traits connecting the plain, input, and form representations, plus
//! the [`Edit`] form-field wrapper and validation [`Message`]s.

/// Connects a plain type with its input type `I` and form type `E`.
///
/// This trait is normally implemented by `#[derive(Validatable)]` on a type
/// generic over a [`FieldFamily`](crate::FieldFamily): for a type `T`, the
/// derive implements `Validatable<T<Input>, T<Form>>` for `T<Plain>`. User
/// code usually calls the more convenient methods on
/// [`ValidatableForm`] and [`ValidatableInput`] instead of using this trait
/// directly.
pub trait Validatable<I, E>: Sized {
    /// Validates a form, writing per-field [`Message`]s back into it.
    ///
    /// Returns `Some(plain)` when every field validates, `None` otherwise.
    /// On failure the form's fields carry the corresponding error messages;
    /// on success the messages are cleared.
    fn validate_from(form: &mut E) -> Option<Self>;
    /// Like [`validate_from`](Self::validate_from), but always runs the
    /// derived per-field validation even when the type opts into
    /// [`CustomValidate`] via `#[validatable(custom_validate)]`.
    fn validate_from_original(form: &mut E) -> Option<Self> {
        Self::validate_from(form)
    }
    /// Returns the default input value (empty strings, `false`, etc.).
    ///
    /// For enums this is the input representation of the *first* variant,
    /// with its fields set to their defaults.
    fn default_input() -> I;
    /// Converts a validated value back into its input representation.
    fn into_input(self) -> I;
    /// Extracts the raw input from a form, dropping validation results.
    fn form_into_input(form: E) -> I;
    /// Wraps raw input into a pristine form (no messages, `edited: false`).
    fn input_into_form(input: I) -> E;

    /// Converts a validated value into a pristine form for editing.
    fn into_form(self) -> E {
        Self::input_into_form(self.into_input())
    }

    /// Runs the derived validation, then the closure `f` for additional
    /// rules (cross-field checks, external configuration, and so on).
    ///
    /// The closure receives the form, the result of the derived validation,
    /// and a [`ValidateContext`]; it reports failures by calling
    /// [`Edit::fail`] / [`Edit::validate_by`] (or [`ValidateContext::fail`]
    /// directly). The final result is `None` when either stage failed.
    ///
    /// This is the building block for [`CustomValidate`] implementations and
    /// for validation methods that take extra arguments.
    fn validate_by<F>(form: &mut E, f: F) -> Option<Self>
    where
        F: Fn(&mut E, &mut Option<Self>, &mut ValidateContext),
    {
        let mut context = ValidateContext::init();
        let mut value = Self::validate_from_original(form);
        f(form, &mut value, &mut context);
        if context.is_failed() {
            None
        } else {
            value
        }
    }
}

/// Validation of a single value from its input representation.
///
/// This is the leaf-level counterpart of [`Validatable`]: it is implemented
/// by field types such as the primitives (`bool`, integers, floats, `char`,
/// `String`, and `Option`s of these), `NonEmptyString`, and
/// [`ValidatedValue`](crate::ValidatedValue). Implement it manually to make
/// a custom scalar type usable as a [`Field`](crate::Field); also implement
/// [`DefaultInputType`] so the type (and `Option` of it) can be named as
/// `Field<F, _>`:
///
/// ```
/// # #[cfg(feature = "serde")]
/// use serde::{Deserialize, Serialize}; // only needed with the `serde` feature
/// use validatable::*;
///
/// #[derive(PartialEq, Clone, Debug)]
/// #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
/// struct Email(String);
///
/// impl ValidatableValue<String> for Email {
///     fn validate_from(input: &String) -> Result<Self, Message> {
///         if input.contains('@') {
///             Ok(Email(input.clone()))
///         } else {
///             Err(Message::Text("must contain @".to_string()))
///         }
///     }
///     fn default_input() -> String {
///         String::new()
///     }
///     fn into_input(self) -> String {
///         self.0
///     }
/// }
///
/// // Declaring that `Email` is edited as a `String` by default lets fields
/// // be written simply as `Field<F, Email>` (or `Field<F, Option<Email>>`)
/// // instead of spelling out the input and form types with
/// // `FieldWith<F, Email, Edit<String>, String>`.
/// impl DefaultInputType for Email {
///     type InputType = String;
///     type FormType = Edit<String>;
/// }
///
/// let email = <Email as ValidatableValue<String>>::validate_from(&"a@b".to_string());
/// assert_eq!(email, Ok(Email("a@b".to_string())));
///
/// // `Option<Email>` is usable as a `Field` too, with no further impls.
/// #[derive(Validatable, PartialEq, Clone, Debug)]
/// struct Contact<F: FieldFamily> {
///     email: Field<F, Option<Email>>,
/// }
///
/// let mut form = Contact::<Form>::default();
/// form.email.input("a@b".to_string());
/// assert_eq!(
///     form.validate(),
///     Some(Contact { email: Some(Email("a@b".to_string())) })
/// );
/// ```
///
/// Every `P: ValidatableValue<I>` automatically participates in form
/// validation through a blanket `Validatable<I, Edit<I>>` implementation.
pub trait ValidatableValue<I>: Sized {
    /// Validates the input and produces the value, or an error [`Message`].
    fn validate_from(input: &I) -> Result<Self, Message>;
    /// Returns the default input value (typically an empty string).
    fn default_input() -> I;
    /// Converts the value back into its input representation.
    fn into_input(self) -> I;
}

/// Convenience methods available on every form type `T<Form>`.
///
/// Implemented by `#[derive(Validatable)]`; the methods delegate to
/// [`Validatable`].
pub trait ValidatableForm<P, I>: Sized
where
    P: Validatable<I, Self>,
{
    /// Validates the form, writing per-field messages back into it, and
    /// returns the plain value when everything is valid.
    fn validate(&mut self) -> Option<P> {
        <P as Validatable<I, Self>>::validate_from(self)
    }
    /// Creates a pristine form with default input values.
    fn new() -> Self {
        <P as Validatable<I, Self>>::input_into_form(<P as Validatable<I, Self>>::default_input())
    }
    /// Extracts the raw input, dropping validation results.
    fn into_input(self) -> I {
        P::form_into_input(self)
    }
}

/// Convenience methods available on every input type `T<Input>`.
///
/// Implemented by `#[derive(Validatable)]`; the methods delegate to
/// [`Validatable`].
pub trait ValidatableInput<P, E>: Sized
where
    P: Validatable<Self, E>,
    E: ValidatableForm<P, Self>,
{
    /// Validates the input and returns the plain value.
    ///
    /// The per-field error details are discarded (the error is always
    /// [`Message::ContentProblem`]); when the caller needs to know *which*
    /// fields failed, convert to the form type with
    /// [`into_form`](Self::into_form) and validate that instead.
    fn validate(self) -> Result<P, Message> {
        let mut edit = <P as Validatable<Self, E>>::input_into_form(self);
        edit.validate().ok_or(Message::ContentProblem)
    }
    /// Creates the default input value.
    fn new() -> Self {
        <P as Validatable<Self, E>>::default_input()
    }
    /// Wraps the input into a pristine form.
    fn into_form(self) -> E {
        P::input_into_form(self)
    }
}

/// Custom whole-form validation, opted into with
/// `#[validatable(custom_validate)]`.
///
/// When a type derives `Validatable` with the `custom_validate` attribute,
/// calling `validate()` dispatches to this trait (implemented by you for
/// `T<Form>`) instead of the derived per-field validation. Implementations
/// typically call [`Validatable::validate_by`], which first runs the derived
/// validation and then lets you add cross-field rules:
///
/// A cross-field rule enforced here only holds for `T<Plain>` values that
/// were actually produced by `validate()` — it is not tracked by the type
/// system. `T<Plain>` is a struct, and a struct literal is a constructor
/// like any other: if its fields are `pub`, calling code can assemble
/// independently valid field values into a combination this trait never
/// checked, with or without `custom_validate` being called. Keep the fields
/// private (exposing read accessors instead) whenever the invariant must
/// hold unconditionally.
///
/// ```
/// use validatable::*;
///
/// #[derive(Validatable, PartialEq, Clone, Debug)]
/// #[validatable(custom_validate)]
/// struct Range<F: FieldFamily> {
///     low: Field<F, i32>,
///     high: Field<F, i32>,
/// }
///
/// impl CustomValidate<Range<Plain>> for Range<Form> {
///     fn custom_validate(&mut self) -> Option<Range<Plain>> {
///         Range::<Plain>::validate_by(self, |form, value, c| {
///             if let Some(v) = value {
///                 if v.low > v.high {
///                     form.low.fail(c, Message::Text("must be <= high".into()));
///                 }
///             }
///         })
///     }
/// }
///
/// let mut form = Range::<Form>::default();
/// form.low.input("5".to_string());
/// form.high.input("1".to_string());
/// assert_eq!(form.validate(), None);
/// assert_eq!(form.low.message, Some(Message::Text("must be <= high".into())));
///
/// form.high.input("9".to_string());
/// assert_eq!(form.validate(), Some(Range { low: 5, high: 9 }));
/// ```
pub trait CustomValidate<P>: Sized {
    /// Validates the form and returns the plain value when it is valid.
    fn custom_validate(&mut self) -> Option<P>;
}

/// Declares the default input and form representations of a plain type.
///
/// [`Field<F, P>`](crate::Field) uses this to pick the concrete field type
/// for each family: `P` itself for `Plain`, `P::InputType` for `Input`, and
/// `P::FormType` for `Form`. For example, `u32` declares
/// `InputType = String` and `FormType = Edit<String>` — numbers are edited
/// as strings in a form.
pub trait DefaultInputType {
    /// The raw input representation (e.g. `String` for numbers).
    type InputType;
    /// The form representation, usually `Edit<InputType>`.
    type FormType;
}

/// A form field: an input value together with its latest validation result.
///
/// `Edit<I>` is the default form representation of a field whose input type
/// is `I`. Frontend code binds the UI to [`value`](Self::value), displays
/// [`message`](Self::message), and may consult [`edited`](Self::edited) to
/// decide *whether* to display it.
///
/// ```
/// use validatable::*;
///
/// #[derive(Validatable, PartialEq, Clone, Debug)]
/// struct Item<F: FieldFamily> {
///     count: Field<F, u32>,
/// }
///
/// let mut form = Item::<Form>::default();
/// form.count.input("abc".to_string());
/// assert_eq!(form.validate(), None);
/// assert_eq!(
///     form.count.message,
///     Some(Message::BadFormat(Format::UnsignedInteger))
/// );
///
/// form.count.input("7".to_string());
/// assert_eq!(form.validate(), Some(Item { count: 7 }));
/// assert_eq!(form.count.message, None);
/// ```
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Edit<I> {
    /// The current input value, as edited by the user.
    pub value: I,
    /// The result of the latest validation: `None` when the field passed
    /// (or has not been validated yet), `Some` otherwise.
    pub message: Option<Message>,
    /// Whether the user has touched this field (set by
    /// [`input`](Self::input)).
    ///
    /// Validation does not consult this flag; it exists so that UIs can
    /// suppress error messages on fields the user has not edited yet, e.g.
    /// on a freshly opened form that was validated once.
    pub edited: bool,
}

impl<I> Edit<I> {
    /// Creates a field that already carries a validation message.
    ///
    /// Useful on the backend to attach server-side errors to a form before
    /// returning it to the frontend.
    pub fn with_message(value: I, message: Message) -> Self {
        Edit {
            value,
            message: Some(message),
            edited: false,
        }
    }

    /// Creates a pristine field from an input value (no message,
    /// `edited: false`).
    pub fn from_input(value: I) -> Self {
        Edit {
            value,
            message: None,
            edited: false,
        }
    }

    /// Replaces the value and marks the field as [`edited`](Self::edited).
    ///
    /// Call this from UI event handlers when the user changes the field.
    pub fn input(&mut self, value: I) {
        self.value = value;
        self.edited = true;
    }

    /// Applies an ad-hoc check to the value inside a
    /// [`Validatable::validate_by`] closure.
    ///
    /// When `f` returns `Some(message)`, the message is stored on the field
    /// and the surrounding [`ValidateContext`] is marked as failed.
    pub fn validate_by<F>(&mut self, c: &mut ValidateContext, f: F)
    where
        F: Fn(&I) -> Option<Message>,
    {
        if let Some(m) = f(&self.value) {
            self.message = Some(m);
            c.fail();
        }
    }

    /// Marks this field as failed with `message` and records the failure in
    /// the [`ValidateContext`].
    pub fn fail(&mut self, c: &mut ValidateContext, message: Message) {
        self.message = Some(message);
        c.fail();
    }
}

/// A structured validation error.
///
/// Messages carry no display text (except [`Message::Text`]); render them in
/// the frontend's language of choice. Bound values are conveyed as strings
/// so that a single type covers all field types.
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Message {
    /// The input was empty but a value is required.
    Empty,
    /// A nested structure contains at least one invalid field. Also the
    /// catch-all error of [`ValidatableInput::validate`].
    ContentProblem,
    /// The input could not be parsed as the expected [`Format`].
    BadFormat(Format),
    /// The value is below the contained minimum (rendered as a string).
    ValueExceedMin(String),
    /// The value is above the contained maximum (rendered as a string).
    ValueExceedMax(String),
    /// The length is below the contained minimum (rendered as a string).
    LengthExceedMin(String),
    /// The length is above the contained maximum (rendered as a string).
    LengthExceedMax(String),
    /// The input contains the listed forbidden characters (sorted,
    /// deduplicated, capped at 10 distinct characters so that a large input
    /// cannot inflate this message).
    InvalidChars(Vec<char>),
    /// A custom, free-form message.
    Text(String),
}

/// The expected format reported by [`Message::BadFormat`].
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Format {
    /// Expected `true` or `false`.
    Bool,
    /// Expected a single character.
    Char,
    /// Expected a signed integer (`i8`, `i16`, `i32`, or `i64`).
    SignedInteger,
    /// Expected an unsigned integer (`u8`, `u16`, `u32`, or `u64`).
    UnsignedInteger,
    /// Expected a floating-point number.
    Float,
}

impl<P: ValidatableValue<I>, I> Validatable<I, Edit<I>> for P {
    fn validate_from(form: &mut Edit<I>) -> Option<Self> {
        match P::validate_from(&form.value) {
            Ok(p) => {
                form.message = None;
                Some(p)
            }
            Err(message) => {
                form.message = Some(message);
                None
            }
        }
    }

    fn default_input() -> I {
        P::default_input()
    }

    fn into_input(self) -> I {
        P::into_input(self)
    }

    fn form_into_input(form: Edit<I>) -> I {
        form.value
    }

    fn input_into_form(input: I) -> Edit<I> {
        Edit::from_input(input)
    }
}

/// Tracks whether any check failed during a
/// [`Validatable::validate_by`] run.
///
/// Custom validation closures receive a `ValidateContext` and mark failures
/// through [`Edit::fail`] / [`Edit::validate_by`] or directly with
/// [`fail`](Self::fail); `validate_by` returns `None` when the context ends
/// up failed.
pub struct ValidateContext {
    failed: bool,
}

impl ValidateContext {
    /// Creates a context with no recorded failure.
    pub fn init() -> Self {
        ValidateContext { failed: false }
    }
    /// Records a failure.
    pub fn fail(&mut self) {
        self.failed = true;
    }
    /// Returns `true` when a failure has been recorded.
    pub fn is_failed(&self) -> bool {
        self.failed
    }
}