summaryrefslogtreecommitdiffstats
path: root/src/git/user.rs
blob: d0d32c1bad64a036821f24ab4930c35f60a95361 (plain)
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
use std::fmt::Display;

/// Represents a user within a commit with a name and email address
#[derive(Debug, Eq, PartialEq)]
pub(crate) struct User {
	name: Option<String>,
	email: Option<String>,
}

impl User {
	/// Creates a new user
	#[must_use]
	pub(crate) fn new(name: Option<&str>, email: Option<&str>) -> Self {
		Self {
			email: email.map(String::from),
			name: name.map(String::from),
		}
	}

	/// Get the optional name of the user
	#[must_use]
	pub(crate) fn name(&self) -> Option<&str> {
		self.name.as_deref()
	}

	/// Get the optional email of the user
	#[must_use]
	pub(crate) fn email(&self) -> Option<&str> {
		self.email.as_deref()
	}

	/// Returns `true` if one of name or email is a `Some` value.
	#[must_use]
	pub(crate) const fn is_some(&self) -> bool {
		self.name.is_some() || self.email.is_some()
	}
}

impl Display for User {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		if let Some(name) = self.name() {
			if let Some(email) = self.email() {
				write!(f, "{name} <{email}>")
			}
			else {
				write!(f, "{name}")
			}
		}
		else if let Some(email) = self.email() {
			write!(f, "<{email}>")
		}
		else {
			write!(f, "")
		}
	}
}

#[cfg(test)]
mod tests {
	use claims::assert_some_eq;
	use rstest::rstest;

	use super::*;

	#[test]
	fn name() {
		let user = User::new(Some("name"), None);
		assert_some_eq!(user.name(), "name");
	}

	#[test]
	fn email() {
		let user = User::new(None, Some("email"));
		assert_some_eq!(user.email(), "email");
	}

	#[rstest]
	#[case(Some("name"), None)]
	#[case(None, Some("email"))]
	#[case(Some("email"), Some("email"))]
	fn is_some_none_when_some(#[case] name: Option<&str>, #[case] email: Option<&str>) {
		let user = User::new(name, email);
		assert!(user.is_some());
	}

	#[test]
	fn is_some_none_when_none() {
		let user = User::new(None, None);
		assert!(!user.is_some());
	}

	#[test]
	fn to_string_with_none_name_and_none_email() {
		let user = User::new(None, None);
		assert_eq!(user.to_string(), "");
	}

	#[test]
	fn to_string_with_none_name_and_some_email() {
		let user = User::new(None, Some("me@example.com"));
		assert_eq!(user.to_string(), "<me@example.com>");
	}

	#[test]
	fn to_string_with_some_name_and_none_email() {
		let user = User::new(Some("Tim Oram"), None);
		assert_eq!(user.to_string(), "Tim Oram");
	}

	#[test]
	fn to_string_with_some_name_and_some_email() {
		let user = User::new(Some("Tim Oram"), Some("me@example.com"));
		assert_eq!(user.to_string(), "Tim Oram <me@example.com>");
	}
}