graphql 2.6.11 → 2.6.13

data/lib/graphql/types/big_int.rb

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

data/lib/graphql/types/boolean.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     class Boolean < GraphQL::Schema::Scalar

data/lib/graphql/types/float.rb

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

data/lib/graphql/types/id.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     class ID < GraphQL::Schema::Scalar

data/lib/graphql/types/int.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
-    # @see {Types::BigInt} for handling integers outside 32-bit range.
+    # See [Types::BigInt](rdoc-ref:Types::BigInt) for handling integers outside 32-bit range.
     class Int < GraphQL::Schema::Scalar
       description "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."
 

data/lib/graphql/types/iso_8601_date.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     # This scalar takes `Date`s and transmits them as strings,
@@ -16,14 +17,30 @@ module GraphQL
       description "An ISO 8601-encoded date"
       specified_by_url "https://tools.ietf.org/html/rfc3339"
 
-      # @param value [Date,Time,DateTime,String]
-      # @return [String]
+      # **Parameters**
+      #
+      # - `value` (`Date, Time, DateTime, String`)
+      #
+      # **Returns**
+      #
+      # - `String`
+      #
+      # :call-seq:
+      #   coerce_result(Date | Time | DateTime | String value, _ctx) -> String
       def self.coerce_result(value, _ctx)
         Date.parse(value.to_s).iso8601
       end
 
-      # @param str_value [String, Date, DateTime, Time]
-      # @return [Date, nil]
+      # **Parameters**
+      #
+      # - `str_value` (`String, Date, DateTime, Time`)
+      #
+      # **Returns**
+      #
+      # - `Date, nil`
+      #
+      # :call-seq:
+      #   coerce_input(value, ctx) -> Date | nil
       def self.coerce_input(value, ctx)
         if value.is_a?(::Date)
           value

data/lib/graphql/types/iso_8601_date_time.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require 'time'
 
@@ -23,18 +24,36 @@ module GraphQL
       # i.e. ActiveSupport::JSON::Encoder.time_precision (3 by default)
       DEFAULT_TIME_PRECISION = 0
 
-      # @return [Integer]
+      # **Returns**
+      #
+      # - `Integer`
+      #
+      # :call-seq:
+      #   time_precision() -> Integer
       def self.time_precision
         @time_precision || DEFAULT_TIME_PRECISION
       end
 
-      # @param [Integer] value
+      # **Parameters**
+      #
+      # - `value` (`Integer`)
+      #
+      # :call-seq:
+      #   time_precision=(Integer value)
       def self.time_precision=(value)
         @time_precision = value
       end
 
-      # @param value [Time,Date,DateTime,String]
-      # @return [String]
+      # **Parameters**
+      #
+      # - `value` (`Time, Date, DateTime, String`)
+      #
+      # **Returns**
+      #
+      # - `String`
+      #
+      # :call-seq:
+      #   coerce_result(Time | Date | DateTime | String value, _ctx) -> String
       def self.coerce_result(value, _ctx)
         case value
         when Date
@@ -49,8 +68,16 @@ module GraphQL
         raise GraphQL::Error, "An incompatible object (#{value.class}) was given to #{self}. Make sure that only Times, Dates, DateTimes, and well-formatted Strings are used with this type. (#{error.message})"
       end
 
-      # @param str_value [String]
-      # @return [Time]
+      # **Parameters**
+      #
+      # - `str_value` (`String`)
+      #
+      # **Returns**
+      #
+      # - `Time`
+      #
+      # :call-seq:
+      #   coerce_input(String str_value, _ctx) -> Time
       def self.coerce_input(str_value, _ctx)
         Time.iso8601(str_value)
       rescue ArgumentError, TypeError

data/lib/graphql/types/iso_8601_duration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     # This scalar takes `Duration`s and transmits them as strings,
@@ -16,20 +17,41 @@ module GraphQL
     class ISO8601Duration < GraphQL::Schema::Scalar
       description "An ISO 8601-encoded duration"
 
