Merge pull request #12 from jhheider/add-serde-feature

add feature: "serde"

Author: jhheider

.github/workflows/check-and-lint.yaml

@@ -22,6 +22,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: check
+          args: --all-features
         env:
           RUSTFLAGS: "-D warnings"
 

.justfile

@@ -4,7 +4,7 @@ default:
 
 # Generate coverage/lcov.info
 coverage:
-  cargo tarpaulin --engine ptrace -o lcov --output-dir coverage
+  cargo tarpaulin --engine ptrace -o lcov --output-dir coverage --all --all-targets --all-features
 
 # For getting ptrace as html on macos
 docker-coverage:

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "semverator"
-version = "0.8.0"
+version = "0.9.0"
 edition = "2021"
 license = "Apache-2.0"
 readme = "../README.md"
@@ -13,7 +13,7 @@ categories = ["command-line-utilities"]
 [dependencies]
 anyhow = "1.0.75"
 clap = { version = '4.4.2', features = ['cargo'] }
-libsemverator = { path = "../lib", version = "0.8.0" }
+libsemverator = { path = "../lib", version = "0.9.0" }
 
 [lints.rust]
 unexpected_cfgs = { level = "allow", check-cfg = ['cfg(tarpaulin_include)'] }

cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libsemverator"
-version = "0.8.0"
+version = "0.9.0"
 edition = "2021"
 license = "Apache-2.0"
 readme = "../README.md"
@@ -10,13 +10,21 @@ repository = "https://github.com/jhheider/semverator"
 keywords = ["semver", "semantic", "versioning", "pkgx"]
 categories = ["command-line-utilities"]
 
+[features]
+serde = ["dep:serde", "dep:serde_json"]
+
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
 anyhow = "1.0.75"
 lazy_static = "1.5.0"
 regex = "1.9.5"
+serde = { version = "1.0.217", optional = true }
+serde_json = { version = "1.0.135", optional = true }
 
 [lints.rust]
 unexpected_cfgs = { level = "allow", check-cfg = ['cfg(tarpaulin_include)'] }
+
+[dev-dependencies]
+serde_test = "1.0.177"

lib/Cargo.toml

@@ -1,4 +1,6 @@
 use crate::semver::Semver;
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use std::{
     fmt,
     hash::{Hash, Hasher},
@@ -118,3 +120,24 @@ fn at(left: &Semver, right: &Semver) -> bool {
 
     true
 }
+
+impl PartialEq for Range {
+    fn eq(&self, other: &Self) -> bool {
+        self.set == other.set
+    }
+}
+
+#[cfg(feature = "serde")]
+impl Serialize for Range {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        serializer.serialize_str(&format!("{self}"))
+    }
+}
+
+#[cfg(feature = "serde")]
+impl<'de> Deserialize<'de> for Range {
+    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+        let s = String::deserialize(deserializer)?;
+        Range::parse(&s).map_err(serde::de::Error::custom)
+    }
+}

lib/src/range/mod.rs

@@ -1,3 +1,5 @@
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use std::fmt;
 
 pub mod bump;
@@ -67,3 +69,18 @@ impl fmt::Display for Semver {
         Ok(())
     }
 }
+
+#[cfg(feature = "serde")]
+impl Serialize for Semver {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        serializer.serialize_str(&self.raw)
+    }
+}
+
+#[cfg(feature = "serde")]
+impl<'de> Deserialize<'de> for Semver {
+    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+        let s = String::deserialize(deserializer)?;
+        Semver::parse(&s).map_err(serde::de::Error::custom)
+    }
+}

lib/src/semver/mod.rs

@@ -1,6 +1,7 @@
-use anyhow::Result;
-
 use crate::{range::Range, semver::Semver};
+use anyhow::Result;
+#[cfg(feature = "serde")]
+use serde_test::{assert_tokens, Token};
 
 #[test]
 fn test_parse() -> Result<()> {
@@ -279,3 +280,20 @@ fn test_display() -> Result<()> {
 
     Ok(())
 }
+
+#[cfg(feature = "serde")]
+#[test]
+fn test_serde() -> Result<()> {
+    let ra = Range::parse("^3.7")?;
+    let rb = Range::parse("=3.11")?;
+    let rc = Range::parse("^3.9")?;
+
+    assert_tokens(&ra, &[Token::Str("^3.7")]);
+    assert_tokens(&rb, &[Token::Str("=3.11")]);
+    assert_tokens(&rc, &[Token::Str("^3.9")]);
+
+    let rd = serde_json::from_str::<Range>("\"your mom\"");
+    assert!(rd.is_err());
+
+    Ok(())
+}

lib/src/tests/range.rs

@@ -1,5 +1,7 @@
 use crate::semver::{bump::SemverComponent, Semver};
 use anyhow::Result;
+#[cfg(feature = "serde")]
+use serde_test::{assert_tokens, Token};
 
 #[test]
 fn test_parse() -> Result<()> {
@@ -181,3 +183,18 @@ fn test_display() -> Result<()> {
 
     Ok(())
 }
+
+#[cfg(feature = "serde")]
+#[test]
+fn test_serde() -> Result<()> {
+    let a = Semver::parse("1.2.3")?;
+    let b = Semver::parse("1.2.4")?;
+
+    assert_tokens(&a, &[Token::Str("1.2.3")]);
+    assert_tokens(&b, &[Token::Str("1.2.4")]);
+
+    let c = serde_json::from_str::<Semver>("\"your mom\"");
+    assert!(c.is_err());
+
+    Ok(())
+}