Fix outdated example in README.md

tomhoule · tomhoule · commit ca7f805ceb8c · 2018-08-22T19:34:04.000+02:00
diff --git a/README.md b/README.md
@@ -62,10 +62,12 @@ A typed GraphQL client library for Rust.
   extern crate graphql_client;
   extern crate reqwest;
 
+  use graphql_client::{GraphQLQuery, GraphQLResponse};
+
   fn perform_my_query(variables: &my_query::Variables) -> Result<(), failure::Error> {
 
       // this is the important line
-      let request_body = MyQuery::expand(variables);
+      let request_body = MyQuery::build_query(variables);
 
       let client = reqwest::Client::new();
       let mut res = client.post("/graphql").json(&request_body).send()?;
diff --git a/graphql_query_derive/src/codegen.rs b/graphql_query_derive/src/codegen.rs
@@ -132,7 +132,6 @@ pub(crate) fn response_for_query(
         #variables_struct
 
         #response_derives
-        #[serde(rename_all = "camelCase")]
         pub struct ResponseData {
             #(#response_data_fields,)*
         }
diff --git a/graphql_query_derive/src/inputs.rs b/graphql_query_derive/src/inputs.rs
@@ -22,13 +22,20 @@ impl GqlInput {
         fields.sort_unstable_by(|a, b| a.name.cmp(&b.name));
         let fields = fields.iter().map(|field| {
             let ty = field.type_.to_rust(&context, "");
-            let name = Ident::new(&field.name.to_snake_case(), Span::call_site());
-            quote!(pub #name: #ty)
+            let original_name = &field.name;
+            let snake_case_name = field.name.to_snake_case();
+            let rename = if snake_case_name.as_str() != original_name.as_str() {
+                quote!(#[serde(rename = #original_name)])
+            } else {
+                quote!()
+            };
+            let name = Ident::new(&snake_case_name, Span::call_site());
+
+            quote!(#rename pub #name: #ty)
         });
 
         Ok(quote! {
             #[derive(Debug, Serialize)]
-            #[serde(rename_all = "camelCase")]
             pub struct #name {
                 #(#fields,)*
             }
@@ -52,7 +59,8 @@ impl ::std::convert::From<graphql_parser::schema::InputObjectType> for GqlInput
                         type_: field.value_type.into(),
                     };
                     (name, field)
-                }).collect(),
+                })
+                .collect(),
         }
     }
 }
@@ -79,7 +87,8 @@ impl ::std::convert::From<introspection_response::FullType> for GqlInput {
                             .into(),
                     };
                     (name, field)
-                }).collect(),
+                })
+                .collect(),
         }
     }
 }
@@ -127,19 +136,19 @@ mod tests {
                     },
                 ),
             ].into_iter()
-            .collect(),
+                .collect(),
         };
 
         let expected: String = vec![
             "# [ derive ( Debug , Serialize ) ] ",
-            "# [ serde ( rename_all = \"camelCase\" ) ] ",
             "pub struct Cat { ",
             "pub offsprings : Vec < Cat > , ",
+            "# [ serde ( rename = \"pawsCount\" ) ] ",
             "pub paws_count : Float , ",
             "pub requirements : Option < CatRequirements > , ",
             "}",
         ].into_iter()
-        .collect();
+            .collect();
 
         let mut context = QueryContext::new_empty();
         context.schema.inputs.insert(cat.name.clone(), cat);