-      # @return [Integer, nil]
+      # **Returns**
+      #
+      # - `Integer, nil`
+      #
+      # :call-seq:
+      #   seconds_precision() -> Integer | nil
       def self.seconds_precision
         # ActiveSupport::Duration precision defaults to whatever input was given
         @seconds_precision
       end
 
-      # @param [Integer, nil] value
+      # **Parameters**
+      #
+      # - `value` (`Integer, nil`)
+      #
+      # :call-seq:
+      #   seconds_precision=(Integer | nil value)
       def self.seconds_precision=(value)
         @seconds_precision = value
       end
 
-      # @param value [ActiveSupport::Duration, String]
-      # @return [String]
-      # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined or if an incompatible object is passed
+      # **Parameters**
+      #
+      # - `value` (`ActiveSupport::Duration, String`)
+      #
+      # **Returns**
+      #
+      # - `String`
+      #
+      # **Raises**
+      #
+      # - `GraphQL::Error` — if ActiveSupport::Duration is not defined or if an incompatible object is passed
+      #
+      # :call-seq:
+      #   coerce_result(ActiveSupport::Duration | String value, _ctx) -> String | GraphQL::Error
       def self.coerce_result(value, _ctx)
         unless defined?(ActiveSupport::Duration)
           raise GraphQL::Error, "ActiveSupport >= 5.0 must be loaded to use the built-in ISO8601Duration type."
@@ -50,10 +72,21 @@ module GraphQL
         end
       end
 
-      # @param value [String, ActiveSupport::Duration]
-      # @return [ActiveSupport::Duration, nil]
-      # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined
-      # @raise [GraphQL::DurationEncodingError] if duration cannot be parsed
+      # **Parameters**
+      #
+      # - `value` (`String, ActiveSupport::Duration`)
+      #
+      # **Returns**
+      #
+      # - `ActiveSupport::Duration, nil`
+      #
+      # **Raises**
+      #
+      # - `GraphQL::Error` — if ActiveSupport::Duration is not defined
+      # - `GraphQL::DurationEncodingError` — if duration cannot be parsed
+      #
+      # :call-seq:
+      #   coerce_input(String | ActiveSupport::Duration value, ctx) -> ActiveSupport::Duration | nil | GraphQL::Error | GraphQL::DurationEncodingError
       def self.coerce_input(value, ctx)
         unless defined?(ActiveSupport::Duration)
           raise GraphQL::Error, "ActiveSupport >= 5.0 must be loaded to use the built-in ISO8601Duration type."

data/lib/graphql/types/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     # An untyped JSON scalar that maps to Ruby hashes, arrays, strings, integers, floats, booleans and nils.

data/lib/graphql/types/relay/base_connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
@@ -9,38 +10,43 @@ module GraphQL
       # You may wish to copy this code into your own base class,
       # so you can extend your own `BaseObject` instead of `GraphQL::Schema::Object`.
       #
