Merge pull request #108 from mathstuf/stutter-rename

api: remove `GraphQL` prefix from type names

Author: tomhoule

CHANGELOG.md

@@ -46,6 +46,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Most of the `graphql-query-derive` crate was factored out into a new `graphql-client-codegen` crate that should enable code generation through means other than custom derives (CLI, build scripts...). Thanks @h-michael for this important refactoring!
 
+- Types have been renamed. Types no longer have a `GraphQL` prefix.
+
 ### Fixed
 
 - Handle all Rust keywords as field names in codegen by appending `_` to the generated names, so a field called `type` in a GraphQL query will become a `type_` field in the generated struct. Thanks to @scrogson!

README.md

@@ -52,7 +52,7 @@ A typed GraphQL client library for Rust.
 
   That module contains all the struct and enum definitions necessary to deserialize a response to that query.
 
-  The root type for the response is named `ResponseData`. The GraphQL response will take the form of a `GraphQLResponse<ResponseData>` (the [GraphQLResponse](https://docs.rs/graphql_client/latest/graphql_client/struct.GraphQLResponse.html) type is always the same).
+  The root type for the response is named `ResponseData`. The GraphQL response will take the form of a `Response<ResponseData>` (the [Response](https://docs.rs/graphql_client/latest/graphql_client/struct.Response.html) type is always the same).
 
   The module also contains a struct called `Variables` representing the variables expected by the query.
 
@@ -64,7 +64,7 @@ A typed GraphQL client library for Rust.
   extern crate graphql_client;
   extern crate reqwest;
 
-  use graphql_client::{GraphQLQuery, GraphQLResponse};
+  use graphql_client::{GraphQLQuery, Response};
 
   fn perform_my_query(variables: &my_query::Variables) -> Result<(), failure::Error> {
 
@@ -73,7 +73,7 @@ A typed GraphQL client library for Rust.
 
       let client = reqwest::Client::new();
       let mut res = client.post("/graphql").json(&request_body).send()?;
-      let response_body: GraphQLResponse<my_query::ResponseData> = res.json()?;
+      let response_body: Response<my_query::ResponseData> = res.json()?;
       println!("{:#?}", response_body);
       Ok(())
   }

examples/call_from_js/src/lib.rs

@@ -98,7 +98,7 @@ fn cb() -> Closure<Fn(String)> {
 
         let parent = document.body();
 
-        let json: GraphQLResponse<puppy_smiles::ResponseData> =
+        let json: Response<puppy_smiles::ResponseData> =
             serde_json::from_str(&s).expect("failed to deserialize");
         let response = document.createElement("div");
         let mut inner_html = String::new();

examples/github/src/main.rs

@@ -73,7 +73,7 @@ fn main() -> Result<(), failure::Error> {
         .json(&q)
         .send()?;
 
-    let response_body: GraphQLResponse<query1::ResponseData> = res.json()?;
+    let response_body: Response<query1::ResponseData> = res.json()?;
     info!("{:?}", response_body);
 
     if let Some(errors) = response_body.errors {

graphql_client_cli/src/main.rs

@@ -74,7 +74,7 @@ fn introspect_schema(
         None => Box::new(::std::io::stdout()),
     };
 
-    let request_body: graphql_client::GraphQLQueryBody<()> = graphql_client::GraphQLQueryBody {
+    let request_body: graphql_client::QueryBody<()> = graphql_client::QueryBody {
         variables: (),
         query: introspection_query::QUERY,
         operation_name: introspection_query::OPERATION_NAME,

graphql_client_codegen/src/lib.rs

@@ -151,8 +151,8 @@ pub fn generate_module_token_stream(
             type Variables = #module_name::Variables;
             type ResponseData = #module_name::ResponseData;
 
-            fn build_query(variables: Self::Variables) -> ::graphql_client::GraphQLQueryBody<Self::Variables> {
-                ::graphql_client::GraphQLQueryBody {
+            fn build_query(variables: Self::Variables) -> ::graphql_client::QueryBody<Self::Variables> {
+                ::graphql_client::QueryBody {
                     variables,
                     query: #module_name::QUERY,
                     operation_name: #module_name::OPERATION_NAME,

src/lib.rs

@@ -72,12 +72,12 @@ pub trait GraphQLQuery<'de> {
     type ResponseData: serde::Deserialize<'de>;
 
     /// Produce a GraphQL query struct that can be JSON serialized and sent to a GraphQL API.
-    fn build_query(variables: Self::Variables) -> GraphQLQueryBody<Self::Variables>;
+    fn build_query(variables: Self::Variables) -> QueryBody<Self::Variables>;
 }
 
 /// The form in which queries are sent over HTTP in most implementations. This will be built using the [`GraphQLQuery`] trait normally.
 #[derive(Debug, Serialize, Deserialize)]
-pub struct GraphQLQueryBody<Variables>
+pub struct QueryBody<Variables>
 where
     Variables: serde::Serialize,
 {
@@ -90,7 +90,7 @@ where
     pub operation_name: &'static str,
 }
 
-/// Represents a location inside a query string. Used in errors. See [`GraphQLError`].
+/// Represents a location inside a query string. Used in errors. See [`Error`].
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 pub struct Location {
     /// The line number in the query string where the error originated (starting from 1).
@@ -99,7 +99,7 @@ pub struct Location {
     pub column: i32,
 }
 
-/// Part of a path in a query. It can be an object key or an array index. See [`GraphQLError`].
+/// Part of a path in a query. It can be an object key or an array index. See [`Error`].
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 #[serde(untagged)]
 pub enum PathFragment {
@@ -132,7 +132,7 @@ pub enum PathFragment {
 /// # fn main() -> Result<(), failure::Error> {
 /// use graphql_client::*;
 ///
-/// let body: GraphQLResponse<ResponseData> = serde_json::from_value(json!({
+/// let body: Response<ResponseData> = serde_json::from_value(json!({
 ///     "data": null,
 ///     "errors": [
 ///         {
@@ -146,10 +146,10 @@ pub enum PathFragment {
 ///      ],
 /// }))?;
 ///
-/// let expected: GraphQLResponse<ResponseData> = GraphQLResponse {
+/// let expected: Response<ResponseData> = Response {
 ///     data: None,
 ///     errors: Some(vec![
-///         GraphQLError {
+///         Error {
 ///             message: "The server crashed. Sorry.".to_owned(),
 ///             locations: Some(vec![
 ///                 Location {
@@ -160,7 +160,7 @@ pub enum PathFragment {
 ///             path: None,
 ///             extensions: None,
 ///         },
-///         GraphQLError {
+///         Error {
 ///             message: "Seismic activity detected".to_owned(),
 ///             locations: None,
 ///             path: Some(vec![
@@ -178,7 +178,7 @@ pub enum PathFragment {
 /// # }
 /// ```
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
-pub struct GraphQLError {
+pub struct Error {
     /// The human-readable error message. This is the only required field.
     pub message: String,
     /// Which locations in the query the error applies to.
@@ -220,17 +220,17 @@ pub struct GraphQLError {
 /// # }
 /// #
 /// # fn main() -> Result<(), failure::Error> {
-/// use graphql_client::GraphQLResponse;
+/// use graphql_client::Response;
 ///
-/// let body: GraphQLResponse<ResponseData> = serde_json::from_value(json!({
+/// let body: Response<ResponseData> = serde_json::from_value(json!({
 ///     "data": {
 ///         "users": [{"id": 13}],
 ///         "dogs": [{"name": "Strelka"}],
 ///     },
 ///     "errors": [],
 /// }))?;
 ///
-/// let expected: GraphQLResponse<ResponseData> = GraphQLResponse {
+/// let expected: Response<ResponseData> = Response {
 ///     data: Some(ResponseData {
 ///         users: vec![User { id: 13 }],
 ///         dogs: vec![Dog { name: "Strelka".to_owned() }],
@@ -244,11 +244,11 @@ pub struct GraphQLError {
 /// # }
 /// ```
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
-pub struct GraphQLResponse<Data> {
+pub struct Response<Data> {
     /// The absent, partial or complete response data.
     pub data: Option<Data>,
     /// The top-level errors returned by the server.
-    pub errors: Option<Vec<GraphQLError>>,
+    pub errors: Option<Vec<Error>>,
 }
 
 #[cfg(test)]
@@ -261,11 +261,11 @@ mod tests {
             "message": "I accidentally your whole query"
         });
 
-        let deserialized_error: GraphQLError = serde_json::from_value(err).unwrap();
+        let deserialized_error: Error = serde_json::from_value(err).unwrap();
 
         assert_eq!(
             deserialized_error,
-            GraphQLError {
+            Error {
                 message: "I accidentally your whole query".to_string(),
                 locations: None,
                 path: None,
@@ -282,11 +282,11 @@ mod tests {
             "path": ["home", "alone", 3, "rating"]
         });
 
-        let deserialized_error: GraphQLError = serde_json::from_value(err).unwrap();
+        let deserialized_error: Error = serde_json::from_value(err).unwrap();
 
         assert_eq!(
             deserialized_error,
-            GraphQLError {
+            Error {
                 message: "I accidentally your whole query".to_string(),
                 locations: Some(vec![
                     Location {
@@ -321,7 +321,7 @@ mod tests {
             }
         });
 
-        let deserialized_error: GraphQLError = serde_json::from_value(err).unwrap();
+        let deserialized_error: Error = serde_json::from_value(err).unwrap();
 
         let mut expected_extensions = HashMap::new();
         expected_extensions.insert("code".to_owned(), json!("CAN_NOT_FETCH_BY_ID"));
@@ -330,7 +330,7 @@ mod tests {
 
         assert_eq!(
             deserialized_error,
-            GraphQLError {
+            Error {
                 message: "I accidentally your whole query".to_string(),
                 locations: Some(vec![
                     Location {

tests/introspection.rs

@@ -23,7 +23,7 @@ const INTROSPECTION_RESPONSE: &'static str =
 
 #[test]
 fn leading_underscores_are_preserved() {
-    let deserialized: graphql_client::GraphQLResponse<introspection_query::ResponseData> =
+    let deserialized: graphql_client::Response<introspection_query::ResponseData> =
         serde_json::from_str(INTROSPECTION_RESPONSE).unwrap();
     assert!(deserialized.data.is_some());
     assert!(deserialized.data.unwrap().schema.is_some());