Merge pull request #1868 from modosc/dig-inputobject-arguments

add #dig to Schema::InputObject and Query::Arguments

Author: Robert Mosolgo

lib/graphql.rb

@@ -67,6 +67,7 @@ def self.scan_with_ragel(graphql_string)
 require "graphql/analysis"
 require "graphql/tracing"
 require "graphql/execution"
+require "graphql/dig"
 require "graphql/schema"
 require "graphql/types"
 require "graphql/relay"

lib/graphql/dig.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module GraphQL
+  module Dig
+    # implemented using the old activesupport #dig instead of the ruby built-in
+    # so we can use some of the magic in Schema::InputObject and Query::Arguments
+    # to handle stringified/symbolized keys.
+    #
+    # @param args [Array<[String, Symbol>] Retrieves the value object corresponding to the each key objects repeatedly
+    # @return [Object]
+    def dig(own_key, *rest_keys)
+      val = self[own_key]
+      if val.nil? || rest_keys.empty?
+        val
+      else
+        val.dig(*rest_keys)
+      end
+    end
+  end
+end

lib/graphql/query/arguments.rb

@@ -6,6 +6,7 @@ class Query
     # {Arguments} recursively wraps the input in {Arguments} instances.
     class Arguments
       extend Forwardable
+      include GraphQL::Dig
 
       def self.construct_arguments_class(argument_owner)
         argument_definitions = argument_owner.arguments

lib/graphql/schema/input_object.rb

@@ -5,6 +5,7 @@ class InputObject < GraphQL::Schema::Member
       extend GraphQL::Schema::Member::AcceptsDefinition
       extend Forwardable
       extend GraphQL::Schema::Member::HasArguments
+      include GraphQL::Dig
 
       def initialize(values, context:, defaults_used:)
         @context = context

spec/graphql/query/arguments_spec.rb

@@ -121,6 +121,27 @@
     end
   end
 
+  describe "#dig" do
+    it "returns the value at that key" do
+      assert_equal 1, arguments.dig("a")
+      assert_equal 1, arguments.dig(:a)
+      assert arguments.dig("inputObject").is_a?(GraphQL::Query::Arguments)
+    end
+
+    it "works with nested keys" do
+      assert_equal 3, arguments.dig("inputObject", "d")
+      assert_equal 3, arguments.dig(:inputObject, :d)
+      assert_equal 3, arguments.dig("inputObject", :d)
+      assert_equal 3, arguments.dig(:inputObject, "d")
+    end
+
+    it "returns nil for missing keys" do
+      assert_nil arguments.dig("z")
+      assert_nil arguments.dig(7)
+    end
+  end
+
+
   describe "#key?" do
     let(:arg_values) { [] }
     let(:schema) {

spec/graphql/schema/input_object_spec.rb

@@ -151,4 +151,55 @@ class TestInput2 < GraphQL::Schema::InputObject
       assert_equal({ a: 1, b: 2, input_object: { d: 3, e: 4 } }, input_object.to_h)
     end
   end
+
+  describe "#dig" do
+    module InputObjectDigTest
+      class TestInput1 < GraphQL::Schema::InputObject
+        graphql_name "TestInput1"
+        argument :d, Int, required: true
+        argument :e, Int, required: true
+      end
+
+      class TestInput2 < GraphQL::Schema::InputObject
+        graphql_name "TestInput2"
+        argument :a, Int, required: true
+        argument :b, Int, required: true
+        argument :c, TestInput1, as: :inputObject, required: true
+      end
+
+      TestInput1.to_graphql
+      TestInput2.to_graphql
+    end
+    arg_values = {a: 1, b: 2, c: { d: 3, e: 4 }}
+
+    input_object = InputObjectDigTest::TestInput2.new(
+      arg_values,
+      context: nil,
+      defaults_used: Set.new
+    )
+    it "returns the value at that key" do
+      assert_equal 1, input_object.dig("a")
+      assert_equal 1, input_object.dig(:a)
+      assert input_object.dig("inputObject").is_a?(GraphQL::Schema::InputObject)
+    end
+
+    it "works with nested keys" do
+      assert_equal 3, input_object.dig("inputObject", "d")
+      assert_equal 3, input_object.dig(:inputObject, :d)
+      assert_equal 3, input_object.dig("inputObject", :d)
+      assert_equal 3, input_object.dig(:inputObject, "d")
+    end
+
+    it "returns nil for missing keys" do
+      assert_nil input_object.dig("z")
+      assert_nil input_object.dig(7)
+    end
+
+    it "handles underscored keys" do
+      # TODO - shouldn't this work too?
+      # assert_equal 3, input_object.dig('input_object', 'd')
+      assert_equal 3, input_object.dig(:input_object, :d)
+    end
+
+  end
 end