graphql-client 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dc218011045b6cacca2b4cf958da5327c947bfc
-  data.tar.gz: 2edfa03b6d800d722609f5abbd76605a9a479b61
+  metadata.gz: bd882791666554b4b6999b5e6e1089187eb06e9a
+  data.tar.gz: 5c1e142aee92b113edef6c34a90484ff32b2fd0e
 SHA512:
-  metadata.gz: c142fa08a17ff24e0e48b05a48439284ddded4d7496ce6c2739d1c2a1e2e7d12d5da76844f67cac1f2e1ae7b221c8d24061150925e65351f5b6ce1e3818e0f3a
-  data.tar.gz: f6701168cf80f970c9230d7cb43ceeca0a78cba073365ff884ff0d4276142cd72a8d5a94db00301600949a5e696742979553462f43302dce8e87fd19b7d48bf9
+  metadata.gz: 242cd9508205d68cb2459a78bcd689a986c4317478113923d8fbd23d015bf8c936fd84619410228404699a7c229377f6333f857f216853d9991b32603e34443d
+  data.tar.gz: 74fb38b0777b0df123df5c5a09a6e1caf5f69ec3f5f765c859d041900c58e6403cebd0a59c882095524ba18cf08ab0e04dcfca7164b39c6d2e291e8f845b15f1

data/lib/graphql/client.rb

@@ -3,6 +3,7 @@ require "active_support/inflector"
 require "active_support/notifications"
 require "graphql"
 require "graphql/client/collocated_enforcement"
+require "graphql/client/definition_variables"
 require "graphql/client/error"
 require "graphql/client/errors"
 require "graphql/client/query_result"
@@ -233,7 +234,10 @@ module GraphQL
 
       document_dependencies = Language::Nodes::Document.new(definitions: doc.definitions + definition_dependencies.to_a)
 
-      rules = GraphQL::StaticValidation::ALL_RULES - [GraphQL::StaticValidation::FragmentsAreUsed]
+      rules = GraphQL::StaticValidation::ALL_RULES - [
+        GraphQL::StaticValidation::FragmentsAreUsed,
+        GraphQL::StaticValidation::FieldsHaveAppropriateSelections
+      ]
       validator = GraphQL::StaticValidation::Validator.new(schema: self.schema, rules: rules)
       query = GraphQL::Query.new(self.schema, document: document_dependencies)
 
@@ -293,6 +297,63 @@ module GraphQL
       end
     end
 
+    # Public: Create operation definition from a fragment definition.
+    #
+    # Automatically determines operation variable set.
+    #
+    # Examples
+    #
+    #   FooFragment = Client.parse <<-'GRAPHQL'
+    #     fragment on Mutation {
+    #       updateFoo(id: $id, content: $content)
+    #     }
+    #   GRAPHQL
+    #
+    #   # mutation($id: ID!, $content: String!) {
+    #   #   updateFoo(id: $id, content: $content)
+    #   # }
+    #   FooMutation = Client.create_operation(FooFragment)
+    #
+    # fragment - A FragmentDefinition definition.
+    #
+    # Returns an OperationDefinition.
+    def create_operation(fragment, filename = nil, lineno = nil)
+      unless fragment.is_a?(GraphQL::Client::FragmentDefinition)
+        raise TypeError, "expected fragment to be a GraphQL::Client::FragmentDefinition, but was #{fragment.class}"
+      end
+
+      if filename.nil? && lineno.nil?
+        location = caller_locations(1, 1).first
+        filename = location.path
+        lineno = location.lineno
+      end
+
+      variables = GraphQL::Client::DefinitionVariables.operation_variables(self.schema, fragment.document, fragment.definition_name)
+      type_name = fragment.definition_node.type.name
+
+      if schema.query && type_name == schema.query.name
+        operation_type = "query"
+      elsif schema.mutation && type_name == schema.mutation.name
+        operation_type = "mutation"
+      elsif schema.subscription && type_name == schema.subscription.name
+        operation_type = "subscription"
+      else
+        types = [schema.query, schema.mutation, schema.subscription].compact
+        raise Error, "Fragment must be defined on #{types.map(&:name).join(", ")}"
+      end
+
+      doc_ast = GraphQL::Language::Nodes::Document.new(definitions: [
+        GraphQL::Language::Nodes::OperationDefinition.new(
+          operation_type: operation_type,
+          variables: variables,
+          selections: [
+            GraphQL::Language::Nodes::FragmentSpread.new(name: fragment.name)
+          ]
+        )
+      ])
+      parse(doc_ast.to_query_string, filename, lineno)
+    end
+
     attr_reader :document
 
     def query(definition, variables: {}, context: {})

