graphql 1.9.18 → 1.13.24

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: 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.
+      module HasNodeField
+        def self.included(child_class)
+          child_class.field(**field_options, &field_block)
+        end
+
+        class << self
+          def field_options
+            {
+              name: "node",
+              type: GraphQL::Types::Relay::Node,
+              null: true,
+              description: "Fetches an object given its ID.",
+              relay_node_field: true,
+            }
+          end
+
+          def field_block
+            Proc.new {
+              argument :id, "ID!",
+                description: "ID of the object."
+
+              def resolve(obj, args, ctx)
+                ctx.schema.object_from_id(args[:id], ctx)
+              end
+
+              def resolve_field(obj, args, ctx)
+                resolve(obj, args, ctx)
+              end
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: 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.
+      module HasNodesField
+        def self.included(child_class)
+          child_class.field(**field_options, &field_block)
+        end
+
+        class << self
+          def field_options
+            {
+              name: "nodes",
+              type: [GraphQL::Types::Relay::Node, null: true],
+              null: false,
+              description: "Fetches a list of objects given a list of IDs.",
+              relay_nodes_field: true,
+            }
+          end
+
+          def field_block
+            Proc.new {
+              argument :ids, "[ID!]!",
+                description: "IDs of the objects."
+
+              def resolve(obj, args, ctx)
+                args[:ids].map { |id| ctx.schema.object_from_id(id, ctx) }
+              end
+
+              def resolve_field(obj, args, ctx)
+                resolve(obj, args, ctx)
+              end
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,10 +7,8 @@ module GraphQL
       # or you can take it as inspiration for your own implementation
       # of the `Node` interface.
       module Node
-        include Types::Relay::BaseInterface
-        default_relay(true)
-        description "An object with an ID."
-        field(:id, ID, null: false, description: "ID of the object.")
+        include GraphQL::Schema::Interface
+        include Types::Relay::NodeBehaviors
       end
     end
   end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Types
+    module Relay
+      module NodeBehaviors
+        def self.included(child_module)
+          child_module.extend(DefaultRelay)
+          child_module.description("An object with an ID.")
+          child_module.field(:id, ID, null: false, description: "ID of the object.")
+        end
+      end
+    end
+  end
+end

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

@@ -2,11 +2,10 @@
 module GraphQL
   module Types
     module Relay
-      # This can be used for implementing `Query.node(id: ...)`,
-      # or use it for inspiration for your own field definition.
+      # Don't use this field directly, instead, use one of these approaches:
       #
       # @example Adding this field directly
-      #   add_field(GraphQL::Types::Relay::NodeField)
+      #   include GraphQL::Types::Relay::HasNodeField
       #
       # @example Implementing a similar field in your own Query root
       #
@@ -19,25 +18,7 @@ module GraphQL
       #     context.schema.object_from_id(id, context)
       #   end
       #
-      NodeField = GraphQL::Schema::Field.new(
-        name: "node",
-        owner: nil,
-        type: GraphQL::Types::Relay::Node,
-        null: true,
-        description: "Fetches an object given its ID.",
-        relay_node_field: true,
-      ) do
-        argument :id, "ID!", required: true,
-          description: "ID of the object."
-
-        def resolve(obj, args, ctx)
-          ctx.schema.object_from_id(args[:id], ctx)
-        end
-
-        def resolve_field(obj, args, ctx)
-          resolve(obj, args, ctx)
-        end
-      end
+      DeprecatedNodeField = GraphQL::Schema::Field.new(owner: nil, **HasNodeField.field_options, &HasNodeField.field_block)
     end
   end
 end

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

@@ -2,11 +2,10 @@
 module GraphQL
   module Types
     module Relay
-      # This can be used for implementing `Query.nodes(ids: ...)`,
-      # or use it for inspiration for your own field definition.
+      # Don't use this directly, instead, use one of these:
       #
       # @example Adding this field directly
-      #   add_field(GraphQL::Types::Relay::NodesField)
+      #   include GraphQL::Types::Relay::HasNodesField
       #
       # @example Implementing a similar field in your own Query root
       #
@@ -21,25 +20,24 @@ module GraphQL
       #     end
       #   end
       #
-      NodesField = GraphQL::Schema::Field.new(
-        name: "nodes",
-        owner: nil,
-        type: [GraphQL::Types::Relay::Node, null: true],
-        null: false,
-        description: "Fetches a list of objects given a list of IDs.",
-        relay_nodes_field: true,
-      ) do
-        argument :ids, "[ID!]!", required: true,
-          description: "IDs of the objects."
+      def self.const_missing(const_name)
+        if const_name == :NodesField
+          message = "NodesField is deprecated, use `include GraphQL::Types::Relay::HasNodesField` instead."
+          message += "\n(referenced from #{caller(1, 1).first})"
+          GraphQL::Deprecation.warn(message)
 
-        def resolve(obj, args, ctx)
-          args[:ids].map { |id| ctx.schema.object_from_id(id, ctx) }
-        end
+          DeprecatedNodesField
+        elsif const_name == :NodeField
+          message = "NodeField is deprecated, use `include GraphQL::Types::Relay::HasNodeField` instead."
+          message += "\n(referenced from #{caller(1, 1).first})"
+          GraphQL::Deprecation.warn(message)
 
-        def resolve_field(obj, args, ctx)
-          resolve(obj, args, ctx)
+          DeprecatedNodeField
+        else
+          super
         end
       end
+      DeprecatedNodesField = GraphQL::Schema::Field.new(owner: nil, **HasNodesField.field_options, &HasNodesField.field_block)
     end
   end
 end

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

@@ -3,20 +3,8 @@ module GraphQL
   module Types
     module Relay
       # The return type of a connection's `pageInfo` field
-      class PageInfo < Types::Relay::BaseObject
-        default_relay true
-        description "Information about pagination in a connection."
-        field :has_next_page, Boolean, null: false,
-          description: "When paginating forwards, are there more items?"
-
-        field :has_previous_page, Boolean, null: false,
-          description: "When paginating backwards, are there more items?"
-
-        field :start_cursor, String, null: true,
-          description: "When paginating backwards, the cursor to continue."
-
-        field :end_cursor, String, null: true,
-          description: "When paginating forwards, the cursor to continue."
+      class PageInfo < GraphQL::Schema::Object
+        include PageInfoBehaviors
       end
     end
   end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  module Types
+    module Relay
+      module PageInfoBehaviors
+        def self.included(child_class)
+          child_class.extend GraphQL::Types::Relay::DefaultRelay
+
+          child_class.description "Information about pagination in a connection."
+          child_class.field :has_next_page, Boolean, null: false,
+            description: "When paginating forwards, are there more items?"
+
+          child_class.field :has_previous_page, Boolean, null: false,
+            description: "When paginating backwards, are there more items?"
+
+          child_class.field :start_cursor, String, null: true,
+            description: "When paginating backwards, the cursor to continue."
+
+          child_class.field :end_cursor, String, null: true,
+            description: "When paginating forwards, the cursor to continue."
+        end
+      end
+    end
+  end
+end

data/lib/graphql/types/relay.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
-require "graphql/types/relay/base_field"
-require "graphql/types/relay/base_object"
-require "graphql/types/relay/base_interface"
+
+# behavior modules:
+require "graphql/types/relay/default_relay"
+require "graphql/types/relay/connection_behaviors"
+require "graphql/types/relay/edge_behaviors"
+require "graphql/types/relay/node_behaviors"
+require "graphql/types/relay/page_info_behaviors"
+require "graphql/types/relay/has_node_field"
+require "graphql/types/relay/has_nodes_field"
+
+# concrete classes based on the gem defaults:
 require "graphql/types/relay/page_info"
 require "graphql/types/relay/base_connection"
 require "graphql/types/relay/base_edge"

data/lib/graphql/types/string.rb

@@ -7,9 +7,15 @@ module GraphQL
 
       def self.coerce_result(value, ctx)
         str = value.to_s
-        str.encoding == Encoding::UTF_8 ? str : str.encode(Encoding::UTF_8)
+        if str.ascii_only? || str.encoding == Encoding::UTF_8
+          str
+        elsif str.frozen?
+          str.encode(Encoding::UTF_8)
+        else
+          str.encode!(Encoding::UTF_8)
+        end
       rescue EncodingError
-        err = GraphQL::StringEncodingError.new(str)
+        err = GraphQL::StringEncodingError.new(str, context: ctx)
         ctx.schema.type_error(err, ctx)
       end
 

data/lib/graphql/unauthorized_error.rb

@@ -12,7 +12,7 @@ module GraphQL
     attr_reader :type
 
     # @return [GraphQL::Query::Context] the context for the current query
-    attr_reader :context
+    attr_accessor :context
 
     def initialize(message = nil, object: nil, type: nil, context: nil)
       if message.nil? && object.nil? && type.nil?
@@ -22,7 +22,7 @@ module GraphQL
       @object = object
       @type = type
       @context = context
-      message ||= "An instance of #{object.class} failed #{type.name}'s authorization check"
+      message ||= "An instance of #{object.class} failed #{type.graphql_name}'s authorization check"
       super(message)
     end
   end

data/lib/graphql/union_type.rb

@@ -1,29 +1,9 @@
 # frozen_string_literal: true
 module GraphQL
-  # A Union is is a collection of object types which may appear in the same place.
-  #
-  # The members of a union are declared with `possible_types`.
-  #
-  # @example A union of object types
-  #   MediaUnion = GraphQL::UnionType.define do
-  #     name "Media"
-  #     description "Media objects which you can enjoy"
-  #     possible_types [AudioType, ImageType, VideoType]
-  #   end
-  #
-  # A union itself has no fields; only its members have fields.
-  # So, when you query, you must use fragment spreads to access fields.
-  #
-  # @example Querying for fields on union members
-  #  {
-  #    searchMedia(name: "Jens Lekman") {
-  #      ... on Audio { name, duration }
-  #      ... on Image { name, height, width }
-  #      ... on Video { name, length, quality }
-  #    }
-  #  }
-  #
+  # @api deprecated
   class UnionType < GraphQL::BaseType
+    extend Define::InstanceDefinable::DeprecatedDefine
+
     # Rubocop was unhappy about the syntax when this was a proc literal
     class AcceptPossibleTypesDefinition
       def self.call(target, possible_types, options = {})
@@ -31,7 +11,7 @@ module GraphQL
       end
     end
 
-    accepts_definitions :resolve_type, :type_membership_class,
+    deprecated_accepts_definitions :resolve_type, :type_membership_class,
       possible_types: AcceptPossibleTypesDefinition
     ensure_defined :possible_types, :resolve_type, :resolve_type_proc, :type_membership_class
 
@@ -96,7 +76,7 @@ module GraphQL
     # @return [GraphQL::ObjectType, nil] The type named `type_name` if it exists and is a member of this {UnionType}, (else `nil`)
     def get_possible_type(type_name, ctx)
       type = ctx.query.get_type(type_name)
-      type if type && ctx.query.schema.possible_types(self, ctx).include?(type)
+      type if type && ctx.query.warden.possible_types(self).include?(type)
     end
 
     # Check if a type is a possible type of this {UnionType}

data/lib/graphql/unresolved_type_error.rb

@@ -24,8 +24,8 @@ module GraphQL
       @parent_type = parent_type
       @resolved_type = resolved_type
       @possible_types = possible_types
-      message = "The value from \"#{field.name}\" on \"#{parent_type}\" could not be resolved to \"#{field.type}\". " \
-        "(Received: `#{resolved_type.inspect}`, Expected: [#{possible_types.map(&:inspect).join(", ")}]) " \
+      message = "The value from \"#{field.graphql_name}\" on \"#{parent_type.graphql_name}\" could not be resolved to \"#{field.type.to_type_signature}\". " \
+        "(Received: `#{resolved_type.inspect}`, Expected: [#{possible_types.map(&:graphql_name).join(", ")}]) " \
         "Make sure you have defined a `resolve_type` proc on your schema and that value `#{value.inspect}` " \
         "gets resolved to a valid type. You may need to add your type to `orphan_types` if it implements an " \
         "interface but isn't a return type of any other field."

data/lib/graphql/upgrader/member.rb

@@ -771,6 +771,7 @@ module GraphQL
 
     class Member
       def initialize(member, skip: SkipOnNullKeyword, type_transforms: DEFAULT_TYPE_TRANSFORMS, field_transforms: DEFAULT_FIELD_TRANSFORMS, clean_up_transforms: DEFAULT_CLEAN_UP_TRANSFORMS)
+        GraphQL::Deprecation.warn "#{self.class} will be removed from GraphQL-Ruby 2.0 (but there's no point in using it after you've transformed your code, anyways)"
         @member = member
         @skip = skip
         @type_transforms = type_transforms

data/lib/graphql/upgrader/schema.rb

@@ -4,6 +4,7 @@ module GraphQL
   module Upgrader
     class Schema
       def initialize(schema)
+        GraphQL::Deprecation.warn "#{self.class} will be removed from GraphQL-Ruby 2.0 (but there's no point in using it after you've transformed your code, anyways)"
         @schema = schema
       end
 

data/lib/graphql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GraphQL
-  VERSION = "1.9.18"
+  VERSION = "1.13.24"
 end

data/lib/graphql.rb

@@ -4,15 +4,42 @@ require "json"
 require "set"
 require "singleton"
 require "forwardable"
-require_relative "./graphql/railtie" if defined? Rails::Railtie
+require "ostruct"
 
 module GraphQL
+  # forwards-compat for argument handling
+  module Ruby2Keywords
+    if RUBY_VERSION < "2.7"
+      def ruby2_keywords(*)
+      end
+    end
+  end
+
   class Error < StandardError
   end
 
+  # This error is raised when GraphQL-Ruby encounters a situation
+  # that it *thought* would never happen. Please report this bug!
+  class InvariantError < Error
+    def initialize(message)
+      message += "
+
+This is probably a bug in GraphQL-Ruby, please report this error on GitHub: https://github.com/rmosolgo/graphql-ruby/issues/new?template=bug_report.md"
+      super(message)
+    end
+  end
+
   class RequiredImplementationMissingError < Error
   end
 
+  class << self
+    def default_parser
+      @default_parser ||= GraphQL::Language::Parser
+    end
+
+    attr_writer :default_parser
+  end
+
   # Turn a query string or schema definition into an AST
   # @param graphql_string [String] a GraphQL query string or schema definition
   # @return [GraphQL::Language::Nodes::Document]
@@ -40,28 +67,26 @@ module GraphQL
   def self.scan_with_ragel(graphql_string)
     GraphQL::Language::Lexer.tokenize(graphql_string)
   end
-
-  # Support Ruby 2.2 by implementing `-"str"`. If we drop 2.2 support, we can remove this backport.
-  module StringDedupBackport
-    refine String do
-      def -@
-        if frozen?
-          self
-        else
-          self.dup.freeze
-        end
-      end
-    end
-  end
 end
 
 # Order matters for these:
 
 require "graphql/execution_error"
+require "graphql/runtime_type_error"
+require "graphql/unresolved_type_error"
+require "graphql/invalid_null_error"
+require "graphql/analysis_error"
+require "graphql/coercion_error"
+require "graphql/invalid_name_error"
+require "graphql/integer_decoding_error"
+require "graphql/integer_encoding_error"
+require "graphql/string_encoding_error"
+require "graphql/date_encoding_error"
+
 require "graphql/define"
+require "graphql/deprecation"
 require "graphql/base_type"
 require "graphql/object_type"
-
 require "graphql/enum_type"
 require "graphql/input_object_type"
 require "graphql/interface_type"
@@ -79,15 +104,23 @@ require "graphql/scalar_type"
 require "graphql/name_validator"
 
 require "graphql/language"
+
+require_relative "./graphql/railtie" if defined? Rails::Railtie
+
 require "graphql/analysis"
 require "graphql/tracing"
-require "graphql/execution"
 require "graphql/dig"
+require "graphql/execution"
+require "graphql/pagination"
 require "graphql/schema"
+require "graphql/query"
+require "graphql/types"
+require "graphql/dataloader"
+require "graphql/filter"
+require "graphql/internal_representation"
 require "graphql/directive"
+require "graphql/static_validation"
 require "graphql/execution"
-require "graphql/types"
-require "graphql/relay"
 require "graphql/boolean_type"
 require "graphql/float_type"
 require "graphql/id_type"
@@ -97,23 +130,11 @@ require "graphql/schema/built_in_types"
 require "graphql/schema/loader"
 require "graphql/schema/printer"
 require "graphql/introspection"
+require "graphql/relay"
 
-require "graphql/analysis_error"
-require "graphql/coercion_error"
-require "graphql/literal_validation_error"
-require "graphql/runtime_type_error"
-require "graphql/invalid_null_error"
-require "graphql/invalid_name_error"
-require "graphql/unresolved_type_error"
-require "graphql/integer_encoding_error"
-require "graphql/string_encoding_error"
-require "graphql/query"
-require "graphql/internal_representation"
-require "graphql/static_validation"
 require "graphql/version"
 require "graphql/compatibility"
 require "graphql/function"
-require "graphql/filter"
 require "graphql/subscriptions"
 require "graphql/parse_error"
 require "graphql/backtrace"
@@ -123,3 +144,38 @@ require "graphql/authorization"
 require "graphql/unauthorized_error"
 require "graphql/unauthorized_field_error"
 require "graphql/load_application_object_failed_error"
+require "graphql/directive/include_directive"
+require "graphql/directive/skip_directive"
+require "graphql/directive/deprecated_directive"
+
+module GraphQL
+  # Ruby has `deprecate_constant`,
+  # but I don't see a way to give a nice error message in that case,
+  # so I'm doing this instead.
+  DEPRECATED_INT_TYPE = INT_TYPE
+  DEPRECATED_FLOAT_TYPE = FLOAT_TYPE
+  DEPRECATED_STRING_TYPE = STRING_TYPE
+  DEPRECATED_BOOLEAN_TYPE = BOOLEAN_TYPE
+  DEPRECATED_ID_TYPE = ID_TYPE
+
+  remove_const :INT_TYPE
+  remove_const :FLOAT_TYPE
+  remove_const :STRING_TYPE
+  remove_const :BOOLEAN_TYPE
+  remove_const :ID_TYPE
+
+  def self.const_missing(const_name)
+    deprecated_const_name = :"DEPRECATED_#{const_name}"
+    if const_defined?(deprecated_const_name)
+      deprecated_type = const_get(deprecated_const_name)
+      deprecated_caller = caller(1, 1).first
+      # Don't warn about internal uses, like `types.Int`
+      if !deprecated_caller.include?("lib/graphql")
+        warn "GraphQL::#{const_name} is deprecated and will be removed in GraphQL-Ruby 2.0, use GraphQL::Types::#{deprecated_type.graphql_name} instead. (from #{deprecated_caller})"
+      end
+      deprecated_type
+    else
+      super
+    end
+  end
+end

data/readme.md

@@ -1,15 +1,12 @@
 # graphql <img src="https://cloud.githubusercontent.com/assets/2231765/9094460/cb43861e-3b66-11e5-9fbf-71066ff3ab13.png" height="40" alt="graphql-ruby"/>
 
-[![Build Status](https://travis-ci.org/rmosolgo/graphql-ruby.svg?branch=master)](https://travis-ci.org/rmosolgo/graphql-ruby)
+[![CI Suite](https://github.com/rmosolgo/graphql-ruby/actions/workflows/ci.yaml/badge.svg)](https://github.com/rmosolgo/graphql-ruby/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/graphql.svg)](https://rubygems.org/gems/graphql)
-[![Code Climate](https://codeclimate.com/github/rmosolgo/graphql-ruby/badges/gpa.svg)](https://codeclimate.com/github/rmosolgo/graphql-ruby)
-[![Test Coverage](https://codeclimate.com/github/rmosolgo/graphql-ruby/badges/coverage.svg)](https://codeclimate.com/github/rmosolgo/graphql-ruby)
-[![built with love](https://cloud.githubusercontent.com/assets/2231765/6766607/d07992c6-cfc9-11e4-813f-d9240714dd50.png)](https://rmosolgo.github.io/react-badges/)
 
 A Ruby implementation of [GraphQL](https://graphql.org/).
 
 - [Website](https://graphql-ruby.org/)
-- [API Documentation](https://www.rubydoc.info/gems/graphql)
+- [API Documentation](https://www.rubydoc.info/github/rmosolgo/graphql-ruby)
 - [Newsletter](https://tinyletter.com/graphql-ruby)
 
 ## Installation
@@ -47,6 +44,6 @@ I also sell [GraphQL::Pro](https://graphql.pro) which provides several features
 
 ## Getting Involved
 
-- __Say hi & ask questions__ in the [#ruby channel on Slack](https://graphql-slack.herokuapp.com/) or [on Twitter](https://twitter.com/rmosolgo)!
+- __Say hi & ask questions__ in the #graphql-ruby channel on [Discord](https://discord.com/invite/xud7bH9) or [on Twitter](https://twitter.com/rmosolgo)!
 - __Report bugs__ by posting a description, full stack trace, and all relevant code in a  [GitHub issue](https://github.com/rmosolgo/graphql-ruby/issues).
 - __Start hacking__ with the [Development guide](https://graphql-ruby.org/development).