graphql-client 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fb2c7543a34c26a3ffa6718ddb35a4e4ae9972c
-  data.tar.gz: f879a3fff89104e8c5eff98ba15c62ec2694de17
+  metadata.gz: 490142029326d682bd6956d1f825d9429aa49389
+  data.tar.gz: 3cc776110140c024c801f8b3a9eb52bf72cc924f
 SHA512:
-  metadata.gz: d0b95e7dd51deebc8edd667ac3b824f270173992f5b8d7017eb96490c0a9eab6e4fdee58a989209640062e3f70a74f52e607a056b730ca34eeb6bc6599ef6d99
-  data.tar.gz: 2c21b4f7ec54721953afaeb88f41f10af9b13006cfbaca45e6573649df23b464afa39d6208d4dacc29ce0bfdc558a67290e3915afd6d094ea7aa7a50000137a0
+  metadata.gz: 2e3cba4f02d0fff593cadcbd0d39bcdecb0576f087bb9088f2dc5902426bb54b7829ea3eb7d8d96c86fae155eb6ba248c5414ba24006834c8a4d806063e1be4c
+  data.tar.gz: bb8b0a56f1f1d0be7a4315aa626af65a08e7285adb03fb02e382a0fb6fdb53e67326ed6654f171709f267897141e396813ac2245f6c45097157b78f492dba7da

data/lib/graphql/client.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 require "active_support/inflector"
 require "active_support/notifications"
 require "graphql"
 require "graphql/client/error"
 require "graphql/client/errors"
 require "graphql/client/query_result"
+require "graphql/client/query_typename"
 require "graphql/client/response"
 require "graphql/language/nodes/deep_freeze_ext"
 require "json"
@@ -95,9 +97,11 @@ module GraphQL
         end
       end
 
-      def initialize(node:, document:)
+      def initialize(node:, document:, schema:, document_types:)
         @definition_node = node
         @document = document
+        @schema = schema
+        @document_types = document_types
       end
 
       # Internal: Get underlying operation or fragment defintion AST node for
@@ -130,13 +134,15 @@ module GraphQL
       # and any FragmentDefinition dependencies.
       attr_reader :document
 
+      attr_reader :schema
+
       def new(*args)
         type.new(*args)
       end
 
       def type
         # TODO: Fix type indirection
-        @type ||= GraphQL::Client::QueryResult.wrap(definition_node, name: "#{name}.type")
+        @type ||= GraphQL::Client::QueryResult.wrap(definition_node, name: "#{name}.type", types: @document_types)
       end
     end
 
@@ -208,13 +214,24 @@ module GraphQL
           error.set_backtrace(["#{filename}:#{lineno + validation_line}"] + caller) if filename && lineno
           raise error
         end
+
+        document_types = DocumentTypes.analyze_types(@schema, doc).freeze
+      else
+        document_types = {}.freeze
       end
 
+      QueryTypename.insert_typename_fields(doc, types: document_types)
+
       definitions = {}
       doc.definitions.each do |node|
         node.name = nil if node.name == "__anonymous__"
         sliced_document = Language::DefinitionSlice.slice(document_dependencies, node.name)
-        definition = Definition.for(node: node, document: sliced_document)
+        definition = Definition.for(
+          schema: @schema,
+          node: node,
+          document: sliced_document,
+          document_types: document_types
+        )
         definitions[node.name] = definition
       end
 

data/lib/graphql/client/document_types.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "graphql"
+
+module GraphQL
+  class Client
+    # Internal: Use schema to detect definition and field types.
+    module DocumentTypes
+      # Internal: Detect all types used in a given document
+      #
+      # schema - A GraphQL::Schema
+      # document - A GraphQL::Language::Nodes::Document to scan
+      #
+      # Returns a Hash[Language::Nodes::Node] to GraphQL::Type objects.
+      def self.analyze_types(schema, document)
+        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 schema to be a GraphQL::Language::Nodes::Document, but was #{document.class}"
+        end
+
+        visitor = GraphQL::Language::Visitor.new(document)
+        type_stack = GraphQL::StaticValidation::TypeStack.new(schema, visitor)
+
+        fields = {}
+
+        visitor[GraphQL::Language::Nodes::OperationDefinition] << ->(node, _parent) do
+          fields[node] = type_stack.object_types.last
+        end
+        visitor[GraphQL::Language::Nodes::FragmentDefinition] << ->(node, _parent) do
+          fields[node] = type_stack.object_types.last
+        end
+        visitor[GraphQL::Language::Nodes::Field] << ->(node, _parent) do
+          fields[node] = type_stack.field_definitions.last.type
+        end
+        visitor.visit
+
+        fields
+      end
+    end
+  end
+end

data/lib/graphql/client/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   class Client
     # Public: Abstract base class for all errors raised by GraphQL::Client.

data/lib/graphql/client/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "graphql/client/hash_with_indifferent_access"
 
 module GraphQL

data/lib/graphql/client/erubis.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "action_view"
 
 module GraphQL

data/lib/graphql/client/hash_with_indifferent_access.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_support/inflector"
 
 module GraphQL

data/lib/graphql/client/http.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "json"
 require "net/http"
 require "uri"

data/lib/graphql/client/list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "graphql/client/errors"
 
 module GraphQL

data/lib/graphql/client/log_subscriber.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_support/log_subscriber"
 
 module GraphQL

data/lib/graphql/client/query_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_support/inflector"
 require "graphql"
 require "graphql/client/errors"
