added feature-based parser

Author: dotansimha

Cargo.lock

@@ -11,11 +11,14 @@ documentation = "https://github.com/dotansimha/graphql-tools-rs"
 authors = ["Dotan Simha <[email protected]>"]
 
 [dependencies]
-graphql-parser = { version = "0.5.0", package = "graphql-parser-hive-fork" }
+graphql-parser = { version = "^0.4.0", optional = true }
+graphql-parser-hive-fork = { version = "^0.5.0", optional = true }
 lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_with = "2.2.0"
 
-[dev-dependencies]
-graphql-parser = { version = "0.5.0", package = "graphql-parser-hive-fork" }
+[features]
+default = ["graphql_parser"]
+graphql_parser_fork = ["dep:graphql-parser-hive-fork"]
+graphql_parser = ["dep:graphql-parser"]

Cargo.toml

@@ -2,8 +2,6 @@
 
 [Documentation](https://docs.rs/graphql-tools) | [Crate](https://crates.io/crates/graphql-tools) | [GitHub](https://github.com/dotansimha/graphql-tools-rs)
 
-> **Note: this crate is still under development (see roadmap below)**
-
 The [`graphql_tools` crate](https://crates.io/crates/graphql-tools) implements tooling around GraphQL for Rust libraries. Most of the tools are based on `trait`s and `struct`s implemented in [`graphql_parser` crate](https://crates.io/crates/graphql-parser).
 
 The goal of this library is to create a common layer of tools that has similar/improved APIs to [`graphql-js` reference implementation](https://github.com/graphql/graphql-js) and [`graphql-tools` from the JS/TS ecosystem](https://github.com/ardatan/graphql-tools).
@@ -25,23 +23,16 @@ Or, if you are using [`cargo-edit`](https://github.com/killercup/cargo-edit):
 cargo add graphql-tools
 ```
 
-### Roadmap and progress
-
-- [ ] Better documentation 
-- [x] AST Visitor for GraphQL schema (`graphql_parser::schema::Document`)
-- [x] AST Visitor for GraphQL operations (`graphql_parser::operation::Document`) 
-- [x] AST Visitor with TypeInfo
-- [x] AST tools (ongoing)
-- [x] `struct` extensions
-- [x] GraphQL Validation engine
-- [x] Validation rules
-- [x] GraphQL operations transformer
+By default, this crate is using the [`graphql-parser`](https://github.com/graphql-rust/graphql-parser) library for parsing. If you wish to use an alternative implementation such as [`graphql-hive/graphql-parser-hive-fork`](https://github.com/graphql-hive/graphql-parser-hive-fork), use the following `features` setup:
 
-> If you have an idea / missing feature, feel free to open an issue / start a GitHub discussion!
+```toml
+[dependencies]
+graphql-tools = { version = "...", features = "graphql_parser_fork", default-features = false }
+```
 
 #### Validation Rules
 
-> This comparison is based on `graphql-js` refernece implementation. 
+> This comparison is based on `graphql-js` refernece implementation.
 
 - [x] ExecutableDefinitions (not actually needed)
 - [x] UniqueOperationNames
@@ -68,4 +59,4 @@ cargo add graphql-tools
 - [x] ProvidedRequiredArguments
 - [x] VariablesInAllowedPosition
 - [x] OverlappingFieldsCanBeMerged
-- [ ] UniqueInputFieldNames (blocked by https://github.com/graphql-rust/graphql-parser/issues/59)
+- [ ] UniqueInputFieldNames (blocked by https://github.com/graphql-rust/graphql-parser/issues/59)

README.md

@@ -1,4 +1,4 @@
-use graphql_parser::query::*;
+use crate::parser::query::*;
 
 #[derive(Clone, Debug)]
 pub enum Transformed<T> {

src/ast/operation_transformer.rs

@@ -1,6 +1,6 @@
 use std::collections::{BTreeMap, HashMap};
 
-use graphql_parser::query::TypeCondition;
+use crate::parser::query::TypeCondition;
 
 use crate::static_graphql::{
     query::{self, *},
@@ -278,7 +278,8 @@ fn visit_input_value<'a, Visitor, UserContext>(
                 let input_type = context
                     .current_input_type_literal()
                     .and_then(|v| context.schema.type_by_name(v.inner_type()))
-                    .and_then(|v| v.input_field_by_name(sub_key)).map(|v| &v.value_type);
+                    .and_then(|v| v.input_field_by_name(sub_key))
+                    .map(|v| &v.value_type);
 
                 context.with_input_type(input_type, |context| {
                     let param = &(sub_key.clone(), sub_value.clone());

src/ast/operation_visitor.rs

@@ -174,7 +174,7 @@ pub trait SchemaVisitor<T = ()> {
 
 #[test]
 fn visit_schema() {
-    use graphql_parser::schema::parse_schema;
+    use crate::parser::schema::parse_schema;
     let schema_ast = parse_schema(
         r#"
     scalar Date

src/ast/schema_visitor.rs

@@ -11,7 +11,7 @@ pub mod static_graphql {
     macro_rules! static_graphql {
     ($m:ident, $m2:ident, {$($n:ident,)*}) => {
         pub mod $m {
-            use graphql_parser::$m2 as $m;
+            use crate::parser::$m2 as $m;
             pub use $m::*;
             $(
                 pub type $n = $m::$n<'static, String>;
@@ -35,3 +35,8 @@ pub mod static_graphql {
 pub mod introspection;
 
 pub mod validation;
+
+#[cfg(feature = "graphql_parser")]
+pub extern crate graphql_parser as parser;
+#[cfg(feature = "graphql_parser_fork")]
+pub extern crate graphql_parser_hive_fork as parser;

src/lib.rs

@@ -1,5 +1,5 @@
-use graphql_parser::query::{Definition, TypeCondition};
-use graphql_parser::Pos;
+use crate::parser::query::{Definition, TypeCondition};
+use crate::parser::Pos;
 
 use super::ValidationRule;
 use crate::ast::ext::TypeDefinitionExtension;

src/validation/rules/overlapping_fields_can_be_merged.rs

@@ -1,6 +1,6 @@
 use std::collections::HashMap;
 
-use graphql_parser::Pos;
+use crate::parser::Pos;
 
 use super::ValidationRule;
 use crate::ast::{visit_document, OperationVisitor, OperationVisitorContext};

src/validation/rules/unique_argument_names.rs

@@ -1,7 +1,7 @@
 use std::collections::hash_map::Entry;
 use std::collections::HashMap;
 
-use graphql_parser::Pos;
+use crate::parser::Pos;
 
 use super::ValidationRule;
 use crate::ast::{visit_document, OperationVisitor, OperationVisitorContext};