Add support for jiff v0.2 (#1332)

This commit adds support for v0.2 of the `jiff` date-time crate, similar to how it is already implemented for `chrono` and `time`.
---------

Co-authored-by: Juha Kukkonen <juha7kukkonen@gmail.com>

Author: Turbo87

README.md

@@ -84,6 +84,10 @@ and the `ipa` is _api_ reversed. Aaand... `ipa` is also an awesome type of beer
   By default these types are parsed as `string`. `OffsetDateTime` and `PrimitiveDateTime` will use `date-time` format. `Date` will use
   `date` format and `Duration` will not have any format. To override default `string` representation users have to use `value_type` attribute
   to override the type. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
+- **`jiff_0_2`** Add support for [jiff 0.2](https://crates.io/crates/jiff) `Zoned`, and `civil::Date` types.
+  By default these types are parsed as `string`. `Zoned` will use `date-time` format. `civil::Date` will use
+  `date` format. To override default `string` representation users have to use `value_type` attribute
+  to override the type. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
 - **`decimal`**: Add support for [rust_decimal](https://crates.io/crates/rust_decimal) `Decimal` type. **By default**
   it is interpreted as `String`. If you wish to change the format you need to override the type.
   See the `value_type` in [component derive docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html).

scripts/test.sh

@@ -19,7 +19,7 @@ for crate in $crates; do
     if [[ "$crate" == "utoipa" ]]; then
         $CARGO ${CARGO_COMMAND} -p utoipa --features openapi_extensions,preserve_order,preserve_path_order,debug,macros
     elif [[ "$crate" == "utoipa-gen" ]]; then
-        $CARGO ${CARGO_COMMAND} -p utoipa-gen --features utoipa/actix_extras,chrono,decimal,utoipa/uuid,uuid,utoipa/ulid,ulid,utoipa/url,url,utoipa/time,time,utoipa/repr,utoipa/smallvec,smallvec,rc_schema,utoipa/rc_schema,utoipa/macros
+        $CARGO ${CARGO_COMMAND} -p utoipa-gen --features utoipa/actix_extras,chrono,decimal,utoipa/uuid,uuid,utoipa/ulid,ulid,utoipa/url,url,utoipa/time,time,jiff_0_2,utoipa/repr,utoipa/smallvec,smallvec,rc_schema,utoipa/rc_schema,utoipa/macros
         $CARGO ${CARGO_COMMAND} -p utoipa-gen --test schema_derive_test --features decimal_float,utoipa/macros
 
         $CARGO ${CARGO_COMMAND} -p utoipa-gen --test path_derive_auto_into_responses --features auto_into_responses,utoipa/uuid,uuid,utoipa/macros

utoipa-gen/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog - utoipa-gen
 
+## Unreleased
+
+### Added
+
+* Add support for jiff v0.2 (https://github.com/juahku/utoipa/pull/1332)
+
 ## 5.3.1 - Jan 6 2025
 
 ### Fixed

utoipa-gen/Cargo.toml

@@ -51,6 +51,7 @@ smallvec = { version = "1.10", features = ["serde"] }
 rust_decimal = { version = "1", default-features = false }
 chrono = { version = "0.4", features = ["serde"] }
 time = { version = "0.3", features = ["serde-human-readable"] }
+jiff = { version = "0.2", features = ["serde"] }
 serde_with = "3.0"
 insta = { version = "1.41", features = ["json"] }
 
@@ -69,6 +70,7 @@ ulid = ["dep:ulid"]
 url = ["dep:url"]
 axum_extras = ["regex", "syn/extra-traits"]
 time = []
+jiff_0_2 = []
 smallvec = []
 repr = []
 indexmap = []

utoipa-gen/src/schema_type.rs

@@ -135,6 +135,11 @@ impl SchemaType<'_> {
                 );
             }
 
+            #[cfg(feature = "jiff_0_2")]
+            if !primitive {
+                primitive = matches!(name, "Zoned" | "Date");
+            }
+
             primitive
         }
     }
@@ -268,7 +273,7 @@ impl ToTokensDiagnostics for SchemaType<'_> {
                 schema_type_tokens(tokens, SchemaTypeInner::String, self.nullable)
             }
 
-            #[cfg(any(feature = "chrono", feature = "time"))]
+            #[cfg(any(feature = "chrono", feature = "time", feature = "jiff_0_2"))]
             "Date" | "Duration" => {
                 schema_type_tokens(tokens, SchemaTypeInner::String, self.nullable)
             }
@@ -295,6 +300,8 @@ impl ToTokensDiagnostics for SchemaType<'_> {
             "PrimitiveDateTime" | "OffsetDateTime" => {
                 schema_type_tokens(tokens, SchemaTypeInner::String, self.nullable)
             }
