slack_morphism/models/common/
emoji.rs

1use std::fmt;
2
3use rvstruct::ValueStruct;
4use serde::{
5    de::{MapAccess, Visitor},
6    Deserialize, Deserializer, Serialize, Serializer,
7};
8use url::Url;
9
10/// Represent a Slack custom emoji name without the leading `:` and trailing `:`
11#[derive(Debug, Eq, PartialEq, Hash, Clone, Serialize, Deserialize, ValueStruct)]
12pub struct SlackEmojiName(pub String);
13
14#[derive(Debug, Eq, PartialEq, Hash, Clone)]
15pub enum SlackEmojiRef {
16    Url(Url),
17    Alias(SlackEmojiName),
18}
19
20const SLACK_EMOJI_ALIAS_PREFIX: &str = "alias:";
21
22impl Serialize for SlackEmojiRef {
23    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
24    where
25        S: Serializer,
26    {
27        match self {
28            SlackEmojiRef::Url(url) => serializer.serialize_str(url.as_ref()),
29            SlackEmojiRef::Alias(alias) => {
30                serializer.serialize_str(&format!("{SLACK_EMOJI_ALIAS_PREFIX}{alias}"))
31            }
32        }
33    }
34}
35
36struct SlackEmojiRefVisitor {}
37
38impl SlackEmojiRefVisitor {
39    fn new() -> Self {
40        Self {}
41    }
42}
43
44impl<'de> Visitor<'de> for SlackEmojiRefVisitor {
45    type Value = SlackEmojiRef;
46
47    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
48        formatter.write_str("a Slack custom emoji URL or alias in the form of 'alias:<name>'")
49    }
50
51    fn visit_borrowed_str<E>(self, v: &'de str) -> Result<Self::Value, E>
52    where
53        E: serde::de::Error,
54    {
55        if v.starts_with(SLACK_EMOJI_ALIAS_PREFIX) {
56            let parsed_value: Vec<_> = v.split(':').collect();
57            if parsed_value.len() == 2 {
58                return Ok(SlackEmojiRef::Alias(SlackEmojiName(
59                    parsed_value[1].to_string(),
60                )));
61            }
62        }
63
64        let emoji_url: Url = v.parse().unwrap();
65        Ok(SlackEmojiRef::Url(emoji_url))
66    }
67}
68
69impl<'de> Deserialize<'de> for SlackEmojiRef {
70    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
71    where
72        D: Deserializer<'de>,
73    {
74        deserializer.deserialize_str(SlackEmojiRefVisitor::new())
75    }
76}
77
78#[cfg(test)]
79mod test {
80    use super::*;
81
82    mod serialize {
83        use super::*;
84
85        #[test]
86        fn test_serialize_emoji_url() {
87            let emoji_url = SlackEmojiRef::Url(Url::parse("https://example.com").unwrap());
88            assert_eq!(
89                serde_json::to_string(&emoji_url).unwrap(),
90                "\"https://example.com/\""
91            );
92        }
93
94        #[test]
95        fn test_serialize_emoji_alias() {
96            let emoji_alias = SlackEmojiRef::Alias(SlackEmojiName::new("smile".to_string()));
97            assert_eq!(
98                serde_json::to_string(&emoji_alias).unwrap(),
99                "\"alias:smile\""
100            );
101        }
102    }
103
104    mod deserialize {
105        use super::*;
106
107        #[test]
108        fn test_deserialize_emoji_url() {
109            assert_eq!(
110                serde_json::from_str::<SlackEmojiRef>("\"https://example.com\"").unwrap(),
111                SlackEmojiRef::Url(Url::parse("https://example.com").unwrap())
112            );
113        }
114
115        #[test]
116        fn test_serialize_emoji_alias() {
117            assert_eq!(
118                serde_json::from_str::<SlackEmojiRef>("\"alias:smile\"").unwrap(),
119                SlackEmojiRef::Alias(SlackEmojiName::new("smile".to_string()))
120            );
121        }
122    }
123}