graphql 1.8.7 → 1.9.0

data/spec/graphql/object_type_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe GraphQL::ObjectType do
-  let(:type) { Dummy::CheeseType }
+  let(:type) { Dummy::Cheese.graphql_definition }
 
   it "doesn't allow double non-null constraints" do
     assert_raises(GraphQL::DoubleNonNullTypeError) {
@@ -45,10 +45,10 @@ describe GraphQL::ObjectType do
   describe "interfaces" do
     it "may have interfaces" do
       assert_equal([
-        Dummy::EdibleInterface,
-        Dummy::EdibleAsMilkInterface,
-        Dummy::AnimalProductInterface,
-        Dummy::LocalProductInterface
+        Dummy::Edible.graphql_definition,
+        Dummy::EdibleAsMilk.graphql_definition,
+        Dummy::AnimalProduct.graphql_definition,
+        Dummy::LocalProduct.graphql_definition
       ], type.interfaces)
     end
 
@@ -85,7 +85,7 @@ describe GraphQL::ObjectType do
   end
 
   it "accepts fields definition" do
-    last_produced_dairy = GraphQL::Field.define(name: :last_produced_dairy, type: Dummy::DairyProductUnion)
+    last_produced_dairy = GraphQL::Field.define(name: :last_produced_dairy, type: Dummy::DairyProduct)
     cow_type = GraphQL::ObjectType.define(name: "Cow", fields: [last_produced_dairy])
     assert_equal([last_produced_dairy], cow_type.fields)
   end
@@ -94,54 +94,54 @@ describe GraphQL::ObjectType do
     it "adds an interface" do
       type = GraphQL::ObjectType.define do
         name 'Hello'
-        implements Dummy::EdibleInterface
-        implements Dummy::AnimalProductInterface
+        implements Dummy::Edible
+        implements Dummy::AnimalProduct
 
         field :hello, types.String
       end
 
-      assert_equal([Dummy::EdibleInterface, Dummy::AnimalProductInterface], type.interfaces)
+      assert_equal([Dummy::Edible.graphql_definition, Dummy::AnimalProduct.graphql_definition], type.interfaces)
     end
 
     it "adds many interfaces" do
       type = GraphQL::ObjectType.define do
         name 'Hello'
-        implements Dummy::EdibleInterface, Dummy::AnimalProductInterface
+        implements Dummy::Edible, Dummy::AnimalProduct
 
         field :hello, types.String
       end
 
-      assert_equal([Dummy::EdibleInterface, Dummy::AnimalProductInterface], type.interfaces)
+      assert_equal([Dummy::Edible.graphql_definition, Dummy::AnimalProduct.graphql_definition], type.interfaces)
     end
 
     it "preserves existing interfaces and appends a new one" do
       type = GraphQL::ObjectType.define do
         name 'Hello'
-        interfaces [Dummy::EdibleInterface]
-        implements Dummy::AnimalProductInterface
+        interfaces [Dummy::Edible]
+        implements Dummy::AnimalProduct
 
         field :hello, types.String
       end
 
-      assert_equal([Dummy::EdibleInterface, Dummy::AnimalProductInterface], type.interfaces)
+      assert_equal([Dummy::Edible.graphql_definition, Dummy::AnimalProduct.graphql_definition], type.interfaces)
     end
 
     it "can be used to inherit fields from the interface" do
       type_1 = GraphQL::ObjectType.define do
         name 'Hello'
-        implements Dummy::EdibleInterface
-        implements Dummy::AnimalProductInterface
+        implements Dummy::Edible
+        implements Dummy::AnimalProduct
       end
 
       type_2 = GraphQL::ObjectType.define do
         name 'Hello'
-        implements Dummy::EdibleInterface
-        implements Dummy::AnimalProductInterface, inherit: true
+        implements Dummy::Edible
+        implements Dummy::AnimalProduct, inherit: true
       end
 
       type_3 = GraphQL::ObjectType.define do
         name 'Hello'
-        implements Dummy::EdibleInterface, Dummy::AnimalProductInterface, inherit: true
+        implements Dummy::Edible, Dummy::AnimalProduct, inherit: true
       end
 
       assert_equal [], type_1.all_fields.map(&:name)
@@ -158,16 +158,18 @@ describe GraphQL::ObjectType do
     end
 
     it "exposes defined field property" do
-      field_without_prop = Dummy::CheeseType.get_field("flavor")
-      field_with_prop = Dummy::CheeseType.get_field("fatContent")
+      field_without_prop = Dummy::Cheese.graphql_definition.get_field("flavor")
+      field_with_prop = Dummy::Cheese.graphql_definition.get_field("fatContent")
       assert_equal(field_without_prop.property, nil)
-      assert_equal(field_with_prop.property, :fat_content)
+      # This used to lookup `:fat_content`, but not since migrating to class-based
+      assert_equal(field_with_prop.property, nil)
     end
 
     it "looks up from interfaces" do
-      field_from_self = Dummy::CheeseType.get_field("fatContent")
-      field_from_iface = Dummy::MilkType.get_field("fatContent")
-      assert_equal(field_from_self.property, :fat_content)
+      field_from_self = Dummy::Cheese.graphql_definition.get_field("fatContent")
+      field_from_iface = Dummy::Milk.graphql_definition.get_field("fatContent")
+      # This used to lookup `:fat_content`, but not since migrating to class-based
+      assert_equal(field_from_self.property, nil)
       assert_equal(field_from_iface.property, nil)
     end
   end
@@ -175,6 +177,9 @@ describe GraphQL::ObjectType do
   describe "#dup" do
     it "copies fields and interfaces without altering the original" do
       type.interfaces # load the internal cache
+      assert_equal 4, type.interfaces.size
+      assert_equal 9, type.fields.size
+
       type_2 = type.dup
 
       # IRL, use `+=`, not this
@@ -185,8 +190,8 @@ describe GraphQL::ObjectType do
 
       assert_equal 4, type.interfaces.size
       assert_equal 5, type_2.interfaces.size
-      assert_equal 8, type.fields.size
-      assert_equal 9, type_2.fields.size
+      assert_equal 9, type.fields.size
+      assert_equal 10, type_2.fields.size
     end
   end
 end

data/spec/graphql/query/arguments_spec.rb

@@ -121,6 +121,27 @@ describe GraphQL::Query::Arguments do
     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) {

data/spec/graphql/query/context_spec.rb

@@ -217,6 +217,34 @@ TABLE
     end
   end
 
+  describe "read values" do
+    let(:context) { GraphQL::Query::Context.new(query: OpenStruct.new(schema: schema), values: {a: {b: 1}}, object: nil) }
+
+    it "allows you to read values of contexts using []" do
+      assert_equal({b: 1}, context[:a])
+    end
+
+    it "allows you to read values of contexts using dig" do
+      if RUBY_VERSION >= '2.3.0'
+        assert_equal(1, context.dig(:a, :b))
+      else
+        assert_raises NoMethodError do
+          context.dig(:a, :b)
+        end
+      end
+    end
+  end
+
+  describe "splatting" do
+    let(:context) { GraphQL::Query::Context.new(query: OpenStruct.new(schema: schema), values: {a: {b: 1}}, object: nil) }
+
+    let(:splat) { ->(**context) { context } }
+
+    it "runs successfully" do
+      assert_equal({a: { b: 1 }}, splat.call(context))
+    end
+  end
+
   describe "accessing context after the fact" do
     let(:query_string) { %|
       { pushContext }

data/spec/graphql/query/executor_spec.rb

@@ -110,7 +110,7 @@ describe GraphQL::Query::Executor do
       DummyQueryType = GraphQL::ObjectType.define do
         name "Query"
         field :dairy do
-          type Dummy::DairyType
+          type Dummy::Dairy.graphql_definition
           resolve ->(t, a, c) {
             raise if resolved
             resolved = true
@@ -119,7 +119,7 @@ describe GraphQL::Query::Executor do
         end
       end
 
-      GraphQL::Schema.define(query: DummyQueryType, mutation: Dummy::DairyAppMutationType, resolve_type: ->(a,b,c) { :pass }, id_from_object: :pass)
+      GraphQL::Schema.define(query: DummyQueryType, mutation: Dummy::DairyAppMutation.graphql_definition, resolve_type: ->(a,b,c) { :pass }, id_from_object: :pass)
     }
     let(:variables) { nil }
     let(:query_string) { %|
@@ -186,29 +186,31 @@ describe GraphQL::Query::Executor do
       end
     end
 
-    describe "if the schema has a rescue handler" do
-      before do
-        # HACK: reach to the underlying instance to perform a side-effect
-        schema.graphql_definition.rescue_from(RuntimeError) { "Error was handled!" }
-      end
+    if TESTING_RESCUE_FROM
+      describe "if the schema has a rescue handler" do
+        before do
+          # HACK: reach to the underlying instance to perform a side-effect
+          schema.graphql_definition.rescue_from(RuntimeError) { "Error was handled!" }
+        end
 
-      after do
-        # remove the handler from the middleware:
-        schema.remove_handler(RuntimeError)
-      end
+        after do
+          # remove the handler from the middleware:
+          schema.remove_handler(RuntimeError)
+        end
 
-      it "adds to the errors key" do
-        expected = {
-          "data" => {"error" => nil},
-          "errors"=>[
-            {
-              "message"=>"Error was handled!",
-              "locations" => [{"line"=>1, "column"=>17}],
-              "path"=>["error"]
-            }
-          ]
-        }
-        assert_equal(expected, result)
+        it "adds to the errors key" do
+          expected = {
+            "data" => {"error" => nil},
+            "errors"=>[
+              {
+                "message"=>"Error was handled!",
+                "locations" => [{"line"=>1, "column"=>17}],
+                "path"=>["error"]
+              }
+            ]
+          }
+          assert_equal(expected, result)
+        end
       end
     end
   end
@@ -255,10 +257,10 @@ describe GraphQL::Query::Executor do
             {
               "message" => "Variable input of type ReplaceValuesInput! was provided invalid value",
               "locations" => [{ "line" => 1, "column" => 13 }],
-              "value" => nil,
-              "problems" => [
-                { "path" => [], "explanation" => "Expected value to not be null" }
-              ]
+              "extensions" => {
+                "value" => nil,
+                "problems" => [{ "path" => [], "explanation" => "Expected value to not be null" }]
+              }
             }
           ]
         }
@@ -275,10 +277,10 @@ describe GraphQL::Query::Executor do
             {
               "message" => "Variable input of type ReplaceValuesInput! was provided invalid value",
               "locations" => [{ "line" => 1, "column" => 13 }],
-              "value" => {},
-              "problems" => [
-                { "path" => ["values"], "explanation" => "Expected value to not be null" }
-              ]
+              "extensions" => {
+                "value" => {},
+                "problems" => [{ "path" => ["values"], "explanation" => "Expected value to not be null" }]
+              }
             }
           ]
         }