diff --git a/graphql_query_derive/src/objects.rs b/graphql_query_derive/src/objects.rs
@@ -76,7 +76,6 @@ impl GqlObject {
             #(#field_impls)*
 
             #derives
-            #[serde(rename_all = "camelCase")]
             #description
             pub struct #name {
                 #(#fields,)*
diff --git a/graphql_query_derive/src/operations.rs b/graphql_query_derive/src/operations.rs
@@ -50,8 +50,14 @@ impl Operation {
         let fields = variables.iter().map(|variable| {
             let name = &variable.name;
             let ty = variable.ty.to_rust(context, "");
-            let name = Ident::new(&name.to_snake_case(), Span::call_site());
-            quote!(pub #name: #ty)
+            let snake_case_name = name.to_snake_case();
+            let rename = if snake_case_name.as_str() != name.as_str() {
+                quote!(#[serde(rename = #name)])
+            } else {
+                quote!()
+            };
+            let name = Ident::new(&snake_case_name, Span::call_site());
+            quote!(#rename pub #name: #ty)
         });
 
         let default_constructors = variables
@@ -60,7 +66,6 @@ impl Operation {
 
         quote! {
             #[derive(Serialize)]
-            #[serde(rename_all = "camelCase")]
             pub struct Variables {
                 #(#fields,)*
             }
diff --git a/graphql_query_derive/src/shared.rs b/graphql_query_derive/src/shared.rs
@@ -20,9 +20,17 @@ pub(crate) fn render_object_field(
         };
     }
 
-    let name_ident = Ident::new(&field_name.to_snake_case(), Span::call_site());
+    let snake_case_name = field_name.to_snake_case();
 
-    quote!(#description pub #name_ident: #field_type)
+    let rename = if snake_case_name != field_name {
+        quote!(#[serde(rename = #field_name)])
+    } else {
+        quote!()
+    };
+
+    let name_ident = Ident::new(&snake_case_name, Span::call_site());
+
+    quote!(#description #rename pub #name_ident: #field_type)
 }
 
 pub(crate) fn field_impls_for_selection(
@@ -51,7 +59,8 @@ pub(crate) fn field_impls_for_selection(
             } else {
                 Ok(quote!())
             }
-        }).collect()
+        })
+        .collect()
 }
 
 pub(crate) fn response_fields_for_selection(
@@ -94,5 +103,6 @@ pub(crate) fn response_fields_for_selection(
             SelectionItem::InlineFragment(_) => {
                 Err(format_err!("inline fragment on object field"))?
             }
-        }).collect()
+        })
+        .collect()
 }
diff --git a/graphql_query_derive/src/unions.rs b/graphql_query_derive/src/unions.rs
@@ -16,10 +16,7 @@ pub struct GqlUnion {
 enum UnionError {
     #[fail(display = "Unknown type: {}", ty)]
     UnknownType { ty: String },
-    #[fail(
-        display = "Missing __typename in selection for {}",
-        union_name
-    )]
+    #[fail(display = "Missing __typename in selection for {}", union_name)]
     MissingTypename { union_name: String },
 }
 
