Merge pull request #6 from MidasLamb/better-serde-error-message

Better serde error message

Author: MidasLamb

CHANGELOG.md

@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.2.1]
+### Added
+
+### Changed
+* The error message when using `serde` now indicates that the empty string could not be deserialized.
+* Bumped rust edition to `2021`
+
+### Removed
 ## [0.2.0]
 ### Added
 * `serde` support behind the `serde` feature flag.
@@ -22,5 +30,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-[Unreleased]: https://github.com/MidasLamb/non-empty-string/v0.2.0...HEAD
+[Unreleased]: https://github.com/MidasLamb/non-empty-string/v0.2.1...HEAD
+[0.2.1]: https://github.com/MidasLamb/non-empty-string/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/MidasLamb/non-empty-string/compare/v0.1.0...v0.2.0

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "non-empty-string"
-version = "0.2.0"
-edition = "2018"
+version = "0.2.1"
+edition = "2021"
 authors = ["Midas Lambrichts <[email protected]>"]
 license = "MIT OR Apache-2.0"
 description = "A simple type for non empty Strings, similar to NonZeroUsize and friends."

src/serde_support.rs

@@ -27,15 +27,11 @@ impl<'de> de::Deserialize<'de> for NonEmptyString {
     }
 }
 
-pub enum DeserializeError {}
-
-type Result<T, E = DeserializeError> = std::result::Result<T, E>;
-
 impl<'de> Visitor<'de> for NonEmptyStringVisitor {
     type Value = NonEmptyString;
 
     fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
-        formatter.write_str("an integer between -2^31 and 2^31")
+        formatter.write_str("a string with a length of more than 0")
     }
 
     fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
@@ -55,13 +51,12 @@ impl<'de> Visitor<'de> for NonEmptyStringVisitor {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use crate::*;
     use assert_matches::assert_matches;
     use serde_json::json;
 
     #[test]
-    fn serialize_works() {
+    fn serialize_non_empty_string_and_normal_string_give_the_same_result() {
         let value = NonEmptyString("abc".to_owned());
         let result = serde_json::to_string(&value);
 
@@ -80,11 +75,40 @@ mod tests {
         assert_matches!(e, Ok(v) if v == expected)
     }
 
+    fn deserialize_x_fails(value: serde_json::Value, expected_error_message: &'static str) {
+        let e: Result<NonEmptyString, _> = serde_json::from_value(value);
+        assert_matches!(e, Err(error) if &error.to_string() == expected_error_message)
+    }
+
     #[test]
     fn deserialize_empty_fails() {
-        let e: Result<NonEmptyString, _> = serde_json::from_value(json!(""));
+        deserialize_x_fails(
+            json!(""),
+            "invalid value: string \"\", expected a string with a length of more than 0",
+        )
+    }
+
+    #[test]
+    fn deserialize_number_fails() {
+        deserialize_x_fails(
+            json!(8),
+            "invalid type: integer `8`, expected a string with a length of more than 0",
+        )
+    }
+
+    #[test]
+    fn deserialize_object_fails() {
+        deserialize_x_fails(
+            json!({}),
+            "invalid type: map, expected a string with a length of more than 0",
+        )
+    }
 
-        assert!(e.is_err());
-        // assert_matches!(e, Ok(expected))
+    #[test]
+    fn deserialize_sequence_fails() {
+        deserialize_x_fails(
+            json!([]),
+            "invalid type: sequence, expected a string with a length of more than 0",
+        )
     }
 }