@@ -295,11 +297,13 @@ describe GraphQL::Query::Executor do
             {
               "message" => "Variable input of type [DairyProductInput] was provided invalid value",
               "locations" => [{ "line" => 1, "column" => 10 }],
-              "value" => [{ "foo" => "bar" }],
-              "problems" => [
-                { "path" => [0, "foo"], "explanation" => "Field is not defined on DairyProductInput" },
-                { "path" => [0, "source"], "explanation" => "Expected value to not be null" }
-              ]
+              "extensions" => {
+                "value" => [{ "foo" => "bar" }],
+                "problems" => [
+                  { "path" => [0, "foo"], "explanation" => "Field is not defined on DairyProductInput" },
+                  { "path" => [0, "source"], "explanation" => "Expected value to not be null" }
+                ]
+              }
             }
           ]
         }

data/spec/graphql/query_spec.rb

@@ -435,8 +435,10 @@ describe GraphQL::Query do
             {
               "message" => "Variable cheeseId of type Int! was provided invalid value",
               "locations"=>[{ "line" => 2, "column" => 23 }],
-              "value" => "2",
-              "problems" => [{ "path" => [], "explanation" => 'Could not coerce value "2" to Int' }]
+              "extensions" => {
+                "value" => "2",
+                "problems" => [{ "path" => [], "explanation" => 'Could not coerce value "2" to Int' }]
+              }
             }
           ]
         }
