graphql 2.6.12 → 2.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24a0e699fe2f72dd869173b2bc6aa96ec8d40e738a293bc56b9176debca03861
-  data.tar.gz: 18b16bf0c467f5f8dc0c00ea2bcf2fbaf53283edc9f09a3789918523090a97ce
+  metadata.gz: 36d986ef7f7b1916194937668e714823fcc92844d9cbbd3adebad6fae134f9ff
+  data.tar.gz: 84b4da9a3b9fc6c56cf6b8a5629567609a91c50eae60ac8ac825218cd0f73d4c
 SHA512:
-  metadata.gz: 74a34839ced3a300d20ca370cb37a7c88c56345ecb056e9b9caa7a424fdb7573c5a014b80a32772cc2a5eb40d83e568c5d0875d93b029b1663dda9547fc06ba1
-  data.tar.gz: 65dcfea9802c9fb682e6595ef2d2d224a256c0650ff24fa57774eac420b27e594b3c432a104d76c8e033c659a608940661ea4503e0737f63d7839ff36f5f4405
+  metadata.gz: 2ecdf1096d357f3413087513d2076d2e6ed8d56c29cc9a535b24f2b8d16df88055abec49b2dbf423c315dbbfe0f58a30b0e9507c6a6d63152e77c949e53a3c70
+  data.tar.gz: e19b69ee6bcf4db6f58f53e990ba8aa9ca5a70e0b8dce3174ae2ca10f62226d7fc12a75a3d3f74f521094453ab37f724c225477173bd42c8ede70269809a701b

data/.rdoc_options

@@ -0,0 +1,4 @@
+---
+markup: markdown
+main_page: readme.md
+title: GraphQL Ruby API Documentation

data/lib/generators/graphql/core.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators/base'
 
 module Graphql

data/lib/generators/graphql/detailed_trace_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators/active_record'
 
 module Graphql

data/lib/generators/graphql/enum_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 
 module Graphql

data/lib/generators/graphql/field_extractor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators/base'
 
 module Graphql

data/lib/generators/graphql/input_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 require 'generators/graphql/field_extractor'
 

data/lib/generators/graphql/install/mutation_root_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 
 require "rails/generators/base"
 require_relative "../core"

data/lib/generators/graphql/install_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require 'rails/generators/base'
 require_relative 'core'

data/lib/generators/graphql/interface_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 
 module Graphql

data/lib/generators/graphql/loader_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require "rails/generators/named_base"
 require_relative "core"
 
 module Graphql
   module Generators
-    # @example Generate a `GraphQL::Batch` loader by name.
-    #     rails g graphql:loader RecordLoader
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Batch` loader by name.**
+    #
+    # ```ruby
+    # rails g graphql:loader RecordLoader
+    # ```
     class LoaderGenerator < Rails::Generators::NamedBase
       include Core
 

data/lib/generators/graphql/mutation_create_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative 'orm_mutations_base'
 
 module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
-    #     rails g graphql:mutation CreatePostMutation
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Schema::RelayClassicMutation` by name**
+    #
+    # ```ruby
+    # rails g graphql:mutation CreatePostMutation
+    # ```
     class MutationCreateGenerator < OrmMutationsBase
 
       desc "Scaffold a Relay Classic ORM create mutation for the given model class"

data/lib/generators/graphql/mutation_delete_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative 'orm_mutations_base'
 
 module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
-    #     rails g graphql:mutation DeletePostMutation
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Schema::RelayClassicMutation` by name**
+    #
+    # ```ruby
+    # rails g graphql:mutation DeletePostMutation
+    # ```
     class MutationDeleteGenerator < OrmMutationsBase
 
       desc "Scaffold a Relay Classic ORM delete mutation for the given model class"

data/lib/generators/graphql/mutation_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require 'rails/generators/named_base'
 require_relative 'core'
