egelm 0.3.1

A simple message-driven framework for building GUI applications in Rust using egui.
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

//! Look up and display emoji in an `egelm` application.

/// A displayable emoji returned by [`emoji`].
///
/// The value wraps static emoji metadata and implements [`std::fmt::Display`],
/// so it can be passed to formatting macros or converted into a [`String`].
///
/// # Examples
///
/// ```
/// use egelm::emoji::emoji;
///
/// let rocket = emoji("rocket");
/// assert_eq!(rocket.to_string(), "🚀");
/// ```
pub struct Emoji {
	inner: &'static emojis::Emoji,
}

impl AsRef<emojis::Emoji> for Emoji {
	fn as_ref(&self) -> &'static emojis::Emoji {
		self.inner
	}
}

impl From<&'static emojis::Emoji> for Emoji {
	fn from(value: &'static emojis::Emoji) -> Self {
		Self { inner: value }
	}
}

impl std::fmt::Display for Emoji {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.write_str(self.inner.as_str())
	}
}

impl From<Emoji> for String {
	fn from(value: Emoji) -> Self {
		value.to_string()
	}
}

/// Lookup an emoji in *O(1)* time using `gemoji` shortcode: [here](https://www.webfx.com/tools/emoji-cheat-sheet).
///
/// Returns an [`Emoji`] that you can use in [`egui::Label`]s.
///
/// If the Emoji does not exist, it is replaced by a default and a [`tracing::warn`] will be created.
///
/// # Panics
///
/// Panics if the bundled emoji database does not contain the `no_entry`
/// fallback. This should never happen.
///
/// # Examples
///
/// ```
/// # use egelm::prelude::*;
/// assert_eq!(emoji("rocket").to_string(), "🚀");
/// assert_eq!(emoji("something_that_does_not_exist").to_string(), "â›”");
/// ```
///
/// ```
/// # use egelm::prelude::*;
/// # egelm::window::run_test(|ui| {
/// ui.label(format!("rocket emoji: {}", emoji("rocket")));
/// # })?;
/// # Ok::<(), egelm::error::Error>(())
/// ```
pub fn emoji(name: impl AsRef<str> + std::fmt::Display) -> Emoji {
	match emojis::get_by_shortcode(name.as_ref()).map(|x| x.into()) {
		Some(o) => o,
		None => {
			tracing::warn!(":{name}: does not exist");
			emojis::get_by_shortcode("no_entry")
				.map(|x| x.into())
				.unwrap()
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn known_shortcode_returns_matching_emoji() {
		let rocket = emoji("rocket");

		assert_eq!(rocket.to_string(), "🚀");
		assert_eq!(rocket.as_ref().as_str(), "🚀");
	}

	#[test]
	fn unknown_shortcode_uses_no_entry_fallback() {
		assert_eq!(emoji("not_a_real_shortcode").to_string(), "â›”");
	}

	#[test]
	fn emoji_converts_into_string() {
		let value: String = emoji("wave").into();

		assert_eq!(value, "👋");
	}
}