Support skipping fields in Queryable derive (falls back to Default impl)

diesel-rs · Oct 27, 2021 · 7b773fb · 7b773fb
1 parent 9cb852b
commit 7b773fb
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 16 deletions.
diff --git a/diesel_derives/src/field.rs b/diesel_derives/src/field.rs
@@ -100,11 +100,19 @@ impl Field {
         }
     }
 
-    pub fn ty_for_deserialize(&self) -> Result<Cow<syn::Type>, Diagnostic> {
-        if let Some(meta) = self.flags.nested_item("deserialize_as")? {
-            meta.ty_value().map(Cow::Owned)
-        } else {
-            Ok(Cow::Borrowed(&self.ty))
+    /// Returns None if has `skip` flag
+    pub fn ty_for_deserialize(&self) -> Result<Option<Cow<syn::Type>>, Diagnostic> {
+        match (
+            self.flags.nested_item("deserialize_as")?,
+            self.has_flag("skip"),
+        ) {
+            (Some(meta), false) => Ok(Some(Cow::Owned(meta.ty_value()?))),
+            (None, false) => Ok(Some(Cow::Borrowed(&self.ty))),
+            (None, true) => Ok(None),
+            (Some(_), true) => Err(self
+                .flags
+                .span()
+                .error("Cannot have both `deserialize_as` and `skip` attributes")),
         }
     }
 }

diff --git a/diesel_derives/src/lib.rs b/diesel_derives/src/lib.rs
@@ -413,6 +413,9 @@ pub fn derive_query_id(input: TokenStream) -> TokenStream {
 ///   Then `Type` is converted via
 ///   [`.try_into`](https://doc.rust-lang.org/stable/std/convert/trait.TryInto.html#tymethod.try_into)
 ///   into the field type. By default this derive will deserialize directly into the field type
+/// * `[diesel(skip)]`, instead of deserializing anything into that type, deserialization will
+///   behave as if this field wasn't here, and it will simply be set using the `Default` impl
+///   of the type of the field.
 ///
 /// # Examples
 ///

diff --git a/diesel_derives/src/queryable.rs b/diesel_derives/src/queryable.rs
@@ -12,14 +12,22 @@ pub fn derive(item: syn::DeriveInput) -> Result<proc_macro2::TokenStream, Diagno
     let field_ty = model
         .fields()
         .iter()
-        .map(Field::ty_for_deserialize)
+        .filter_map(|f| Field::ty_for_deserialize(f).transpose())
         .collect::<Result<Vec<_>, _>>()?;
     let field_ty = &field_ty;
-    let build_expr = model.fields().iter().enumerate().map(|(i, f)| {
-        let i = syn::Index::from(i);
-        f.name.assign(parse_quote!(row.#i.try_into()?))
-    });
-    let sql_type = (0..model.fields().len())
+    let build_expr = {
+        let mut non_default_field_idx = 0;
+        model.fields().iter().map(move |f| {
+            f.name.assign(if f.has_flag("skip") {
+                parse_quote!(std::default::Default::default())
+            } else {
+                let i = syn::Index::from(non_default_field_idx);
+                non_default_field_idx += 1;
+                parse_quote!(row.#i.try_into()?)
+            })
+        })
+    };
+    let sql_type = (0..field_ty.len())
         .map(|i| {
             let i = syn::Ident::new(&format!("__ST{}", i), proc_macro2::Span::call_site());
             quote!(#i)
@@ -32,7 +40,7 @@ pub fn derive(item: syn::DeriveInput) -> Result<proc_macro2::TokenStream, Diagno
     generics
         .params
         .push(parse_quote!(__DB: diesel::backend::Backend));
-    for id in 0..model.fields().len() {
+    for id in 0..field_ty.len() {
         let ident = syn::Ident::new(&format!("__ST{}", id), proc_macro2::Span::call_site());
         generics.params.push(parse_quote!(#ident));
     }

diff --git a/diesel_derives/tests/queryable.rs b/diesel_derives/tests/queryable.rs
@@ -1,12 +1,12 @@
 use diesel::dsl::sql;
-use diesel::sql_types::Integer;
+use diesel::sql_types::{Integer, Text};
 use diesel::*;
 
 use helpers::connection;
 
 #[test]
 fn named_struct_definition() {
-    #[derive(Debug, Clone, Copy, PartialEq, Eq, Queryable)]
+    #[derive(Debug, PartialEq, Eq, Queryable)]
     struct MyStruct {
         foo: i32,
         bar: i32,
@@ -19,7 +19,7 @@ fn named_struct_definition() {
 
 #[test]
 fn tuple_struct() {
-    #[derive(Debug, Clone, Copy, PartialEq, Eq, Queryable)]
+    #[derive(Debug, PartialEq, Eq, Queryable)]
     struct MyStruct(#[column_name = "foo"] i32, #[column_name = "bar"] i32);
 
     let conn = &mut connection();
@@ -29,10 +29,42 @@ fn tuple_struct() {
 
 #[test]
 fn tuple_struct_without_column_name_annotations() {
-    #[derive(Debug, Clone, Copy, PartialEq, Eq, Queryable)]
+    #[derive(Debug, PartialEq, Eq, Queryable)]
     struct MyStruct(i32, i32);
 
     let conn = &mut connection();
     let data = select(sql::<(Integer, Integer)>("1, 2")).get_result(conn);
     assert_eq!(Ok(MyStruct(1, 2)), data);
 }
+
+#[test]
+fn named_struct_definition_with_skip() {
+    #[derive(Debug, PartialEq, Eq, Queryable)]
+    struct MyStruct {
+        foo: i32,
+        #[diesel(skip)]
+        should_be_default: Vec<i32>,
+        bar: String,
+    }
+
+    let conn = &mut connection();
+    let data = select(sql::<(Integer, Text)>("1, '2'")).get_result(conn);
+    assert_eq!(
+        Ok(MyStruct {
+            foo: 1,
+            should_be_default: Vec::default(),
+            bar: "2".to_string(),
+        }),
+        data
+    );
+}
+
+#[test]
+fn tuple_struct_with_skip() {
+    #[derive(Debug, PartialEq, Eq, Queryable)]
+    struct MyStruct(i32, #[diesel(skip)] Option<i32>, String);
+
+    let conn = &mut connection();
+    let data = select(sql::<(Integer, Text)>("1, '2'")).get_result(conn);
+    assert_eq!(Ok(MyStruct(1, None, "2".to_string())), data);
+}