graphql 2.6.12 → 2.6.13

data/lib/graphql/analysis/visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Analysis
     # Depth first traversal through a query AST, calling AST analyzers
@@ -8,7 +9,7 @@ module GraphQL
     # only the selected operation, providing helpers for common use cases such
     # as skipped fields and visiting fragment spreads.
     #
-    # @see {GraphQL::Analysis::Analyzer} AST Analyzers for queries
+    # See [GraphQL::Analysis::Analyzer](rdoc-ref:GraphQL::Analysis::Analyzer) AST Analyzers for queries
     class Visitor < GraphQL::Language::StaticVisitor
       def initialize(query:, analyzers:, timeout:)
         @analyzers = analyzers
@@ -32,13 +33,19 @@ module GraphQL
         super(query.selected_operation)
       end
 
-      # @return [GraphQL::Query] the query being visited
+      # **Returns**
+      #
+      # - `GraphQL::Query` — the query being visited
       attr_reader :query
 
-      # @return [Array<GraphQL::ObjectType>] Types whose scope we've entered
+      # **Returns**
+      #
+      # - `Array<GraphQL::ObjectType>` — Types whose scope we've entered
       attr_reader :object_types
 
-      # @return [Array<GraphQL::AnalysisError]
+      # **Returns**
+      #
+      # - `Array<GraphQL::AnalysisError>` — Array of errors rescued during analysis
       attr_reader :rescued_errors
 
       def visit
@@ -48,23 +55,44 @@ module GraphQL
 
       # Visit Helpers
 
-      # @return [GraphQL::Execution::Interpreter::Arguments] Arguments for this node, merging default values, literal values and query variables
-      # @see {GraphQL::Query#arguments_for}
+      # See [GraphQL::Query#arguments_for](rdoc-ref:GraphQL::Query#arguments_for)
+      #
+      # **Returns**
+      #
+      # - `GraphQL::Execution::Interpreter::Arguments` — Arguments for this node, merging default values, literal values and query variables
+      #
+      # :call-seq:
+      #   arguments_for(ast_node, field_definition) -> GraphQL::Execution::Interpreter::Arguments
       def arguments_for(ast_node, field_definition)
         @query.arguments_for(ast_node, field_definition)
       end
 
-      # @return [Boolean] If the visitor is currently inside a fragment definition
+      # **Returns**
+      #
+      # - `Boolean` — If the visitor is currently inside a fragment definition
+      #
+      # :call-seq:
+      #   visiting_fragment_definition?() -> bool
       def visiting_fragment_definition?
         @in_fragment_def
       end
 
-      # @return [Boolean] If the current node should be skipped because of a skip or include directive
+      # **Returns**
+      #
+      # - `Boolean` — If the current node should be skipped because of a skip or include directive
+      #
+      # :call-seq:
+      #   skipping?() -> bool
       def skipping?
         @skipping
       end
 
-      # @return [Array<String>] The path to the response key for the current field
+      # **Returns**
+      #
+      # - `Array<String>` — The path to the response key for the current field
+      #
+      # :call-seq:
+      #   response_path() -> Array[String]
       def response_path
         @response_path.dup
       end
@@ -206,37 +234,72 @@ module GraphQL
         @path.pop
       end
 
-      # @return [GraphQL::BaseType] The current object type
+      # **Returns**
+      #
+      # - `GraphQL::BaseType` — The current object type
+      #
+      # :call-seq:
+      #   type_definition() -> GraphQL::BaseType
       def type_definition
         @object_types.last
       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
         @object_types[-2]
       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
         @field_definitions.last
       end
 
-      # @return [GraphQL::Field, nil] The GraphQL field which returned the object that the current field belongs to
+      # **Returns**
+      #
+      # - `GraphQL::Field, nil` — The GraphQL field which returned the object that the current field belongs to
+      #
+      # :call-seq:
+      #   previous_field_definition() -> GraphQL::Field | nil
       def previous_field_definition
         @field_definitions[-2]
       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
         @directive_definitions.last
       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
         @argument_definitions.last
       end
 
