Add serde support for types

.gitignore

@@ -1 +1,2 @@
 /target
+/.vscode

Cargo.toml

@@ -16,3 +16,11 @@ members = ["generate"]
 
 [dependencies]
 phf = { version = "0.11.1", default-features = false }
+serde = { version = "1.0.124", default-features = false, features = ["derive"], optional = true }
+
+[dev-dependencies]
+serde_json = "1.0.120"
+toml = "0.8.15"
+
+[features]
+serde = ["dep:serde"]

generate/src/main.rs

@@ -19,6 +19,10 @@ fn write_group_enum<W: io::Write>(w: &mut W, unicode_data: &unicode::ParsedData)
         w,
         "#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]"
     )?;
+    writeln!(
+        w,
+        r#"#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]"#,
+    )?;
     writeln!(w, "pub enum Group {{")?;
     for name in unicode_data.keys() {
         if name == "Component" {

src/gen/mod.rs

@@ -11,6 +11,7 @@ use crate::{Emoji, SkinTone, UnicodeVersion};
 ///
 /// Based on Unicode CLDR data.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Group {
    SmileysAndEmotion,
    PeopleAndBody,

src/lib.rs

@@ -139,13 +139,15 @@ pub struct Emoji {
 
 /// A Unicode version.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct UnicodeVersion {
     major: u32,
     minor: u32,
 }
 
 /// The skin tone of an emoji.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub enum SkinTone {
     Default,
@@ -459,6 +461,43 @@ impl fmt::Display for Emoji {
     }
 }
 
+#[cfg(feature = "serde")]
+impl serde::Serialize for &'static Emoji {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        serializer.serialize_str(self.as_str())
+    }
+}
+
+#[cfg(feature = "serde")]
+impl<'de> serde::Deserialize<'de> for &'static Emoji {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::Deserializer<'de>,
+    {
+        struct Visitor;
+
+        impl<'de> serde::de::Visitor<'de> for Visitor {
+            type Value = &'static Emoji;
+
+            fn expecting(&self, formatter: &mut core::fmt::Formatter) -> core::fmt::Result {
+                formatter.write_str("a string representing an emoji")
+            }
+
+            fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
+            where
+                E: serde::de::Error,
+            {
+                crate::get(value).ok_or_else(|| E::custom("invalid emoji"))
+            }
+        }
+
+        deserializer.deserialize_str(Visitor)
+    }
+}
+
 impl Group {
     /// Returns an iterator over all groups.
     ///

tests/serde.rs

@@ -0,0 +1,70 @@
+#![cfg(feature = "serde")]
+
+use emojis::{Emoji, Group, SkinTone, UnicodeVersion};
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, PartialEq, Eq, Deserialize, Serialize)]
+struct Test {
+    version: UnicodeVersion,
+    skin_tone: SkinTone,
+    group: Group,
+    emoji: &'static Emoji,
+}
+
+#[test]
+fn test_serialize_roundtrip_json() {
+    let test = Test {
+        emoji: emojis::get("🚀").unwrap(),
+        version: UnicodeVersion::new(13, 0),
+        skin_tone: SkinTone::Default,
+        group: Group::Activities,
+    };
+    let serialized = serde_json::to_string_pretty(&test).unwrap();
+    assert_eq!(
+        serialized,
+        r#"{
+  "version": {
+    "major": 13,
+    "minor": 0
+  },
+  "skin_tone": "Default",
+  "group": "Activities",
+  "emoji": "🚀"
+}"#
+    );
+    let deserialized: Test = serde_json::from_str(&serialized).unwrap();
+
+    assert_eq!(deserialized, test);
+}
+
+#[test]
+fn test_serialize_roundtrip_toml() {
+    let test = Test {
+        emoji: emojis::get("🚀").unwrap(),
+        version: UnicodeVersion::new(13, 0),
+        skin_tone: SkinTone::Default,
+        group: Group::Activities,
+    };
+    let serialized = toml::to_string(&test).unwrap();
+    assert_eq!(
+        serialized,
+        r#"skin_tone = "Default"
+group = "Activities"
+emoji = "🚀"
+
+[version]
+major = 13
+minor = 0
+"#
+    );
+
+    let deserialized: Test = toml::from_str(&serialized).unwrap();
+
+    assert_eq!(deserialized, test);
+}
+
+#[test]
+fn emoji_deserialize_invalid() {
+    let err = serde_json::from_str::<Test>(r#"{"emoji":"invalid"}"#).unwrap_err();
+    assert_eq!(err.to_string(), "invalid emoji at line 1 column 18");
+}