@@ -16,7 +17,7 @@ module GraphQL
       # Internal: Get QueryResult class for result of query.
       #
       # Returns subclass of QueryResult or nil.
-      def self.wrap(node, name: nil)
+      def self.wrap(node, name: nil, types: {})
         fields = {}
 
         node.selections.each do |selection|
@@ -25,27 +26,29 @@ module GraphQL
             nil
           when Language::Nodes::Field
             field_name = selection.alias || selection.name
-            field_klass = selection.selections.any? ? wrap(selection, name: "#{name}[:#{field_name}]") : nil
+            field_klass = nil
+            field_klass = wrap(selection, name: "#{name}[:#{field_name}]", types: types) if selection.selections.any?
             fields[field_name] ? fields[field_name] |= field_klass : fields[field_name] = field_klass
           when Language::Nodes::InlineFragment
-            wrap(selection, name: name).fields.each do |fragment_name, klass|
+            wrap(selection, name: name, types: types).fields.each do |fragment_name, klass|
               fields[fragment_name.to_s] ? fields[fragment_name.to_s] |= klass : fields[fragment_name.to_s] = klass
             end
           end
         end
 
-        define(name: name, source_node: node, fields: fields)
+        define(name: name, source_node: node, fields: fields, type: types[node] && types[node].unwrap)
       end
 
       # Internal
-      def self.define(name:, source_node:, fields: {})
+      def self.define(name:, source_node:, fields: {}, type: nil)
         Class.new(self) do
           @name = name
+          @type = type
           @source_node = source_node
           @fields = {}
 
-          fields.each do |field, type|
-            @fields[field.to_sym] = type
+          fields.each do |field, klass|
+            @fields[field.to_sym] = klass
 
             send :attr_reader, field
 
@@ -69,8 +72,8 @@ module GraphQL
             RUBY
           end
 
-          assigns = fields.map do |field, type|
-            if type
+          assigns = fields.map do |field, klass|
+            if klass
               <<-RUBY
                 @#{field} = self.class.fields[:#{field}].cast(@data["#{field}"], @errors.filter_by_path("#{field}"))
               RUBY
@@ -81,6 +84,10 @@ module GraphQL
             end
           end
 
+          if @type && @type.is_a?(GraphQL::ObjectType)
+            assigns.unshift "@__typename = self.class.type.name"
+          end
+
           class_eval <<-RUBY, __FILE__, __LINE__
             def initialize(data, errors = Errors.new)
               @data = data
@@ -94,6 +101,8 @@ module GraphQL
       end
 
       class << self
+        attr_reader :type
+
         attr_reader :source_node
 
         attr_reader :fields
@@ -177,6 +186,9 @@ module GraphQL
       attr_reader :data
       alias to_h data
 
+      attr_reader :__typename
+      alias typename __typename
+
       def inspect
         ivars = self.class.fields.keys.map do |sym|
           value = instance_variable_get("@#{sym}")
@@ -186,7 +198,7 @@ module GraphQL
             "#{sym}=#{value.inspect}"
           end
         end
-        buf = "#<#{self.class.name}"
+        buf = "#<#{self.class.name}".dup
         buf << " " << ivars.join(" ") if ivars.any?
         buf << ">"
         buf

data/lib/graphql/client/query_typename.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require "graphql"
+require "graphql/client/document_types"
+
+module GraphQL
+  class Client
+    # Internal: Insert __typename field selections into query.
+    module QueryTypename
+      # Internal: Insert __typename field selections into query.
+      #
+      # Skips known types when schema is provided.
+      #
+      # document - GraphQL::Language::Nodes::Document to modify
+      # schema - Optional Map of GraphQL::Language::Nodes::Node to GraphQL::Type
+      #
+      # 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
+            end
+          end
+        end
+
+        visitor = GraphQL::Language::Visitor.new(document)
+        visitor[GraphQL::Language::Nodes::Field].leave << on_selections
+        visitor[GraphQL::Language::Nodes::FragmentDefinition].leave << on_selections
+        visitor[GraphQL::Language::Nodes::OperationDefinition].leave << on_selections
+        visitor.visit
+
+        nil
+      end
+
+      def self.node_flatten_selections(selections)
+        selections.flat_map do |selection|
+          case selection
+          when GraphQL::Language::Nodes::Field
+            selection
+          when GraphQL::Language::Nodes::InlineFragment
+            node_flatten_selections(selection.selections)
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/client/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "graphql"
 require "graphql/client"
 require "rails/railtie"

data/lib/graphql/client/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "graphql/client/errors"
 
 module GraphQL

data/lib/graphql/client/view_module.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_support/dependencies"
 require "active_support/inflector"
 require "graphql/client/erubis"

data/lib/graphql/language/nodes/deep_freeze_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "graphql"
 
 module GraphQL

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rubocop"
 
 module RuboCop

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_support/inflector"
 require "graphql"
 require "graphql/client/erubis"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-client
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,6 +115,7 @@ files:
 - LICENSE
 - README.md
 - lib/graphql/client.rb
+- lib/graphql/client/document_types.rb
 - lib/graphql/client/error.rb
 - lib/graphql/client/errors.rb
 - lib/graphql/client/erubis.rb
@@ -123,6 +124,7 @@ files:
 - lib/graphql/client/list.rb
 - lib/graphql/client/log_subscriber.rb
 - lib/graphql/client/query_result.rb
+- lib/graphql/client/query_typename.rb
 - lib/graphql/client/railtie.rb
 - lib/graphql/client/response.rb
 - lib/graphql/client/view_module.rb
@@ -149,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: GraphQL Client