data/lib/graphql/client/definition_variables.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require "graphql"
+
+module GraphQL
+  class Client
+    # Internal: Detect variables used in a definition.
+    module DefinitionVariables
+      # Internal: Detect all variables used in a given operation or fragment
+      # definition.
+      #
+      # schema - A GraphQL::Schema
+      # document - A GraphQL::Language::Nodes::Document to scan
+      # definition_name - A String definition name. Defaults to anonymous definition.
+      #
+      # Returns a Hash[Symbol] to GraphQL::Type objects.
+      def self.variables(schema, document, definition_name = nil)
+        unless schema.is_a?(GraphQL::Schema)
+          raise TypeError, "expected schema to be a GraphQL::Schema, but was #{schema.class}"
+        end
+
+        unless document.is_a?(GraphQL::Language::Nodes::Document)
+          raise TypeError, "expected document to be a GraphQL::Language::Nodes::Document, but was #{document.class}"
+        end
+
+        sliced_document = GraphQL::Language::DefinitionSlice.slice(document, definition_name)
+
+        visitor = GraphQL::Language::Visitor.new(sliced_document)
+        type_stack = GraphQL::StaticValidation::TypeStack.new(schema, visitor)
+
+        variables = {}
+
+        visitor[GraphQL::Language::Nodes::VariableIdentifier] << ->(node, parent) do
+          if definition = type_stack.argument_definitions.last
+            existing_type = variables[node.name.to_sym]
+
+            if existing_type && existing_type.unwrap != definition.type.unwrap
+              raise GraphQL::Client::ValidationError, "$#{node.name} was already declared as #{existing_type.unwrap}, but was #{definition.type.unwrap}"
+            elsif !existing_type.is_a?(GraphQL::NonNullType)
+              variables[node.name.to_sym] = definition.type
+            end
+          end
+        end
+
+        visitor.visit
+
+        variables
+      end
+
+      # Internal: Detect all variables used in a given operation or fragment
+      # definition.
+      #
+      # schema - A GraphQL::Schema
+      # document - A GraphQL::Language::Nodes::Document to scan
+      # definition_name - A String definition name. Defaults to anonymous definition.
+      #
+      # Returns a Hash[Symbol] to VariableDefinition objects.
+      def self.operation_variables(schema, document, definition_name = nil)
+        variables(schema, document, definition_name).map { |name, type|
+          GraphQL::Language::Nodes::VariableDefinition.new(name: name.to_s, type: variable_node(type))
+        }
+      end
+
+      # Internal: Get AST node for GraphQL type.
+      #
+      # type - A GraphQL::Type
+      #
+      # Returns GraphQL::Language::Nodes::Type.
+      def self.variable_node(type)
+        case type
+        when GraphQL::NonNullType
+          GraphQL::Language::Nodes::NonNullType.new(of_type: variable_node(type.of_type))
+        when GraphQL::ListType
+          GraphQL::Language::Nodes::ListType.new(of_type: variable_node(type.of_type))
+        else
+          GraphQL::Language::Nodes::TypeName.new(name: type.name)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/client/erubi_enhancer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Client
+    # Public: Erubi enhancer that adds support for GraphQL static query sections.
+    #
+    #   <%graphql
+    #     query GetVerison {
+    #       version
+    #     }
+    #   %>
+    #   <%= data.version %>
+    #
+    module ErubiEnhancer
+      # Internal: Extend Erubi handler to simply ignore <%graphql sections.
+      def initialize(input, *args)
+        input = input.gsub(/<%graphql/, "<%#")
+        super(input, *args)
+      end
+    end
+  end
+end

data/lib/graphql/client/erubis.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "action_view"
+require "graphql/client/erubis_enhancer"
 
 module GraphQL
   class Client
@@ -18,24 +19,12 @@ module GraphQL
     #   ActionView::Template::Handlers::ERB.erb_implementation = GraphQL::Client::Erubis
     #
     class Erubis < ActionView::Template::Handlers::Erubis
-      # Public: Extract GraphQL section from ERB template.
-      #
-      # src - String ERB text
-      #
-      # Returns String GraphQL query and line number or nil or no section was
-      # defined.
+      # Deprecated: Use ViewModule.extract_graphql_section.
       def self.extract_graphql_section(src)
-        query_string = src.scan(/<%graphql([^%]+)%>/).flatten.first
-        return nil unless query_string
-        [query_string, Regexp.last_match.pre_match.count("\n") + 1]
+        ViewModule.extract_graphql_section(src)
       end
 
-      # Internal: Extend Rails' Erubis handler to simply ignore <%graphql
-      # sections.
-      def convert_input(src, input)
-        input = input.gsub(/<%graphql/, "<%#")
-        super(src, input)
-      end
+      include ErubisEnhancer
     end
   end
 end

