Release 0.9.10

Fix documentation of serialize_tuple and SerializeTuple

serde/Cargo.toml

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

serde/src/ser/mod.rs

@@ -466,13 +466,13 @@ pub trait Serializer: Sized {
     fn serialize_seq_fixed_size(self, size: usize) -> Result<Self::SerializeSeq, Self::Error>;
 
     /// Begin to serialize a tuple. This call must be followed by zero or more
-    /// calls to `serialize_field`, then a call to `end`.
+    /// calls to `serialize_element`, then a call to `end`.
     ///
     /// ```rust,ignore
     /// let mut tup = serializer.serialize_tuple(3)?;
-    /// tup.serialize_field(&self.0)?;
-    /// tup.serialize_field(&self.1)?;
-    /// tup.serialize_field(&self.2)?;
+    /// tup.serialize_element(&self.0)?;
+    /// tup.serialize_element(&self.1)?;
+    /// tup.serialize_element(&self.2)?;
     /// tup.end()
     /// ```
     fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, Self::Error>;
@@ -646,9 +646,9 @@ pub trait SerializeSeq {
 ///
 /// ```rust,ignore
 /// let mut tup = serializer.serialize_tuple(3)?;
-/// tup.serialize_field(&self.0)?;
-/// tup.serialize_field(&self.1)?;
-/// tup.serialize_field(&self.2)?;
+/// tup.serialize_element(&self.0)?;
+/// tup.serialize_element(&self.1)?;
+/// tup.serialize_element(&self.2)?;
 /// tup.end()
 /// ```
 pub trait SerializeTuple {

serde/src/ser/private.rs

@@ -11,7 +11,7 @@ pub fn serialize_tagged_newtype<S, T>(serializer: S,
                                       variant_ident: &'static str,
                                       tag: &'static str,
                                       variant_name: &'static str,
-                                      value: T)
+                                      value: &T)
                                       -> Result<S::Ok, S::Error>
     where S: Serializer,
           T: Serialize

serde_codegen_internals/Cargo.toml

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

serde_codegen_internals/src/ast.rs

@@ -38,7 +38,7 @@ impl<'a> Item<'a> {
     pub fn from_ast(cx: &Ctxt, item: &'a syn::MacroInput) -> Item<'a> {
         let attrs = attr::Item::from_ast(cx, item);
 
-        let body = match item.body {
+        let mut body = match item.body {
             syn::Body::Enum(ref variants) => Body::Enum(enum_from_ast(cx, variants)),
             syn::Body::Struct(ref variant_data) => {
                 let (style, fields) = struct_from_ast(cx, variant_data);
@@ -46,6 +46,22 @@ impl<'a> Item<'a> {
             }
         };
 
+        match body {
+            Body::Enum(ref mut variants) => {
+                for ref mut variant in variants {
+                    variant.attrs.rename_by_rule(attrs.rename_all());
+                    for ref mut field in &mut variant.fields {
+                        field.attrs.rename_by_rule(variant.attrs.rename_all());
+                    }
+                }
+            }
+            Body::Struct(_, ref mut fields) => {
+                for field in fields {
+                    field.attrs.rename_by_rule(attrs.rename_all());
+                }
+            }
+        }
+
         Item {
             ident: item.ident.clone(),
             attrs: attrs,

serde_codegen_internals/src/attr.rs

@@ -2,6 +2,7 @@ use Ctxt;
 use syn;
 use syn::MetaItem::{List, NameValue, Word};
 use syn::NestedMetaItem::{Literal, MetaItem};
+use std::str::FromStr;
 
 // This module handles parsing of `#[serde(...)]` attributes. The entrypoints
 // are `attr::Item::from_ast`, `attr::Variant::from_ast`, and
@@ -11,6 +12,8 @@ use syn::NestedMetaItem::{Literal, MetaItem};
 // user will see errors simultaneously for all bad attributes in the crate
 // rather than just the first.
 
+pub use case::RenameRule;
+
 struct Attr<'c, T> {
     cx: &'c Ctxt,
     name: &'static str,
@@ -91,6 +94,7 @@ pub struct Item {
     name: Name,
     deny_unknown_fields: bool,
     default: Default,
+    rename_all: RenameRule,
     ser_bound: Option<Vec<syn::WherePredicate>>,
     de_bound: Option<Vec<syn::WherePredicate>>,
     tag: EnumTag,
@@ -135,6 +139,7 @@ impl Item {
         let mut de_name = Attr::none(cx, "rename");
         let mut deny_unknown_fields = BoolAttr::none(cx, "deny_unknown_fields");
         let mut default = Attr::none(cx, "default");
+        let mut rename_all = Attr::none(cx, "rename_all");
         let mut ser_bound = Attr::none(cx, "bound");
         let mut de_bound = Attr::none(cx, "bound");
         let mut untagged = BoolAttr::none(cx, "untagged");
@@ -160,6 +165,20 @@ impl Item {
                         }
                     }
 
+                    // Parse `#[serde(rename_all="foo")]`
+                    MetaItem(NameValue(ref name, ref lit)) if name == "rename_all" => {
+                        if let Ok(s) = get_string_from_lit(cx, name.as_ref(), name.as_ref(), lit) {
+                            match RenameRule::from_str(&s) {
+                                Ok(rename_rule) => rename_all.set(rename_rule),
+                                Err(()) => {
+                                    cx.error(format!("unknown rename rule for #[serde(rename_all \
+                                                      = {:?})]",
+                                                     s))
+                                }
+                            }
+                        }
+                    }
+
                     // Parse `#[serde(deny_unknown_fields)]`
                     MetaItem(Word(ref name)) if name == "deny_unknown_fields" => {
                         deny_unknown_fields.set_true();
@@ -244,7 +263,8 @@ impl Item {
                                     content.set(s);
                                 }
                                 syn::Body::Struct(_) => {
-                                    cx.error("#[serde(content = \"...\")] can only be used on enums")
+                                    cx.error("#[serde(content = \"...\")] can only be used on \
+                                              enums")
                                 }
                             }
                         }
@@ -297,7 +317,10 @@ impl Item {
                 EnumTag::External
             }
             (false, Some(tag), Some(content)) => {
-                EnumTag::Adjacent { tag: tag, content: content }
+                EnumTag::Adjacent {
+                    tag: tag,
+                    content: content,
+                }
             }
             (true, Some(_), Some(_)) => {
                 cx.error("untagged enum cannot have #[serde(tag = \"...\", content = \"...\")]");
@@ -312,6 +335,7 @@ impl Item {
             },
             deny_unknown_fields: deny_unknown_fields.get(),
             default: default.get().unwrap_or(Default::None),
+            rename_all: rename_all.get().unwrap_or(RenameRule::None),
             ser_bound: ser_bound.get(),
             de_bound: de_bound.get(),
             tag: tag,
@@ -322,6 +346,10 @@ impl Item {
         &self.name
     }
 
+    pub fn rename_all(&self) -> &RenameRule {
+        &self.rename_all
+    }
+
     pub fn deny_unknown_fields(&self) -> bool {
         self.deny_unknown_fields
     }
@@ -347,6 +375,9 @@ impl Item {
 #[derive(Debug)]
 pub struct Variant {
     name: Name,
+    ser_renamed: bool,
+    de_renamed: bool,
+    rename_all: RenameRule,
     skip_deserializing: bool,
     skip_serializing: bool,
 }
@@ -357,6 +388,7 @@ impl Variant {
         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");
+        let mut rename_all = Attr::none(cx, "rename_all");
 
         for meta_items in variant.attrs.iter().filter_map(get_serde_meta_items) {
             for meta_item in meta_items {
@@ -376,6 +408,21 @@ impl Variant {
                             de_name.set_opt(de);
                         }
                     }
+
+                    // Parse `#[serde(rename_all="foo")]`
+                    MetaItem(NameValue(ref name, ref lit)) if name == "rename_all" => {
+                        if let Ok(s) = get_string_from_lit(cx, name.as_ref(), name.as_ref(), lit) {
+                            match RenameRule::from_str(&s) {
+                                Ok(rename_rule) => rename_all.set(rename_rule),
+                                Err(()) => {
+                                    cx.error(format!("unknown rename rule for #[serde(rename_all \
+                                                      = {:?})]",
+                                                     s))
+                                }
+                            }
+                        }
+                    }
+
                     // Parse `#[serde(skip_deserializing)]`
                     MetaItem(Word(ref name)) if name == "skip_deserializing" => {
                         skip_deserializing.set_true();
@@ -396,11 +443,18 @@ impl Variant {
             }
         }
 
+        let ser_name = ser_name.get();
+        let ser_renamed = ser_name.is_some();
+        let de_name = de_name.get();
+        let de_renamed = de_name.is_some();
         Variant {
             name: Name {
-                serialize: ser_name.get().unwrap_or_else(|| variant.ident.to_string()),
-                deserialize: de_name.get().unwrap_or_else(|| variant.ident.to_string()),
+                serialize: ser_name.unwrap_or_else(|| variant.ident.to_string()),
+                deserialize: de_name.unwrap_or_else(|| variant.ident.to_string()),
             },
+            ser_renamed: ser_renamed,
+            de_renamed: de_renamed,
+            rename_all: rename_all.get().unwrap_or(RenameRule::None),
             skip_deserializing: skip_deserializing.get(),
             skip_serializing: skip_serializing.get(),
         }
@@ -410,6 +464,19 @@ impl Variant {
         &self.name
     }
 
+    pub fn rename_by_rule(&mut self, rule: &RenameRule) {
+        if !self.ser_renamed {
+            self.name.serialize = rule.apply_to_variant(&self.name.serialize);
+        }
+        if !self.de_renamed {
+            self.name.deserialize = rule.apply_to_variant(&self.name.deserialize);
+        }
+    }
+
+    pub fn rename_all(&self) -> &RenameRule {
+        &self.rename_all
+    }
+
     pub fn skip_deserializing(&self) -> bool {
         self.skip_deserializing
     }
@@ -423,6 +490,8 @@ impl Variant {
 #[derive(Debug)]
 pub struct Field {
     name: Name,
+    ser_renamed: bool,
+    de_renamed: bool,
     skip_serializing: bool,
     skip_deserializing: bool,
     skip_serializing_if: Option<syn::Path>,
@@ -571,11 +640,17 @@ impl Field {
             default.set_if_none(Default::Default);
         }
 
+        let ser_name = ser_name.get();
+        let ser_renamed = ser_name.is_some();
+        let de_name = de_name.get();
+        let de_renamed = de_name.is_some();
         Field {
             name: Name {
-                serialize: ser_name.get().unwrap_or_else(|| ident.clone()),
-                deserialize: de_name.get().unwrap_or(ident),
+                serialize: ser_name.unwrap_or_else(|| ident.clone()),
+                deserialize: de_name.unwrap_or(ident),
             },
+            ser_renamed: ser_renamed,
+            de_renamed: de_renamed,
             skip_serializing: skip_serializing.get(),
             skip_deserializing: skip_deserializing.get(),
             skip_serializing_if: skip_serializing_if.get(),
@@ -591,6 +666,15 @@ impl Field {
         &self.name
     }
 
+    pub fn rename_by_rule(&mut self, rule: &RenameRule) {
+        if !self.ser_renamed {
+            self.name.serialize = rule.apply_to_field(&self.name.serialize);
+        }
+        if !self.de_renamed {
+            self.name.deserialize = rule.apply_to_field(&self.name.deserialize);
+        }
+    }
+
     pub fn skip_serializing(&self) -> bool {
         self.skip_serializing
     }

serde_codegen_internals/src/case.rs

@@ -0,0 +1,115 @@
+use std::ascii::AsciiExt;
+use std::str::FromStr;
+
+use self::RenameRule::*;
+
+#[derive(Debug, PartialEq)]
+pub enum RenameRule {
+    /// Don't apply a default rename rule.
+    None,
+    /// Rename direct children to "PascalCase" style, as typically used for enum variants.
+    PascalCase,
+    /// Rename direct children to "camelCase" style.
+    CamelCase,
+    /// Rename direct children to "snake_case" style, as commonly used for fields.
+    SnakeCase,
+    /// Rename direct children to "SCREAMING_SNAKE_CASE" style, as commonly used for constants.
+    ScreamingSnakeCase,
+    /// Rename direct children to "kebab-case" style.
+    KebabCase,
+}
+
+impl RenameRule {
+    pub fn apply_to_variant(&self, variant: &str) -> String {
+        match *self {
+            None | PascalCase => variant.to_owned(),
+            CamelCase => variant[..1].to_ascii_lowercase() + &variant[1..],
+            SnakeCase => {
+                let mut snake = String::new();
+                for (i, ch) in variant.char_indices() {
+                    if i > 0 && ch.is_uppercase() {
+                        snake.push('_');
+                    }
+                    snake.push(ch.to_ascii_lowercase());
+                }
+                snake
+            }
+            ScreamingSnakeCase => SnakeCase.apply_to_variant(variant).to_ascii_uppercase(),
+            KebabCase => SnakeCase.apply_to_variant(variant).replace('_', "-"),
+        }
+    }
+
+    pub fn apply_to_field(&self, field: &str) -> String {
+        match *self {
+            None | SnakeCase => field.to_owned(),
+            PascalCase => {
+                let mut pascal = String::new();
+                let mut capitalize = true;
+                for ch in field.chars() {
+                    if ch == '_' {
+                        capitalize = true;
+                    } else if capitalize {
+                        pascal.push(ch.to_ascii_uppercase());
+                        capitalize = false;
+                    } else {
+                        pascal.push(ch);
+                    }
+                }
+                pascal
+            }
+            CamelCase => {
+                let pascal = PascalCase.apply_to_field(field);
+                pascal[..1].to_ascii_lowercase() + &pascal[1..]
+            }
+            ScreamingSnakeCase => field.to_ascii_uppercase(),
+            KebabCase => field.replace('_', "-"),
+        }
+    }
+}
+
+impl FromStr for RenameRule {
+    type Err = ();
+
+    fn from_str(rename_all_str: &str) -> Result<Self, Self::Err> {
+        match rename_all_str {
+            "PascalCase" => Ok(PascalCase),
+            "camelCase" => Ok(CamelCase),
+            "snake_case" => Ok(SnakeCase),
+            "SCREAMING_SNAKE_CASE" => Ok(ScreamingSnakeCase),
+            "kebab-case" => Ok(KebabCase),
+            _ => Err(()),
+        }
+    }
+}
+
+#[test]
+fn rename_variants() {
+    for &(original, camel, snake, screaming, kebab) in
+        &[("Outcome", "outcome", "outcome", "OUTCOME", "outcome"),
+          ("VeryTasty", "veryTasty", "very_tasty", "VERY_TASTY", "very-tasty"),
+          ("A", "a", "a", "A", "a"),
+          ("Z42", "z42", "z42", "Z42", "z42")] {
+        assert_eq!(None.apply_to_variant(original), original);
+        assert_eq!(PascalCase.apply_to_variant(original), original);
+        assert_eq!(CamelCase.apply_to_variant(original), camel);
+        assert_eq!(SnakeCase.apply_to_variant(original), snake);
+        assert_eq!(ScreamingSnakeCase.apply_to_variant(original), screaming);
+        assert_eq!(KebabCase.apply_to_variant(original), kebab);
+    }
+}
+
+#[test]
+fn rename_fields() {
+    for &(original, pascal, camel, screaming, kebab) in
+        &[("outcome", "Outcome", "outcome", "OUTCOME", "outcome"),
+          ("very_tasty", "VeryTasty", "veryTasty", "VERY_TASTY", "very-tasty"),
+          ("a", "A", "a", "A", "a"),
+          ("z42", "Z42", "z42", "Z42", "z42")] {
+        assert_eq!(None.apply_to_field(original), original);
+        assert_eq!(PascalCase.apply_to_field(original), pascal);
+        assert_eq!(CamelCase.apply_to_field(original), camel);
+        assert_eq!(SnakeCase.apply_to_field(original), original);
+        assert_eq!(ScreamingSnakeCase.apply_to_field(original), screaming);
+        assert_eq!(KebabCase.apply_to_field(original), kebab);
+    }
+}

serde_codegen_internals/src/lib.rs

@@ -5,3 +5,5 @@ pub mod attr;
 
 mod ctxt;
 pub use ctxt::Ctxt;
+
+mod case;

serde_derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_derive"
-version = "0.9.9"
+version = "0.9.10"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "Macros 1.1 implementation of #[derive(Serialize, Deserialize)]"
@@ -23,5 +23,5 @@ proc-macro = true
 
 [dependencies]
 quote = "0.3.8"
-serde_codegen_internals = { version = "=0.14.0", default-features = false, path = "../serde_codegen_internals" }
+serde_codegen_internals = { version = "=0.14.1", default-features = false, path = "../serde_codegen_internals" }
 syn = { version = "0.11", features = ["visit"] }

serde_test/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde_test"
-version = "0.9.9"
+version = "0.9.10"
 authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "Token De/Serializer for testing De/Serialize implementations"

test_suite/Cargo.toml

@@ -5,10 +5,7 @@ authors = ["Erick Tryzelaar <erick.tryzelaar@gmail.com>"]
 publish = false
 
 [features]
-unstable-testing = [
-    "compiletest_rs",
-    "serde/unstable-testing",
-]
+unstable-testing = ["compiletest_rs"]
 
 [dev-dependencies]
 fnv = "1.0"
@@ -19,7 +16,3 @@ serde_test = { path = "../serde_test" }
 
 [dependencies]
 compiletest_rs = { version = "0.2", optional = true }
-
-[[test]]
-name = "test"
-path = "tests/test.rs"

test_suite/tests/compiletest.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "unstable-testing")]
+
 extern crate compiletest_rs as compiletest;
 
 use std::env;

test_suite/tests/test.rs

@@ -1,23 +0,0 @@
-#![cfg_attr(feature = "unstable-testing", feature(test, non_ascii_idents))]
-
-#[cfg(feature = "unstable-testing")]
-extern crate test;
-
-#[macro_use]
-extern crate serde_derive;
-
-extern crate serde;
-extern crate serde_test;
-
-#[macro_use]
-mod macros;
-
-mod test_annotations;
-mod test_bytes;
-mod test_de;
-mod test_gen;
-mod test_macros;
-mod test_ser;
-
-#[cfg(feature = "unstable-testing")]
-mod compiletest;

test_suite/tests/test_annotations.rs

@@ -1,3 +1,6 @@
+#[macro_use]
+extern crate serde_derive;
+
 extern crate serde;
 use self::serde::{Serialize, Serializer, Deserialize, Deserializer};
 

test_suite/tests/test_bytes.rs

@@ -1,4 +1,7 @@
+extern crate serde;
 use serde::bytes::{ByteBuf, Bytes};
+
+extern crate serde_test;
 use serde_test::{assert_tokens, assert_ser_tokens, assert_de_tokens, Token};
 
 #[test]

test_suite/tests/test_de.rs

@@ -1,9 +1,13 @@
+#[macro_use]
+extern crate serde_derive;
+
 use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
 use std::net;
 use std::path::PathBuf;
 use std::time::Duration;
 use std::default::Default;
 
+extern crate serde;
 use serde::Deserialize;
 
 extern crate fnv;
@@ -17,6 +21,9 @@ use self::serde_test::{
     assert_de_tokens_error,
 };
 
+#[macro_use]
+mod macros;
+
 //////////////////////////////////////////////////////////////////////////
 
 #[derive(Copy, Clone, PartialEq, Debug, Deserialize)]

test_suite/tests/test_gen.rs

@@ -2,6 +2,11 @@
 // successfully when there are a variety of generics and non-(de)serializable
 // types involved.
 
+#![cfg_attr(feature = "unstable-testing", feature(non_ascii_idents))]
+
+#[macro_use]
+extern crate serde_derive;
+
 extern crate serde;
 use self::serde::ser::{Serialize, Serializer};
 use self::serde::de::{Deserialize, Deserializer};

test_suite/tests/test_macros.rs

@@ -1,3 +1,6 @@
+#[macro_use]
+extern crate serde_derive;
+
 extern crate serde_test;
 use self::serde_test::{
     Error,
@@ -1222,3 +1225,89 @@ fn test_enum_in_untagged_enum() {
         ]
     );
 }
+
+#[test]
+fn test_rename_all() {
+    #[derive(Serialize, Deserialize, Debug, PartialEq)]
+    #[serde(rename_all = "snake_case")]
+    enum E {
+        #[serde(rename_all = "camelCase")]
+        Serialize {
+            serialize: bool,
+            serialize_seq: bool,
+        },
+        #[serde(rename_all = "kebab-case")]
+        SerializeSeq {
+            serialize: bool,
+            serialize_seq: bool,
+        },
+        #[serde(rename_all = "SCREAMING_SNAKE_CASE")]
+        SerializeMap {
+            serialize: bool,
+            serialize_seq: bool,
+        },
+    }
+
+    #[derive(Serialize, Deserialize, Debug, PartialEq)]
+    #[serde(rename_all = "PascalCase")]
+    struct S {
+        serialize: bool,
+        serialize_seq: bool,
+    }
+
+    assert_tokens(
+        &E::Serialize { serialize: true, serialize_seq: true },
+        &[
+            Token::EnumMapStart("E", "serialize", 2),
+            Token::EnumMapSep,
+            Token::Str("serialize"),
+            Token::Bool(true),
+            Token::EnumMapSep,
+            Token::Str("serializeSeq"),
+            Token::Bool(true),
+            Token::EnumMapEnd,
+        ]
+    );
+
+    assert_tokens(
+        &E::SerializeSeq { serialize: true, serialize_seq: true },
+        &[
+            Token::EnumMapStart("E", "serialize_seq", 2),
+            Token::EnumMapSep,
+            Token::Str("serialize"),
+            Token::Bool(true),
+            Token::EnumMapSep,
+            Token::Str("serialize-seq"),
+            Token::Bool(true),
+            Token::EnumMapEnd,
+        ]
+    );
+
+    assert_tokens(
+        &E::SerializeMap { serialize: true, serialize_seq: true },
+        &[
+            Token::EnumMapStart("E", "serialize_map", 2),
+            Token::EnumMapSep,
+            Token::Str("SERIALIZE"),
+            Token::Bool(true),
+            Token::EnumMapSep,
+            Token::Str("SERIALIZE_SEQ"),
+            Token::Bool(true),
+            Token::EnumMapEnd,
+        ]
+    );
+
+    assert_tokens(
+        &S { serialize: true, serialize_seq: true },
+        &[
+            Token::StructStart("S", 2),
+            Token::StructSep,
+            Token::Str("Serialize"),
+            Token::Bool(true),
+            Token::StructSep,
+            Token::Str("SerializeSeq"),
+            Token::Bool(true),
+            Token::StructEnd,
+        ]
+    );
+}

test_suite/tests/test_ser.rs

@@ -1,9 +1,14 @@
+#[macro_use]
+extern crate serde_derive;
+
 use std::collections::{BTreeMap, HashMap, HashSet};
 use std::net;
 use std::path::{Path, PathBuf};
 use std::str;
 use std::time::Duration;
 
+extern crate serde;
+
 extern crate serde_test;
 use self::serde_test::{
     Error,
@@ -18,6 +23,9 @@ use self::fnv::FnvHasher;
 #[cfg(feature = "unstable")]
 use serde::ser::iterator;
 
+#[macro_use]
+mod macros;
+
 //////////////////////////////////////////////////////////////////////////
 
 #[derive(Serialize)]