graphql 2.6.11 → 2.6.13

data/lib/graphql/invalid_null_error.rb

@@ -1,27 +1,39 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   # Raised automatically when a field's resolve function returns `nil`
   # for a non-null field.
   class InvalidNullError < GraphQL::RuntimeError
-    # @return [GraphQL::BaseType] The owner of {#field}
+    # **Returns**
+    #
+    # - `GraphQL::BaseType` — The owner of [field](rdoc-ref:#field)
     attr_reader :parent_type
 
-    # @return [GraphQL::Field] The field which failed to return a value
+    # **Returns**
+    #
+    # - `GraphQL::Field` — The field which failed to return a value
     attr_reader :field
 
-    # @return [GraphQL::Language::Nodes::Field] the field where the error occurred
+    # **Returns**
+    #
+    # - `GraphQL::Language::Nodes::Field` — the field where the error occurred
+    #
+    # :call-seq:
+    #   ast_node() -> GraphQL::Language::Nodes::Field
     def ast_node
       @ast_nodes.first
     end
 
     attr_reader :ast_nodes
 
-    # @return [Boolean] indicates an array result caused the error
+    # **Returns**
+    #
+    # - `Boolean` — indicates an array result caused the error
     attr_reader :is_from_array
 
     attr_accessor :path
 
-    def initialize(parent_type, field, ast_node_or_nodes, is_from_array: false, path: nil)
+    def initialize(parent_type, field, ast_node_or_nodes, is_from_array: false, path: nil, element_type: nil)
       @parent_type = parent_type
       @field = field
       @ast_nodes = Array(ast_node_or_nodes)
@@ -32,7 +44,8 @@ module GraphQL
       # whether it was caused by a null instead of the list or a
       # null element.
       if @is_from_array
-        super("Cannot return null for non-nullable element of type '#{@field.type.of_type.of_type.to_type_signature}' for #{@parent_type.graphql_name}.#{@field.graphql_name}")
+        element_type ||= @field.type.of_type.of_type
+        super("Cannot return null for non-nullable element of type '#{element_type.to_type_signature}' for #{@parent_type.graphql_name}.#{@field.graphql_name}")
       else
         super("Cannot return null for non-nullable field #{@parent_type.graphql_name}.#{@field.graphql_name}")
       end

data/lib/graphql/language/block_string.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     module BlockString
@@ -13,7 +14,7 @@ module GraphQL
         end
 
         lines = has_newline ? str.split("\n") : [str]
-        common_indent = nil
+        common_indent = nil #: Integer?
 
         # find the common whitespace
         lines.each_with_index do |line, idx|

data/lib/graphql/language/cache.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require 'graphql/version'
 require 'digest/sha2'
@@ -8,7 +9,7 @@ require 'tempfile'
 
 module GraphQL
   module Language
-    # This cache is used by {GraphQL::Language::Parser.parse_file} when it's enabled.
+    # This cache is used by [GraphQL::Language::Parser.parse_file](rdoc-ref:GraphQL::Language::Parser.parse_file) when it's enabled.
     #
     # With Rails, parser caching may enabled by setting `config.graphql.parser_cache = true` in your Rails application.
     #
@@ -23,11 +24,16 @@ module GraphQL
     # You will need to clear the cache directory for each new deployment of your application.
     # Also note that the parser cache will grow as your schema is loaded, so the cache directory must be writable.
     #
-    # @see GraphQL::Railtie for simple Rails integration
+    # See [GraphQL::Railtie](rdoc-ref:GraphQL::Railtie) for simple Rails integration
     class Cache
-      # @param path [Pathname] The directory where cache entries are stored.
-      # @param secret [String, nil] A stable secret for verifying cache entries. When omitted,
+      # **Parameters**
+      #
+      # - `path` (`Pathname`) — The directory where cache entries are stored.
+      # - `secret` (`String, nil`) — A stable secret for verifying cache entries. When omitted,
       #   a process-local secret is generated. Pass `nil` to disable cache signing.
