graphql 1.10.2 → 2.0.21

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

@@ -10,6 +10,8 @@ module GraphQL
       # 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
@@ -20,103 +22,27 @@ module GraphQL
       #
       #   # Then extend them for the object in your app
       #   class Types::PostEdge < Types::BaseEdge
-      #     node_type(Types::Post)
+      #     node_type Types::Post
       #   end
+      #
       #   class Types::PostConnection < Types::BaseConnection
-      #     edge_type(Types::PostEdge)
+      #     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
-      class BaseConnection < Types::Relay::BaseObject
-        extend Forwardable
-        def_delegators :@object, :cursor_from_node, :parent
-
-        class << self
-          # @return [Class]
-          attr_reader :node_type
-
-          # @return [Class]
-          attr_reader :edge_class
-
-          # Configure this connection to return `edges` and `nodes` based on `edge_type_class`.
-          #
-          # This method will use the inputs to create:
-          # - `edges` field
-          # - `nodes` field
-          # - description
-          #
-          # 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).
-          def edge_type(edge_type_class, edge_class: GraphQL::Relay::Edge, node_type: edge_type_class.node_type, nodes_field: true)
-            # Set this connection's graphql name
-            node_type_name = node_type.graphql_name
-
-            @node_type = node_type
-            @edge_type = edge_type_class
-            @edge_class = edge_class
-
-            field :edges, [edge_type_class, null: true],
-              null: true,
-              description: "A list of edges.",
-              edge_class: edge_class
-
-            define_nodes_field if nodes_field
-
-            description("The connection type for #{node_type_name}.")
-          end
-
-          # Filter this list according to the way its node type would scope them
-          def scope_items(items, context)
-            node_type.scope_items(items, context)
-          end
-
-          # Add the shortcut `nodes` field to this connection and its subclasses
-          def nodes_field
-            define_nodes_field
-          end
-
-          def authorized?(obj, ctx)
-            true # Let nodes be filtered out
-          end
-
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
-          def visible?(ctx)
-            node_type.visible?(ctx)
-          end
-
-          private
-
-          def define_nodes_field
-            field :nodes, [@node_type, null: true],
-              null: true,
-              description: "A list of nodes."
-          end
-        end
-
-        field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
-
-        # By default this calls through to the ConnectionWrapper's edge nodes method,
-        # but sometimes you need to override it to support the `nodes` field
-        def nodes
-          @object.edge_nodes
-        end
-
-        def edges
-          if @object.is_a?(GraphQL::Pagination::Connection)
-            @object.edges
-          elsif context.interpreter?
-            context.schema.after_lazy(object.edge_nodes) do |nodes|
-              nodes.map { |n| self.class.edge_class.new(n, object) }
-            end
-          else
-            # This is done by edges_instrumentation
-            @object.edge_nodes
-          end
-        end
+      class BaseConnection < Schema::Object
+        include ConnectionBehaviors
       end
     end
   end

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

@@ -21,40 +21,8 @@ module GraphQL
       #   end
       #
       # @see {Relay::BaseConnection} for connection types
