graphql 1.9.17 → 1.11.7

data/lib/graphql/define/instance_definable.rb

@@ -1,118 +1,19 @@
 # frozen_string_literal: true
 module GraphQL
   module Define
-    # This module provides the `.define { ... }` API for
-    # {GraphQL::BaseType}, {GraphQL::Field} and others.
-    #
-    # Calling `.accepts_definitions(...)` creates:
-    #
-    # - a keyword to the `.define` method
-    # - a helper method in the `.define { ... }` block
-    #
-    # The `.define { ... }` block will be called lazily. To be sure it has been
-    # called, use the private method `#ensure_defined`. That will call the
-    # definition block if it hasn't been called already.
-    #
-    # The goals are:
-    #
-    # - Minimal overhead in consuming classes
-    # - Independence between consuming classes
-    # - Extendable by third-party libraries without monkey-patching or other nastiness
-    #
-    # @example Make a class definable
-    #   class Car
-    #     include GraphQL::Define::InstanceDefinable
-    #     attr_accessor :make, :model, :doors
-    #     accepts_definitions(
-    #       # These attrs will be defined with plain setters, `{attr}=`
-    #       :make, :model,
-    #       # This attr has a custom definition which applies the config to the target
-    #       doors: ->(car, doors_count) { doors_count.times { car.doors << Door.new } }
-    #     )
-    #     ensure_defined(:make, :model, :doors)
-    #
-    #     def initialize
-    #       @doors = []
-    #     end
-    #   end
-    #
-    #   class Door; end;
-    #
-    #   # Create an instance with `.define`:
-    #   subaru_baja = Car.define do
-    #     make "Subaru"
-    #     model "Baja"
-    #     doors 4
-    #   end
-    #
-    #   # The custom proc was applied:
-    #   subaru_baja.doors #=> [<Door>, <Door>, <Door>, <Door>]
-    #
-    # @example Extending the definition of a class
-    #   # Add some definitions:
-    #   Car.accepts_definitions(all_wheel_drive: GraphQL::Define.assign_metadata_key(:all_wheel_drive))
-    #
-    #   # Use it in a definition
-    #   subaru_baja = Car.define do
-    #     # ...
-    #     all_wheel_drive true
-    #   end
-    #
-    #   # Access it from metadata
-    #   subaru_baja.metadata[:all_wheel_drive] # => true
-    #
-    # @example Extending the definition of a class via a plugin
-    #   # A plugin is any object that responds to `.use(definition)`
-    #   module SubaruCar
-    #     extend self
-    #
-    #     def use(defn)
-    #       # `defn` has the same methods as within `.define { ... }` block
-    #       defn.make "Subaru"
-    #       defn.doors 4
-    #     end
-    #   end
-    #
-    #   # Use the plugin within a `.define { ... }` block
-    #   subaru_baja = Car.define do
-    #     use SubaruCar
-    #     model 'Baja'
-    #   end
-    #
-    #   subaru_baja.make # => "Subaru"
-    #   subaru_baja.doors # => [<Door>, <Door>, <Door>, <Door>]
-    #
-    # @example Making a copy with an extended definition
-    #   # Create an instance with `.define`:
-    #   subaru_baja = Car.define do
-    #     make "Subaru"
-    #     model "Baja"
-    #     doors 4
-    #   end
-    #
-    #   # Then extend it with `#redefine`
-    #   two_door_baja = subaru_baja.redefine do
-    #     doors 2
-    #   end
+    # @api deprecated
     module InstanceDefinable
       def self.included(base)
         base.extend(ClassMethods)
         base.ensure_defined(:metadata)
       end
 
-      # `metadata` can store arbitrary key-values with an object.
-      #
-      # @return [Hash<Object, Object>] Hash for user-defined storage
+      # @api deprecated
       def metadata
         @metadata ||= {}
       end
 
-      # Mutate this instance using functions from its {.definition}s.
-      # Keywords or helpers in the block correspond to keys given to `accepts_definitions`.
-      #
-      # Note that the block is not called right away -- instead, it's deferred until
-      # one of the defined fields is needed.
-      # @return [void]
+      # @api deprecated
       def define(**kwargs, &block)
         # make sure the previous definition_proc was executed:
         ensure_defined
@@ -121,9 +22,7 @@ module GraphQL
         nil
       end
 
-      # Shallow-copy this object, then apply new definitions to the copy.
-      # @see {#define} for arguments
-      # @return [InstanceDefinable] A new instance, with any extended definitions
+      # @api deprecated
       def redefine(**kwargs, &block)
         ensure_defined
         new_inst = self.dup