+      #
+      # :call-seq:
+      #   initialize(Pathname path, String | nil secret:)
       def initialize(path, secret: SecureRandom.random_bytes(32))
         @path = path
         @secret = secret

data/lib/graphql/language/comment.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     module Comment

data/lib/graphql/language/definition_slice.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     module DefinitionSlice

data/lib/graphql/language/document_from_schema_definition.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
-    # @api private
     #
-    # {GraphQL::Language::DocumentFromSchemaDefinition} is used to convert a {GraphQL::Schema} object
-    # To a {GraphQL::Language::Document} AST node.
+    # **Parameters**
     #
-    # @param context [Hash]
-    # @param only [<#call(member, ctx)>]
-    # @param except [<#call(member, ctx)>]
-    # @param include_introspection_types [Boolean] Whether or not to include introspection types in the AST
-    # @param include_built_in_scalars [Boolean] Whether or not to include built in scalars in the AST
-    # @param include_built_in_directives [Boolean] Whether or not to include built in directives in the AST
-    class DocumentFromSchemaDefinition
+    # - `context` (`Hash`)
+    # - `only` (`<#call(member, ctx)>`)
+    # - `except` (`<#call(member, ctx)>`)
+    # - `include_introspection_types` (`Boolean`) — Whether or not to include introspection types in the AST
+    # - `include_built_in_scalars` (`Boolean`) — Whether or not to include built in scalars in the AST
+    # - `include_built_in_directives` (`Boolean`) — Whether or not to include built in directives in the AST
+    class DocumentFromSchemaDefinition # :nodoc:
       def initialize(
         schema, context: nil, include_introspection_types: false,
         include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false

data/lib/graphql/language/generation.rb

@@ -1,21 +1,35 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
-    # Exposes {.generate}, which turns AST nodes back into query strings.
+    # Exposes [.generate](rdoc-ref:.generate), which turns AST nodes back into query strings.
     module Generation
       extend self
 
       # Turn an AST node back into a string.
       #
-      # @example Turning a document into a query
-      #    document = GraphQL.parse(query_string)
-      #    GraphQL::Language::Generation.generate(document)
-      #    # => "{ ... }"
+      # **Examples**
       #
-      # @param node [GraphQL::Language::Nodes::AbstractNode] an AST node to recursively stringify
-      # @param indent [String] Whitespace to add to each printed node
-      # @param printer [GraphQL::Language::Printer] An optional custom printer for printing AST nodes. Defaults to GraphQL::Language::Printer
-      # @return [String] Valid GraphQL for `node`
+      # **Example: Turning a document into a query**
+      #
+      # ```ruby
+      # document = GraphQL.parse(query_string)
+      # GraphQL::Language::Generation.generate(document)
+      # # => "{ ... }"
+      # ```
+      #
+      # **Parameters**
+      #
+      # - `node` (`GraphQL::Language::Nodes::AbstractNode`) — an AST node to recursively stringify
+      # - `indent` (`String`) — Whitespace to add to each printed node
+      # - `printer` (`GraphQL::Language::Printer`) — An optional custom printer for printing AST nodes. Defaults to GraphQL::Language::Printer
+      #
+      # **Returns**
+      #
+      # - `String` — Valid GraphQL for `node`
+      #
+      # :call-seq:
+      #   generate(GraphQL::Language::Nodes::AbstractNode node, String indent:, GraphQL::Language::Printer printer:) -> String
       def generate(node, indent: "", printer: GraphQL::Language::Printer.new)
         printer.print(node, indent: indent)
       end

data/lib/graphql/language/lexer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
 
@@ -35,6 +36,10 @@ module GraphQL
           @scanner.skip(IGNORE_REGEXP)
           if @scanner.skip(COMMENT_REGEXP)
             @tokens_count += 1
+            if @tokens_count > @max_tokens
+              @pos = @scanner.pos
+              raise_parse_error("This query is too large to execute.")
+            end
             next
           end
           break