-      # @example Implementation a connection and edge
-      #   class BaseObject < GraphQL::Schema::Object; end
-      #
-      #   # Given some object in your app ...
-      #   class Types::Post < BaseObject
-      #   end
-      #
-      #   # Make a couple of base classes:
-      #   class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge; end
-      #   class Types::BaseConnection < GraphQL::Types::Relay::BaseConnection; end
-      #
-      #   # Then extend them for the object in your app
-      #   class Types::PostEdge < Types::BaseEdge
-      #     node_type Types::Post
-      #   end
-      #
-      #   class Types::PostConnection < Types::BaseConnection
-      #     edge_type Types::PostEdge,
-      #               edges_nullable: true,
-      #               edge_nullable: true,
-      #               node_nullable: true,
-      #               nodes_field: true
-      #
-      #     # Alternatively, you can call the class methods followed by your edge type
-      #     # edges_nullable true
-      #     # edge_nullable true
-      #     # node_nullable true
-      #     # has_nodes_field true
-      #     # edge_type Types::PostEdge
-      #   end
-      #
-      # @see Relay::BaseEdge for edge types
+      # See [Relay::BaseEdge](rdoc-ref:Relay::BaseEdge) for edge types
+      #
+      # **Examples**
+      #
+      # **Example: Implementation a connection and edge**
+      #
+      # ```ruby
+      # class BaseObject < GraphQL::Schema::Object; end
+      #
+      # # Given some object in your app ...
+      # class Types::Post < BaseObject
+      # end
+      #
+      # # Make a couple of base classes:
+      # class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge; end
+      # class Types::BaseConnection < GraphQL::Types::Relay::BaseConnection; end
+      #
+      # # Then extend them for the object in your app
+      # class Types::PostEdge < Types::BaseEdge
+      #   node_type Types::Post
+      # end
+      #
+      # class Types::PostConnection < Types::BaseConnection
+      #   edge_type Types::PostEdge,
+      #             edges_nullable: true,
+      #             edge_nullable: true,
+      #             node_nullable: true,
+      #             nodes_field: true
+      #
+      #   # Alternatively, you can call the class methods followed by your edge type
+      #   # edges_nullable true
+      #   # edge_nullable true
+      #   # node_nullable true
+      #   # has_nodes_field true
+      #   # edge_type Types::PostEdge
+      # end
+      # ```
       class BaseConnection < Schema::Object
         include ConnectionBehaviors
       end

data/lib/graphql/types/relay/base_edge.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     module Relay
@@ -10,17 +11,22 @@ module GraphQL
       # For example, you may want to extend your own `BaseObject` instead of the
       # built-in `GraphQL::Schema::Object`.
       #
-      # @example Making a UserEdge type
-      #   # Make a base class for your app
-      #   class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge
-      #   end
+      # See [GraphQL::Types::Relay::BaseConnection](rdoc-ref:GraphQL::Types::Relay::BaseConnection) for connection types
       #
-      #   # Then extend your own base class
-      #   class Types::UserEdge < Types::BaseEdge
-      #     node_type(Types::User)
-      #   end
+      # **Examples**
       #
-      # @see {Relay::BaseConnection} for connection types
+      # **Example: Making a UserEdge type**
+      #
+      # ```ruby
+      # # Make a base class for your app
+      # class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge
+      # end
+      #
+      # # Then extend your own base class
+      # class Types::UserEdge < Types::BaseEdge
+      #   node_type(Types::User)
+      # end
+      # ```
       class BaseEdge < GraphQL::Schema::Object
         include Types::Relay::EdgeBehaviors
       end

data/lib/graphql/types/relay/connection_behaviors.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
     module Relay
+      #--
+      # @requires_ancestor: GraphQL::Schema::Object
       module ConnectionBehaviors
         extend Forwardable
         def_delegators :@object, :cursor_from_node, :parent