@@ -154,7 +53,12 @@ module GraphQL
             defn_proxy = DefinedObjectProxy.new(self)
             # Apply definition from `define(...)` kwargs
             defn.define_keywords.each do |keyword, value|
-              defn_proxy.public_send(keyword, value)
+              # Don't splat string hashes, which blows up on Rubies before 2.7
+              if value.is_a?(Hash) && value.each_key.all? { |k| k.is_a?(Symbol) }
+                defn_proxy.public_send(keyword, **value)
+              else
+                defn_proxy.public_send(keyword, value)
+              end
             end
             # and/or apply definition from `define { ... }` block
             if defn.define_proc
@@ -287,13 +191,19 @@ module GraphQL
       end
 
       class AssignAttribute
+        extend GraphQL::Ruby2Keywords
+
         def initialize(attr_name)
           @attr_assign_method = :"#{attr_name}="
         end
 
-        def call(defn, value)
-          defn.public_send(@attr_assign_method, value)
+        # Even though we're just using the first value here,
+        # We have to add a splat here to use `ruby2_keywords`,
+        # so that it will accept a `[{}]` input from the caller.
+        def call(defn, *value)
+          defn.public_send(@attr_assign_method, value.first)
         end
+        ruby2_keywords :call
       end
     end
   end

data/lib/graphql/directive/deprecated_directive.rb

@@ -1,13 +1,2 @@
 # frozen_string_literal: true
-GraphQL::Directive::DeprecatedDirective = GraphQL::Directive.define do
-  name "deprecated"
-  description "Marks an element of a GraphQL schema as no longer supported."
-  locations([GraphQL::Directive::FIELD_DEFINITION, GraphQL::Directive::ENUM_VALUE])
-
-  reason_description = "Explains why this element was deprecated, usually also including a "\
-    "suggestion for how to access supported similar data. Formatted "\
-    "in [Markdown](https://daringfireball.net/projects/markdown/)."
-
-  argument :reason, GraphQL::STRING_TYPE, reason_description, default_value: GraphQL::Directive::DEFAULT_DEPRECATION_REASON
-  default_directive true
-end
+GraphQL::Directive::DeprecatedDirective = GraphQL::Schema::Directive::Deprecated.graphql_definition

data/lib/graphql/directive.rb

@@ -45,7 +45,6 @@ module GraphQL
       INPUT_FIELD_DEFINITION = :INPUT_FIELD_DEFINITION,
     ]
 
