graphql 2.6.11 → 2.6.13

data/lib/graphql/static_validation/all_rules.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
-    # Default rules for {GraphQL::StaticValidation::Validator}
+    # Default rules for [GraphQL::StaticValidation::Validator](rdoc-ref:GraphQL::StaticValidation::Validator)
     #
     # Order is important here. Some validators skip later hooks.
     # which stops the visit on that node. That way it doesn't try to find fields on types that

data/lib/graphql/static_validation/base_visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class BaseVisitor < GraphQL::Language::StaticVisitor
@@ -16,20 +17,35 @@ module GraphQL
         @schema = context.schema
         @inline_fragment_paths = {}
         @field_unwrapped_types = {}.compare_by_identity
+        @child_positions = {}.compare_by_identity
         super(document)
       end
 
       attr_reader :context
 
-      # @return [Array<String>] The nesting of the current position in the AST
+      # **Returns**
+      #
+      # - `Array<String>` — The nesting of the current position in the AST
+      #
+      # :call-seq:
+      #   path() -> Array[String]
       def path
         @path[0, @path_depth]
       end
 
       # Build a class to visit the AST and perform validation,
       # or use a pre-built class if rules is `ALL_RULES` or empty.
-      # @param rules [Array<Module, Class>]
-      # @return [Class] A class for validating `rules` during visitation
+      #
+      # **Parameters**
+      #
+      # - `rules` (`Array<Module, Class>`)
+      #
+      # **Returns**
+      #
+      # - `Class` — A class for validating `rules` during visitation
+      #
+      # :call-seq:
+      #   including_rules(Array[Module | Class] rules) -> Class
       def self.including_rules(rules)
         if rules.empty?
           # It's not doing _anything?!?_
@@ -159,6 +175,7 @@ module GraphQL
           @current_argument_definition = @parent_argument_definition
           @parent_argument_definition = prev_parent
           @path_depth -= 1
+          @child_positions.delete(node)
         end
 
         def on_fragment_spread(node, parent)
@@ -171,7 +188,7 @@ module GraphQL
         def on_input_object(node, parent)
           arg_defn = @current_argument_definition
           if arg_defn && arg_defn.type.list?
-            @path[@path_depth] = parent.children.index(node)
+            @path[@path_depth] = child_positions(parent)[node]
             @path_depth += 1
             super
             @path_depth -= 1
@@ -180,27 +197,60 @@ module GraphQL
           end
         end
 
-        # @return [GraphQL::BaseType] The current object type
+        def child_positions(parent)
+          @child_positions[parent] ||= begin
+            positions = {}.compare_by_identity
+            parent.children.each_with_index { |child, index| positions[child] ||= index }
+            positions
+          end
+        end
+
+        # **Returns**
+        #
+        # - `GraphQL::BaseType` — The current object type
+        #
+        # :call-seq:
+        #   type_definition() -> GraphQL::BaseType
         def type_definition
           @current_object_type
         end
 
-        # @return [GraphQL::BaseType] The type which the current type came from
+        # **Returns**
+        #
+        # - `GraphQL::BaseType` — The type which the current type came from
+        #
+        # :call-seq:
+        #   parent_type_definition() -> GraphQL::BaseType
         def parent_type_definition
           @parent_object_type
         end
 
-        # @return [GraphQL::Field, nil] The most-recently-entered GraphQL::Field, if currently inside one
+        # **Returns**
+        #
+        # - `GraphQL::Field, nil` — The most-recently-entered GraphQL::Field, if currently inside one
+        #
+        # :call-seq:
+        #   field_definition() -> GraphQL::Field | nil
         def field_definition
           @current_field_definition
         end
 
-        # @return [GraphQL::Directive, nil] The most-recently-entered GraphQL::Directive, if currently inside one
+        # **Returns**
+        #
+        # - `GraphQL::Directive, nil` — The most-recently-entered GraphQL::Directive, if currently inside one
+        #
+        # :call-seq:
+        #   directive_definition() -> GraphQL::Directive | nil
         def directive_definition
           @current_directive_definition
         end
 
-        # @return [GraphQL::Argument, nil] The most-recently-entered GraphQL::Argument, if currently inside one
+        # **Returns**
+        #
+        # - `GraphQL::Argument, nil` — The most-recently-entered GraphQL::Argument, if currently inside one
+        #
+        # :call-seq:
+        #   argument_definition() -> GraphQL::Argument | nil
         def argument_definition
           # Return the parent argument definition (not the current one).
           @parent_argument_definition

data/lib/graphql/static_validation/definition_dependencies.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     # Track fragment dependencies for operations
     # and expose the fragment definitions which
     # are used by a given operation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module DefinitionDependencies
       attr_reader :dependencies
 
@@ -65,7 +68,13 @@ module GraphQL
       end
 
       # A map of operation definitions to an array of that operation's dependencies
-      # @return [DependencyMap]
+      #
+      # **Returns**
+      #
+      # - `DependencyMap`
+      #
+      # :call-seq:
+      #   dependency_map(&block) -> DependencyMap
       def dependency_map(&block)
         @dependency_map ||= resolve_dependencies(&block)
       end
@@ -73,13 +82,19 @@ module GraphQL
       # Map definition AST nodes to the definition AST nodes they depend on.
       # Expose circular dependencies.
       class DependencyMap
