Release 0.8.21

Implement skip_serializing for enum variant

README.md

@@ -11,6 +11,7 @@ You may be looking for:
 - [Setting up `#[derive(Serialize, Deserialize)]`](https://serde.rs/codegen.html)
 - [Examples](https://serde.rs/examples.html)
 - [API documentation](https://docs.serde.rs/serde/)
+- [Release notes](https://github.com/serde-rs/serde/releases)
 
 ## Serde in action
 

serde/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde"
-version = "0.8.19"
+version = "0.8.21"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "A generic serialization/deserialization framework"

serde/src/de/impls.rs

@@ -283,6 +283,12 @@ impl Visitor for StringVisitor {
         Ok(v)
     }
 
+    fn visit_unit<E>(&mut self) -> Result<String, E>
+        where E: Error,
+    {
+        Ok(String::new())
+    }
+
     fn visit_bytes<E>(&mut self, v: &[u8]) -> Result<String, E>
         where E: Error,
     {

serde_codegen/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_codegen"
-version = "0.8.19"
+version = "0.8.21"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "Macros to auto-generate implementations for the serde framework"
@@ -22,8 +22,8 @@ with-syn = []
 
 [dependencies]
 clippy = { version = "^0.*", optional = true }
-quote = "0.3"
+quote = "0.3.8"
-serde_codegen_internals = { version = "=0.11.1", default-features = false, path = "../serde_codegen_internals" }
+serde_codegen_internals = { version = "=0.11.3", default-features = false, path = "../serde_codegen_internals" }
 syn = { version = "0.10", features = ["aster", "visit"] }
-syntex = { version = "^0.50.0", optional = true }
+syntex = { version = "^0.52.0", optional = true }
-syntex_syntax = { version = "^0.50.0", optional = true }
+syntex_syntax = { version = "^0.52.0", optional = true }

serde_codegen/src/de.rs

@@ -496,6 +496,7 @@ fn deserialize_item_enum(
 
     let variant_visitor = deserialize_field_visitor(
         variants.iter()
+            .filter(|variant| !variant.attrs.skip_deserializing())
             .map(|variant| variant.attrs.name().deserialize_name())
             .collect(),
         item_attrs,
@@ -518,7 +519,7 @@ fn deserialize_item_enum(
 
     // Match arms to extract a variant from a string
     let mut variant_arms = vec![];
-    for (i, variant) in variants.iter().enumerate() {
+    for (i, variant) in variants.iter().filter(|variant| !variant.attrs.skip_deserializing()).enumerate() {
         let variant_name = aster::id(format!("__field{}", i));
         let variant_name = quote!(__Field::#variant_name);
 

serde_codegen/src/lib.rs

@@ -38,11 +38,11 @@ fn syntex_registry() -> syntex::Registry {
 
         impl fold::Folder for StripAttributeFolder {
             fn fold_attribute(&mut self, attr: ast::Attribute) -> Option<ast::Attribute> {
-                match attr.node.value.node {
+                if attr.value.name == "serde" {
-                    ast::MetaItemKind::List(ref n, _) if n == &"serde" => { return None; }
+                    if let ast::MetaItemKind::List(..) = attr.value.node {
-                    _ => {}
+                        return None;
+                    }
                 }
-
                 Some(attr)
             }
 
@@ -118,11 +118,10 @@ macro_rules! shim {
             struct MarkSerdeAttributesUsed;
             impl visit::Visitor for MarkSerdeAttributesUsed {
                 fn visit_attribute(&mut self, attr: &ast::Attribute) {
-                    match attr.node.value.node {
+                    if attr.value.name == "serde" {
-                        ast::MetaItemKind::List(ref name, _) if name == "serde" => {
+                        if let ast::MetaItemKind::List(..) = attr.value.node {
                             attr::mark_used(attr);
                         }
-                        _ => {}
                     }
                 }
             }
@@ -159,15 +158,15 @@ mod shim {
 #[cfg(feature = "with-syn")]
 #[doc(hidden)]
 /// Not public API. Use the serde_derive crate.
-pub fn expand_derive_serialize(item: &str) -> Result<String, String> {
+pub fn expand_derive_serialize(item: &str) -> Result<quote::Tokens, String> {
     let syn_item = syn::parse_macro_input(item).unwrap();
-    ser::expand_derive_serialize(&syn_item).map(|derive| derive.to_string())
+    ser::expand_derive_serialize(&syn_item)
 }
 
 #[cfg(feature = "with-syn")]
 #[doc(hidden)]
 /// Not public API. Use the serde_derive crate.
-pub fn expand_derive_deserialize(item: &str) -> Result<String, String> {
+pub fn expand_derive_deserialize(item: &str) -> Result<quote::Tokens, String> {
     let syn_item = syn::parse_macro_input(item).unwrap();
-    de::expand_derive_deserialize(&syn_item).map(|derive| derive.to_string())
+    de::expand_derive_deserialize(&syn_item)
 }

serde_codegen/src/ser.rs

@@ -256,76 +256,80 @@ fn serialize_variant(
     let variant_ident = variant.ident.clone();
     let variant_name = variant.attrs.name().serialize_name();
 
-    match variant.style {
+    if variant.attrs.skip_serializing() {
-        Style::Unit => {
+        let skipped_msg = format!("The enum variant {}::{} cannot be serialized",
-            quote! {
+                                type_ident, variant_ident);
-                #type_ident::#variant_ident =>
+        let skipped_err = quote! {
-                    _serde::ser::Serializer::serialize_unit_variant(
+            Err(_serde::ser::Error::invalid_value(#skipped_msg))
-                        _serializer,
+        };
-                        #type_name,
+        let fields_pat = match variant.style {
-                        #variant_index,
+            Style::Unit => quote!(),
-                        #variant_name,
+            Style::Newtype | Style::Tuple => quote!( (..) ),
-                    ),
+            Style::Struct => quote!( {..} ),
-            }
+        };
-        },
+        quote! {
-        Style::Newtype => {
+            #type_ident::#variant_ident #fields_pat => #skipped_err,
-            let block = serialize_newtype_variant(
-                type_name,
-                variant_index,
-                variant_name,
-                ty,
-                generics,
-                &variant.fields[0],
-            );
-
-            quote! {
-                #type_ident::#variant_ident(ref __simple_value) => #block,
-            }
-        },
-        Style::Tuple => {
-            let field_names: Vec<Tokens> = (0 .. variant.fields.len())
-                .map(|i| {
-                    let id = aster::id(format!("__field{}", i));
-                    quote!(ref #id)
-                })
-                .collect();
-
-            let pat = quote!(#type_ident::#variant_ident(#(#field_names),*));
-
-            let block = serialize_tuple_variant(
-                type_name,
-                variant_index,
-                variant_name,
-                generics,
-                ty,
-                &variant.fields,
-            );
-
-            quote! {
-                #pat => { #block }
-            }
         }
-        Style::Struct => {
+    } else { // variant wasn't skipped
-            let fields = variant.fields.iter().map(|field| {
+        match variant.style {
-                let id = match field.ident {
+            Style::Unit => {
-                    Some(ref name) => name.clone(),
+                quote! {
-                    None => panic!("struct variant has unnamed fields"),
+                    #type_ident::#variant_ident =>
-                };
+                        _serde::ser::Serializer::serialize_unit_variant(
-                quote!(ref #id)
+                            _serializer,
-            });
+                            #type_name,
-            let pat = quote!(#type_ident::#variant_ident { #(#fields),* });
+                            #variant_index,
+                            #variant_name,
+                        ),
+                }
+            },
+            Style::Newtype => {
+                let block = serialize_newtype_variant(
+                    type_name,
+                    variant_index,
+                    variant_name,
+                    ty,
+                    generics,
+                    &variant.fields[0],
+                );
 
-            let block = serialize_struct_variant(
+                quote! {
-                variant_index,
+                    #type_ident::#variant_ident(ref __simple_value) => #block,
-                variant_name,
+                }
-                generics,
+            },
-                ty,
+            Style::Tuple => {
-                &variant.fields,
+                let field_names = (0 .. variant.fields.len())
-                item_attrs,
+                    .map(|i| aster::id(format!("__field{}", i)));
-            );
 
-            quote! {
+                let block = serialize_tuple_variant(
-                #pat => { #block }
+                    type_name,
+                    variant_index,
+                    variant_name,
+                    generics,
+                    ty,
+                    &variant.fields,
+                );
+
+                quote! {
+                    #type_ident::#variant_ident(#(ref #field_names),*) => { #block }
+                }
+            }
+            Style::Struct => {
+                let fields = variant.fields.iter()
+                    .map(|f| f.ident.clone().expect("struct variant has unnamed fields"));
+
+                let block = serialize_struct_variant(
+                    variant_index,
+                    variant_name,
+                    generics,
+                    ty,
+                    &variant.fields,
+                    item_attrs,
+                );
+
+                quote! {
+                    #type_ident::#variant_ident { #(ref #fields),* } => { #block }
+                }
             }
         }
     }

serde_codegen_internals/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_codegen_internals"
-version = "0.11.1"
+version = "0.11.3"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "AST representation used by Serde codegen. Unstable."

serde_codegen_internals/src/attr.rs

@@ -187,12 +187,16 @@ impl Item {
 #[derive(Debug)]
 pub struct Variant {
     name: Name,
+    skip_deserializing: bool,
+    skip_serializing: bool,
 }
 
 impl Variant {
     pub fn from_ast(cx: &Ctxt, variant: &syn::Variant) -> Self {
         let mut ser_name = Attr::none(cx, "rename");
         let mut de_name = Attr::none(cx, "rename");
+        let mut skip_deserializing = BoolAttr::none(cx, "skip_deserializing");
+        let mut skip_serializing = BoolAttr::none(cx, "skip_serializing");
 
         for meta_items in variant.attrs.iter().filter_map(get_serde_meta_items) {
             for meta_item in meta_items {
@@ -212,6 +216,14 @@ impl Variant {
                             de_name.set_opt(de);
                         }
                     }
+                    // Parse `#[serde(skip_deserializing)]`
+                    MetaItem(Word(ref name)) if name == "skip_deserializing" => {
+                        skip_deserializing.set_true();
+                    }
+                    // Parse `#[serde(skip_serializing)]`
+                    MetaItem(Word(ref name)) if name == "skip_serializing" => {
+                        skip_serializing.set_true();
+                    }
 
                     MetaItem(ref meta_item) => {
                         cx.error(format!("unknown serde variant attribute `{}`",
@@ -230,12 +242,22 @@ impl Variant {
                 serialize: ser_name.get().unwrap_or_else(|| variant.ident.to_string()),
                 deserialize: de_name.get().unwrap_or_else(|| variant.ident.to_string()),
             },
+            skip_deserializing: skip_deserializing.get(),
+            skip_serializing: skip_serializing.get(),
         }
     }
 
     pub fn name(&self) -> &Name {
         &self.name
     }
+
+    pub fn skip_deserializing(&self) -> bool {
+        self.skip_deserializing
+    }
+
+    pub fn skip_serializing(&self) -> bool {
+        self.skip_serializing
+    }
 }
 
 /// Represents field attribute information

serde_derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_derive"
-version = "0.8.19"
+version = "0.8.21"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "Macros 1.1 implementation of #[derive(Serialize, Deserialize)]"
@@ -15,7 +15,7 @@ name = "serde_derive"
 proc-macro = true
 
 [dependencies.serde_codegen]
-version = "=0.8.19"
+version = "=0.8.21"
 path = "../serde_codegen"
 default-features = false
 features = ["with-syn"]
@@ -23,5 +23,5 @@ features = ["with-syn"]
 [dev-dependencies]
 compiletest_rs = "^0.2.0"
 fnv = "1.0"
-serde = { version = "0.8.19", path = "../serde" }
+serde = { version = "0.8.21", path = "../serde" }
-serde_test = { version = "0.8.19", path = "../serde_test" }
+serde_test = { version = "0.8.21", path = "../serde_test" }

serde_derive/src/lib.rs

@@ -1,5 +1,4 @@
 #![feature(proc_macro, proc_macro_lib)]
-#![cfg(not(test))]
 
 extern crate proc_macro;
 extern crate serde_codegen;

serde_test/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_test"
-version = "0.8.19"
+version = "0.8.21"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "Token De/Serializer for testing De/Serialize implementations"
@@ -12,4 +12,4 @@ keywords = ["serde", "serialization"]
 include = ["Cargo.toml", "src/**/*.rs"]
 
 [dependencies]
-serde = { version = "0.8.19", path = "../serde" }
+serde = { version = "0.8.21", path = "../serde" }

testing/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_testing"
-version = "0.8.19"
+version = "0.8.21"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "A generic serialization/deserialization framework"

testing/tests/test_de.rs

@@ -37,7 +37,10 @@ enum Enum {
     Unit,
     Simple(i32),
     Seq(i32, i32, i32),
-    Map { a: i32, b: i32, c: i32 }
+    Map { a: i32, b: i32, c: i32 },
+    #[allow(dead_code)]
+    #[serde(skip_deserializing)]
+    Skipped,
 }
 
 //////////////////////////////////////////////////////////////////////////
@@ -215,6 +218,9 @@ declare_tests! {
             Token::SeqEnd,
         ],
     }
+    test_unit_string {
+        String::new() => &[Token::Unit],
+    }
     test_tuple_struct {
         TupleStruct(1, 2, 3) => &[
             Token::SeqStart(Some(3)),
@@ -802,6 +808,12 @@ declare_error_tests! {
         ],
         Error::UnknownVariant("Foo".to_owned()),
     }
+    test_enum_skipped_variant<Enum> {
+        &[
+            Token::EnumUnit("Enum", "Skipped"),
+        ],
+        Error::UnknownVariant("Skipped".to_owned()),
+    }
     test_struct_seq_too_long<Struct> {
         &[
             Token::SeqStart(Some(4)),

testing/tests/test_ser.rs

@@ -30,12 +30,20 @@ struct Struct {
     c: i32,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, PartialEq, Debug)]
 enum Enum {
     Unit,
     One(i32),
     Seq(i32, i32),
     Map { a: i32, b: i32 },
+    #[serde(skip_serializing)]
+    SkippedUnit,
+    #[serde(skip_serializing)]
+    SkippedOne(i32),
+    #[serde(skip_serializing)]
+    SkippedSeq(i32, i32),
+    #[serde(skip_serializing)]
+    SkippedMap { _a: i32, _b: i32 },
 }
 
 //////////////////////////////////////////////////////////////////////////
@@ -388,3 +396,23 @@ fn test_cannot_serialize_paths() {
         &[],
         Error::InvalidValue("Path contains invalid UTF-8 characters".to_owned()));
 }
+
+#[test]
+fn test_enum_skipped() {
+    assert_ser_tokens_error(
+        &Enum::SkippedUnit,
+        &[],
+        Error::InvalidValue("The enum variant Enum::SkippedUnit cannot be serialized".to_owned()));
+    assert_ser_tokens_error(
+        &Enum::SkippedOne(42),
+        &[],
+        Error::InvalidValue("The enum variant Enum::SkippedOne cannot be serialized".to_owned()));
+    assert_ser_tokens_error(
+        &Enum::SkippedSeq(1, 2),
+        &[],
+        Error::InvalidValue("The enum variant Enum::SkippedSeq cannot be serialized".to_owned()));
+    assert_ser_tokens_error(
+        &Enum::SkippedMap { _a: 1, _b: 2 },
+        &[],
+        Error::InvalidValue("The enum variant Enum::SkippedMap cannot be serialized".to_owned()));
+}