@@ -7,8 +8,13 @@ module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
-    #     rails g graphql:mutation CreatePostMutation
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Schema::RelayClassicMutation` by name**
+    #
+    # ```ruby
+    # rails g graphql:mutation CreatePostMutation
+    # ```
     class MutationGenerator < Rails::Generators::NamedBase
       include Core
 

data/lib/generators/graphql/mutation_update_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative 'orm_mutations_base'
 
 module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
-    #     rails g graphql:mutation UpdatePostMutation
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Schema::RelayClassicMutation` by name**
+    #
+    # ```ruby
+    # rails g graphql:mutation UpdatePostMutation
+    # ```
     class MutationUpdateGenerator < OrmMutationsBase
 
       desc "Scaffold a Relay Classic ORM update mutation for the given model class"

data/lib/generators/graphql/object_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 require 'generators/graphql/field_extractor'
 

data/lib/generators/graphql/orm_mutations_base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require 'rails/generators/named_base'
 require_relative 'core'
@@ -7,8 +8,13 @@ module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
-    #     rails g graphql:mutation CreatePostMutation
+    # **Examples**
+    #
+    # **Example: Generate a `GraphQL::Schema::RelayClassicMutation` by name**
+    #
+    # ```ruby
+    # rails g graphql:mutation CreatePostMutation
+    # ```
     class OrmMutationsBase < Rails::Generators::NamedBase
       include Core
       include Rails::Generators::ResourceHelpers

data/lib/generators/graphql/relay.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 module Graphql
   module Generators
     module Relay

data/lib/generators/graphql/relay_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require 'rails/generators/base'
 require_relative 'core'

data/lib/generators/graphql/scalar_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 
 module Graphql

data/lib/generators/graphql/type_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'rails/generators'
 require 'rails/generators/base'
 require 'graphql'
@@ -34,10 +35,19 @@ module Graphql
       # Take a type expression in any combination of GraphQL or Ruby styles
       # and return it in a specified output style
       # TODO: nullability / list with `mode: :graphql` doesn't work
-      # @param type_expresson [String]
-      # @param mode [Symbol]
-      # @param null [Boolean]
-      # @return [(String, Boolean)] The type expression, followed by `null:` value
+      #
+      # **Parameters**
+      #
+      # - `type_expresson` (`String`)
+      # - `mode` (`Symbol`)
+      # - `null` (`Boolean`)
+      #
+      # **Returns**
+      #
+      # - `(String, Boolean)` — The type expression, followed by `null:` value
+      #
+      # :call-seq:
+      #   normalize_type_expression(type_expression, Symbol mode:, bool null:) -> (String, bool)
       def self.normalize_type_expression(type_expression, mode:, null: true)
         if type_expression.start_with?("!")
           normalize_type_expression(type_expression[1..-1], mode: mode, null: false)
@@ -73,22 +83,42 @@ module Graphql
 
       private
 
-      # @return [String] The user-provided type name, normalized to Ruby code
+      # **Returns**
+      #
+      # - `String` — The user-provided type name, normalized to Ruby code
+      #
+      # :call-seq:
+      #   type_ruby_name() -> String
       def type_ruby_name
         @type_ruby_name ||= self.class.normalize_type_expression(name, mode: :ruby)[0]
       end
 
-      # @return [String] The user-provided type name, as a GraphQL name
+      # **Returns**
+      #
+      # - `String` — The user-provided type name, as a GraphQL name
+      #
+      # :call-seq:
+      #   type_graphql_name() -> String
       def type_graphql_name
         @type_graphql_name ||= self.class.normalize_type_expression(name, mode: :graphql)[0]
       end
 
-      # @return [String] The user-provided type name, as a file name (without extension)
+      # **Returns**
+      #
+      # - `String` — The user-provided type name, as a file name (without extension)
+      #
+      # :call-seq:
+      #   type_file_name() -> String
       def type_file_name
         @type_file_name ||= "#{type_graphql_name}Type".underscore
       end
 