data/lib/graphql/client/erubis_enhancer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Client
+    # Public: Erubis enhancer that adds support for GraphQL static query sections.
+    #
+    #   <%graphql
+    #     query GetVerison {
+    #       version
+    #     }
+    #   %>
+    #   <%= data.version %>
+    #
+    module ErubisEnhancer
+      # Internal: Extend Erubis handler to simply ignore <%graphql sections.
+      def convert_input(src, input)
+        input = input.gsub(/<%graphql/, "<%#")
+        super(src, input)
+      end
+    end
+  end
+end

data/lib/graphql/client/query_result.rb

@@ -233,11 +233,13 @@ module GraphQL
       attr_reader :__typename
       alias typename __typename
 
-      def type_of?(type)
-        if type = self.class.schema.types.fetch(type.to_s, nil)
-          self.class.schema.possible_types(type).any? { |t| @__typename == t.name }
-        else
-          false
+      def type_of?(*types)
+        types.any? do |type|
+          if type = self.class.schema.types.fetch(type.to_s, nil)
+            self.class.schema.possible_types(type).any? { |t| @__typename == t.name }
+          else
+            false
+          end
         end
       end
 

data/lib/graphql/client/query_typename.rb

@@ -16,17 +16,20 @@ module GraphQL
       # Returns nothing.
       def self.insert_typename_fields(document, types: {})
         on_selections = ->(node, _parent) do
-          return unless node.selections.any?
-
           type = types[node]
-          case type && type.unwrap
-          when NilClass, GraphQL::InterfaceType, GraphQL::UnionType
-            names = node_flatten_selections(node.selections).map { |s| s.respond_to?(:name) ? s.name : nil }
-            names = Set.new(names.compact)
 
-            unless names.include?("__typename")
-              node.selections = [GraphQL::Language::Nodes::Field.new(name: "__typename")] + node.selections
+          if node.selections.any?
+            case type && type.unwrap
+            when NilClass, GraphQL::InterfaceType, GraphQL::UnionType
+              names = node_flatten_selections(node.selections).map { |s| s.respond_to?(:name) ? s.name : nil }
+              names = Set.new(names.compact)
+
+              unless names.include?("__typename")
+                node.selections = [GraphQL::Language::Nodes::Field.new(name: "__typename")] + node.selections
+              end
             end
+          elsif type && type.unwrap.is_a?(GraphQL::ObjectType)
+            node.selections = [GraphQL::Language::Nodes::Field.new(name: "__typename")]
           end
         end
 

data/lib/graphql/client/view_module.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "active_support/dependencies"
 require "active_support/inflector"
-require "graphql/client/erubis"
+require "graphql/client/erubis_enhancer"
 
 module GraphQL
   class Client
@@ -19,6 +19,18 @@ module GraphQL
     module ViewModule
       attr_accessor :client
 
+      # Public: Extract GraphQL section from ERB template.
+      #
+      # src - String ERB text
+      #
+      # Returns String GraphQL query and line number or nil or no section was
+      # defined.
+      def self.extract_graphql_section(src)
+        query_string = src.scan(/<%graphql([^%]+)%>/).flatten.first
+        return nil unless query_string
+        [query_string, Regexp.last_match.pre_match.count("\n") + 1]
+      end
+
       # Public: Eager load module and all subdependencies.
       #
       # Use in production when cache_classes is true.
@@ -124,7 +136,7 @@ module GraphQL
 
         if File.extname(path) == ".erb"
           contents = File.read(path)
-          query, lineno = GraphQL::Client::Erubis.extract_graphql_section(contents)
+          query, lineno = ViewModule.extract_graphql_section(contents)
           mod = client.parse(query, path, lineno) if query
         end
 

data/lib/rubocop/cop/graphql/overfetch.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "active_support/inflector"
 require "graphql"
-require "graphql/client/erubis"
+require "graphql/client/view_module"
 require "rubocop"
 
 module RuboCop
@@ -13,7 +13,7 @@ module RuboCop
 
         def investigate(processed_source)
           erb = File.read(processed_source.buffer.name)
-          query, = ::GraphQL::Client::Erubis.extract_graphql_section(erb)
+          query, = ::GraphQL::Client::ViewModule.extract_graphql_section(erb)
           return unless query
 
           aliases = {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-client
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,6 +64,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -130,10 +158,13 @@ files:
 - README.md
 - lib/graphql/client.rb
 - lib/graphql/client/collocated_enforcement.rb
+- lib/graphql/client/definition_variables.rb
 - lib/graphql/client/document_types.rb
 - lib/graphql/client/error.rb
 - lib/graphql/client/errors.rb
+- lib/graphql/client/erubi_enhancer.rb
 - lib/graphql/client/erubis.rb
+- lib/graphql/client/erubis_enhancer.rb
 - lib/graphql/client/hash_with_indifferent_access.rb
 - lib/graphql/client/http.rb
 - lib/graphql/client/list.rb
@@ -166,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: GraphQL Client