graphql-client 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30231d5575e5a6012a4d8f650d69b25820d75d800c6d53a3efa1e6304577e03
-  data.tar.gz: c1de7029eb91165c620f05bd864eed6efd60ed36526074bfc444b47cdbff3604
+  metadata.gz: 3d469dea9c19c2b7b70f57554d66dab3374c496ef09bc013d9464509faac1243
+  data.tar.gz: 7fdc9c16119e205cc1e200ee4fc5d882776bbd94c1294dc075963428d7d9f7e4
 SHA512:
-  metadata.gz: 00a451679c6f3d68b748c0f1bed6ed4ad0a3ac796954d19ad09c347ee669ff6d756d57b4390b7153c787d8a97d6f28ebf3eefde99183906159a80bc8a80bb338
-  data.tar.gz: ef0a5bae3219ea84c139dabfe4b96eda4621c7da4d9ef9fa752af681d637f43a0871f36c07e629fb96ef1d1368ff0352e2cacf749b08d7c7e1171185f6952e15
+  metadata.gz: 51ad31a0fd1faf1275037177e7b22f29f597ab9c03868831422de07f563a1c2911a32372832f45053c2430648a267067a721b66df5697fbc1e8735fefddf78b1
+  data.tar.gz: 6162d16ba9cefdd82356c89fd799744bcb0777716c0a379c403f519c4aa5fb1c1d2a0a15955852f31d76326fcb6ceebb24fc861c85d211078e5b492bbbc95e0f

data/lib/graphql/client/definition.rb

@@ -147,41 +147,58 @@ module GraphQL
       # Internal: Nodes AST indexes.
       def indexes
         @indexes ||= begin
-          visitor = GraphQL::Language::Visitor.new(document)
-          definitions = index_node_definitions(visitor)
-          spreads = index_spreads(visitor)
+          visitor = DefinitionVisitor.new(document)
           visitor.visit
-          { definitions: definitions, spreads: spreads }
+          { definitions: visitor.definitions, spreads: visitor.spreads }
         end
       end
 
-      private
+      class DefinitionVisitor < GraphQL::Language::Visitor
+        attr_reader :spreads, :definitions
 
-        def cast_object(obj)
-          if obj.class.is_a?(GraphQL::Client::Schema::ObjectType)
-            unless obj._spreads.include?(definition_node.name)
-              raise TypeError, "#{definition_node.name} is not included in #{obj.source_definition.name}"
-            end
-            schema_class.cast(obj.to_h, obj.errors)
-          else
-            raise TypeError, "unexpected #{obj.class}"
-          end
+        def initialize(doc)
+          super
+          @spreads = {}
+          @definitions = {}
+          @current_definition = nil
         end
 
-        EMPTY_SET = Set.new.freeze
+        def on_field(node, parent)
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        end
 
-        def index_spreads(visitor)
-          spreads = {}
-          on_node = ->(node, _parent) do
-            node_spreads = flatten_spreads(node).map(&:name)
-            spreads[node] = node_spreads.empty? ? EMPTY_SET : Set.new(node_spreads).freeze
-          end
+        def on_fragment_definition(node, parent)
+          @current_definition = node
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        ensure
+          @current_definition = nil
+        end
 
-          visitor[GraphQL::Language::Nodes::Field] << on_node
-          visitor[GraphQL::Language::Nodes::FragmentDefinition] << on_node
-          visitor[GraphQL::Language::Nodes::OperationDefinition] << on_node
+        def on_operation_definition(node, parent)
+          @current_definition = node
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        ensure
+          @current_definition = nil
+        end
 
-          spreads
+        def on_inline_fragment(node, parent)
+          @definitions[node] = @current_definition
+          super
+        end
+
+        private
+
+        EMPTY_SET = Set.new.freeze
+
+        def get_spreads(node)
+          node_spreads = flatten_spreads(node).map(&:name)
+          node_spreads.empty? ? EMPTY_SET : Set.new(node_spreads).freeze
         end
 
         def flatten_spreads(node)
@@ -198,25 +215,20 @@ module GraphQL
           end
           spreads
         end
+      end
 