@@ -150,7 +147,7 @@ mod tests {
             SelectionItem::InlineFragment(SelectionInlineFragment {
                 on: "User".to_string(),
                 fields: Selection(vec![SelectionItem::Field(SelectionField {
-                    name: "first_name".to_string(),
+                    name: "firstName".to_string(),
                     fields: Selection(vec![]),
                 })]),
             }),
@@ -178,17 +175,17 @@ mod tests {
                 fields: vec![
                     GqlObjectField {
                         description: None,
-                        name: "first_name".to_string(),
+                        name: "firstName".to_string(),
                         type_: FieldType::Named(Ident::new("String", Span::call_site())),
                     },
                     GqlObjectField {
                         description: None,
-                        name: "last_name".to_string(),
+                        name: "lastName".to_string(),
                         type_: FieldType::Named(Ident::new("String", Span::call_site())),
                     },
                     GqlObjectField {
                         description: None,
-                        name: "created_at".to_string(),
+                        name: "createdAt".to_string(),
                         type_: FieldType::Named(Ident::new("Date", Span::call_site())),
                     },
                 ],
@@ -235,7 +232,7 @@ mod tests {
             SelectionItem::InlineFragment(SelectionInlineFragment {
                 on: "User".to_string(),
                 fields: Selection(vec![SelectionItem::Field(SelectionField {
-                    name: "first_name".to_string(),
+                    name: "firstName".to_string(),
                     fields: Selection(vec![]),
                 })]),
             }),
@@ -272,17 +269,17 @@ mod tests {
                     },
                     GqlObjectField {
                         description: None,
-                        name: "first_name".to_string(),
+                        name: "firstName".to_string(),
                         type_: FieldType::Named(string_type()),
                     },
                     GqlObjectField {
                         description: None,
-                        name: "last_name".to_string(),
+                        name: "lastName".to_string(),
                         type_: FieldType::Named(string_type()),
                     },
                     GqlObjectField {
                         description: None,
-                        name: "created_at".to_string(),
+                        name: "createdAt".to_string(),
                         type_: FieldType::Named(Ident::new("Date", Span::call_site())),
                     },
                 ],
@@ -307,7 +304,7 @@ mod tests {
                     },
                     GqlObjectField {
                         description: None,
-                        name: "created_at".to_string(),
+                        name: "createdAt".to_string(),
                         type_: FieldType::Named(Ident::new("Date", Span::call_site())),
                     },
                 ],
@@ -324,16 +321,14 @@ mod tests {
             result.unwrap().to_string(),
             vec![
                 "# [ derive ( Deserialize ) ] ",
-                "# [ serde ( rename_all = \"camelCase\" ) ] ",
-                "pub struct MeowOnUser { pub first_name : String , } ",
+                "pub struct MeowOnUser { # [ serde ( rename = \"firstName\" ) ] pub first_name : String , } ",
                 "# [ derive ( Deserialize ) ] ",
-                "# [ serde ( rename_all = \"camelCase\" ) ] ",
                 "pub struct MeowOnOrganization { pub title : String , } ",
                 "# [ derive ( Deserialize ) ] ",
                 "# [ serde ( tag = \"__typename\" ) ] ",
                 "pub enum Meow { User ( MeowOnUser ) , Organization ( MeowOnOrganization ) }",
             ].into_iter()
-            .collect::<String>(),
+                .collect::<String>(),
         );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,6 @@ pub(crate) fn response_for_query(`
`132`	`132`	`#variables_struct`
`133`	`133`
`134`	`134`	`#response_derives`
`135`		`- #[serde(rename_all = "camelCase")]`
`136`	`135`	`pub struct ResponseData {`
`137`	`136`	`#(#response_data_fields,)*`
`138`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,17 @@ pub(crate) fn render_object_field(`
`20`	`20`	`};`
`21`	`21`	`}`
`22`	`22`
`23`		`- let name_ident = Ident::new(&field_name.to_snake_case(), Span::call_site());`
	`23`	`+ let snake_case_name = field_name.to_snake_case();`
`24`	`24`
`25`		`- quote!(#description pub #name_ident: #field_type)`
	`25`	`+ let rename = if snake_case_name != field_name {`
	`26`	`+ quote!(#[serde(rename = #field_name)])`
	`27`	`+ } else {`
	`28`	`+ quote!()`
	`29`	`+ };`
	`30`	`+`
	`31`	`+ let name_ident = Ident::new(&snake_case_name, Span::call_site());`
	`32`	`+`
	`33`	`+ quote!(#description #rename pub #name_ident: #field_type)`
`26`	`34`	`}`
`27`	`35`
`28`	`36`	`pub(crate) fn field_impls_for_selection(`
`@@ -51,7 +59,8 @@ pub(crate) fn field_impls_for_selection(`
`51`	`59`	`} else {`
`52`	`60`	`Ok(quote!())`
`53`	`61`	`}`
`54`		`- }).collect()`
	`62`	`+ })`
	`63`	`+ .collect()`
`55`	`64`	`}`
`56`	`65`
`57`	`66`	`pub(crate) fn response_fields_for_selection(`
`@@ -94,5 +103,6 @@ pub(crate) fn response_fields_for_selection(`
`94`	`103`	`SelectionItem::InlineFragment(_) => {`
`95`	`104`	`Err(format_err!("inline fragment on object field"))?`
`96`	`105`	`}`
`97`		`- }).collect()`
	`106`	`+ })`
	`107`	`+ .collect()`
`98`	`108`	`}`