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
use crate::{Validation, ValidationErrors, ValidatorFn};
use std::fmt::Debug;

#[cfg(feature = "async")]
use crate::AsyncValidatorFn;

#[cfg(feature = "async")]
use futures::future::join_all;

/// Validates a particular type of value, can contain many validation
/// functions. Generally used with a single key for all contained
/// validation functions.
///
/// ## Example
/// ```
/// use form_validation::{Validation, ValidationError, Validator};
///
/// let v: Validator<i32, String> = Validator::new()
/// .validation(|value: &i32, key: &String| {
///     if value < &0 {
///         let value_clone = *value;
///         Err(ValidationError::new(key.clone(), "NOT_LESS_THAN_0")
///             .with_message(move |key| {
///                 format!(
///                     "The value of {} ({}) cannot be less than 0",
///                     key, value_clone
///                 )
///         }).into()) // convert into ValidationErrors
///     } else {
///         Ok(())
///     }
/// })
/// .validation(|value: &i32, key: &String| {
///     if value > &10 {
///         let value_clone = *value;
///         Err(ValidationError::new(key.clone(), "NOT_GREATER_THAN_10")
///             .with_message(move |key| {
///                 format!(
///                     "The value of {} ({}) cannot be greater than 10",
///                     key, value_clone
///                 )
///         }).into())
///     } else {
///         Ok(())
///     }
/// });
///
/// let key = "field1".to_string();
///
/// {
///     let errors = v.validate_value(&11, &key).unwrap_err();
///     assert_eq!(1, errors.len());
///     let error = errors.errors.get(0).unwrap();
///     assert_eq!("NOT_GREATER_THAN_10", error.type_id);
/// }

/// assert!(v.validate_value(&5, &key).is_ok());
///
/// {
///     let errors = v.validate_value(&-1, &key).unwrap_err();
///     assert_eq!(1, errors.len());
///     let error = errors.errors.get(0).unwrap();
///     assert_eq!("NOT_LESS_THAN_0", error.type_id);
/// }
/// ```
#[derive(Clone, Debug)]
pub struct Validator<Value, Key> {
    pub validations: Vec<ValidatorFn<Value, Key>>,
}

impl<Value, Key> PartialEq for Validator<Value, Key> {
    fn eq(&self, other: &Self) -> bool {
        if self.validations.len() == other.validations.len() {
            let mut all_validations_same = true;

            for (i, this_validation) in self.validations.iter().enumerate() {
                let other_validation = other.validations.get(i).unwrap();

                all_validations_same &= this_validation == other_validation;
            }

            all_validations_same
        } else {
            false
        }
    }
}

impl<Value, Key> Validator<Value, Key> {
    /// Create a new `Validator`.
    pub fn new() -> Self {
        Self {
            validations: Vec::new(),
        }
    }

    /// A factory method to add a validation function to this validator.
    pub fn validation<F: Into<ValidatorFn<Value, Key>> + 'static>(
        mut self,
        validator_fn: F,
    ) -> Self {
        self.validations.push(validator_fn.into());
        self
    }
}

impl<Value, Key> Validation<Value, Key> for Validator<Value, Key>
where
    Key: PartialEq + Clone,
{
    fn validate_value(&self, value: &Value, key: &Key) -> Result<(), ValidationErrors<Key>> {
        let mut errors = ValidationErrors::default();

        for validation in &self.validations {
            if let Err(new_errors) = validation.validate_value(value, key) {
                errors.extend(new_errors)
            }
        }

        if !errors.is_empty() {
            Err(errors)
        } else {
            Ok(())
        }
    }
}

impl<Value, Key> Default for Validator<Value, Key> {
    fn default() -> Self {
        Validator::new()
    }
}

/// Validates a particular type of value asynchronously, can contain
/// many validation functions. Generally used with a single key for
/// all contained validation functions.
///
/// See [Validator] for the synchronous version.
///
/// ```
/// use form_validation::{AsyncValidator, ValidationError, AsyncValidatorFn, ValidatorFn};
/// use futures::executor::block_on;
///
/// let v: AsyncValidator<i32, String> = AsyncValidator::new()
///     .validation(AsyncValidatorFn::new(|value: &i32, key: &String| {
///         let value = *value;
///         let key = key.clone();
///         Box::pin(async move {
///             if value < 0 {
///                 Err(ValidationError::new(key.clone(), "NOT_LESS_THAN_0")
///                     .with_message(move |key| {
///                         format!("The value of {} ({}) cannot be less than 0", key, value)
///                     })
///                     .into()) // convert into ValidationErrors
///             } else {
///                 Ok(())
///             }
///         })
///     }))
///     // also supports compatibility with the synchronous ValidatorFn
///     .validation(ValidatorFn::new(|value: &i32, key: &String| {
///         if value > &10 {
///             let value_clone = *value;
///             Err(ValidationError::new(key.clone(), "NOT_GREATER_THAN_10")
///                 .with_message(move |key| {
///                     format!(
///                         "The value of {} ({}) cannot be greater than 10",
///                         key, value_clone
///                     )
///                 })
///                 .into()) // convert into ValidationErrors
///         } else {
///             Ok(())
///         }
///     }));
/// let key = "field1".to_string();
/// {
///     let errors = block_on(v.validate_value(&11, &key)).unwrap_err();
///     assert_eq!(1, errors.len());
///     let error = errors.errors.get(0).unwrap();
///     assert_eq!("NOT_GREATER_THAN_10", error.type_id);
/// }
///
/// assert!(block_on(v.validate_value(&5, &key)).is_ok());
///
/// {
///     let errors = block_on(v.validate_value(&-1, &key)).unwrap_err();
///     assert_eq!(1, errors.len());
///     let error = errors.errors.get(0).unwrap();
///     assert_eq!("NOT_LESS_THAN_0", error.type_id);
/// }
/// ```
#[cfg(feature = "async")]
#[cfg_attr(docsrs, doc(cfg(feature = "async")))]
#[derive(Clone, PartialEq, Debug)]
pub struct AsyncValidator<Value, Key> {
    pub validations: Vec<AsyncValidatorFn<Value, Key>>,
}

