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
use anyhow::Context;
pub use email_address::EmailAddress;
use nutype::nutype;
pub use phonenumber::PhoneNumber;
#[derive(Debug, Clone, PartialEq, Eq)]
/// Represents a person with a name and contact information.
pub struct Person {
/// The first name of the person.
first_name: NameString,
/// The last name of the person.
last_name: NameString,
/// The email address of the person.
email: Option<EmailAddress>,
/// The phone number of the person.
phone: Option<PhoneNumber>,
}
#[nutype(
sanitize(trim),
validate(not_empty, len_char_max = NAME_LEN),
derive(Debug, Eq, PartialEq, Clone, Display, Deref)
)]
pub struct NameString(String);
impl Person {
/// Create a new `Person` with the given name.
///
/// # Arguments
/// * `name` - The name of the person.
///
/// # Returns
/// A new `Person` instance.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
///
/// let person = Person::new("Margherita", "Hack").unwrap();
/// ```
pub fn new(name: impl Into<String>, surname: impl Into<String>) -> Option<Self> {
let (name, surname) = match (NameString::try_new(name), NameString::try_new(surname)) {
(Ok(n), Ok(s)) => (n, s),
_ => return None,
};
Some(Person {
first_name: name,
last_name: surname,
email: None,
phone: None,
})
}
/// Add or edit the email address of the person.
///
/// # Arguments
/// * `email` - The new email address of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use email_address::EmailAddress;
/// use std::str::FromStr;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let email = EmailAddress::from_str("margherita.hack@example.com").unwrap();
/// person.update_email(email.clone());
/// assert_eq!(person.email(), &Some(email));
/// ```
pub fn update_email(&mut self, email: EmailAddress) {
self.email = Some(email);
}
/// Remove the email address of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use email_address::EmailAddress;
/// use std::str::FromStr;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let email = EmailAddress::from_str("margherita.hack@example.com").unwrap();
/// person.update_email(email.clone());
/// assert_eq!(person.email(), &Some(email));
/// person.rm_email();
/// assert!(person.email().is_none());
/// ```
pub fn rm_email(&mut self) {
self.email = None;
}
/// Add or edit the phone number of the person.
///
/// # Arguments
/// * `phone` - The new phone number of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use std::str::FromStr;
/// use phonenumber::PhoneNumber;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let phone = PhoneNumber::from_str("+1234567890").unwrap();
/// person.update_phone(phone.clone());
/// assert_eq!(person.phone(), &Some(phone));
/// ```
pub fn update_phone(&mut self, phone: PhoneNumber) {
self.phone = Some(phone);
}
/// Remove the phone number of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use std::str::FromStr;
/// use phonenumber::PhoneNumber;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let phone = PhoneNumber::from_str("+1234567890").unwrap();
/// person.update_phone(phone.clone());
/// assert_eq!(person.phone(), &Some(phone));
/// person.rm_phone();
/// assert!(person.phone().is_none());
/// ```
pub fn rm_phone(&mut self) {
self.phone = None;
}
/// Get the phone number of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use phonenumber::PhoneNumber;
/// use std::str::FromStr;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let phone = PhoneNumber::from_str("+1234567890").unwrap();
/// person.update_phone(phone.clone());
/// assert_eq!(person.phone(), &Some(phone));
/// ```
pub fn phone(&self) -> &Option<PhoneNumber> {
&self.phone
}
/// Get the email of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
/// use email_address::EmailAddress;
/// use std::str::FromStr;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// let email = EmailAddress::from_str("margherita.hack@example.com").unwrap();
/// person.update_email(email.clone());
/// assert_eq!(person.email(), &Some(email));
/// ```
pub fn email(&self) -> &Option<EmailAddress> {
&self.email
}
/// Get the name of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// assert_eq!(person.full_name(), "Margherita Hack");
/// ```
pub fn full_name(&self) -> String {
format!("{} {}", self.first_name, self.last_name)
}
/// Get the first name of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
///
/// let person = Person::new("Margherita", "Hack").unwrap();
/// assert_eq!(person.first_name(), "Margherita");
/// ```
pub fn first_name(&self) -> &str {
&self.first_name
}
/// Update the first name of the person.
///
/// # Errors
///
/// It can return an error, if the input `name` can't be converted to
/// `NameString`
///
/// # Examples
///
/// ```
/// use planter_core::person::Person;
///
/// let mut person = Person::new("Margaret", "Hack").unwrap();
/// person.update_first_name("Margherita").unwrap();
/// assert_eq!(person.first_name(), "Margherita");
/// ```
pub fn update_first_name(&mut self, name: impl Into<String>) -> anyhow::Result<()> {
self.first_name =
NameString::try_new(name).context("Input can't be converted into NameString.")?;
Ok(())
}
/// Get the last name of the person.
///
/// # Examples
/// ```
/// use planter_core::person::Person;
///
/// let mut person = Person::new("Margherita", "Hack").unwrap();
/// assert_eq!(person.last_name(), "Hack");
/// ```
pub fn last_name(&self) -> &str {
&self.last_name
}
/// Update the last name of the person.
///
/// # Errors
///
/// It can return an error, if the input `name` can't be converted to
/// `NameString`
///
/// # Examples
///
/// ```
/// use planter_core::person::Person;
///
/// let mut person = Person::new("Margherita", "Hacker").unwrap();
/// person.update_last_name("Hack").unwrap();
/// assert_eq!(person.last_name(), "Hack");
/// ```
pub fn update_last_name(&mut self, name: impl Into<String>) -> anyhow::Result<()> {
self.last_name =
NameString::try_new(name).context("Input can't be converted into NameString.")?;
Ok(())
}
}
const NAME_LEN: usize = 50;
#[cfg(test)]
/// Test utilities for the `person` module.
pub mod test_utils {
use std::str::FromStr;
use email_address::EmailAddress;
use phonenumber::PhoneNumber;
use proptest::prelude::Strategy;
/// Generate a random email address.
pub fn email() -> impl Strategy<Value = EmailAddress> {
r"^\+?[1-9][0-9]{7,14}$".prop_map(|s: String| EmailAddress::from_str(&s).unwrap())
}
/// Generate a random phone number.
pub fn phone_number() -> impl Strategy<Value = PhoneNumber> {
r"^\d{3}-\d{3}-\d{4}$".prop_map(|s: String| PhoneNumber::from_str(&s).unwrap())
}
}