-        def index_node_definitions(visitor)
-          current_definition = nil
-          enter_definition = ->(node, _parent) { current_definition = node }
-          leave_definition = ->(node, _parent) { current_definition = nil }
-
-          visitor[GraphQL::Language::Nodes::FragmentDefinition].enter << enter_definition
-          visitor[GraphQL::Language::Nodes::FragmentDefinition].leave << leave_definition
-          visitor[GraphQL::Language::Nodes::OperationDefinition].enter << enter_definition
-          visitor[GraphQL::Language::Nodes::OperationDefinition].leave << leave_definition
-
-          definitions = {}
-          on_node = ->(node, _parent) { definitions[node] = current_definition }
-          visitor[GraphQL::Language::Nodes::Field] << on_node
-          visitor[GraphQL::Language::Nodes::FragmentDefinition] << on_node
-          visitor[GraphQL::Language::Nodes::InlineFragment] << on_node
-          visitor[GraphQL::Language::Nodes::OperationDefinition] << on_node
-          definitions
+      private
+
+      def cast_object(obj)
+        if obj.class.is_a?(GraphQL::Client::Schema::ObjectType)
+          unless obj._spreads.include?(definition_node.name)
+            raise TypeError, "#{definition_node.name} is not included in #{obj.source_definition.name}"
+          end
+          schema_class.cast(obj.to_h, obj.errors)
+        else
+          raise TypeError, "unexpected #{obj.class}"
         end
+      end
     end
   end
 end

data/lib/graphql/client/definition_variables.rb

@@ -24,26 +24,33 @@ module GraphQL
 
         sliced_document = GraphQL::Language::DefinitionSlice.slice(document, definition_name)
 
-        visitor = GraphQL::Language::Visitor.new(sliced_document)
-        type_stack = GraphQL::StaticValidation::TypeStack.new(schema, visitor)
+        visitor = VariablesVisitor.new(sliced_document, schema: schema)
+        visitor.visit
+        visitor.variables
+      end
+
+      class VariablesVisitor < GraphQL::Language::Visitor
+        prepend GraphQL::Client::TypeStack
+
+        def initialize(*_args, **_kwargs)
+          super
+          @variables = {}
+        end
 
-        variables = {}
+        attr_reader :variables
 
-        visitor[GraphQL::Language::Nodes::VariableIdentifier] << ->(node, parent) do
-          if definition = type_stack.argument_definitions.last
-            existing_type = variables[node.name.to_sym]
+        def on_variable_identifier(node, parent)
+          if definition = @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 && existing_type.kind.non_null?)
-              variables[node.name.to_sym] = definition.type
+              @variables[node.name.to_sym] = definition.type
             end
           end
+          super
         end
-
-        visitor.visit
-
-        variables
       end
 
       # Internal: Detect all variables used in a given operation or fragment

data/lib/graphql/client/document_types.rb

@@ -1,10 +1,41 @@
 # frozen_string_literal: true
 require "graphql"
+require "graphql/client/type_stack"
 
 module GraphQL
   class Client
     # Internal: Use schema to detect definition and field types.
     module DocumentTypes