#[cfg(feature = "async")]
impl<Value, Key> AsyncValidator<Value, Key>
where
    Key: Clone + PartialEq,
    Value: Clone + PartialEq,
{
    /// Create a new `Validator`.
    pub fn new() -> Self {
        Self {
            validations: Vec::new(),
        }
    }

    /// A factory method to add a validation function to this validator.
    pub fn validation<F: Into<AsyncValidatorFn<Value, Key>> + 'static>(
        mut self,
        async_validator_fn: F,
    ) -> Self {
        self.validations.push(async_validator_fn.into());
        self
    }

    pub async fn validate_value(
        &self,
        value: &Value,
        key: &Key,
    ) -> Result<(), ValidationErrors<Key>> {
        let mut errors = ValidationErrors::default();

        let futures = self
            .validations
            .iter()
            .map(|async_validator_fn| async_validator_fn.validate_value(value, key))
            .collect::<Vec<_>>();

        // Execute all the futures concurrently
        let results: Vec<Result<(), ValidationErrors<Key>>> = join_all(futures).await;

        for result in results {
            if let Err(new_errors) = result {
                errors.extend(new_errors)
            }
        }

        if !errors.is_empty() {
            Err(errors)
        } else {
            Ok(())
        }
    }
}

#[cfg(feature = "async")]
impl<Value, Key> Default for AsyncValidator<Value, Key>
where
    Key: Clone + PartialEq,
    Value: Clone + PartialEq,
{
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(feature = "async")]
impl<Value, Key> From<Validator<Value, Key>> for AsyncValidator<Value, Key>
where
    Value: Clone + PartialEq + 'static,
    Key: Clone + PartialEq + 'static,
{
    fn from(validator: Validator<Value, Key>) -> Self {
        let mut async_validator: AsyncValidator<Value, Key> = AsyncValidator::new();

        for validator_fn in validator.validations {
            async_validator = async_validator.validation(validator_fn);
        }

        async_validator
    }
}

#[cfg(test)]
mod test {
    #[cfg(feature = "async")]
    mod async_tests {
        use super::super::{AsyncValidator, Validator};
        use crate::ValidationError;
        use futures::executor::block_on;

        /// Unit test for the `From<Validator> for AsyncValidator` implmentation
        #[test]
        fn async_validator_from_validator() {
            let v: Validator<i32, String> = Validator::new()
                .validation(|value: &i32, key: &String| {
                    if value < &0 {
                        let value_clone = *value;
                        Err(ValidationError::new(key.clone(), "NOT_LESS_THAN_0")
                            .with_message(move |key| {
                                format!(
                                    "The value of {} ({}) cannot be less than 0",
                                    key, value_clone
                                )
                            })
                            .into())
                    } else {
                        Ok(())
                    }
                })
                .validation(|value: &i32, key: &String| {
                    if value > &10 {
                        let value_clone = *value;
                        Err(ValidationError::new(key.clone(), "NOT_GREATER_THAN_10")
                            .with_message(move |key| {
                                format!(
                                    "The value of {} ({}) cannot be greater than 10",
                                    key, value_clone
                                )
                            })
                            .into())
                    } else {
                        Ok(())
                    }
                });

            // perform the conversion
            let av: AsyncValidator<i32, String> = v.into();

            let key = "field1".to_string();
            {
                let errors = block_on(av.validate_value(&11, &key)).unwrap_err();
                assert_eq!(1, errors.len());
                let error = errors.errors.get(0).unwrap();
                assert_eq!("NOT_GREATER_THAN_10", error.type_id);
            }
            assert!(block_on(av.validate_value(&5, &key)).is_ok());
            {
                let errors = block_on(av.validate_value(&-1, &key)).unwrap_err();
                assert_eq!(1, errors.len());
                let error = errors.errors.get(0).unwrap();
                assert_eq!("NOT_LESS_THAN_0", error.type_id);
            }
        }
    }
}