@@ -453,8 +455,10 @@ describe GraphQL::Query do
             {
               "message" => "Variable cheeseId of type Int! was provided invalid value",
               "locations" => [{"line" => 2, "column" => 23}],
-              "value" => nil,
-              "problems" => [{ "path" => [], "explanation" => "Expected value to not be null" }]
+              "extensions" => {
+                "value" => nil,
+                "problems" => [{ "path" => [], "explanation" => "Expected value to not be null" }]
+              }
             }
           ]
         }
@@ -471,8 +475,10 @@ describe GraphQL::Query do
             {
               "message" => "Variable cheeseId of type Int! was provided invalid value",
               "locations" => [{"line" => 2, "column" => 23}],
-              "value" => nil,
-              "problems" => [{ "path" => [], "explanation" => "Expected value to not be null" }]
+              "extensions" => {
+                "value" => nil,
+                "problems" => [{ "path" => [], "explanation" => "Expected value to not be null" }]
+              }
             }
           ]
         }

data/spec/graphql/schema/argument_spec.rb

@@ -13,6 +13,15 @@ describe GraphQL::Schema::Argument do
 
         argument :aliased_arg, String, required: false, as: :renamed
         argument :prepared_arg, Int, required: false, prepare: :multiply
+        argument :prepared_by_proc_arg, Int, required: false, prepare: ->(val, context) { context[:multiply_by] * val }
+
+        class Multiply
+          def call(val, context)
+            context[:multiply_by] * val
+          end
+        end
+
+        argument :prepared_by_callable_arg, Int, required: false, prepare: Multiply.new
       end
 
       def field(**args)
