Merge pull request #229 from graphql-rust/cli-modules-reform

Make generated code less confusing.

Author: tomhoule

CHANGELOG.md

@@ -7,6 +7,46 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 0.7.0 - 2019-03-21
+
+### Changed
+
+- The `selected_operation` derive attribute is deprecated. **The name of the
+  struct under derive now has to match one of the operations defined in the query
+  file.**
+- The CLI now takes the schema path as a required keyword argument.
+- The CLI was revamped to generate separate modules for each operation in a given query file.
+
+  The idea now is that if you generate code for the following document:
+
+  ```graphql
+  # In my_query.graphql
+
+  query QueryA { .... }
+  query QueryB { .... }
+  mutation SomeMutation { ... }
+    ```
+
+  The CLI generated code will look like this:
+
+  ```rust
+  // In my_query.rs
+
+  pub struct QueryA;
+
+  pub mod query_a { ... }
+
+  pub struct QueryB;
+
+  pub mod query_b { ... }
+
+  pub struct SomeMutation;
+
+  pub mod some_mutation { ... }
+    ```
+
+  That way the operations don't live in the same module, there is no risk of names clashing anymore.
+
 ### Fixed
 
 - Changes to query files will now always trigger code generation for the corresponding modules on the next build.

README.md

@@ -29,7 +29,7 @@ A typed GraphQL client library for Rust.
 
 - In order to provide precise types for a response, graphql_client needs to read the query and the schema at compile-time.
 
-  To download the schema, you have multiple options. This projects provides a [CLI](https://github.com/graphql-rust/graphql-client/tree/master/graphql_client_cli), but there are also more mature tools like [apollo-cli](https://github.com/apollographql/apollo-cli). It does not matter which one you use, the resulting `schema.json` is the same.
+  To download the schema, you have multiple options. This projects provides a [CLI](https://github.com/graphql-rust/graphql-client/tree/master/graphql_client_cli), however it does not matter what tool you use, the resulting `schema.json` is the same.
 
 - We now have everything we need to derive Rust types for our query. This is achieved through a procedural macro, as in the following snippet:
 
@@ -47,10 +47,10 @@ A typed GraphQL client library for Rust.
       schema_path = "tests/unions/union_schema.graphql",
       query_path = "tests/unions/union_query.graphql",
   )]
-  pub struct MyQuery;
+  pub struct UnionQuery;
   ```
 
-  The `derive` will generate a module named `my_query` in this example - the name is the struct's name, but in snake case.
+  The `derive` will generate a module named `union_query` in this example - the name is the struct's name, but in snake case.
 
   That module contains all the struct and enum definitions necessary to deserialize a response to that query.
 
@@ -74,16 +74,16 @@ A typed GraphQL client library for Rust.
       query_path = "tests/unions/union_query.graphql",
       response_derives = "Debug",
   )]
-  pub struct MyQuery;
+  pub struct UnionQuery;
 
-  fn perform_my_query(variables: my_query::Variables) -> Result<(), failure::Error> {
+  fn perform_my_query(variables: union_query::Variables) -> Result<(), failure::Error> {
 
       // this is the important line
-      let request_body = MyQuery::build_query(variables);
+      let request_body = UnionQuery::build_query(variables);
 
       let client = reqwest::Client::new();
       let mut res = client.post("/graphql").json(&request_body).send()?;
-      let response_body: Response<my_query::ResponseData> = res.json()?;
+      let response_body: Response<union_query::ResponseData> = res.json()?;
       println!("{:#?}", response_body);
       Ok(())
   }
@@ -105,7 +105,7 @@ extern crate graphql_client;
     query_path = "tests/unions/union_query.graphql",
     response_derives = "Serialize,PartialEq",
 )]
-struct SearchQuery;
+struct UnionQuery;
 ```
 
 ## Custom scalars
