Merge pull request #175 from h-michael/code-gen

Generate all queries at onece

Author: tomhoule

README.md

@@ -128,6 +128,16 @@ 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.
+
+#[derive(GraphQLQuery)]
+#[graphql(
+    schema_path = "src/graphql/schema.json",
+    query_path = "src/graphql/queries/my_query.graphql",
+    selected_operation = "SearchQuery"
+)]
+pub struct MyQuery;
+
 There is an example [in the tests](./tests/operation_selection).
 
 ## Documentation for the generated modules

graphql_client/tests/operation_selection.rs

@@ -11,15 +11,15 @@ use graphql_client::GraphQLQuery;
 #[graphql(
     query_path = "tests/operation_selection/queries.graphql",
     schema_path = "tests/operation_selection/schema.graphql",
-    response_derives = "Debug,PartialEq",
+    response_derives = "Debug,PartialEq"
 )]
 pub struct Heights;
 
 #[derive(GraphQLQuery)]
 #[graphql(
     query_path = "tests/operation_selection/queries.graphql",
     schema_path = "tests/operation_selection/schema.graphql",
-    response_derives = "Debug,PartialEq",
+    response_derives = "Debug,PartialEq"
 )]
 pub struct Echo;
 
@@ -28,10 +28,19 @@ pub struct Echo;
 #[graphql(
     query_path = "tests/operation_selection/queries.graphql",
     schema_path = "tests/operation_selection/schema.graphql",
-    response_derives = "Debug,PartialEq",
+    response_derives = "Debug,PartialEq"
 )]
 pub struct Unrelated;
 
+#[derive(GraphQLQuery)]
+#[graphql(
+    query_path = "tests/operation_selection/queries.graphql",
+    schema_path = "tests/operation_selection/schema.graphql",
+    response_derives = "Debug,PartialEq",
+    selected_operation = "Echo"
+)]
+pub struct SelectedOperation;
+
 const HEIGHTS_RESPONSE: &'static str = r##"{"mountainHeight": 224, "buildingHeight": 12}"##;
 const ECHO_RESPONSE: &'static str = r##"{"echo": "tiramisù"}"##;
 
