wary 0.3.1

A simple validation and transformation library.
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

//! Rule for requring a value to be empty or not empty.
//!
//! See [`RequiredRule`] for more information.

use crate::toolbox::rule::*;

#[doc(hidden)]
pub type Rule<Mode> = RequiredRule<Mode>;

#[derive(Debug, thiserror::Error, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize), serde(untagged))]
pub enum Error {
	#[error("value should be empty")]
	ShouldBeEmpty,
	#[error("value should not be empty")]
	CannotBeEmpty,
}

impl Error {
	#[must_use]
	pub(crate) fn code(&self) -> &'static str {
		match self {
			Self::ShouldBeEmpty => "should_be_empty",
			Self::CannotBeEmpty => "cannot_be_empty",
		}
	}

	pub(crate) fn message(&self) -> &'static str {
		match self {
			Self::ShouldBeEmpty => "value should be empty",
			Self::CannotBeEmpty => "value should not be empty",
		}
	}
}

pub struct Not;

/// Rule for requring a value to be empty or not empty.
///
/// # Example
///
/// ```
/// use wary::{Wary, Validate};
///
/// #[derive(Wary)]
/// struct Person {
///   #[validate(required)]
///   name: String,
///   #[validate(required(not))]
///   numbers: Vec<u8>,
///   #[validate(required)]
///   greeting: Option<String>,
///   #[validate(required, inner(required))]
///   nested: Option<Option<String>>,
/// }
///
/// let person = Person {
///   name: "hello".into(), // good
///   numbers: vec![1, 2, 3], // error, should be empty
///   greeting: None, // error, should not be empty
///   nested: Some(None), // error, should not be empty
/// };
///
/// assert!(person.validate(&()).is_err());
///
/// let person = Person {
///   name: "hello".into(), // good
///   numbers: vec![], // good
///   greeting: Some("hello".into()), // good
///   nested: Some(None), // good. inner(required) is applied to the nested String
/// };
///
/// assert!(person.validate(&()).is_ok());
/// ```
#[must_use]
pub struct RequiredRule<Mode> {
	mode: PhantomData<Mode>,
}

impl RequiredRule<Unset> {
	#[inline]
	pub const fn new() -> Self {
		Self { mode: PhantomData }
	}

	/// Require the value to be empty.
	///
	/// # Example
	///
	/// ```
	/// use wary::{Wary, Validate};
	///
	/// #[derive(Wary)]
	/// struct Person {
	///  #[validate(required(not))]
	///  name: String,
	/// }
	///
	/// let person = Person {
	///   name: "hello".into(), // error, should be empty
	/// };
	///
	/// assert!(person.validate(&()).is_err());
	/// ```
	#[inline]
	pub const fn not(self) -> RequiredRule<Not> {
		RequiredRule { mode: PhantomData }
	}
}

impl<I: ?Sized> crate::Rule<I> for RequiredRule<Unset>
where
	I: AsSlice,
{
	type Context = ();

	fn validate(&self, _ctx: &Self::Context, item: &I) -> Result<()> {
		let slice = item.as_slice();

		if slice.is_empty() {
			Err(Error::CannotBeEmpty.into())
		} else {
			Ok(())
		}
	}
}

impl<I: ?Sized> crate::Rule<I> for RequiredRule<Not>
where
	I: AsSlice,
{
	type Context = ();

	fn validate(&self, _ctx: &Self::Context, item: &I) -> Result<()> {
		let slice = item.as_slice();

		if slice.is_empty() {
			Ok(())
		} else {
			Err(Error::ShouldBeEmpty.into())
		}
	}
}

#[cfg(test)]
mod test {
	use super::{Not, RequiredRule};
	use crate::toolbox::test::*;

	const rule: RequiredRule<Unset> = RequiredRule::new();
	const not: RequiredRule<Not> = RequiredRule::new().not();

	#[test]
	fn test_required_rule_option() {
		assert!(rule.validate(&(), &Some(1)).is_ok());
		assert!(rule.validate(&(), &None::<i32>).is_err());

		assert!(not.validate(&(), &Some(1)).is_err());
		assert!(not.validate(&(), &None::<i32>).is_ok());
	}

	#[test]
	fn test_required_rule_slice() {
		assert!(rule.validate(&(), &[1]).is_ok());
		assert!(rule.validate(&(), &vec![1, 2, 3]).is_ok());
		assert!(rule.validate(&(), "hello").is_ok());

		assert!(rule.validate(&(), &[0; 0]).is_err());
		assert!(rule.validate(&(), &Vec::<i32>::new()).is_err());
		assert!(rule.validate(&(), "").is_err());

		assert!(not.validate(&(), &[1]).is_err());
		assert!(not.validate(&(), &vec![1, 2, 3]).is_err());
		assert!(not.validate(&(), "hello").is_err());

		assert!(not.validate(&(), &[0; 0]).is_ok());
		assert!(not.validate(&(), &Vec::<i32>::new()).is_ok());
		assert!(not.validate(&(), "").is_ok());
	}
}