graphql 2.6.12 → 2.6.13

data/lib/graphql/language/parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "strscan"
 require "graphql/language/nodes"
@@ -76,12 +77,17 @@ module GraphQL
 
       private
 
-      # @return [Array<Integer>] Byte offsets of each line break in the original string
+      # **Returns**
+      #
+      # - `Array<Integer>` — Byte offsets of each line break in the original string
+      #
+      # :call-seq:
+      #   lines_at() -> Array[Integer]
       def lines_at
         @lines_at ||= begin
           graphql_str = @graphql_str.b
           la = []
-          idx = 0
+          idx = 0 #: Integer?
           while idx
             idx = graphql_str.index("\n", idx)
             if idx
@@ -159,7 +165,7 @@ module GraphQL
             expect_token(:LPAREN)
             defs = []
             while !at?(:RPAREN)
-              loc = pos
+              loc = pos #: untyped
               expect_token(:VAR_SIGN)
               var_name = parse_name
               expect_token(:COLON)
@@ -169,7 +175,7 @@ module GraphQL
                 value
               end
 
-              directives = parse_directives
+              directives = parse_directives #: untyped
 
               defs << Nodes::VariableDefinition.new(
                 pos: loc,
@@ -251,15 +257,15 @@ module GraphQL
                 if at?(:QUERY)
                   advance_token
                   expect_token(:COLON)
-                  query = parse_name
+                  query = parse_name #: untyped
                 elsif at?(:MUTATION)
                   advance_token
                   expect_token(:COLON)
-                  mutation = parse_name
+                  mutation = parse_name #: untyped
                 elsif at?(:SUBSCRIPTION)
                   advance_token
                   expect_token(:COLON)
-                  subscription = parse_name
+                  subscription = parse_name #: untyped
                 else
                   expect_one_of([:QUERY, :MUTATION, :SUBSCRIPTION])
                 end
@@ -292,15 +298,15 @@ module GraphQL
               if at?(:QUERY)
                 advance_token
                 expect_token(:COLON)
-                query = parse_name
+                query = parse_name #: untyped
               elsif at?(:MUTATION)
                 advance_token
                 expect_token(:COLON)
-                mutation = parse_name
+                mutation = parse_name #: untyped
               elsif at?(:SUBSCRIPTION)
                 advance_token
                 expect_token(:COLON)
-                subscription = parse_name
+                subscription = parse_name #: untyped
               else
                 expect_one_of([:QUERY, :MUTATION, :SUBSCRIPTION])
               end
@@ -737,7 +743,7 @@ module GraphQL
           advance_token
           args = []
           while !at?(:RCURLY)
-            loc = pos
+            loc = pos #: untyped
             n = parse_name
             expect_token(:COLON)
             args << Argument.new(pos: loc, name: n, value: value, filename: @filename, source: self)

data/lib/graphql/language/printer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     class Printer
@@ -30,27 +31,41 @@ module GraphQL
 
       # Turn an arbitrary AST node back into a string.
       #
-      # @example Turning a document into a query string
-      #    document = GraphQL.parse(query_string)
-      #    GraphQL::Language::Printer.new.print(document)
-      #    # => "{ ... }"
+      # **Examples**
       #
+      # **Example: Turning a document into a query string**
       #
-      # @example Building a custom printer
+      # ```ruby
+      # document = GraphQL.parse(query_string)
+      # GraphQL::Language::Printer.new.print(document)
+      # # => "{ ... }"
+      # ```
       #
-      #  class MyPrinter < GraphQL::Language::Printer
-      #    def print_argument(arg)
-      #      print_string("#{arg.name}: <HIDDEN>")
-      #    end
-      #  end
+      # **Example: Building a custom printer**
       #
-      #  MyPrinter.new.print(document)
-      #  # => "mutation { pay(creditCard: <HIDDEN>) { success } }"
+      # ```ruby
+      # class MyPrinter < GraphQL::Language::Printer
+      #   def print_argument(arg)
+      #     print_string("#{arg.name}: <HIDDEN>")
+      #   end
+      # end
       #
-      # @param node [Nodes::AbstractNode]
-      # @param indent [String] Whitespace to add to the printed node
-      # @param truncate_size [Integer, nil] The size to truncate to.
-      # @return [String] Valid GraphQL for `node`
+      # MyPrinter.new.print(document)
+      # # => "mutation { pay(creditCard: <HIDDEN>) { success } }"
+      # ```
+      #
+      # **Parameters**
+      #
+      # - `node` (`Nodes::AbstractNode`)
+      # - `indent` (`String`) — Whitespace to add to the printed node
+      # - `truncate_size` (`Integer, nil`) — The size to truncate to.
+      #
+      # **Returns**
+      #
+      # - `String` — Valid GraphQL for `node`
+      #
+      # :call-seq:
+      #   print(Nodes::AbstractNode node, String indent:, Integer | nil truncate_size:) -> String
       def print(node, indent: "", truncate_size: nil)
         truncate_size = truncate_size ? [truncate_size - OMISSION.size, 0].max : nil
         @out = TruncatableBuffer.new(truncate_size: truncate_size)

data/lib/graphql/language/sanitized_printer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     # A custom printer used to print sanitized queries. It inlines provided variables
@@ -10,11 +11,16 @@ module GraphQL
     # on the type of fields or arguments, we have to track the current object, field
     # and input type while printing the query.
     #
-    # @example Printing a scrubbed string
-    #   printer = QueryPrinter.new(query)
-    #   puts printer.sanitized_query_string
+    # See [Query#sanitized_query_string](rdoc-ref:Query#sanitized_query_string)
     #
-    # @see {Query#sanitized_query_string}
+    # **Examples**
+    #
+    # **Example: Printing a scrubbed string**
+    #
+    # ```ruby
+    # printer = QueryPrinter.new(query)
+    # puts printer.sanitized_query_string
+    # ```
     class SanitizedPrinter < GraphQL::Language::Printer
 
       REDACTED = "\"<REDACTED>\""
@@ -27,7 +33,12 @@ module GraphQL
         @inline_variables = inline_variables
       end
 
-      # @return [String, nil] A scrubbed query string, if the query was valid.
+      # **Returns**
+      #
+      # - `String, nil` — A scrubbed query string, if the query was valid.
+      #
+      # :call-seq:
+      #   sanitized_query_string() -> String | nil
       def sanitized_query_string
         if query.valid?
           print(query.document)

data/lib/graphql/language/static_visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     # Like `GraphQL::Language::Visitor` except it doesn't support
@@ -9,7 +10,13 @@ module GraphQL
       end
 
       # Visit `document` and all children
-      # @return [void]
+      #
+      # **Returns**
+      #
+      # - `void`
+      #
+      # :call-seq:
+      #   visit() -> void
       def visit
         # `@document` may be any kind of node:
         visit_method = @document.visit_method
@@ -104,9 +111,17 @@ module GraphQL
           # To customize this hook, override one of its make_visit_methods (or the base method?)
           # in your subclasses.
           #
-          # @param node [GraphQL::Language::Nodes::AbstractNode] the node being visited
-          # @param parent [GraphQL::Language::Nodes::AbstractNode, nil] the previously-visited node, or `nil` if this is the root node.
-          # @return [void]
+          # **Parameters**
+          #
+          # - `node` (`GraphQL::Language::Nodes::AbstractNode`) — the node being visited
+          # - `parent` (`GraphQL::Language::Nodes::AbstractNode, nil`) — the previously-visited node, or `nil` if this is the root node.
+          #
+          # **Returns**
+          #
+          # - `void`
+          #
+          # :call-seq:
+          #   #{node_method}(GraphQL::Language::Nodes::AbstractNode node, GraphQL::Language::Nodes::AbstractNode | nil parent) -> void
           def #{node_method}(node, parent)
             #{
               if method_defined?(child_visit_method)

data/lib/graphql/language/visitor.rb

@@ -1,37 +1,43 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Language
     # Depth-first traversal through the tree, calling hooks at each stop.
     #
-    # @example Create a visitor counting certain field names
-    #   class NameCounter < GraphQL::Language::Visitor
-    #     def initialize(document, field_name)
-    #       super(document)
-    #       @field_name = field_name
-    #       @count = 0
-    #     end
+    # See [GraphQL::Language::StaticVisitor](rdoc-ref:GraphQL::Language::StaticVisitor) for a faster visitor that doesn't support modifying the document
     #
-    #     attr_reader :count
+    # **Examples**
     #
-    #     def on_field(node, parent)
-    #       # if this field matches our search, increment the counter
-    #       if node.name == @field_name
-    #         @count += 1
-    #       end
-    #       # Continue visiting subfields:
-    #       super
-    #     end
+    # **Example: Create a visitor counting certain field names**
+    #
+    # ```ruby
+    # class NameCounter < GraphQL::Language::Visitor
+    #   def initialize(document, field_name)
+    #     super(document)
+    #     @field_name = field_name
+    #     @count = 0
     #   end
     #
-    #   # Initialize a visitor
-    #   visitor = NameCounter.new(document, "name")
-    #   # Run it
-    #   visitor.visit
-    #   # Check the result
-    #   visitor.count
-    #   # => 3
+    #   attr_reader :count
+    #
+    #   def on_field(node, parent)
+    #     # if this field matches our search, increment the counter
+    #     if node.name == @field_name
+    #       @count += 1
+    #     end
+    #     # Continue visiting subfields:
+    #     super
+    #   end
+    # end
     #
-    # @see GraphQL::Language::StaticVisitor for a faster visitor that doesn't support modifying the document
+    # # Initialize a visitor
+    # visitor = NameCounter.new(document, "name")
+    # # Run it
+    # visitor.visit
+    # # Check the result
+    # visitor.count
+    # # => 3
+    # ```
     class Visitor
       class DeleteNode; end
 
@@ -44,11 +50,19 @@ module GraphQL
         @result = nil
       end
 
-      # @return [GraphQL::Language::Nodes::Document] The document with any modifications applied
+      # **Returns**
+      #
+      # - `GraphQL::Language::Nodes::Document` — The document with any modifications applied
       attr_reader :result
 
       # Visit `document` and all children
-      # @return [void]
+      #
+      # **Returns**
+      #
+      # - `void`
+      #
+      # :call-seq:
+      #   visit() -> void
       def visit
         # `@document` may be any kind of node:
         visit_method = :"#{@document.visit_method}_with_modifications"
@@ -175,9 +189,17 @@ module GraphQL
           # To customize this hook, override one of its make_visit_methods (or the base method?)
           # in your subclasses.
           #
-          # @param node [GraphQL::Language::Nodes::AbstractNode] the node being visited
-          # @param parent [GraphQL::Language::Nodes::AbstractNode, nil] the previously-visited node, or `nil` if this is the root node.
-          # @return [Array, nil] If there were modifications, it returns an array of new nodes, otherwise, it returns `nil`.
+          # **Parameters**
+          #
+          # - `node` (`GraphQL::Language::Nodes::AbstractNode`) — the node being visited
+          # - `parent` (`GraphQL::Language::Nodes::AbstractNode, nil`) — the previously-visited node, or `nil` if this is the root node.
+          #
+          # **Returns**
+          #
+          # - `Array, nil` — If there were modifications, it returns an array of new nodes, otherwise, it returns `nil`.
+          #
+          # :call-seq:
+          #   #{node_method}(GraphQL::Language::Nodes::AbstractNode node, GraphQL::Language::Nodes::AbstractNode | nil parent) -> Array | nil
           def #{node_method}(node, parent)
             if node.equal?(DELETE_NODE)
               # This might be passed to `super(DELETE_NODE, ...)`

data/lib/graphql/language.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/language/block_string"
 require "graphql/language/comment"
 require "graphql/language/printer"
@@ -16,8 +17,7 @@ require "strscan"
 
 module GraphQL
   module Language
-    # @api private
-    def self.serialize(value)
+    def self.serialize(value) # :nodoc:
       if value.is_a?(Hash)
         serialized_hash = value.map do |k, v|
           "#{k}:#{serialize v}"
@@ -43,12 +43,18 @@ module GraphQL
 
     # Returns a new string if any single-quoted newlines were escaped.
     # Otherwise, returns `query_str` unchanged.
-    # @return [String]
+    #
+    # **Returns**
+    #
+    # - `String`
+    #
+    # :call-seq:
+    #   escape_single_quoted_newlines(query_str) -> String
     def self.escape_single_quoted_newlines(query_str)
       scanner = StringScanner.new(query_str)
-      inside_single_quoted_string = false
-      inside_triple_quoted_string = false
-      new_query_str = nil
+      inside_single_quoted_string = false #: bool
+      inside_triple_quoted_string = false #: bool
+      new_query_str = nil #: String?
       while !scanner.eos?
         if scanner.skip('"""')
           inside_triple_quoted_string = !inside_triple_quoted_string
@@ -83,7 +89,7 @@ module GraphQL
       new_query_str || query_str
     end
 
-    LEADING_REGEX = Regexp.union(" ", *Lexer::Punctuation.constants.map { |const| Lexer::Punctuation.const_get(const) })
+    LEADING_REGEX = Regexp.union([" ", *Lexer::Punctuation.constants.map { |const| Lexer::Punctuation.const_get(const) }])
 
     # Optimized pattern using:
     # - Possessive quantifiers (*+, ++) to prevent backtracking in number patterns

data/lib/graphql/load_application_object_failed_error.rb

@@ -1,18 +1,27 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   # Raised when a argument is configured with `loads:` and the client provides an `ID`,
   # but no object is loaded for that ID.
   #
-  # @see GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader#load_application_object_failed, A hook which you can override in resolvers, mutations and input objects.
+  # See [GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader#load_application_object_failed](rdoc-ref:GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader#load_application_object_failed) A hook which you can override in resolvers, mutations and input objects.
   class LoadApplicationObjectFailedError < GraphQL::ExecutionError
-    # @return [GraphQL::Schema::Argument] the argument definition for the argument that was looked up
+    # **Returns**
+    #
+    # - `GraphQL::Schema::Argument` — the argument definition for the argument that was looked up
     attr_reader :argument
-    # @return [String] The ID provided by the client
+    # **Returns**
+    #
+    # - `String` — The ID provided by the client
     attr_reader :id
-    # @return [Object] The value found with this ID
+    # **Returns**
+    #
+    # - `Object` — The value found with this ID
     attr_reader :object
-    # @return [GraphQL::Query::Context]
+    # **Returns**
+    #
+    # - `GraphQL::Query::Context`
     attr_reader :context
 
     def initialize(argument:, id:, object:, context:)

data/lib/graphql/name_validator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class NameValidator
     VALID_NAME_REGEX = /^[_a-zA-Z][_a-zA-Z0-9]*$/

data/lib/graphql/pagination/active_record_relation_connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/pagination/relation_connection"
 
 module GraphQL

data/lib/graphql/pagination/array_connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/pagination/connection"
 
 module GraphQL
@@ -20,14 +21,22 @@ module GraphQL
       end
 
       def cursor_for(item)
-        idx = items.find_index(item) + 1
-        encode(idx.to_s)
+        index = cursor_index_for(item, items)
+        encode((index + 1).to_s)
+      end
+
+      def cursor_for_position(item, position) # :nodoc:
+        if self.class.custom_cursor_for?(ArrayConnection)
+          super
+        else
+          encode((@paged_nodes_offset + position + 1).to_s)
+        end
       end
 
       private
 
       def index_from_cursor(cursor)
-        index = Integer(decode(cursor), 10, exception: false)
+        index = Integer(decode(cursor), 10, exception: false) #: Integer?
         if index.nil? || index <= 0
           raise GraphQL::ExecutionError, "Invalid cursor: #{cursor.inspect}"
         end
@@ -38,14 +47,15 @@ module GraphQL
       # It doesn't do anything on subsequent calls.
       def load_nodes
         @nodes ||= begin
+          sliced_nodes_offset = after ? index_from_cursor(after) : 0
           sliced_nodes = if before && after
             end_idx = index_from_cursor(before) - 2
-            end_idx < 0 ? [] : items[index_from_cursor(after)..end_idx] || []
+            end_idx < 0 ? [] : items[sliced_nodes_offset..end_idx] || []
           elsif before
             end_idx = index_from_cursor(before) - 2
             end_idx < 0 ? [] : items[0..end_idx] || []
           elsif after
-            items[index_from_cursor(after)..-1] || []
+            items[sliced_nodes_offset..-1] || []
           else
             items
           end
@@ -71,9 +81,13 @@ module GraphQL
           end
 
           limited_nodes = sliced_nodes
+          @paged_nodes_offset = sliced_nodes_offset
 
           limited_nodes = limited_nodes.first(first) if first
-          limited_nodes = limited_nodes.last(last) if last
+          if last
+            @paged_nodes_offset += [limited_nodes.length - last, 0].max
+            limited_nodes = limited_nodes.last(last)
+          end
 
           limited_nodes
         end