-        # @return [Array<GraphQL::Language::Nodes::FragmentDefinition>]
+        # **Returns**
+        #
+        # - `Array<GraphQL::Language::Nodes::FragmentDefinition>`
         attr_reader :cyclical_definitions
 
-        # @return [Hash<Node, Array<GraphQL::Language::Nodes::FragmentSpread>>]
+        # **Returns**
+        #
+        # - `Hash<Node, Array<GraphQL::Language::Nodes::FragmentSpread>>`
         attr_reader :unmet_dependencies
 
-        # @return [Array<GraphQL::Language::Nodes::FragmentDefinition>]
+        # **Returns**
+        #
+        # - `Array<GraphQL::Language::Nodes::FragmentDefinition>`
         attr_reader :unused_dependencies
 
         def initialize
@@ -89,7 +104,12 @@ module GraphQL
           @unused_dependencies = []
         end
 
-        # @return [Array<GraphQL::Language::Nodes::AbstractNode>] dependencies for `definition_node`
+        # **Returns**
+        #
+        # - `Array<GraphQL::Language::Nodes::AbstractNode>` — dependencies for `definition_node`
+        #
+        # :call-seq:
+        #   [](definition_node) -> Array[GraphQL::Language::Nodes::AbstractNode]
         def [](definition_node)
           @dependencies[definition_node]
         end
@@ -190,9 +210,9 @@ module GraphQL
           end
         end
 
-        # Anything left in @immediate_dependencies is cyclical
+        # Anything left in `@immediate_dependencies` is cyclical
         cyclical_nodes = @defdep_immediate_dependencies.keys.map { |n| @defdep_node_paths[n] }
-        # @immediate_dependencies also includes operation names, but we don't care about
+        # `@immediate_dependencies` also includes operation names, but we don't care about
         # those. They became nil when we looked them up on `@fragment_definitions`, so remove them.
         cyclical_nodes.compact!
         dependency_map.cyclical_definitions.concat(cyclical_nodes)

data/lib/graphql/static_validation/error.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     # Generates GraphQL-compliant validation message.
     class Error
       # Convenience for validators
+      #--
+      # @requires_ancestor: Kernel
       module ErrorHelper
         # Error `error_message` is located at `node`
         def error(error_message, nodes, context: nil, path: nil, extensions: {})

data/lib/graphql/static_validation/interpreter_visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class InterpreterVisitor < BaseVisitor

data/lib/graphql/static_validation/literal_validator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     # Test whether `ast_value` is a valid input for `type`

data/lib/graphql/static_validation/rules/argument_literals_are_compatible.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
+    # @requires_ancestor: GraphQL::StaticValidation::ArgumentsAreDefined
     module ArgumentLiteralsAreCompatible
       def on_argument(node, parent)
         # Check the child arguments first;

data/lib/graphql/static_validation/rules/argument_literals_are_compatible_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class ArgumentLiteralsAreCompatibleError < StaticValidation::Error

data/lib/graphql/static_validation/rules/argument_names_are_unique.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module ArgumentNamesAreUnique
       include GraphQL::StaticValidation::Error::ErrorHelper
 

data/lib/graphql/static_validation/rules/argument_names_are_unique_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class ArgumentNamesAreUniqueError < StaticValidation::Error

data/lib/graphql/static_validation/rules/arguments_are_defined.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module ArgumentsAreDefined
       def on_argument(node, parent)
         parent_defn = parent_definition(parent)

data/lib/graphql/static_validation/rules/arguments_are_defined_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class ArgumentsAreDefinedError < StaticValidation::Error

data/lib/graphql/static_validation/rules/directives_are_defined.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module DirectivesAreDefined
       def initialize(*)
         super

data/lib/graphql/static_validation/rules/directives_are_defined_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class DirectivesAreDefinedError < StaticValidation::Error

data/lib/graphql/static_validation/rules/directives_are_in_valid_locations.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module DirectivesAreInValidLocations
       include GraphQL::Language
 

data/lib/graphql/static_validation/rules/directives_are_in_valid_locations_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class DirectivesAreInValidLocationsError < StaticValidation::Error

data/lib/graphql/static_validation/rules/fields_are_defined_on_type.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
     module FieldsAreDefinedOnType
       def on_field(node, parent)
         parent_type = @parent_object_type

data/lib/graphql/static_validation/rules/fields_are_defined_on_type_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class FieldsAreDefinedOnTypeError < StaticValidation::Error

data/lib/graphql/static_validation/rules/fields_have_appropriate_selections.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     # Scalars _can't_ have selections
     # Objects _must_ have selections
+    #--
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor
+    # @requires_ancestor: GraphQL::StaticValidation::BaseVisitor::ContextMethods
     module FieldsHaveAppropriateSelections
       include GraphQL::StaticValidation::Error::ErrorHelper
 
@@ -40,7 +44,11 @@ module GraphQL
             selection_strs = ast_node.selections.map do |n|
               case n
               when GraphQL::Language::Nodes::InlineFragment
-                "\"... on #{n.type.name} { ... }\""
+                if (n_type = n.type)
+                  "\"... on #{n_type.name} { ... }\""
+                else
+                  "\"... { ... }\""
+                end
               when GraphQL::Language::Nodes::Field
                 "\"#{n.name}\""
               when GraphQL::Language::Nodes::FragmentSpread

data/lib/graphql/static_validation/rules/fields_have_appropriate_selections_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module StaticValidation
     class FieldsHaveAppropriateSelectionsError < StaticValidation::Error