@@ -26,10 +35,17 @@ describe GraphQL::Schema::Argument do
 
     class Schema < GraphQL::Schema
       query(Query)
+      if TESTING_INTERPRETER
+        use GraphQL::Execution::Interpreter
+      end
     end
   end
 
-
+  describe "#path" do
+    it "includes type, field and argument names" do
+      assert_equal "Query.field.argWithBlock", SchemaArgumentTest::Query.fields["field"].arguments["argWithBlock"].path
+    end
+  end
 
   describe "#name" do
     it "reflects camelization" do
@@ -89,5 +105,23 @@ describe GraphQL::Schema::Argument do
       # Make sure it's getting the renamed symbol:
       assert_equal '{:prepared_arg=>15}', res["data"]["field"]
     end
+    it "calls the method on the provided Proc" do
+      query_str = <<-GRAPHQL
+      { field(preparedByProcArg: 5) }
+      GRAPHQL
+
+      res = SchemaArgumentTest::Schema.execute(query_str, context: {multiply_by: 3})
+      # Make sure it's getting the renamed symbol:
+      assert_equal '{:prepared_by_proc_arg=>15}', res["data"]["field"]
+    end
+    it "calls the method on the provided callable object" do
+      query_str = <<-GRAPHQL
+      { field(preparedByCallableArg: 5) }
+      GRAPHQL
+
+      res = SchemaArgumentTest::Schema.execute(query_str, context: {multiply_by: 3})
+      # Make sure it's getting the renamed symbol:
+      assert_equal '{:prepared_by_callable_arg=>15}', res["data"]["field"]
+    end
   end
 end

data/spec/graphql/schema/build_from_definition_spec.rb