@@ -14,6 +17,7 @@ module GraphQL
           child_class.edges_nullable(true)
           child_class.edge_nullable(true)
           child_class.module_exec {
+            #: self as GraphQL::Types::Relay::ConnectionBehaviors::ClassMethods
             self.edge_type = nil
             self.node_type = nil
             self.edge_class = nil
@@ -22,6 +26,8 @@ module GraphQL
           add_page_info_field(child_class)
         end
 
+        #--
+        # @requires_ancestor: singleton(GraphQL::Schema::Object)
         module ClassMethods
           def inherited(child_class)
             super
@@ -47,10 +53,14 @@ module GraphQL
             @default_broadcastable = new_value
           end
 
-          # @return [Class]
+          # **Returns**
+          #
+          # - `Class`
           attr_reader :node_type
 
-          # @return [Class]
+          # **Returns**
+          #
+          # - `Class`
           attr_reader :edge_class
 
           # Configure this connection to return `edges` and `nodes` based on `edge_type_class`.
@@ -63,7 +73,13 @@ module GraphQL
           # It's called when you subclass this base connection, trying to use the
           # class name to set defaults. You can call it again in the class definition
           # to override the default (or provide a value, if the default lookup failed).
-          # @param field_options [Hash] Any extra keyword arguments to pass to the `field :edges, ...` and `field :nodes, ...` configurations
+          #
+          # **Parameters**
+          #
+          # - `field_options` (`Hash`) — Any extra keyword arguments to pass to the `field :edges, ...` and `field :nodes, ...` configurations
+          #
+          # :call-seq:
+          #   edge_type(edge_type_class, edge_class:, node_type:, nodes_field:, node_nullable:, edges_nullable:, edge_nullable:, Hash field_options:)
           def edge_type(edge_type_class, edge_class: GraphQL::Pagination::Connection::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil)
             # Set this connection's graphql name
             node_type_name = node_type.graphql_name

data/lib/graphql/types/relay/edge_behaviors.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
     module Relay
+      #--
+      # @requires_ancestor: GraphQL::Schema::Object
       module EdgeBehaviors
         def self.included(child_class)
           child_class.description("An edge in a connection.")
           child_class.field(:cursor, String, null: false, description: "A cursor for use in pagination.")
           child_class.extend(ClassMethods)
-          child_class.class_exec { self.node_type = nil }
+          child_class.class_exec {
+            #: self as GraphQL::Types::Relay::EdgeBehaviors::ClassMethods
+            self.node_type = nil
+          }
           child_class.node_nullable(true)
           child_class.default_broadcastable(nil)
         end
@@ -21,6 +27,8 @@ module GraphQL
           @object.node
         end
 
+        #--
+        # @requires_ancestor: singleton(GraphQL::Schema::Object)
         module ClassMethods
           def inherited(child_class)
             super
@@ -43,9 +51,14 @@ module GraphQL
 
           # Get or set the Object type that this edge wraps.
           #
-          # @param node_type [Class] A `Schema::Object` subclass
-          # @param null [Boolean]
-          # @param field_options [Hash] Any extra arguments to pass to the `field :node` configuration
+          # **Parameters**
+          #
+          # - `node_type` (`Class`) — A `Schema::Object` subclass
+          # - `null` (`Boolean`)
+          # - `field_options` (`Hash`) — Any extra arguments to pass to the `field :node` configuration
+          #
+          # :call-seq:
+          #   node_type(Class node_type, bool null:, Hash field_options:)
           def node_type(node_type = nil, null: self.node_nullable, field_options: nil)
             if node_type
               @node_type = node_type

data/lib/graphql/types/relay/has_node_field.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
     module Relay
       # Include this module to your root Query type to get a Relay-compliant `node(id: ID!): Node` field that uses the schema's `object_from_id` hook.
+      #--
+      # @requires_ancestor: GraphQL::Schema::Object
       module HasNodeField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
@@ -17,7 +20,8 @@ module GraphQL
         end
 
         def get_relay_node(id:)
-          self.class.get_relay_node(context, id: id)
+          query_class = self.class #: as GraphQL::Types::Relay::HasNodeField::ExecutionMethods
+          query_class.get_relay_node(context, id: id)
         end
 
         class << self
@@ -35,6 +39,7 @@ module GraphQL
 
           def field_block
             Proc.new {
+              #: self as GraphQL::Schema::Field
               argument :id, "ID!",
                 description: "ID of the object."
             }

data/lib/graphql/types/relay/has_nodes_field.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
     module Relay
       # Include this module to your root Query type to get a Relay-style `nodes(id: ID!): [Node]` field that uses the schema's `object_from_id` hook.
+      #--
+      # @requires_ancestor: GraphQL::Schema::Object
       module HasNodesField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
@@ -17,7 +20,8 @@ module GraphQL
         end
 
         def get_relay_nodes(ids:)
-          self.class.get_relay_nodes(context, ids: ids)
+          query_class = self.class #: as GraphQL::Types::Relay::HasNodesField::ExecutionMethods
+          query_class.get_relay_nodes(context, ids: ids)
         end
 
         class << self
@@ -35,6 +39,7 @@ module GraphQL
 
           def field_block
             Proc.new {
+              #: self as GraphQL::Schema::Field
               argument :ids, "[ID!]!",
                 description: "IDs of the objects."
             }

data/lib/graphql/types/relay/node.rb

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

data/lib/graphql/types/relay/node_behaviors.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Types
     module Relay
+      #--
+      # @requires_ancestor: GraphQL::Schema::Object
       module NodeBehaviors
         def self.included(child_module)
           child_module.extend(ClassMethods)
@@ -12,7 +15,8 @@ module GraphQL
         end
 
         def default_global_id
-          self.class.default_global_id(object, context)
+          node_class = self.class #: as GraphQL::Types::Relay::NodeBehaviors::ExecutionMethods
+          node_class.default_global_id(object, context)
         end
 
         module ClassMethods

data/lib/graphql/types/relay/page_info.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     module Relay

data/lib/graphql/types/relay/page_info_behaviors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Types
     module Relay

data/lib/graphql/types/relay.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 # behavior modules:
 require "graphql/types/relay/connection_behaviors"
@@ -23,11 +24,11 @@ module GraphQL
     # open up the source files and copy the relevant methods and configuration into
     # your own classes.
     #
-    # For example, the provided object types extend {Types::Relay::BaseObject},
+    # For example, the provided object types extend `Types::Relay::BaseObject`,
     # but you might want to:
     #
-    # 1. Migrate the extensions from {Types::Relay::BaseObject} into _your app's_ base object
-    # 2. Copy {Relay::BaseConnection}, {Relay::BaseEdge}, etc into _your app_, and
+    # 1. Migrate the extensions from `Types::Relay::BaseObject` into _your app's_ base object
+    # 2. Copy [Relay::BaseConnection](rdoc-ref:Relay::BaseConnection), [Relay::BaseEdge](rdoc-ref:Relay::BaseEdge), etc into _your app_, and
     #   change them to extend _your_ base object.
     #
     # Similarly, `BaseField`'s extensions could be migrated to your app

data/lib/graphql/types/string.rb

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

data/lib/graphql/types.rb

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

data/lib/graphql/unauthorized_enum_value_error.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class UnauthorizedEnumValueError < GraphQL::UnauthorizedError
-    # @return [GraphQL::Schema::EnumValue] The value whose `#authorized?` check returned false
+    # **Returns**
+    #
+    # - `GraphQL::Schema::EnumValue` — The value whose `#authorized?` check returned false
     attr_accessor :enum_value
 
     def initialize(type:, context:, enum_value:)

data/lib/graphql/unauthorized_error.rb

@@ -1,17 +1,24 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   # When an `authorized?` hook returns false, this error is used to communicate the failure.
-  # It's passed to {Schema.unauthorized_object}.
+  # It's passed to [Schema.unauthorized_object](rdoc-ref:Schema.unauthorized_object).
   #
   # Alternatively, custom code in `authorized?` may raise this error. It will be routed the same way.
   class UnauthorizedError < GraphQL::RuntimeError
-    # @return [Object] the application object that failed the authorization check
+    # **Returns**
+    #
+    # - `Object` — the application object that failed the authorization check
     attr_reader :object
 
-    # @return [Class] the GraphQL object type whose `.authorized?` method was called (and returned false)
+    # **Returns**
+    #
+    # - `Class` — the GraphQL object type whose `.authorized?` method was called (and returned false)
     attr_reader :type
 
-    # @return [GraphQL::Query::Context] the context for the current query
+    # **Returns**
+    #
+    # - `GraphQL::Query::Context` — the context for the current query
     attr_accessor :context
 
     def initialize(message = nil, object: nil, type: nil, context: nil)

data/lib/graphql/unauthorized_field_error.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class UnauthorizedFieldError < GraphQL::UnauthorizedError
-    # @return [Field] the field that failed the authorization check
+    # **Returns**
+    #
+    # - `Field` — the field that failed the authorization check
     attr_accessor :field
 
     def initialize(message = nil, object: nil, type: nil, context: nil, field: nil)