-      # @return [GraphQL::Argument, nil] The previous GraphQL argument
+      # **Returns**
+      #
+      # - `GraphQL::Argument, nil` — The previous GraphQL argument
+      #
+      # :call-seq:
+      #   previous_argument_definition() -> GraphQL::Argument | nil
       def previous_argument_definition
         @argument_definitions[-2]
       end

data/lib/graphql/analysis.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/analysis/visitor"
 require "graphql/analysis/analyzer"
 require "graphql/analysis/field_usage"
@@ -21,9 +22,17 @@ module GraphQL
     # Multiplex analyzers are ran for all queries, keeping state.
     # Query analyzers are ran per query, without carrying state between queries.
     #
-    # @param multiplex [GraphQL::Execution::Multiplex]
-    # @param analyzers [Array<GraphQL::Analysis::Analyzer>]
-    # @return [Array<Any>] Results from multiplex analyzers
+    # **Parameters**
+    #
+    # - `multiplex` (`GraphQL::Execution::Multiplex`)
+    # - `analyzers` (`Array<GraphQL::Analysis::Analyzer>`)
+    #
+    # **Returns**
+    #
+    # - `Array<Any>` — Results from multiplex analyzers
+    #
+    # :call-seq:
+    #   analyze_multiplex(GraphQL::Execution::Multiplex multiplex, Array[GraphQL::Analysis::Analyzer] analyzers) -> Array[Any]
     def analyze_multiplex(multiplex, analyzers)
       multiplex_analyzers = analyzers.map { |analyzer| analyzer.new(multiplex) }
 
@@ -50,9 +59,17 @@ module GraphQL
       end
     end
 
-    # @param query [GraphQL::Query]
-    # @param analyzers [Array<GraphQL::Analysis::Analyzer>]
-    # @return [Array<Any>] Results from those analyzers
+    # **Parameters**
+    #
+    # - `query` (`GraphQL::Query`)
+    # - `analyzers` (`Array<GraphQL::Analysis::Analyzer>`)
+    #
+    # **Returns**
+    #
+    # - `Array<Any>` — Results from those analyzers
+    #
+    # :call-seq:
+    #   analyze_query(GraphQL::Query query, Array[GraphQL::Analysis::Analyzer] analyzers, multiplex_analyzers:) -> Array[Any]
     def analyze_query(query, analyzers, multiplex_analyzers: [])
       query.current_trace.analyze_query(query: query) do
         query_analyzers = analyzers.map { |analyzer| analyzer.new(query) }

data/lib/graphql/analysis_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class AnalysisError < GraphQL::ExecutionError
   end

data/lib/graphql/autoload.rb

@@ -1,13 +1,25 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
-  # @see GraphQL::Railtie for automatic Rails integration
+  # See [GraphQL::Railtie](rdoc-ref:GraphQL::Railtie) for automatic Rails integration
+  #--
+  # @requires_ancestor: Module
   module Autoload
     # Register a constant named `const_name` to be loaded from `path`.
-    # This is like `Kernel#autoload` but it tracks the constants so they can be eager-loaded with {#eager_load!}
-    # @param const_name [Symbol]
-    # @param path [String]
-    # @return [void]
+    # This is like `Kernel#autoload` but it tracks the constants so they can be eager-loaded with [eager load!](rdoc-ref:#eager_load!)
+    #
+    # **Parameters**
+    #
+    # - `const_name` (`Symbol`)
+    # - `path` (`String`)
+    #
+    # **Returns**
+    #
+    # - `void`
+    #
+    # :call-seq:
+    #   autoload(Symbol const_name, String path) -> void
     def autoload(const_name, path)
       @_eagerloaded_constants ||= []
       @_eagerloaded_constants << const_name
@@ -16,7 +28,13 @@ module GraphQL
     end
 
     # Call this to load this constant's `autoload` dependents and continue calling recursively
-    # @return [void]
+    #
+    # **Returns**
+    #
+    # - `void`
+    #
+    # :call-seq:
+    #   eager_load!() -> void
     def eager_load!
       @_eager_loading = true
       if @_eagerloaded_constants
@@ -30,7 +48,12 @@ module GraphQL
 
     private
 