-      class BaseEdge < Types::Relay::BaseObject
-        description "An edge in a connection."
-
-        class << self
-          # Get or set the Object type that this edge wraps.
-          #
-          # @param node_type [Class] A `Schema::Object` subclass
-          # @param null [Boolean]
-          def node_type(node_type = nil, null: true)
-            if node_type
-              @node_type = node_type
-              # Add a default `node` field
-              field :node, node_type, null: null, description: "The item at the end of the edge."
-            end
-            @node_type
-          end
-
-          def authorized?(obj, ctx)
-            true
-          end
-
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
-          def visible?(ctx)
-            node_type.visible?(ctx)
-          end
-        end
-
-
-        field :cursor, String,
-          null: false,
-          description: "A cursor for use in pagination."
+      class BaseEdge < GraphQL::Schema::Object
+        include Types::Relay::EdgeBehaviors
       end
     end
   end

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

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Types
+    module Relay
+      module ConnectionBehaviors
+        extend Forwardable
+        def_delegators :@object, :cursor_from_node, :parent
+
+        def self.included(child_class)
+          child_class.extend(ClassMethods)
+          child_class.has_nodes_field(true)
+          child_class.node_nullable(true)
+          child_class.edges_nullable(true)
+          child_class.edge_nullable(true)
+          child_class.module_eval {
+            self.edge_type = nil
+            self.node_type = nil
+            self.edge_class = nil
+          }
+          add_page_info_field(child_class)
+        end
+
+        module ClassMethods
+          def inherited(child_class)
+            super
+            child_class.has_nodes_field(has_nodes_field)
+            child_class.node_nullable(node_nullable)
+            child_class.edges_nullable(edges_nullable)
+            child_class.edge_nullable(edge_nullable)
+            child_class.edge_type = nil
+            child_class.node_type = nil
+            child_class.edge_class = nil
+          end
+
+          def default_relay?
+            true
+          end
+
+          # @return [Class]
+          attr_reader :node_type
+
+          # @return [Class]
+          attr_reader :edge_class
+
+          # Configure this connection to return `edges` and `nodes` based on `edge_type_class`.
+          #
+          # This method will use the inputs to create:
+          # - `edges` field
+          # - `nodes` field
+          # - description
+          #
+          # 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
+          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
+
+            @node_type = node_type
+            @edge_type = edge_type_class
+            @edge_class = edge_class
+
+            base_field_options = {
+              name: :edges,
+              type: [edge_type_class, null: edge_nullable],
+              null: edges_nullable,
+              description: "A list of edges.",
+              connection: false,
+              # Assume that the connection was scoped before this step:
+              scope: false,
+            }
+
+            if field_options
+              base_field_options.merge!(field_options)
+            end
+
+            field(**base_field_options)
+
+            define_nodes_field(node_nullable, field_options: field_options) if nodes_field
+
+            description("The connection type for #{node_type_name}.")
+          end
+
+          # Filter this list according to the way its node type would scope them
+          def scope_items(items, context)
+            node_type.scope_items(items, context)
+          end
+
+          # Add the shortcut `nodes` field to this connection and its subclasses
+          def nodes_field(node_nullable: self.node_nullable, field_options: nil)
+            define_nodes_field(node_nullable, field_options: field_options)
+          end
+
+          def authorized?(obj, ctx)
+            true # Let nodes be filtered out
+          end
+
+          def visible?(ctx)
+            # if this is an abstract base class, there may be no `node_type`
+            node_type ? node_type.visible?(ctx) : super
+          end
+
+          # Set the default `node_nullable` for this class and its child classes. (Defaults to `true`.)
+          # Use `node_nullable(false)` in your base class to make non-null `node` and `nodes` fields.
+          def node_nullable(new_value = nil)
+            if new_value.nil?
+              defined?(@node_nullable) ? @node_nullable : superclass.node_nullable
+            else
+              @node_nullable = new_value
+            end
+          end
+
+          # Set the default `edges_nullable` for this class and its child classes. (Defaults to `true`.)
+          # Use `edges_nullable(false)` in your base class to make non-null `edges` fields.
+          def edges_nullable(new_value = nil)
+            if new_value.nil?
+              defined?(@edges_nullable) ? @edges_nullable : superclass.edges_nullable
+            else
+              @edges_nullable = new_value
+            end
+          end
+
+          # Set the default `edge_nullable` for this class and its child classes. (Defaults to `true`.)
+          # Use `edge_nullable(false)` in your base class to make non-null `edge` fields.
+          def edge_nullable(new_value = nil)
+            if new_value.nil?
+              defined?(@edge_nullable) ? @edge_nullable : superclass.edge_nullable
+            else
+              @edge_nullable = new_value
+            end
+          end
+
+          # Set the default `nodes_field` for this class and its child classes. (Defaults to `true`.)
+          # Use `nodes_field(false)` in your base class to prevent adding of a nodes field.
+          def has_nodes_field(new_value = nil)
+            if new_value.nil?
+              defined?(@nodes_field) ? @nodes_field : superclass.has_nodes_field
+            else
+              @nodes_field = new_value
+            end
+          end
+
+          protected
+
+          attr_writer :edge_type, :node_type,  :edge_class
+
+          private
+
+          def define_nodes_field(nullable, field_options: nil)
+            base_field_options = {
+              name: :nodes,
+              type: [@node_type, null: nullable],
+              null: nullable,
+              description: "A list of nodes.",
+              connection: false,
+              # Assume that the connection was scoped before this step:
+              scope: false,
+            }
+            if field_options
+              base_field_options.merge!(field_options)
+            end
+            field(**base_field_options)
+          end
+        end
+
+        class << self
+          def add_page_info_field(obj_type)
+            obj_type.field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Types
+    module Relay
+      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_eval { self.node_type = nil }
+          child_class.node_nullable(true)
+        end
+
+        module ClassMethods
+          def inherited(child_class)
+            super
+            child_class.node_type = nil
+            child_class.node_nullable = nil
+          end
+
+          def default_relay?
+            true
+          end
+
+          # 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
+          def node_type(node_type = nil, null: self.node_nullable, field_options: nil)
+            if node_type
+              @node_type = node_type
+              # Add a default `node` field
+              base_field_options = {
+                name: :node,
+                type: node_type,
+                null: null,
+                description: "The item at the end of the edge.",
+                connection: false,
+              }
+              if field_options
+                base_field_options.merge!(field_options)
+              end
+              field(**base_field_options)
+            end
+            @node_type
+          end
+
+          def authorized?(obj, ctx)
+            true
+          end
+
+          def visible?(ctx)
+            node_type.visible?(ctx)
+          end
+
+          # Set the default `node_nullable` for this class and its child classes. (Defaults to `true`.)
+          # Use `node_nullable(false)` in your base class to make non-null `node` field.
+          def node_nullable(new_value = nil)
+            if new_value.nil?
+              @node_nullable != nil ? @node_nullable : superclass.node_nullable
+            else
+              @node_nullable = new_value
+            end
+          end
+
+          protected
+
+          attr_writer :node_type, :node_nullable
+        end
+      end
+    end
+  end
+end

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,25 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Types
+    module Relay
+      module NodeBehaviors
+        def self.included(child_module)
+          child_module.extend(ClassMethods)
+          child_module.description("An object with an ID.")
+          child_module.field(:id, ID, null: false, description: "ID of the object.", resolver_method: :default_global_id)
+        end
+
+        def default_global_id
+          context.schema.id_from_object(object, self.class, context)
+        end
+
+        module ClassMethods
+          def default_relay?
+            true
+          end
+        end
+      end
+    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,30 @@
+# frozen_string_literal: true
+module GraphQL
+  module Types
+    module Relay
+      module PageInfoBehaviors
+        def self.included(child_class)
+          child_class.extend ClassMethods
+          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
+
+      module ClassMethods
+        def default_relay?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/graphql/types/relay.rb

@@ -1,13 +1,18 @@
 # 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/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"
 require "graphql/types/relay/node"
-require "graphql/types/relay/node_field"
-require "graphql/types/relay/nodes_field"
 
 module GraphQL
   module Types

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.encoding == Encoding::UTF_8 || str.ascii_only?
+          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/version.rb

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