@@ -42,6 +51,8 @@ fn operation_selection_works() {
     let heights_unrelated_response_data: unrelated::ResponseData =
         serde_json::from_str(HEIGHTS_RESPONSE).unwrap();
     let echo_response_data: echo::ResponseData = serde_json::from_str(ECHO_RESPONSE).unwrap();
+    let selected_operation_response_data: selected_operation::ResponseData =
+        serde_json::from_str(ECHO_RESPONSE).unwrap();
 
     let _echo_variables = echo::Variables {
         msg: Some("hi".to_string()),
@@ -56,9 +67,14 @@ fn operation_selection_works() {
         mountain_name: Some("canigou".to_string()),
     };
 
+    let _selected_operation_variables = selected_operation::Variables {
+        msg: Some("hi".to_string()),
+    };
+
     let expected_echo = echo::ResponseData {
         echo: Some("tiramisù".to_string()),
     };
+
     let expected_heights = heights::ResponseData {
         mountain_height: Some(224),
         building_height: Some(12),
@@ -69,9 +85,17 @@ fn operation_selection_works() {
         building_height: Some(12),
     };
 
+    let expected_selected_operation = selected_operation::ResponseData {
+        echo: Some("tiramisù".to_string()),
+    };
+
     assert_eq!(expected_echo, echo_response_data);
     assert_eq!(expected_heights, heights_response_data);
     assert_eq!(expected_heights_unrelated, heights_unrelated_response_data);
+    assert_eq!(
+        expected_selected_operation,
+        selected_operation_response_data
+    );
 }
 
 #[test]

graphql_client_cli/README.md

@@ -1,3 +1,61 @@
 # GraphQL client CLI
 
 This is still a WIP, the main use for it now is to download the `schema.json` from a GraphQL endpoint, which you can also do with [apollo-codegen](https://github.com/apollographql/apollo-cli).
+
+## Install
+
+```
+cargo install graphql-client-cli --force
+```
+
+## introspect schema
+
+```
+USAGE:
+    graphql-client introspect-schema [OPTIONS] <schema_location>
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+OPTIONS:
+        --authorization <authorization>
+        --output <output>                  Where to write the JSON for the introspected schema.
+
+ARGS:
+    <schema_location>    The URL of a GraphQL endpoint to introspect.
+```
+
+## generate client code
+
+```
+USAGE:
+    graphql-client generate [FLAGS] [OPTIONS] <query_path> <schema_path> <module_name> <output>
+
+FLAGS:
+    -h, --help             Prints help information
+        --no-formatting    If you don't want to execute rustfmt to generated code, set this option. Default value is
+                           false. Formating feature is disabled as default installation.
+    -V, --version          Prints version information
+
+OPTIONS:
+    -a, --additional-derives <additional_derives>
+            Additional derives that will be added to the generated structs and enums for the response and the variables.
+            --additional-derives='Serialize,PartialEq'
+    -d, --deprecation-strategy <deprecation_strategy>
+            You can choose deprecation strategy from allow, deny, or warn. Default value is warn.
+
+    -o, --selected-operation <selected_operation>
+            Name of target query. If you don't set this parameter, cli generate all queries in query file.
+
+
+ARGS:
+    <query_path>     Path to graphql query file.
+    <schema_path>    Path to graphql schema file.
+    <module_name>    Name of module.
+    <output>         Path you want to output to.
+```
+
+If you want to use formatting feature, you should install like this.
+
+`cargo install graphql-client-cli --features rustfmt --force`

graphql_client_cli/src/generate.rs

@@ -9,7 +9,8 @@ use syn;
 pub fn generate_code(
     query_path: PathBuf,
     schema_path: PathBuf,
-    selected_operation: String,
+    module_name: String,
+    selected_operation: Option<String>,
     additional_derives: Option<String>,
     deprecation_strategy: &Option<String>,
     no_formatting: bool,
@@ -36,7 +37,9 @@ pub fn generate_code(
     };
 
     let options = GraphQLClientDeriveOptions {
-        struct_name: selected_operation,
+        operation_name: selected_operation,
+        struct_name: None,
+        module_name: Some(module_name),
         additional_derives,
         deprecation_strategy,
         module_visibility,

graphql_client_cli/src/main.rs

@@ -42,8 +42,11 @@ enum Cli {
         /// Path to graphql schema file.
         #[structopt(parse(from_os_str))]
         schema_path: PathBuf,
-        /// Name of struct that is implementation target.
-        selected_operation: String,
+        /// Name of module.
+        module_name: String,
+        /// Name of target query. If you don't set this parameter, cli generate all queries in query file.
+        #[structopt(short = "o", long = "selected-operation")]
+        selected_operation: Option<String>,
         /// Additional derives that will be added to the generated structs and enums for the response and the variables.
         /// --additional-derives='Serialize,PartialEq'
         #[structopt(short = "a", long = "additional-derives")]
@@ -77,6 +80,7 @@ fn main() -> Result<(), failure::Error> {
         Cli::Generate {
             query_path,
             schema_path,
+            module_name,
             selected_operation,
             additional_derives,
             deprecation_strategy,
@@ -86,6 +90,7 @@ fn main() -> Result<(), failure::Error> {
         } => generate::generate_code(
             query_path,
             schema_path,
+            module_name,
             selected_operation,
             additional_derives,
             &deprecation_strategy,

graphql_client_codegen/src/codegen.rs

@@ -3,26 +3,31 @@ use failure;
 use fragments::GqlFragment;
 use graphql_parser::query;
 use operations::Operation;
-use proc_macro2::TokenStream;
+use proc_macro2::{Ident, Span, TokenStream};
 use query::QueryContext;
 use schema;
 use selection::Selection;
 
 /// Selects the first operation matching `struct_name` or the first one. Returns `None` when the query document defines no operation.
 pub(crate) fn select_operation(query: &query::Document, struct_name: &str) -> Option<Operation> {
+    let operations = all_operations(query);
+
+    operations
+        .iter()
+        .find(|op| op.name == struct_name)
+        .map(|i| i.to_owned())
+        .or_else(|| operations.iter().next().map(|i| i.to_owned()))
+}
+
+pub(crate) fn all_operations(query: &query::Document) -> Vec<Operation> {
     let mut operations: Vec<Operation> = Vec::new();
 
     for definition in &query.definitions {
         if let query::Definition::Operation(op) = definition {
             operations.push(op.into());
         }
     }
-
     operations
-        .iter()
-        .find(|op| op.name == struct_name)
-        .map(|i| i.to_owned())
-        .or_else(|| operations.iter().next().map(|i| i.to_owned()))
 }
 
 /// The main code generation function.
@@ -32,6 +37,7 @@ pub fn response_for_query(
     operation: &Operation,
     additional_derives: Option<String>,
     deprecation_strategy: deprecation::DeprecationStrategy,
+    multiple_operation: bool,
 ) -> Result<TokenStream, failure::Error> {
     let mut context = QueryContext::new(schema, deprecation_strategy);
 
@@ -112,7 +118,8 @@ pub fn response_for_query(
             }
         }).collect();
     let fragment_definitions = fragment_definitions?;
-    let variables_struct = operation.expand_variables(&context);
+    let variables_struct =
+        operation.expand_variables(&context, &operation.name, multiple_operation);
 
     let input_object_definitions: Result<Vec<TokenStream>, _> = context
         .schema
@@ -141,6 +148,15 @@ pub fn response_for_query(
 
     let response_derives = context.response_derives();
 
+    let respons_data_struct_name = if multiple_operation {
+        Ident::new(
+            format!("{}ResponseData", operation.name).as_str(),
+            Span::call_site(),
+        )
+    } else {
+        Ident::new("ResponseData", Span::call_site())
+    };
+
     Ok(quote! {
         use serde_derive::*;
 
@@ -166,7 +182,7 @@ pub fn response_for_query(
         #variables_struct
 
         #response_derives
-        pub struct ResponseData {
+        pub struct #respons_data_struct_name {
             #(#response_data_fields,)*
         }
 

graphql_client_codegen/src/deprecation.rs

@@ -14,7 +14,7 @@ pub enum DeprecationStatus {
 }
 
 /// The available deprecation startegies.
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Clone)]
 pub enum DeprecationStrategy {
     /// Allow use of deprecated items in queries, and say nothing.
     Allow,