-    # @return [Boolean] `true` if GraphQL-Ruby is currently eager-loading its constants
+    # **Returns**
+    #
+    # - `Boolean` — `true` if GraphQL-Ruby is currently eager-loading its constants
+    #
+    # :call-seq:
+    #   eager_loading?() -> bool
     def eager_loading?
       @_eager_loading ||= false
     end

data/lib/graphql/backtrace/table.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class Backtrace
     # A class for turning a context into a human-readable table or array
@@ -18,12 +19,22 @@ module GraphQL
         @override_value = value
       end
 
-      # @return [String] A table layout of backtrace with metadata
+      # **Returns**
+      #
+      # - `String` — A table layout of backtrace with metadata
+      #
+      # :call-seq:
+      #   to_table() -> String
       def to_table
         @to_table ||= render_table(rows)
       end
 
-      # @return [Array<String>] An array of position + field name entries
+      # **Returns**
+      #
+      # - `Array<String>` — An array of position + field name entries
+      #
+      # :call-seq:
+      #   to_backtrace() -> Array[String]
       def to_backtrace
         @to_backtrace ||= begin
           backtrace = rows.map { |r| "#{r[0]}: #{r[1]}" }
@@ -43,7 +54,7 @@ module GraphQL
           result = runtime_inst.instance_variable_get(:@response)
           rows = []
           result_path = []
-          last_part = nil
+          last_part = nil #: untyped
           path = @context.current_path
           path.each do |path_part|
             value = value_at(runtime_inst, result_path)
@@ -79,7 +90,7 @@ module GraphQL
           end
 
           object = result.graphql_application_value.object.inspect
-          ast_node = nil
+          ast_node = nil #: untyped
           result.graphql_selections.each do |s|
             found_ast_node = find_ast_node(s, last_part)
             if found_ast_node
@@ -134,7 +145,12 @@ module GraphQL
         nil
       end
 
-      # @return [String]
+      # **Returns**
+      #
+      # - `String`
+      #
+      # :call-seq:
+      #   render_table(rows) -> String
       def render_table(rows)
         max = Array.new(HEADERS.length, MIN_COL_WIDTH)
 

data/lib/graphql/backtrace/traced_error.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class Backtrace
-    # When {Backtrace} is enabled, raised errors are wrapped with {TracedError}.
+    # When [Backtrace](rdoc-ref:GraphQL::Backtrace) is enabled, raised errors are wrapped with [TracedError](rdoc-ref:GraphQL::Backtrace::TracedError).
     class TracedError < GraphQL::Error
-      # @return [Array<String>] Printable backtrace of GraphQL error context
+      # **Returns**
+      #
+      # - `Array<String>` — Printable backtrace of GraphQL error context
       attr_reader :graphql_backtrace
 
-      # @return [GraphQL::Query::Context] The context at the field where the error was raised
+      # **Returns**
+      #
+      # - `GraphQL::Query::Context` — The context at the field where the error was raised
       attr_reader :context
 
       MESSAGE_TEMPLATE = <<-MESSAGE

data/lib/graphql/backtrace.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/backtrace/table"
 require "graphql/backtrace/traced_error"
 module GraphQL
-  # Wrap unhandled errors with {TracedError}.
+  # Wrap unhandled errors with [TracedError](rdoc-ref:TracedError).
   #
-  # {TracedError} provides a GraphQL backtrace with arguments and return values.
-  # The underlying error is available as {TracedError#cause}.
+  # [TracedError](rdoc-ref:TracedError) provides a GraphQL backtrace with arguments and return values.
+  # The underlying error is available as `TracedError#cause`.
   #
-  # @example toggling backtrace annotation
-  #   class MySchema < GraphQL::Schema
-  #     if Rails.env.development? || Rails.env.test?
-  #       use GraphQL::Backtrace
-  #     end
-  #   end
+  # **Examples**
+  #
+  # **Example: toggling backtrace annotation**
   #
+  # ```ruby
+  # class MySchema < GraphQL::Schema
+  #   if Rails.env.development? || Rails.env.test?
+  #     use GraphQL::Backtrace
+  #   end
+  # end
+  # ```
   class Backtrace
     include Enumerable
     extend Forwardable