@@ -127,7 +127,7 @@ extern crate graphql_client;
   query_path = "tests/unions/union_query.graphql",
   deprecated = "warn"
 )]
-pub struct MyQuery;
+pub struct UnionQuery;
 ```
 
 Valid values are:
@@ -143,15 +143,20 @@ The default is `warn`.
 
 You can write multiple operations in one query document (one `.graphql` file). You can then select one by naming the struct you `#[derive(GraphQLQuery)]` on with the same name as one of the operations. This is neat, as it allows sharing fragments between operations.
 
-If you want to name the struct different from query name, you can use ``selected_operation`` argument like this.
+Note that the struct and the operation in the GraphQL file *must* have the same name. We enforce this to make the generated code more predictable.
+
+```rust,skt-empty-main
+#[macro_use]
+extern crate graphql_client;
 
 #[derive(GraphQLQuery)]
 #[graphql(
     schema_path = "tests/unions/union_schema.graphql",
     query_path = "tests/unions/union_query.graphql",
     selected_operation = "SearchQuery"
 )]
-pub struct MyQuery;
+pub struct UnionQuery;
+```
 
 There is an example [in the tests](./tests/operation_selection).
 

graphql_client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "graphql_client"
-version = "0.6.1"
+version = "0.7.0"
 authors = ["Tom Houlé <[email protected]>"]
 description = "Typed GraphQL requests and responses"
 repository = "https://github.com/graphql-rust/graphql-client"
@@ -10,8 +10,7 @@ categories = ["network-programming", "web-programming", "wasm"]
 
 [dependencies]
 failure = "0.1"
-graphql_query_derive = {path = "../graphql_query_derive", version = "0.6.1" }
-itertools = "0.7"
+graphql_query_derive = {path = "../graphql_query_derive", version = "0.7.0" }
 serde = "^1.0.78"
 serde_derive = "1.0"
 serde_json = "1.0"

graphql_client/src/lib.rs

@@ -5,7 +5,6 @@
 #![deny(warnings)]
 #![deny(missing_docs)]
 
-extern crate itertools;
 extern crate serde;
 #[macro_use]
 extern crate serde_derive;
@@ -20,8 +19,6 @@ pub use graphql_query_derive::*;
 use std::collections::HashMap;
 use std::fmt::{self, Display};
 
-use itertools::Itertools;
-
 /// A convenience trait that can be used to build a GraphQL request body.
 ///
 /// This will be implemented for you by codegen in the normal case. It is implemented on the struct you place the derive on.
@@ -208,7 +205,16 @@ impl Display for Error {
         let path = self
             .path
             .as_ref()
-            .map(|fragments| format!("{}", fragments.iter().format("/")))
+            .map(|fragments| {
+                fragments
+                    .iter()
+                    .fold(String::new(), |mut acc, item| {
+                        acc.push_str(&format!("{}/", item));
+                        acc
+                    })
+                    .trim_end_matches('/')
+                    .to_string()
+            })
             .unwrap_or_else(|| "<query>".to_string());
 
         // Get the location of the error. We'll use just the first location for this.

graphql_client/tests/custom_scalars.rs

@@ -16,7 +16,7 @@ type NetworkAddress = Ipv4Addr;
     query_path = "tests/custom_scalars/query.graphql",
     schema_path = "tests/custom_scalars/schema.graphql"
 )]
-pub struct CustomScalarsQuery;
+pub struct CustomScalarQuery;
 
 #[test]
 fn custom_scalars() {
@@ -25,7 +25,7 @@ fn custom_scalars() {
     });
 
     let valid_addr =
-        serde_json::from_value::<custom_scalars_query::ResponseData>(valid_response).unwrap();
+        serde_json::from_value::<custom_scalar_query::ResponseData>(valid_response).unwrap();
 
     assert_eq!(
         valid_addr.address.unwrap(),
@@ -36,7 +36,5 @@ fn custom_scalars() {
         "address": "localhost",
     });
 