-      # @return [Array<NormalizedField>] User-provided fields, in `(name, Ruby type name)` pairs
+      # **Returns**
+      #
+      # - `Array<NormalizedField>` — User-provided fields, in `(name, Ruby type name)` pairs
+      #
+      # :call-seq:
+      #   normalized_fields() -> Array[NormalizedField]
       def normalized_fields
         @normalized_fields ||= fields.map { |f|
           name, raw_type = f.split(":", 2)

data/lib/generators/graphql/union_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require 'generators/graphql/type_generator'
 
 module Graphql

data/lib/graphql/analysis/analyzer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     # Query analyzer for query ASTs. Query analyzers respond to visitor style methods
@@ -7,7 +8,9 @@ module GraphQL
     # When an analyzer is initialized with a Multiplex, you can always get the current query from
     # `visitor.query` in the visit methods.
     #
-    # @param [GraphQL::Query, GraphQL::Execution::Multiplex] The query or multiplex to analyze
+    # **Parameters**
+    #
+    # - `The` (`GraphQL::Query, GraphQL::Execution::Multiplex`) — query or multiplex to analyze
     class Analyzer
       def initialize(subject)
         @subject = subject
@@ -23,21 +26,39 @@ module GraphQL
 
       # Analyzer hook to decide at analysis time whether a query should
       # be analyzed or not.
-      # @return [Boolean] If the query should be analyzed or not
+      #
+      # **Returns**
+      #
+      # - `Boolean` — If the query should be analyzed or not
+      #
+      # :call-seq:
+      #   analyze?() -> bool
       def analyze?
         true
       end
 
       # Analyzer hook to decide at analysis time whether analysis
       # requires a visitor pass; can be disabled for precomputed results.
-      # @return [Boolean] If analysis requires visitation or not
+      #
+      # **Returns**
+      #
+      # - `Boolean` — If analysis requires visitation or not
+      #
+      # :call-seq:
+      #   visit?() -> bool
       def visit?
         true
       end
 
-      # The result for this analyzer. Returning {GraphQL::AnalysisError} results
+      # The result for this analyzer. Returning [GraphQL::AnalysisError](rdoc-ref:GraphQL::AnalysisError) results
       # in a query error.
-      # @return [Any] The analyzer result
+      #
+      # **Returns**
+      #
+      # - `Any` — The analyzer result
+      #
+      # :call-seq:
+      #   result() -> Any
       def result
         raise GraphQL::RequiredImplementationMissingError
       end
@@ -76,14 +97,19 @@ module GraphQL
       # rubocop:enable Development/NoEvalCop
       protected
 
-      # @return [GraphQL::Query, GraphQL::Execution::Multiplex] Whatever this analyzer is analyzing
+      # **Returns**
+      #
+      # - `GraphQL::Query, GraphQL::Execution::Multiplex` — Whatever this analyzer is analyzing
       attr_reader :subject
 
-      # @return [GraphQL::Query, nil] `nil` if this analyzer is visiting a multiplex
-      #  (When this is `nil`, use `visitor.query` inside visit methods to get the current query)
+      # **Returns**
+      #
+      # - `GraphQL::Query, nil` — `nil` if this analyzer is visiting a multiplex (When this is `nil`, use `visitor.query` inside visit methods to get the current query)
       attr_reader :query
 
-      # @return [GraphQL::Execution::Multiplex, nil] `nil` if this analyzer is visiting a query
+      # **Returns**
+      #
+      # - `GraphQL::Execution::Multiplex, nil` — `nil` if this analyzer is visiting a query
       attr_reader :multiplex
     end
   end

data/lib/graphql/analysis/field_usage.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     class FieldUsage < Analyzer

data/lib/graphql/analysis/max_query_complexity.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     # Used under the hood to implement complexity validation,
-    # see {Schema#max_complexity} and {Query#max_complexity}
+    # See [Schema.max_complexity](rdoc-ref:GraphQL::Schema.max_complexity) and `Query#max_complexity`.
     class MaxQueryComplexity < QueryComplexity
       def result
         return if subject.max_complexity.nil?

data/lib/graphql/analysis/max_query_depth.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     class MaxQueryDepth < QueryDepth

data/lib/graphql/analysis/query_complexity.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
-    # Calculate the complexity of a query, using {Field#complexity} values.
+    # Calculate the complexity of a query, using [Field#complexity](rdoc-ref:GraphQL::Schema::Field#complexity) values.
     class QueryComplexity < Analyzer
       # State for the query complexity calculation:
       # - `complexities_on_type` holds complexity scores for each type
@@ -51,11 +52,19 @@ module GraphQL
 
         attr_reader :field_definition, :response_path, :query
 
-        # @param parent_type [Class] The owner of `field_definition`
-        # @param field_definition [GraphQL::Field, GraphQL::Schema::Field] Used for getting the `.complexity` configuration
-        # @param query [GraphQL::Query] Used for `query.possible_types`
-        # @param response_path [Array<String>] The path to the response key for the field
-        # @return [Hash<GraphQL::BaseType, Hash<String, ScopedTypeComplexity>>]
+        # **Parameters**
+        #
+        # - `parent_type` (`Class`) — The owner of `field_definition`
+        # - `field_definition` (`GraphQL::Field, GraphQL::Schema::Field`) — Used for getting the `.complexity` configuration
+        # - `query` (`GraphQL::Query`) — Used for `query.possible_types`
+        # - `response_path` (`Array<String>`) — The path to the response key for the field
+        #
+        # **Returns**
+        #
+        # - `Hash<GraphQL::BaseType, Hash<String, ScopedTypeComplexity>>`
+        #
+        # :call-seq:
+        #   initialize(Class parent_type, GraphQL::Field | GraphQL::Schema::Field field_definition, GraphQL::Query query, Array[String] response_path) -> Hash[GraphQL::BaseType, Hash[String, ScopedTypeComplexity]]
         def initialize(parent_type, field_definition, query, response_path)
           super(&DEFAULT_PROC)
           @parent_type = parent_type
@@ -65,7 +74,9 @@ module GraphQL
           @nodes = []
         end
 
-        # @return [Array<GraphQL::Language::Nodes::Field>]
+        # **Returns**
+        #
+        # - `Array<GraphQL::Language::Nodes::Field>`
         attr_reader :nodes
 
         def own_complexity(child_complexity)
@@ -107,17 +118,30 @@ module GraphQL
 
       private
 
-      # @return [Integer]
+      # **Returns**
+      #
+      # - `Integer`
+      #
+      # :call-seq:
+      #   max_possible_complexity(mode:) -> Integer
       def max_possible_complexity(mode: :future)
         @complexities_on_type_by_query.reduce(0) do |total, (query, scopes_stack)|
           total + merged_max_complexity_for_scopes(query, [scopes_stack.first], mode)
         end
       end
 
-      # @param query [GraphQL::Query] Used for `query.possible_types`
-      # @param scopes [Array<ScopedTypeComplexity>] Array of scoped type complexities
-      # @param mode [:future, :legacy]
-      # @return [Integer]
+      # **Parameters**
+      #
+      # - `query` (`GraphQL::Query`) — Used for `query.possible_types`
+      # - `scopes` (`Array<ScopedTypeComplexity>`) — Array of scoped type complexities
+      # - `mode` (`:future, :legacy`)
+      #
+      # **Returns**
+      #
+      # - `Integer`
+      #
+      # :call-seq:
+      #   merged_max_complexity_for_scopes(GraphQL::Query query, Array[ScopedTypeComplexity] scopes, :future | :legacy mode) -> Integer
       def merged_max_complexity_for_scopes(query, scopes, mode)
         # Aggregate a set of all possible scope types encountered (scope keys).
         # Use a hash, but ignore the values; it's just a fast way to work with the keys.
@@ -182,14 +206,27 @@ module GraphQL
       # A hook which is called whenever a field's max complexity is calculated.
       # Override this method to capture individual field complexity details.
       #
-      # @param scoped_type_complexity [ScopedTypeComplexity]
-      # @param max_complexity [Numeric] Field's maximum complexity including child complexity
-      # @param child_complexity [Numeric, nil] Field's child complexity
+      # **Parameters**
+      #
+      # - `scoped_type_complexity` (`ScopedTypeComplexity`)
+      # - `max_complexity` (`Numeric`) — Field's maximum complexity including child complexity
+      # - `child_complexity` (`Numeric, nil`) — Field's child complexity
+      #
+      # :call-seq:
+      #   field_complexity(ScopedTypeComplexity scoped_type_complexity, Numeric max_complexity:, Numeric | nil child_complexity:)
       def field_complexity(scoped_type_complexity, max_complexity:, child_complexity: nil)
       end
 
-      # @param inner_selections [Array<Hash<String, ScopedTypeComplexity>>] Field selections for a scope
-      # @return [Integer] Total complexity value for all these selections in the parent scope
+      # **Parameters**
+      #
+      # - `inner_selections` (`Array<Hash<String, ScopedTypeComplexity>>`) — Field selections for a scope
+      #
+      # **Returns**
+      #
+      # - `Integer` — Total complexity value for all these selections in the parent scope
+      #
+      # :call-seq:
+      #   merged_max_complexity(query, Array[Hash[String, ScopedTypeComplexity]] inner_selections) -> Integer
       def merged_max_complexity(query, inner_selections)
         child_scopes_by_key = {}
         inner_selections.each do |inner_selection|
@@ -211,7 +248,7 @@ module GraphQL
           end
 
           # Identify the maximum cost and scope among possibilities
-          maximum_cost = 0
+          maximum_cost = 0 #: Integer
           maximum_scope = child_scopes.reduce(child_scopes.last) do |max_scope, possible_scope|
             scope_cost = possible_scope.own_complexity(maximum_children_cost)
             if scope_cost > maximum_cost
@@ -243,8 +280,8 @@ module GraphQL
 
         # Add up the total cost for each unique field name's coalesced selections
         unique_field_keys.each_key.reduce(0) do |total, field_key|
-          composite_scopes = nil
-          field_cost = 0
+          composite_scopes = nil #: Array[untyped]?
+          field_cost = 0 #: Integer
 
           # Collect composite selection scopes for further aggregation,
           # leaf selections report their costs directly.

data/lib/graphql/analysis/query_depth.rb

@@ -1,28 +1,33 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     # A query reducer for measuring the depth of a given query.
     #
     # See https://graphql-ruby.org/queries/ast_analysis.html for more examples.
     #
-    # @example Logging the depth of a query
-    #   class LogQueryDepth < GraphQL::Analysis::QueryDepth
-    #     def result
-    #       log("GraphQL query depth: #{@max_depth}")
-    #     end
-    #   end
+    # **Examples**
     #
-    #   # In your Schema file:
+    # **Example: Logging the depth of a query**
     #
-    #   class MySchema < GraphQL::Schema
-    #     query_analyzer LogQueryDepth
+    # ```ruby
+    # class LogQueryDepth < GraphQL::Analysis::QueryDepth
+    #   def result
+    #     log("GraphQL query depth: #{@max_depth}")
     #   end
+    # end
+    #
+    # # In your Schema file:
     #
-    #   # When you run the query, the depth will get logged:
+    # class MySchema < GraphQL::Schema
+    #   query_analyzer LogQueryDepth
+    # end
     #
-    #   Schema.execute(query_str)
-    #   # GraphQL query depth: 8
+    # # When you run the query, the depth will get logged:
     #
+    # Schema.execute(query_str)
+    # # GraphQL query depth: 8
+    # ```
     class QueryDepth < Analyzer
       def initialize(query)
         @max_depth = 0