data/lib/graphql/coercion_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class CoercionError < GraphQL::ExecutionError
   end

data/lib/graphql/current.rb

@@ -1,28 +1,37 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   # This module exposes Fiber-level runtime information.
   #
   # It won't work across unrelated fibers, although it will work in child Fibers.
   #
-  # @example Setting Up ActiveRecord::QueryLogs
+  # **Examples**
   #
-  #   config.active_record.query_log_tags = [
-  #     :namespaced_controller,
-  #     :action,
-  #     :job,
-  #     # ...
-  #     {
-  #       # GraphQL runtime info:
-  #       current_graphql_operation: -> { GraphQL::Current.operation_name },
-  #       current_graphql_field: -> { GraphQL::Current.field&.path },
-  #       current_dataloader_source: -> { GraphQL::Current.dataloader_source_class },
-  #       # ...
-  #     },
-  #   ]
+  # **Example: Setting Up ActiveRecord::QueryLogs**
   #
+  # ```ruby
+  # config.active_record.query_log_tags = [
+  #   :namespaced_controller,
+  #   :action,
+  #   :job,
+  #   # ...
+  #   {
+  #     # GraphQL runtime info:
+  #     current_graphql_operation: -> { GraphQL::Current.operation_name },
+  #     current_graphql_field: -> { GraphQL::Current.field&.path },
+  #     current_dataloader_source: -> { GraphQL::Current.dataloader_source_class },
+  #     # ...
+  #   },
+  # ]
+  # ```
   module Current
-    # @return [String, nil] Comma-joined operation names for the currently-running {Execution::Multiplex}. `nil` if all operations are anonymous.
+    # **Returns**
+    #
+    # - `String, nil` — Comma-joined operation names for the currently-running `Execution::Multiplex`. `nil` if all operations are anonymous.
+    #
+    # :call-seq:
+    #   operation_name() -> String | nil
     def self.operation_name
       if (m = Fiber[:__graphql_current_multiplex])
         m.context[:__graphql_current_operation_name] ||= begin
@@ -38,8 +47,14 @@ module GraphQL
       end
     end
 
-    # @see GraphQL::Field#path for a string identifying this field
-    # @return [GraphQL::Field, nil] The currently-running field, if there is one.
+    # See [Schema::Member::HasPath#path](rdoc-ref:GraphQL::Schema::Member::HasPath#path) for a string identifying this field
+    #
+    # **Returns**
+    #
+    # - `GraphQL::Field, nil` — The currently-running field, if there is one.
+    #
+    # :call-seq:
+    #   field() -> GraphQL::Field | nil
     def self.field
       if (interpreter_info = Fiber[:__graphql_runtime_info])
         interpreter_info.values&.first&.current_field
@@ -50,12 +65,22 @@ module GraphQL
       end
     end
 
-    # @return [Class, nil] The currently-running {Dataloader::Source} class, if there is one.
+    # **Returns**
+    #
+    # - `Class, nil` — The currently-running [Dataloader::Source](rdoc-ref:Dataloader::Source) class, if there is one.
+    #
+    # :call-seq:
+    #   dataloader_source_class() -> Class | nil
     def self.dataloader_source_class
       Fiber[:__graphql_current_dataloader_source]&.class
     end
 
-    # @return [GraphQL::Dataloader::Source, nil] The currently-running source, if there is one
+    # **Returns**
+    #
+    # - `GraphQL::Dataloader::Source, nil` — The currently-running source, if there is one
+    #
+    # :call-seq:
+    #   dataloader_source() -> GraphQL::Dataloader::Source | nil
     def self.dataloader_source
       Fiber[:__graphql_current_dataloader_source]
     end

data/lib/graphql/dashboard/application_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require "action_controller"
 
 module Graphql

data/lib/graphql/dashboard/detailed_traces.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative "./installable"
 module Graphql
   class Dashboard < Rails::Engine

data/lib/graphql/dashboard/installable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 module Graphql
   class Dashboard < Rails::Engine
     module Installable

data/lib/graphql/dashboard/landings_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 module Graphql
   class Dashboard < Rails::Engine
     class LandingsController < ApplicationController

