Merge pull request #127 from greyblake/fix-serde-complex

greyblake · web-flow · commit fd09132c81a8 · 2024-02-25T12:19:22.000+01:00
Fix serde_complex example
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
   * Support `Arbitrary` for any inner types
 * Ability to specify boundaries (`greater`, `greater_or_equal`, `less`, `less_or_equal`, `len_char_min`, `len_char_max`) with expressions or named constants.
 * Add `#[inline]` attribute to trivial functions
+* Improve error messages
 
 ### v0.4.0 - 2023-11-21
 * Support of arbitrary inner types with custom sanitizers and validators.
diff --git a/examples/serde_complex/src/main.rs b/examples/serde_complex/src/main.rs
@@ -43,7 +43,10 @@ fn main() {
         "#;
         let res: Result<Product, _> = serde_json::from_str(json);
         let err = res.unwrap_err();
-        assert!(err.to_string().contains("empty, expected valid Name"));
+        assert_eq!(
+            err.to_string(),
+            "Name is empty. Expected valid Name at line 3 column 27"
+        );
     }
 
     {
@@ -57,7 +60,10 @@ fn main() {
         "#;
         let res: Result<Product, _> = serde_json::from_str(json);
         let err = res.unwrap_err();
-        assert!(err.to_string().contains("invalid, expected valid ImageUrl"));
+        assert_eq!(
+            err.to_string(),
+            "ImageUrl failed the predicate test. Expected valid ImageUrl at line 4 column 60"
+        );
     }
 
     {
@@ -71,7 +77,10 @@ fn main() {
         "#;
         let res: Result<Product, _> = serde_json::from_str(json);
         let err = res.unwrap_err();
-        assert!(err.to_string().contains("too small, expected valid Price"));
+        assert_eq!(
+            err.to_string(),
+            "Price is too small. The value must be greater than 0.0. Expected valid Price at line 6 column 13"
+        );
     }
 
     {
diff --git a/nutype_macros/src/common/gen/traits.rs b/nutype_macros/src/common/gen/traits.rs
@@ -241,7 +241,7 @@ pub fn gen_impl_trait_serde_deserialize(
         quote! {
             #type_name::new(raw_value).map_err(|validation_error| {
                 // Add a hint about which type is causing the error,
-                let err_msg = format!("{validation_error}, expected valid {}", #type_name_str);
+                let err_msg = format!("{validation_error} Expected valid {}", #type_name_str);
                 <DE::Error as serde::de::Error>::custom(err_msg)
             })
         }
diff --git a/test_suite/tests/any.rs b/test_suite/tests/any.rs
@@ -200,7 +200,10 @@ mod traits {
 
             {
                 let err = "5,5".parse::<Position>().unwrap_err();
-                assert_eq!(err.to_string(), "Failed to parse Position: invalid");
+                assert_eq!(
+                    err.to_string(),
+                    "Failed to parse Position: Position failed the predicate test."
+                );
             }
         }
     }
@@ -284,7 +287,10 @@ mod traits {
 
                 {
                     let err = serde_json::from_str::<LinePoint>("{\"x\":7,\"y\":9}").unwrap_err();
-                    assert_eq!(err.to_string(), "invalid, expected valid LinePoint");
+                    assert_eq!(
+                        err.to_string(),
+                        "LinePoint failed the predicate test. Expected valid LinePoint"
+                    );
                 }
 
                 {
diff --git a/test_suite/tests/float.rs b/test_suite/tests/float.rs
@@ -253,7 +253,10 @@ mod validators {
 
             let err = Percentage::try_from(-0.1).unwrap_err();
 
-            assert_eq!(err.to_string(), "too small");
+            assert_eq!(
+                err.to_string(),
+                "Percentage is too small. The value must be greater or equal to 0.0."
+            );
         }
     }
 }
@@ -457,7 +460,10 @@ mod traits {
 
         // Unhappy path: validation error
         let err: DistParseError = "12.35".parse::<Dist>().unwrap_err();
-        assert_eq!(err.to_string(), "Failed to parse Dist: too big");
+        assert_eq!(
+            err.to_string(),
+            "Failed to parse Dist: Dist is too big. The value must be less than 12.34."
+        );
     }
 
     #[test]
diff --git a/test_suite/tests/integer.rs b/test_suite/tests/integer.rs
@@ -220,7 +220,10 @@ mod validators {
 
             let err = Age::try_from(17).unwrap_err();
 
-            assert_eq!(err.to_string(), "too small");
+            assert_eq!(
+                err.to_string(),
+                "Age is too small. The value must be greater or equal to 18."
+            );
         }
     }
 }
@@ -608,7 +611,10 @@ mod traits {
 
         // Unhappy path: validation error
         let err: AgeParseError = "101".parse::<Age>().unwrap_err();
-        assert_eq!(err.to_string(), "Failed to parse Age: too big");
+        assert_eq!(
+            err.to_string(),
+            "Failed to parse Age: Age is too big. The value must be less or equal to 99."
+        );
     }
 
     #[test]
diff --git a/test_suite/tests/string.rs b/test_suite/tests/string.rs
@@ -223,7 +223,7 @@ mod validators {
         #[nutype(validate(not_empty))]
         pub struct Email(String);
 
-        assert_eq!(EmailError::NotEmptyViolated.to_string(), "empty");
+        assert_eq!(EmailError::NotEmptyViolated.to_string(), "Email is empty.");
     }
 
     mod when_boundaries_defined_as_constants {
diff --git a/test_suite/tests/ui/float/visibility/private.stderr b/test_suite/tests/ui/float/visibility/private.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the struct `Percentage` which is defined here
   --> tests/ui/float/visibility/private.rs:4:5
    |
 4  |     #[nutype(sanitize(with = |n| n.clamp(0.0, 100.0)))]
-   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
    = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/test_suite/tests/ui/float/visibility/private_error.stderr b/test_suite/tests/ui/float/visibility/private_error.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the enum `PercentageError` which is defined here
  --> tests/ui/float/visibility/private_error.rs:4:5
   |
 4 |     #[nutype(validate(greater_or_equal = 0.0, less_or_equal = 100.0))]
-  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
   = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/test_suite/tests/ui/integer/visibility/private.stderr b/test_suite/tests/ui/integer/visibility/private.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the struct `Percentage` which is defined here
   --> tests/ui/integer/visibility/private.rs:4:5
    |
 4  |     #[nutype(sanitize(with = |n: i32| n.clamp(0, 100)))]
-   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
    = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/test_suite/tests/ui/integer/visibility/private_error.stderr b/test_suite/tests/ui/integer/visibility/private_error.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the enum `PercentageError` which is defined here
  --> tests/ui/integer/visibility/private_error.rs:4:5
   |
 4 |     #[nutype(validate(greater_or_equal = 0, less_or_equal = 100))]
-  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
   = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/test_suite/tests/ui/string/visibility/private.stderr b/test_suite/tests/ui/string/visibility/private.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the struct `Email` which is defined here
   --> tests/ui/string/visibility/private.rs:4:5
    |
 4  |     #[nutype(sanitize(trim))]
-   |     ^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
    = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/test_suite/tests/ui/string/visibility/private_error.stderr b/test_suite/tests/ui/string/visibility/private_error.stderr
@@ -13,5 +13,5 @@ note: ...and refers to the enum `NameError` which is defined here
  --> tests/ui/string/visibility/private_error.rs:4:5
   |
 4 |     #[nutype(validate(not_empty))]
-  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly
+  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly
   = note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,10 @@ fn main() {`
`43`	`43`	`"#;`
`44`	`44`	`let res: Result<Product, _> = serde_json::from_str(json);`
`45`	`45`	`let err = res.unwrap_err();`
`46`		`- assert!(err.to_string().contains("empty, expected valid Name"));`
	`46`	`+ assert_eq!(`
	`47`	`+ err.to_string(),`
	`48`	`+ "Name is empty. Expected valid Name at line 3 column 27"`
	`49`	`+ );`
`47`	`50`	`}`
`48`	`51`
`49`	`52`	`{`
`@@ -57,7 +60,10 @@ fn main() {`
`57`	`60`	`"#;`
`58`	`61`	`let res: Result<Product, _> = serde_json::from_str(json);`
`59`	`62`	`let err = res.unwrap_err();`
`60`		`- assert!(err.to_string().contains("invalid, expected valid ImageUrl"));`
	`63`	`+ assert_eq!(`
	`64`	`+ err.to_string(),`
	`65`	`+ "ImageUrl failed the predicate test. Expected valid ImageUrl at line 4 column 60"`
	`66`	`+ );`
`61`	`67`	`}`
`62`	`68`
`63`	`69`	`{`
`@@ -71,7 +77,10 @@ fn main() {`
`71`	`77`	`"#;`
`72`	`78`	`let res: Result<Product, _> = serde_json::from_str(json);`
`73`	`79`	`let err = res.unwrap_err();`
`74`		`- assert!(err.to_string().contains("too small, expected valid Price"));`
	`80`	`+ assert_eq!(`
	`81`	`+ err.to_string(),`
	`82`	`+ "Price is too small. The value must be greater than 0.0. Expected valid Price at line 6 column 13"`
	`83`	`+ );`
`75`	`84`	`}`
`76`	`85`
`77`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ pub fn gen_impl_trait_serde_deserialize(`
`241`	`241`	`quote! {`
`242`	`242`	`#type_name::new(raw_value).map_err(\|validation_error\| {`
`243`	`243`	`// Add a hint about which type is causing the error,`
`244`		`- let err_msg = format!("{validation_error}, expected valid {}", #type_name_str);`
	`244`	`+ let err_msg = format!("{validation_error} Expected valid {}", #type_name_str);`
`245`	`245`	`<DE::Error as serde::de::Error>::custom(err_msg)`
`246`	`246`	`})`
`247`	`247`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,10 @@ mod traits {`
`200`	`200`
`201`	`201`	`{`
`202`	`202`	`let err = "5,5".parse::<Position>().unwrap_err();`
`203`		`- assert_eq!(err.to_string(), "Failed to parse Position: invalid");`
	`203`	`+ assert_eq!(`
	`204`	`+ err.to_string(),`
	`205`	`+ "Failed to parse Position: Position failed the predicate test."`
	`206`	`+ );`
`204`	`207`	`}`
`205`	`208`	`}`
`206`	`209`	`}`
`@@ -284,7 +287,10 @@ mod traits {`
`284`	`287`
`285`	`288`	`{`
`286`	`289`	`let err = serde_json::from_str::<LinePoint>("{\"x\":7,\"y\":9}").unwrap_err();`
`287`		`- assert_eq!(err.to_string(), "invalid, expected valid LinePoint");`
	`290`	`+ assert_eq!(`
	`291`	`+ err.to_string(),`
	`292`	`+ "LinePoint failed the predicate test. Expected valid LinePoint"`
	`293`	`+ );`
`288`	`294`	`}`
`289`	`295`
`290`	`296`	`{`
Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,10 @@ mod validators {`
`253`	`253`
`254`	`254`	`let err = Percentage::try_from(-0.1).unwrap_err();`
`255`	`255`
`256`		`- assert_eq!(err.to_string(), "too small");`
	`256`	`+ assert_eq!(`
	`257`	`+ err.to_string(),`
	`258`	`+ "Percentage is too small. The value must be greater or equal to 0.0."`
	`259`	`+ );`
`257`	`260`	`}`
`258`	`261`	`}`
`259`	`262`	`}`
`@@ -457,7 +460,10 @@ mod traits {`
`457`	`460`
`458`	`461`	`// Unhappy path: validation error`
`459`	`462`	`let err: DistParseError = "12.35".parse::<Dist>().unwrap_err();`
`460`		`- assert_eq!(err.to_string(), "Failed to parse Dist: too big");`
	`463`	`+ assert_eq!(`
	`464`	`+ err.to_string(),`
	`465`	`+ "Failed to parse Dist: Dist is too big. The value must be less than 12.34."`
	`466`	`+ );`
`461`	`467`	`}`
`462`	`468`
`463`	`469`	`#[test]`
Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,10 @@ mod validators {`
`220`	`220`
`221`	`221`	`let err = Age::try_from(17).unwrap_err();`
`222`	`222`
`223`		`- assert_eq!(err.to_string(), "too small");`
	`223`	`+ assert_eq!(`
	`224`	`+ err.to_string(),`
	`225`	`+ "Age is too small. The value must be greater or equal to 18."`
	`226`	`+ );`
`224`	`227`	`}`
`225`	`228`	`}`
`226`	`229`	`}`
`@@ -608,7 +611,10 @@ mod traits {`
`608`	`611`
`609`	`612`	`// Unhappy path: validation error`
`610`	`613`	`let err: AgeParseError = "101".parse::<Age>().unwrap_err();`
`611`		`- assert_eq!(err.to_string(), "Failed to parse Age: too big");`
	`614`	`+ assert_eq!(`
	`615`	`+ err.to_string(),`
	`616`	`+ "Failed to parse Age: Age is too big. The value must be less or equal to 99."`
	`617`	`+ );`
`612`	`618`	`}`
`613`	`619`
`614`	`620`	`#[test]`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,7 @@ mod validators {`
`223`	`223`	`#[nutype(validate(not_empty))]`
`224`	`224`	`pub struct Email(String);`
`225`	`225`
`226`		`- assert_eq!(EmailError::NotEmptyViolated.to_string(), "empty");`
	`226`	`+ assert_eq!(EmailError::NotEmptyViolated.to_string(), "Email is empty.");`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`mod when_boundaries_defined_as_constants {`
Original file line number	Diff line number	Diff line change
@@ -13,5 +13,5 @@ note: ...and refers to the struct `Percentage` which is defined here
`13`	`13`	`--> tests/ui/float/visibility/private.rs:4:5`
`14`	`14`	`\|`
`15`	`15`	`4 \| #[nutype(sanitize(with = \|n\| n.clamp(0.0, 100.0)))]`
`16`		`- \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ consider importing it directly`
	`16`	`+ \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ you could import this directly`
`17`	`17`	= note: this error originates in the attribute macro `nutype` (in Nightly builds, run with -Z macro-backtrace for more info)