+      class AnalyzeTypesVisitor < GraphQL::Language::Visitor
+        prepend GraphQL::Client::TypeStack
+        attr_reader :fields
+
+        def initialize(*a, **kw)
+          @fields = {}
+          super
+        end
+
+        def on_operation_definition(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_fragment_definition(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_inline_fragment(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_field(node, _parent)
+          @fields[node] = @field_definitions.last.type
+          super
+        end
+      end
+
       # Internal: Detect all types used in a given document
       #
       # schema - A GraphQL::Schema
@@ -20,32 +51,15 @@ module GraphQL
           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::InlineFragment] << ->(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 = AnalyzeTypesVisitor.new(document, schema: schema)
         visitor.visit
-
-        fields
+        visitor.fields
       rescue StandardError => err
         if err.is_a?(TypeError)
           raise
         end
         # FIXME: TypeStack my crash on invalid documents
-        fields
+        visitor.fields
       end
     end
   end

data/lib/graphql/client/schema/object_type.rb

@@ -132,13 +132,13 @@ module GraphQL
           case selected_ast_node
           when GraphQL::Language::Nodes::InlineFragment
             continue_selection = if selected_ast_node.type.nil?
-              true
-            else
-              type_condition = definition.client.get_type(selected_ast_node.type.name)
-              applicable_types = definition.client.possible_types(type_condition)
-              # continue if this object type is one of the types matching the fragment condition
-              applicable_types.include?(type)
-            end
+                                   true
+                                 else
+                                   type_condition = definition.client.get_type(selected_ast_node.type.name)
+                                   applicable_types = definition.client.possible_types(type_condition)
+                                   # continue if this object type is one of the types matching the fragment condition
+                                   applicable_types.include?(type)
+                                 end
 
             if continue_selection
               selected_ast_node.selections.each do |next_selected_ast_node|

data/lib/graphql/client/type_stack.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+module GraphQL
+  class Client
+    module TypeStack
+      # @return [GraphQL::Schema] the schema whose types are present in this document
+      attr_reader :schema
+
+      # When it enters an object (starting with query or mutation root), it's pushed on this stack.
+      # When it exits, it's popped off.
+      # @return [Array<GraphQL::ObjectType, GraphQL::Union, GraphQL::Interface>]
+      attr_reader :object_types
+
+      # When it enters a field, it's pushed on this stack (useful for nested fields, args).
+      # When it exits, it's popped off.
+      # @return [Array<GraphQL::Field>] fields which have been entered
+      attr_reader :field_definitions
+
+      # Directives are pushed on, then popped off while traversing the tree
+      # @return [Array<GraphQL::Node::Directive>] directives which have been entered
+      attr_reader :directive_definitions
+
+      # @return [Array<GraphQL::Node::Argument>] arguments which have been entered
+      attr_reader :argument_definitions
+
+      # @return [Array<String>] fields which have been entered (by their AST name)
+      attr_reader :path
+
+      # @param schema [GraphQL::Schema] the schema whose types to use when climbing this document
+      # @param visitor [GraphQL::Language::Visitor] a visitor to follow & watch the types
+      def initialize(document, schema:, **rest)
+        @schema = schema
+        @object_types = []
+        @field_definitions = []
+        @directive_definitions = []
+        @argument_definitions = []
+        @path = []
+        super(document, **rest)
+      end
+
+      def on_directive(node, parent)
+        directive_defn = @schema.directives[node.name]
+        @directive_definitions.push(directive_defn)
+        super(node, parent)
+      ensure
+        @directive_definitions.pop
+      end
+
+      def on_field(node, parent)
+        parent_type = @object_types.last
+        parent_type = parent_type.unwrap
+
+        field_definition = @schema.get_field(parent_type, node.name)
+        @field_definitions.push(field_definition)
+        if !field_definition.nil?
+          next_object_type = field_definition.type
+          @object_types.push(next_object_type)
+        else
+          @object_types.push(nil)
+        end
+        @path.push(node.alias || node.name)
+        super(node, parent)
+      ensure
+        @field_definitions.pop
+        @object_types.pop
+        @path.pop
+      end
+
+      def on_argument(node, parent)
+        if @argument_definitions.last
+          arg_type = @argument_definitions.last.type.unwrap
+          if arg_type.kind.input_object?
+            argument_defn = arg_type.arguments[node.name]
+          else
+            argument_defn = nil
+          end
+        elsif @directive_definitions.last
+          argument_defn = @directive_definitions.last.arguments[node.name]
+        elsif @field_definitions.last
+          argument_defn = @field_definitions.last.arguments[node.name]
+        else
+          argument_defn = nil
+        end
+        @argument_definitions.push(argument_defn)
+        @path.push(node.name)
+        super(node, parent)
+      ensure
+        @argument_definitions.pop
+        @path.pop
+      end
+
+      def on_operation_definition(node, parent)
+        # eg, QueryType, MutationType
+        object_type = @schema.root_type_for_operation(node.operation_type)
+        @object_types.push(object_type)
+        @path.push("#{node.operation_type}#{node.name ? " #{node.name}" : ""}")
+        super(node, parent)
+      ensure
+        @object_types.pop
+        @path.pop
+      end
+
+      def on_inline_fragment(node, parent)
+        object_type = if node.type
+                        @schema.get_type(node.type.name)
+                      else
+                        @object_types.last
+                      end
+        if !object_type.nil?
+          object_type = object_type.unwrap
+        end
+        @object_types.push(object_type)
+        @path.push("...#{node.type ? " on #{node.type.to_query_string}" : ""}")
+        super(node, parent)
+      ensure
+        @object_types.pop
+        @path.pop
+      end
+
+      def on_fragment_definition(node, parent)
+        object_type = if node.type
+                        @schema.get_type(node.type.name)
+                      else
+                        @object_types.last
+                      end
+        if !object_type.nil?
+          object_type = object_type.unwrap
+        end
+        @object_types.push(object_type)
+        @path.push("fragment #{node.name}")
+        super(node, parent)
+      ensure
+        @object_types.pop
+        @path.pop
+      end
+
+      def on_fragment_spread(node, parent)
+        @path.push("... #{node.name}")
+        super(node, parent)
+      ensure
+        @path.pop
+      end
+    end
+  end
+end

data/lib/graphql/client.rb

@@ -2,6 +2,7 @@
 require "active_support/inflector"
 require "active_support/notifications"
 require "graphql"
+require "graphql/client/type_stack"
 require "graphql/client/collocated_enforcement"
 require "graphql/client/definition_variables"
 require "graphql/client/definition"
@@ -425,12 +426,26 @@ module GraphQL
       end.to_h
     end
 
+    class GatherNamesVisitor < GraphQL::Language::Visitor
+      def initialize(node)
+        @names = []
+        super
+      end
+
+      attr_reader :names
+
+      def on_fragment_spread(node, parent)
+        @names << node.name
+        super
+      end
+    end
+
     def find_definition_dependencies(node)
-      names = []
-      visitor = Language::Visitor.new(node)
-      visitor[Language::Nodes::FragmentSpread] << -> (node, parent) { names << node.name }
+      visitor = GatherNamesVisitor.new(node)
       visitor.visit
-      names.uniq
+      names = visitor.names
+      names.uniq!
+      names
     end
 
     def deep_freeze_json_object(obj)

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

@@ -21,19 +21,12 @@ module RuboCop
           query, = ::GraphQL::Client::ViewModule.extract_graphql_section(erb)
           return unless query
 
-          aliases = {}
-          fields = {}
-          ranges = {}
-
           # TODO: Use GraphQL client parser
           document = ::GraphQL.parse(query.gsub(/::/, "__"))
-
-          visitor = ::GraphQL::Language::Visitor.new(document)
-          visitor[::GraphQL::Language::Nodes::Field] << ->(node, _parent) do
-            name = node.alias || node.name
-            fields[name] ||= 0
-            field_aliases(name).each { |n| (aliases[n] ||= []) << name }
-            ranges[name] ||= source_range(processed_source.buffer, node.line, 0)
+          visitor = OverfetchVisitor.new(document) do |line_num|
+            # `source_range` is private to this object,
+            # so yield back out to it to get this info:
+            source_range(processed_source.buffer, line_num, 0)
           end
           visitor.visit
 
@@ -41,30 +34,53 @@ module RuboCop
             method_names = method_names_for(*node)
 
             method_names.each do |method_name|
-              aliases.fetch(method_name, []).each do |field_name|
-                fields[field_name] += 1
+              visitor.aliases.fetch(method_name, []).each do |field_name|
+                visitor.fields[field_name] += 1
               end
             end
           end
 
-          fields.each do |field, count|
+          visitor.fields.each do |field, count|
             next if count > 0
-            add_offense(nil, location: ranges[field], message: "GraphQL field '#{field}' query but was not used in template.")
+            add_offense(nil, location: visitor.ranges[field], message: "GraphQL field '#{field}' query but was not used in template.")
           end
         end
 
-        def field_aliases(name)
-          names = Set.new
+        class OverfetchVisitor < ::GraphQL::Language::Visitor
+          def initialize(doc, &range_for_line)
+            super(doc)
+            @range_for_line = range_for_line
+            @fields = {}
+            @aliases = {}
+            @ranges = {}
+          end
+
+          attr_reader :fields, :aliases, :ranges
+
+          def on_field(node, parent)
+            name = node.alias || node.name
+            fields[name] ||= 0
+            field_aliases(name).each { |n| (aliases[n] ||= []) << name }
+            ranges[name] ||= @range_for_line.call(node.line)
+            super
+          end
 
-          names << name
-          names << "#{name}?"
+          private
 
-          names << underscore_name = ActiveSupport::Inflector.underscore(name)
-          names << "#{underscore_name}?"
+          def field_aliases(name)
+            names = Set.new
 
-          names
+            names << name
+            names << "#{name}?"
+
+            names << underscore_name = ActiveSupport::Inflector.underscore(name)
+            names << "#{underscore_name}?"
+
+            names
+          end
         end
 
+
         def method_names_for(*node)
           receiver, method_name, *_args = node
           method_names = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-client
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - GitHub
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -100,48 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: 1.57.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: 1.57.0
 description: A Ruby library for declaring, composing and executing GraphQL queries
 email: engineering@github.com
 executables: []
@@ -182,6 +176,7 @@ files:
 - lib/graphql/client/schema/scalar_type.rb
 - lib/graphql/client/schema/skip_directive.rb
 - lib/graphql/client/schema/union_type.rb
+- lib/graphql/client/type_stack.rb
 - lib/graphql/client/view_module.rb
 - lib/rubocop/cop/graphql/heredoc.rb
 - lib/rubocop/cop/graphql/overfetch.rb
@@ -189,7 +184,7 @@ homepage: https://github.com/github/graphql-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: GraphQL Client
 test_files: []