-    DEFAULT_DEPRECATION_REASON = 'No longer supported'
     LOCATION_DESCRIPTIONS = {
       QUERY:                    'Location adjacent to a query operation.',
       MUTATION:                 'Location adjacent to a mutation operation.',
@@ -96,6 +95,14 @@ module GraphQL
     def inspect
       "#<GraphQL::Directive #{name}>"
     end
+
+    def type_class
+      metadata[:type_class]
+    end
+
+    def get_argument(argument_name)
+      arguments[argument_name]
+    end
   end
 end
 

data/lib/graphql/enum_type.rb

@@ -1,76 +1,6 @@
 # frozen_string_literal: true
 module GraphQL
-  # Represents a collection of related values.
-  # By convention, enum names are `SCREAMING_CASE_NAMES`,
-  # but other identifiers are supported too.
-  #
-  # You can use as return types _or_ as inputs.
-  #
-  # By default, enums are passed to `resolve` functions as
-  # the strings that identify them, but you can provide a
-  # custom Ruby value with the `value:` keyword.
-  #
-  # @example An enum of programming languages
-  #   LanguageEnum = GraphQL::EnumType.define do
-  #     name "Language"
-  #     description "Programming language for Web projects"
-  #     value("PYTHON", "A dynamic, function-oriented language")
-  #     value("RUBY", "A very dynamic language aimed at programmer happiness")
-  #     value("JAVASCRIPT", "Accidental lingua franca of the web")
-  #   end
-  #
-  # @example Using an enum as a return type
-  #    field :favoriteLanguage, LanguageEnum, "This person's favorite coding language"
-  #    # ...
-  #    # In a query:
-  #    Schema.execute("{ coder(id: 1) { favoriteLanguage } }")
-  #    # { "data" => { "coder" => { "favoriteLanguage" => "RUBY" } } }
-  #
-  # @example Defining an enum input
-  #    field :coders, types[CoderType] do
-  #      argument :knowing, types[LanguageEnum]
-  #      resolve ->(obj, args, ctx) {
-  #        Coder.where(language: args[:knowing])
-  #      }
-  #    end
-  #
-  # @example Using an enum as input
-  #   {
-  #     # find coders who know Python and Ruby
-  #     coders(knowing: [PYTHON, RUBY]) {
-  #       name
-  #       hourlyRate
-  #     }
-  #   }
-  #
-  # @example Enum whose values are different in Ruby-land
-  #   GraphQL::EnumType.define do
-  #     # ...
-  #     # use the `value:` keyword:
-  #     value("RUBY", "Lisp? Smalltalk?", value: :rb)
-  #   end
-  #
-  #   # Now, resolve functions will receive `:rb` instead of `"RUBY"`
-  #   field :favoriteLanguage, LanguageEnum
-  #   resolve ->(obj, args, ctx) {
-  #     args[:favoriteLanguage] # => :rb
-  #   }
-  #
-  # @example Enum whose values are different in ActiveRecord-land
-  #   class Language < ActiveRecord::Base
-  #     enum language: {
-  #       rb: 0
-  #     }
-  #   end
-  #
-  #   # Now enum type should be defined as
-  #   GraphQL::EnumType.define do
-  #     # ...
-  #     # use the `value:` keyword:
-  #     value("RUBY", "Lisp? Smalltalk?", value: 'rb')
-  #   end
-  #
-
+  # @api deprecated
   class EnumType < GraphQL::BaseType
     accepts_definitions :values, value: GraphQL::Define::AssignEnumValue
     ensure_defined(:values, :validate_non_null_input, :coerce_non_null_input, :coerce_result)
@@ -151,6 +81,10 @@ module GraphQL
       def graphql_name
         name
       end
+
+      def type_class
+        metadata[:type_class]
+      end
     end
 
     class UnresolvedValueError < GraphQL::Error

data/lib/graphql/execution/directive_checks.rb

@@ -18,12 +18,12 @@ module GraphQL
           case name
           when SKIP
             args = query.arguments_for(directive_ast_node, directive_defn)
-            if args['if'] == true
+            if args[:if] == true
               return false
             end
           when INCLUDE
             args = query.arguments_for(directive_ast_node, directive_defn)
-            if args['if'] == false
+            if args[:if] == false
               return false
             end
           else

data/lib/graphql/execution/errors.rb

@@ -18,8 +18,7 @@ module GraphQL
     #
     class Errors
       def self.use(schema)
-        schema_class = schema.is_a?(Class) ? schema : schema.target.class
-        schema_class.error_handler = self.new(schema_class)
+        schema.error_handler = self.new(schema)
       end
 
       def initialize(schema)
@@ -41,7 +40,7 @@ module GraphQL
       def with_error_handling(ctx)
         yield
       rescue StandardError => err
-        rescues = @schema.rescues
+        rescues = ctx.schema.rescues
         _err_class, handler = rescues.find { |err_class, handler| err.is_a?(err_class) }
         if handler
           runtime_info = ctx.namespace(:interpreter) || {}

data/lib/graphql/execution/execute.rb

@@ -20,7 +20,7 @@ module GraphQL
 
       def execute(ast_operation, root_type, query)
         result = resolve_root_selection(query)
-        lazy_resolve_root_selection(result, {query: query})
+        lazy_resolve_root_selection(result, **{query: query})
         GraphQL::Execution::Flatten.call(query.context)
       end
 

data/lib/graphql/execution/instrumentation.rb

@@ -77,7 +77,7 @@ module GraphQL
         end
 
         def call_after_hooks(instrumenters, object, after_hook_name, ex)
-          instrumenters.reverse.each do |instrumenter|
+          instrumenters.reverse_each do |instrumenter|
             begin
               instrumenter.public_send(after_hook_name, object)
             rescue => e

data/lib/graphql/execution/interpreter/argument_value.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Execution
+    class Interpreter
+      # A container for metadata regarding arguments present in a GraphQL query.
+      # @see Interpreter::Arguments#argument_values for a hash of these objects.
+      class ArgumentValue
+        def initialize(definition:, value:, default_used:)
+          @definition = definition
+          @value = value
+          @default_used = default_used
+        end
+
+        # @return [Object] The Ruby-ready value for this Argument
+        attr_reader :value
+
+        # @return [GraphQL::Schema::Argument] The definition instance for this argument
+        attr_reader :definition
+
+        # @return [Boolean] `true` if the schema-defined `default_value:` was applied in this case. (No client-provided value was present.)
+        def default_used?
+          @default_used
+        end
+      end
+    end
+  end
+end

data/lib/graphql/execution/interpreter/arguments.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Execution
+    class Interpreter
+      # A wrapper for argument hashes in GraphQL queries.
+      #
+      # @see GraphQL::Query#arguments_for to get access to these objects.
+      class Arguments
+        extend Forwardable
+        include GraphQL::Dig
+
+        # The Ruby-style arguments hash, ready for a resolver.
+        # This hash is the one used at runtime.
+        #
+        # @return [Hash<Symbol, Object>]
+        def keyword_arguments
+          @keyword_arguments ||= begin
+            kwargs = {}
+            argument_values.each do |name, arg_val|
+              kwargs[name] = arg_val.value
+            end
+            kwargs
+          end
+        end
+
+        # @param argument_values [nil, Hash{Symbol => ArgumentValue}]
+        def initialize(argument_values:)
+          @argument_values = argument_values
+          @empty = argument_values.nil? || argument_values.empty?
+        end
+
+        # @return [Hash{Symbol => ArgumentValue}]
+        def argument_values
+          @argument_values ||= {}
+        end
+
+        def empty?
+          @empty
+        end
+
+        def_delegators :keyword_arguments, :key?, :[], :fetch, :keys, :each, :values
+        def_delegators :argument_values, :each_value
+
+        def inspect
+          "#<#{self.class} @keyword_arguments=#{keyword_arguments.inspect}>"
+        end
+      end
+    end
+  end
+end

data/lib/graphql/execution/interpreter/arguments_cache.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Execution
+    class Interpreter
+      class ArgumentsCache
+        def initialize(query)
+          @query = query
+          @storage = Hash.new do |h, ast_node|
+            h[ast_node] = Hash.new do |h2, arg_owner|
+              h2[arg_owner] = Hash.new do |h3, parent_object|
+                # First, normalize all AST or Ruby values to a plain Ruby hash
+                args_hash = prepare_args_hash(ast_node)
+                # Then call into the schema to coerce those incoming values
+                args = arg_owner.coerce_arguments(parent_object, args_hash, query.context)
+
+                h3[parent_object] = @query.schema.after_lazy(args) do |resolved_args|
+                  # when this promise is resolved, update the cache with the resolved value
+                  h3[parent_object] = resolved_args
+                end
+              end
+            end
+          end
+        end
+
+        def fetch(ast_node, argument_owner, parent_object)
+          @storage[ast_node][argument_owner][parent_object]
+        end
+
+        private
+
+        NO_ARGUMENTS = {}.freeze
+
+        NO_VALUE_GIVEN = Object.new
+
+        def prepare_args_hash(ast_arg_or_hash_or_value)
+          case ast_arg_or_hash_or_value
+          when Hash
+            if ast_arg_or_hash_or_value.empty?
+              return NO_ARGUMENTS
+            end
+            args_hash = {}
+            ast_arg_or_hash_or_value.each do |k, v|
+              args_hash[k] = prepare_args_hash(v)
+            end
+            args_hash
+          when Array
+            ast_arg_or_hash_or_value.map { |v| prepare_args_hash(v) }
+          when GraphQL::Language::Nodes::Field, GraphQL::Language::Nodes::InputObject, GraphQL::Language::Nodes::Directive
+            if ast_arg_or_hash_or_value.arguments.empty?
+              return NO_ARGUMENTS
+            end
+            args_hash = {}
+            ast_arg_or_hash_or_value.arguments.each do |arg|
+              v = prepare_args_hash(arg.value)
+              if v != NO_VALUE_GIVEN
+                args_hash[arg.name] = v
+              end
+            end
+            args_hash
+          when GraphQL::Language::Nodes::VariableIdentifier
+            if @query.variables.key?(ast_arg_or_hash_or_value.name)
+              variable_value = @query.variables[ast_arg_or_hash_or_value.name]
+              prepare_args_hash(variable_value)
+            else
+              NO_VALUE_GIVEN
+            end
+          when GraphQL::Language::Nodes::Enum
+            ast_arg_or_hash_or_value.name
+          when GraphQL::Language::Nodes::NullValue
+            nil
+          else
+            ast_arg_or_hash_or_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/execution/interpreter/handles_raw_value.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Execution
+    class Interpreter
+      # Wrapper for raw values
+      class RawValue
+        def initialize(obj = nil)
+          @object = obj
+        end
+
+        def resolve
+          @object
+        end
+      end
+
+      # Allows to return "raw" value from the resolver
+      module HandlesRawValue
+        def raw_value(obj)
+          RawValue.new(obj)
+        end
+      end
+    end
+  end
+end