+            #[cfg(feature = "jiff_0_2")]
+            "Zoned" => schema_type_tokens(tokens, SchemaTypeInner::String, self.nullable),
             _ => schema_type_tokens(tokens, SchemaTypeInner::Object, self.nullable),
         };
 
@@ -399,7 +406,7 @@ impl KnownFormat {
             #[cfg(feature = "chrono")]
             "DateTime" | "NaiveDateTime" => Self::DateTime,
 
-            #[cfg(any(feature = "chrono", feature = "time"))]
+            #[cfg(any(feature = "chrono", feature = "time", feature = "jiff_0_2"))]
             "Date" => Self::Date,
 
             #[cfg(feature = "decimal_float")]
@@ -416,6 +423,9 @@ impl KnownFormat {
 
             #[cfg(feature = "time")]
             "PrimitiveDateTime" | "OffsetDateTime" => Self::DateTime,
+
+            #[cfg(feature = "jiff_0_2")]
+            "Zoned" => Self::DateTime,
             _ => Self::Unknown,
         };
 
@@ -694,8 +704,13 @@ impl PrimitiveType {
                 syn::parse_quote!(String)
             }
 
+            #[cfg(any(feature = "chrono", feature = "time", feature = "jiff_0_2"))]
+            "Date" => {
+                syn::parse_quote!(String)
+            }
+
             #[cfg(any(feature = "chrono", feature = "time"))]
-            "Date" | "Duration" => {
+            "Duration" => {
                 syn::parse_quote!(String)
             }
 
@@ -733,6 +748,11 @@ impl PrimitiveType {
             "PrimitiveDateTime" | "OffsetDateTime" => {
                 syn::parse_quote!(String)
             }
+
+            #[cfg(feature = "jiff_0_2")]
+            "Zoned" => {
+                syn::parse_quote!(String)
+            }
             _ => {
                 // not a primitive type
                 return None;

utoipa-gen/tests/schema_derive_test.rs

@@ -1665,6 +1665,19 @@ fn derive_component_with_time_feature() {
     assert_json_snapshot!(&times);
 }
 
+#[cfg(feature = "jiff_0_2")]
+#[test]
+fn derive_component_with_jiff_0_2_feature() {
+    let doc = api_doc! {
+        struct Timetest {
+            civil_date: jiff::civil::Date,
+            zoned: jiff::Zoned,
+        }
+    };
+
+    assert_json_snapshot!(&doc);
+}
+
 #[test]
 fn derive_struct_component_field_type_override() {
     let post = api_doc! {

utoipa-gen/tests/snapshots/schema_derive_test__derive_component_with_jiff_0_2_feature.snap

@@ -0,0 +1,21 @@
+---
+source: utoipa-gen/tests/schema_derive_test.rs
+expression: "&doc"
+---
+{
+  "properties": {
+    "civil_date": {
+      "format": "date",
+      "type": "string"
+    },
+    "zoned": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "civil_date",
+    "zoned"
+  ],
+  "type": "object"
+}

utoipa/CHANGELOG.md

@@ -5,6 +5,10 @@ to look into changes introduced to **`utoipa-gen`**.
 
 ## Unreleased
 
+### Added
+
+* Add support for jiff v0.2 (https://github.com/juahku/utoipa/pull/1332)
+
 ### Changed
 
 * Replaced `serde_yaml` with `serde_norway` (https://github.com/juhaku/utoipa/pull/1311)

utoipa/Cargo.toml

@@ -43,6 +43,7 @@ uuid = ["utoipa-gen?/uuid"]
 ulid = ["utoipa-gen?/ulid"]
 url = ["utoipa-gen?/url"]
 time = ["utoipa-gen?/time"]
+jiff_0_2 = ["utoipa-gen?/jiff_0_2"]
 smallvec = ["utoipa-gen?/smallvec"]
 indexmap = ["utoipa-gen?/indexmap"]
 openapi_extensions = []

utoipa/src/lib.rs

@@ -81,6 +81,10 @@
 //!   By default these types are parsed as `string`. `OffsetDateTime` and `PrimitiveDateTime` will use `date-time` format. `Date` will use
 //!   `date` format and `Duration` will not have any format. To override default `string` representation users have to use `value_type` attribute
 //!   to override the type. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
+//! * **`jiff_0_2`** Add support for [jiff 0.2](https://crates.io/crates/jiff) `Zoned`, and `civil::Date` types.
+//!   By default these types are parsed as `string`. `Zoned` will use `date-time` format. `civil::Date` will use
+//!   `date` format. To override default `string` representation users have to use `value_type` attribute
+//!   to override the type. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
 //! * **`decimal`** Add support for [rust_decimal](https://crates.io/crates/rust_decimal) `Decimal` type. **By default**
 //!   it is interpreted as `String`. If you wish to change the format you need to override the type.
 //!   See the `value_type` in [`ToSchema` derive docs][to_schema_derive].