data/lib/graphql/dashboard/limiters.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative "./installable"
 module Graphql
   class Dashboard < Rails::Engine

data/lib/graphql/dashboard/operation_store.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative "./installable"
 module Graphql
   class Dashboard < Rails::Engine

data/lib/graphql/dashboard/statics_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 module Graphql
   class Dashboard < Rails::Engine
     class StaticsController < ApplicationController

data/lib/graphql/dashboard/subscriptions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 require_relative "./installable"
 module Graphql
   class Dashboard < Rails::Engine

data/lib/graphql/dashboard.rb

@@ -1,40 +1,54 @@
 # frozen_string_literal: true
+# typed: true
 require 'rails/engine'
 require 'action_controller'
 module Graphql
   # `GraphQL::Dashboard` is a `Rails::Engine`-based dashboard for viewing metadata about your GraphQL schema.
   #
   # Pass the class name of your schema when mounting it.
-  # @see GraphQL::Tracing::DetailedTrace DetailedTrace for viewing production traces in the Dashboard
+  # See [GraphQL::Tracing::DetailedTrace](rdoc-ref:GraphQL::Tracing::DetailedTrace) DetailedTrace for viewing production traces in the Dashboard
   #
-  # @example Mounting the Dashboard in your app
-  #   mount GraphQL::Dashboard, at: "graphql_dashboard", schema: "MySchema"
+  # **Examples**
   #
-  # Pass an array to allow selecting from multiple schemas with the `schema` query parameter.
-  #   mount GraphQL::Dashboard, at: "graphql_dashboard", schema: ["MySchema", "OtherSchema"]
+  # **Example: Mounting the Dashboard in your app**
   #
-  # @example Authenticating the Dashboard with HTTP Basic Auth
-  #   # config/initializers/graphql_dashboard.rb
-  #   GraphQL::Dashboard.middleware.use(Rack::Auth::Basic) do |username, password|
-  #     # Compare the provided username/password to an application setting:
-  #     ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.graphql_dashboard_username, username) &&
-  #       ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.graphql_dashboard_username, password)
-  #   end
+  # ```ruby
+  # mount GraphQL::Dashboard, at: "graphql_dashboard", schema: "MySchema"
+  # ```
+  #
+  # To allow selecting from multiple schemas with the `schema` query parameter:
+  #
+  # ```ruby
+  # mount GraphQL::Dashboard, at: "graphql_dashboard", schema: ["MySchema", "OtherSchema"]
+  # ```
   #
-  # @example Custom Rails authentication
-  #   # config/initializers/graphql_dashboard.rb
-  #   ActiveSupport.on_load(:graphql_dashboard_application_controller) do
-  #     # context here is GraphQL::Dashboard::ApplicationController
+  # **Example: Authenticating the Dashboard with HTTP Basic Auth**
   #
-  #     before_action do
-  #       raise ActionController::RoutingError.new('Not Found') unless current_user&.admin?
-  #     end
+  # ```ruby
+  # # config/initializers/graphql_dashboard.rb
+  # GraphQL::Dashboard.middleware.use(Rack::Auth::Basic) do |username, password|
+  #   # Compare the provided username/password to an application setting:
+  #   ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.graphql_dashboard_username, username) &&
+  #     ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.graphql_dashboard_username, password)
+  # end
+  # ```
   #
-  #     def current_user
-  #       # load current user
-  #     end
+  # **Example: Custom Rails authentication**
+  #
+  # ```ruby
+  # # config/initializers/graphql_dashboard.rb
+  # ActiveSupport.on_load(:graphql_dashboard_application_controller) do
+  #   # context here is GraphQL::Dashboard::ApplicationController
+  #
+  #   before_action do
+  #     raise ActionController::RoutingError.new('Not Found') unless current_user&.admin?
   #   end
   #
+  #   def current_user
+  #     # load current user
+  #   end
+  # end
+  # ```
   class Dashboard < Rails::Engine
     engine_name "graphql_dashboard"
     isolate_namespace(Graphql::Dashboard)

data/lib/graphql/dataloader/active_record_association_source.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "graphql/dataloader/source"
 require "graphql/dataloader/active_record_source"
 

data/lib/graphql/dataloader/active_record_source.rb

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