-    assert!(
-        serde_json::from_value::<custom_scalars_query::ResponseData>(invalid_response).is_err()
-    );
+    assert!(serde_json::from_value::<custom_scalar_query::ResponseData>(invalid_response).is_err());
 }

graphql_client/tests/deprecation.rs

@@ -36,7 +36,7 @@ fn deprecation_allow() {
     // as deprecated.
     #![deny(deprecated)]
     let _ = allow_deprecation::ResponseData {
-        current_user: Some(allow_deprecation::TestCurrentUser {
+        current_user: Some(allow_deprecation::AllowDeprecationCurrentUser {
             id: Some("abcd".to_owned()),
             name: Some("Angela Merkel".to_owned()),
             deprecated_with_reason: Some("foo".to_owned()),
@@ -48,7 +48,7 @@ fn deprecation_allow() {
 #[test]
 fn deprecation_deny() {
     let _ = deny_deprecation::ResponseData {
-        current_user: Some(deny_deprecation::TestCurrentUser {
+        current_user: Some(deny_deprecation::DenyDeprecationCurrentUser {
             id: Some("abcd".to_owned()),
             name: Some("Angela Merkel".to_owned()),
             // Notice the deprecated fields are not included here.
@@ -63,7 +63,7 @@ fn deprecation_deny() {
 fn deprecation_warn() {
     #![allow(deprecated)]
     let _ = warn_deprecation::ResponseData {
-        current_user: Some(warn_deprecation::TestCurrentUser {
+        current_user: Some(warn_deprecation::WarnDeprecationCurrentUser {
             id: Some("abcd".to_owned()),
             name: Some("Angela Merkel".to_owned()),
             deprecated_with_reason: Some("foo".to_owned()),

graphql_client/tests/deprecation/query.graphql

@@ -1,4 +1,22 @@
-query Test {
+query DenyDeprecation {
+  currentUser {
+    name
+    id
+    deprecatedWithReason
+    deprecatedNoReason
+  }
+}
+
+query AllowDeprecation {
+  currentUser {
+    name
+    id
+    deprecatedWithReason
+    deprecatedNoReason
+  }
+}
+
+query WarnDeprecation {
   currentUser {
     name
     id

graphql_client/tests/input_object_variables/input_object_variables_query.graphql

@@ -1,4 +1,4 @@
-query VariablesQuery($msg: Message) {
+query InputObjectVariablesQuery($msg: Message) {
   echo(message: $msg) {
     result
   }

graphql_client/tests/input_object_variables/input_object_variables_query_defaults.graphql

@@ -1,4 +1,4 @@
-query VariablesQuery(
+query DefaultInputObjectVariablesQuery(
   $msg: Message = { to: { email: "[email protected]" } }
 ) {
   echo(message: $msg) {

graphql_client/tests/interfaces.rs

@@ -26,25 +26,31 @@ fn interface_deserialization() {
 
     let expected = ResponseData {
         everything: Some(vec![
-            MyQueryEverything {
+            InterfaceQueryEverything {
                 name: "Audrey Lorde".to_string(),
-                on: MyQueryEverythingOn::Person(MyQueryEverythingOnPerson {
+                on: InterfaceQueryEverythingOn::Person(InterfaceQueryEverythingOnPerson {
                     birthday: Some("1934-02-18".to_string()),
                 }),
             },
-            MyQueryEverything {
+            InterfaceQueryEverything {
                 name: "Laïka".to_string(),
-                on: MyQueryEverythingOn::Dog(MyQueryEverythingOnDog { is_good_dog: true }),
+                on: InterfaceQueryEverythingOn::Dog(InterfaceQueryEverythingOnDog {
+                    is_good_dog: true,
+                }),
             },
-            MyQueryEverything {
+            InterfaceQueryEverything {
                 name: "Mozilla".to_string(),
-                on: MyQueryEverythingOn::Organization(MyQueryEverythingOnOrganization {
-                    industry: Industry::OTHER,
-                }),
+                on: InterfaceQueryEverythingOn::Organization(
+                    InterfaceQueryEverythingOnOrganization {
+                        industry: Industry::OTHER,
+                    },
+                ),
             },
-            MyQueryEverything {
+            InterfaceQueryEverything {
                 name: "Norbert".to_string(),
-                on: MyQueryEverythingOn::Dog(MyQueryEverythingOnDog { is_good_dog: true }),
+                on: InterfaceQueryEverythingOn::Dog(InterfaceQueryEverythingOnDog {
+                    is_good_dog: true,
+                }),
             },
         ]),
     };
@@ -56,7 +62,7 @@ fn interface_deserialization() {
 #[graphql(
     query_path = "tests/interfaces/interface_not_on_everything_query.graphql",
     schema_path = "tests/interfaces/interface_schema.graphql",
-    response_derives = "Debug"
+    response_derives = "Debug,PartialEq"
 )]
 pub struct InterfaceNotOnEverythingQuery;
 
@@ -65,15 +71,43 @@ const RESPONSE_NOT_ON_EVERYTHING: &'static str =
 
 #[test]
 fn interface_not_on_everything_deserialization() {
-    println!("{:?}", RESPONSE);
+    use interface_not_on_everything_query::*;
+
     let response_data: interface_not_on_everything_query::ResponseData =
         serde_json::from_str(RESPONSE_NOT_ON_EVERYTHING).unwrap();
 
-    println!("{:?}", response_data);
+    let expected = ResponseData {
+        everything: Some(vec![
+            InterfaceNotOnEverythingQueryEverything {
+                name: "Audrey Lorde".to_string(),
+                on: InterfaceNotOnEverythingQueryEverythingOn::Person(
+                    InterfaceNotOnEverythingQueryEverythingOnPerson {
+                        birthday: Some("1934-02-18".to_string()),
+                    },
+                ),
+            },
+            InterfaceNotOnEverythingQueryEverything {
+                name: "Laïka".to_string(),
+                on: InterfaceNotOnEverythingQueryEverythingOn::Dog,
+            },
+            InterfaceNotOnEverythingQueryEverything {
+                name: "Mozilla".to_string(),
+                on: InterfaceNotOnEverythingQueryEverythingOn::Organization(
+                    InterfaceNotOnEverythingQueryEverythingOnOrganization {
+                        industry: Industry::OTHER,
+                    },
+                ),
+            },
+            InterfaceNotOnEverythingQueryEverything {
+                name: "Norbert".to_string(),
+                on: InterfaceNotOnEverythingQueryEverythingOn::Dog,
+            },
+        ]),
+    };
 
-    let expected = r##"ResponseData { everything: Some([MyQueryEverything { name: "Audrey Lorde", on: Person(MyQueryEverythingOnPerson { birthday: Some("1934-02-18") }) }, MyQueryEverything { name: "Laïka", on: Dog }, MyQueryEverything { name: "Mozilla", on: Organization(MyQueryEverythingOnOrganization { industry: OTHER }) }, MyQueryEverything { name: "Norbert", on: Dog }]) }"##;
+    // let expected = r##"ResponseData { everything: Some([InterfaceQueryEverything { name: "Audrey Lorde", on: Person(InterfaceQueryEverythingOnPerson { birthday: Some("1934-02-18") }) }, InterfaceQueryEverything { name: "Laïka", on: Dog }, InterfaceQueryEverything { name: "Mozilla", on: Organization(InterfaceQueryEverythingOnOrganization { industry: OTHER }) }, InterfaceQueryEverything { name: "Norbert", on: Dog }]) }"##;
 
-    assert_eq!(format!("{:?}", response_data), expected);
+    assert_eq!(response_data, expected);
 
     assert_eq!(response_data.everything.map(|names| names.len()), Some(4));
 }