@@ -60,37 +60,114 @@ type Hello {
       build_schema_and_compare_output(schema.chop)
     end
 
-    it 'supports descriptions' do
+    it 'supports descriptions and definition_line' do
       schema = <<-SCHEMA
 schema {
   query: Hello
 }
 
-# This is a directive
+"""
+This is a directive
+"""
 directive @foo(
-  # It has an argument
+  """
+  It has an argument
+  """
   arg: Int
 ) on FIELD
 
-# With an enum
+"""
+With an enum
+"""
 enum Color {
   BLUE
 
-  # Not a creative color
+  """
+  Not a creative color
+  """
   GREEN
   RED
 }
 
-# What a great type
-type Hello {
-  anEnum: Color
+"""
+What a great type
+"""
+type Hello implements I {
+  anEnum(s: S): Color
 
-  # And a field to boot
-  str: String
+  """
+  And a field to boot
+  """
+  str(i: Input): String
+}
+
+"""
+An interface
+"""
+interface I {
+  str(i: Input): String
 }
+
+"""
+And an Input
+"""
+input Input {
+  s: String
+}
+
+"""
+A scalar
+"""
+scalar S
+
+"""
+And a union
+"""
+union U = Hello
       SCHEMA
 
       build_schema_and_compare_output(schema.chop)
+
+      built_schema = GraphQL::Schema.from_definition(schema)
+      # The schema's are the same since there's no description
+      assert_equal 1, built_schema.ast_node.line
+      assert_equal 1, built_schema.ast_node.definition_line
+
+      # These account for description:
+      assert_equal 5, built_schema.directives["foo"].ast_node.line, "The ast_node.line points to the description"
+      assert_equal 8, built_schema.directives["foo"].ast_node.definition_line, "The ast_node.definition_line points to the definition"
+
+      arg = built_schema.directives["foo"].arguments["arg"]
+      assert_equal 9, arg.ast_node.line
+      assert_equal 12, arg.ast_node.definition_line
+
+      enum_type = built_schema.types["Color"]
+      assert_equal 15, enum_type.ast_node.line, "The ast_node.line points to the description"
+      assert_equal 18, enum_type.ast_node.definition_line, "The ast_node.definition_line points to the definition"
+
+      enum_value = enum_type.values["GREEN"]
+      assert_equal 21, enum_value.ast_node.line
+      assert_equal 24, enum_value.ast_node.definition_line
+
+      obj_type = built_schema.types["Hello"]
+      assert_equal 28, obj_type.ast_node.line, "The ast_node.line points to the description"
+      assert_equal 31, obj_type.ast_node.definition_line, "The ast_node.definition_line points to the definition"
+
+      field = obj_type.fields["str"]
+      assert_equal 34, field.ast_node.line
+      assert_equal 37, field.ast_node.definition_line
+
+      assert_equal 40, built_schema.types["I"].ast_node.line
+      assert_equal 43, built_schema.types["I"].ast_node.definition_line
+
+      assert_equal 47, built_schema.types["Input"].ast_node.line
+      assert_equal 50, built_schema.types["Input"].ast_node.definition_line
+
+      assert_equal 54, built_schema.types["S"].ast_node.line
+      assert_equal 57, built_schema.types["S"].ast_node.definition_line
+
+      assert_equal 59, built_schema.types["U"].ast_node.line
+      assert_equal 62, built_schema.types["U"].ast_node.definition_line
     end
 
     it 'maintains built-in directives' do
@@ -233,64 +310,102 @@ type Organization {
   email: String
 }
 
-# The connection type for Organization.
+"""
+The connection type for Organization.
+"""
 type OrganizationConnection {
-  # A list of edges.
+  """
+  A list of edges.
+  """
   edges: [OrganizationEdge]
 
-  # A list of nodes.
+  """
+  A list of nodes.
+  """
   nodes: [Organization]
 
-  # Information to aid in pagination.
+  """
+  Information to aid in pagination.
+  """
   pageInfo: PageInfo!
 
-  # Identifies the total count of items in the connection.
+  """
+  Identifies the total count of items in the connection.
+  """
   totalCount: Int!
 }
 
-# An edge in a connection.
+"""
+An edge in a connection.
+"""
 type OrganizationEdge {
-  # A cursor for use in pagination.
+  """
+  A cursor for use in pagination.
+  """
   cursor: String!
 
-  # The item at the end of the edge.
+  """
+  The item at the end of the edge.
+  """
   node: Organization
 }
 
-# Information about pagination in a connection.
+"""
+Information about pagination in a connection.
+"""
 type PageInfo {
-  # When paginating forwards, the cursor to continue.
+  """
+  When paginating forwards, the cursor to continue.
+  """
   endCursor: String
 
-  # When paginating forwards, are there more items?
+  """
+  When paginating forwards, are there more items?
+  """
   hasNextPage: Boolean!
 
-  # When paginating backwards, are there more items?
+  """
+  When paginating backwards, are there more items?
+  """
   hasPreviousPage: Boolean!
 
-  # When paginating backwards, the cursor to continue.
+  """
+  When paginating backwards, the cursor to continue.
+  """
   startCursor: String
 }
 
 type Type {
   name: String
   organization(
-    # The login of the organization to find.
+    """
+    The login of the organization to find.
+    """
     login: String!
   ): Organization
 
-  # A list of organizations the user belongs to.
+  """
+  A list of organizations the user belongs to.
+  """
   organizations(
-    # Returns the elements in the list that come after the specified cursor.
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
     after: String
 
-    # Returns the elements in the list that come before the specified cursor.
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
     before: String
 
-    # Returns the first _n_ elements from the list.
+    """
+    Returns the first _n_ elements from the list.
+    """
     first: Int
 
-    # Returns the last _n_ elements from the list.
+    """
+    Returns the last _n_ elements from the list.
+    """
     last: Int
   ): OrganizationConnection!
 }