graphql 0.19.3 → 0.19.4

data/spec/graphql/schema/printer_spec.rb

@@ -19,7 +19,9 @@ describe GraphQL::Schema::Printer do
 
     sub_input_type = GraphQL::InputObjectType.define do
       name "Sub"
-      input_field :string, types.String
+      description "Test"
+      input_field :string, types.String, 'Something'
+      input_field :int, types.Int, 'Something'
     end
 
     variant_input_type = GraphQL::InputObjectType.define do
@@ -51,6 +53,30 @@ describe GraphQL::Schema::Printer do
       field :comments_count, !types.Int, deprecation_reason: 'Use "comments".'
     end
 
+    audio_type = GraphQL::ObjectType.define do
+      name "Audio"
+
+      field :id, !types.ID
+      field :name, !types.String
+      field :duration, !types.Int
+    end
+
+    image_type = GraphQL::ObjectType.define do
+      name "Image"
+
+      field :id, !types.ID
+      field :name, !types.String
+      field :width, !types.Int
+      field :height, !types.Int
+    end
+
+    media_union_type = GraphQL::UnionType.define do
+      name "Media"
+      description "Media objects"
+
+      possible_types [image_type, audio_type]
+    end
+
     query_root = GraphQL::ObjectType.define do
       name "Query"
       description "The query root of this schema"
@@ -59,57 +85,152 @@ describe GraphQL::Schema::Printer do
         type post_type
         argument :id, !types.ID
         argument :varied, variant_input_type, default_value: { id: "123", int: 234, float: 2.3, enum: :foo, sub: [{ string: "str" }] }
-        resolve -> (obj, args, ctx) { Post.find(args["id"]) }
+        resolve ->(obj, args, ctx) { Post.find(args["id"]) }
+      end
+    end
+
+    create_post_mutation = GraphQL::Relay::Mutation.define do
+      name "CreatePost"
+      description "Create a blog post"
+
+      input_field :title, !types.String
+      input_field :body, !types.String
+
+      return_field :post, post_type
+
+      resolve ->(_, _, _) { }
+    end
+
+    mutation_root = GraphQL::ObjectType.define do
+      name "Mutation"
+
+      field :createPost, field: create_post_mutation.field
+    end
+
+    subscription_root = GraphQL::ObjectType.define do
+      name "Subscription"
+
+      field :post do
+        type post_type
+        argument :id, !types.ID
+        resolve ->(_, _, _) { }
       end
     end
 
-    GraphQL::Schema.define(query: query_root, resolve_type: :pass)
+    GraphQL::Schema.define(
+      query: query_root,
+      mutation: mutation_root,
+      subscription: subscription_root,
+      resolve_type: :pass,
+      orphan_types: [media_union_type]
+    )
   }
 
   describe ".print_introspection_schema" do
     it "returns the schema as a string for the introspection types" do
+      # From https://github.com/graphql/graphql-js/blob/6a0e00fe46951767287f2cc62e1a10b167b2eaa6/src/utilities/__tests__/schemaPrinter-test.js#L599
       expected = <<SCHEMA
 schema {
-  query: Query
+  query: Root
 }
 
-directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-directive @deprecated(reason: String = \"No longer supported\") on FIELD_DEFINITION | ENUM_VALUE
-
+# Directs the executor to include this field or fragment only when the \`if\` argument is true.
+directive @include(
+  # Included when true.
+  if: Boolean!
+) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+# Directs the executor to skip this field or fragment when the \`if\` argument is true.
+directive @skip(
+  # Skipped when true.
+  if: Boolean!
+) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+# Marks an element of a GraphQL schema as no longer supported.
+directive @deprecated(
+  # 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/).
+  reason: String = "No longer supported"
+) on FIELD_DEFINITION | ENUM_VALUE
+
+# A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
+#
+# In some cases, you need to provide options to alter GraphQL's execution behavior
+# in ways field arguments will not suffice, such as conditionally including or
+# skipping a field. Directives provide this by describing additional information
+# to the executor.
 type __Directive {
   name: String!
   description: String
   locations: [__DirectiveLocation!]!
   args: [__InputValue!]!
-  onOperation: Boolean! @deprecated(reason: \"Use `locations`.\")
-  onFragment: Boolean! @deprecated(reason: \"Use `locations`.\")
-  onField: Boolean! @deprecated(reason: \"Use `locations`.\")
+  onOperation: Boolean! @deprecated(reason: "Use \`locations\`.")
+  onFragment: Boolean! @deprecated(reason: "Use \`locations\`.")
+  onField: Boolean! @deprecated(reason: "Use \`locations\`.")
 }
 
+# A Directive can be adjacent to many parts of the GraphQL language, a
+# __DirectiveLocation describes one such possible adjacencies.
 enum __DirectiveLocation {
+  # Location adjacent to a query operation.
   QUERY
+
+  # Location adjacent to a mutation operation.
   MUTATION
+
+  # Location adjacent to a subscription operation.
   SUBSCRIPTION
+
+  # Location adjacent to a field.
   FIELD
+
+  # Location adjacent to a fragment definition.
   FRAGMENT_DEFINITION
+
+  # Location adjacent to a fragment spread.
   FRAGMENT_SPREAD
+
+  # Location adjacent to an inline fragment.
   INLINE_FRAGMENT
+
+  # Location adjacent to a schema definition.
   SCHEMA
+
+  # Location adjacent to a scalar definition.
   SCALAR
+
+  # Location adjacent to an object type definition.
   OBJECT
+
+  # Location adjacent to a field definition.
   FIELD_DEFINITION
+
+  # Location adjacent to an argument definition.
   ARGUMENT_DEFINITION
+
+  # Location adjacent to an interface definition.
   INTERFACE
+
+  # Location adjacent to a union definition.
   UNION
+
+  # Location adjacent to an enum definition.
   ENUM
+
+  # Location adjacent to an enum value definition.
   ENUM_VALUE
+
+  # Location adjacent to an input object type definition.
   INPUT_OBJECT
+
+  # Location adjacent to an input object field definition.
   INPUT_FIELD_DEFINITION
 }
 
+# One possible value for a given Enum. Enum values are unique values, not a
+# placeholder for a string or numeric value. However an Enum value is returned in
+# a JSON response as a string.
 type __EnumValue {
   name: String!
   description: String
@@ -117,6 +238,8 @@ type __EnumValue {
   deprecationReason: String
 }
 
+# Object and Interface types are described by a list of Fields, each of which has
+# a name, potentially a list of arguments, and a return type.
 type __Field {
   name: String!
   description: String
@@ -126,41 +249,82 @@ type __Field {
   deprecationReason: String
 }
 
+# Arguments provided to Fields or Directives and the input fields of an
+# InputObject are represented as Input Values which describe their type and
+# optionally a default value.
 type __InputValue {
   name: String!
   description: String
   type: __Type!
+
+  # A GraphQL-formatted string representing the default value for this input value.
   defaultValue: String
 }
 
+# A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all
+# available types and directives on the server, as well as the entry points for
+# query, mutation, and subscription operations.
 type __Schema {
+  # A list of all types supported by this server.
   types: [__Type!]!
+
+  # The type that query operations will be rooted at.
   queryType: __Type!
+
+  # If this server supports mutation, the type that mutation operations will be rooted at.
   mutationType: __Type
+
+  # If this server support subscription, the type that subscription operations will be rooted at.
   subscriptionType: __Type
+
+  # A list of all directives supported by this server.
   directives: [__Directive!]!
 }
 
+# The fundamental unit of any GraphQL Schema is the type. There are many kinds of
+# types in GraphQL as represented by the \`__TypeKind\` enum.
+#
+# Depending on the kind of a type, certain fields describe information about that
+# type. Scalar types provide no information beyond a name and description, while
+# Enum types provide their values. Object and Interface types provide the fields
+# they describe. Abstract types, Union and Interface, provide the Object types
+# possible at runtime. List and NonNull types compose other types.
 type __Type {
+  kind: __TypeKind!
   name: String
   description: String
-  kind: __TypeKind!
   fields(includeDeprecated: Boolean = false): [__Field!]
-  ofType: __Type
-  inputFields: [__InputValue!]
+  interfaces: [__Type!]
   possibleTypes: [__Type!]
   enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
-  interfaces: [__Type!]
+  inputFields: [__InputValue!]
+  ofType: __Type
 }
 
+# An enum describing what kind of type a given \`__Type\` is.
 enum __TypeKind {
+  # Indicates this type is a scalar.
   SCALAR
+
+  # Indicates this type is an object. \`fields\` and \`interfaces\` are valid fields.
   OBJECT
+
+  # Indicates this type is an interface. \`fields\` and \`possibleTypes\` are valid fields.
   INTERFACE
+
+  # Indicates this type is a union. \`possibleTypes\` is a valid field.
   UNION
+
+  # Indicates this type is an enum. \`enumValues\` is a valid field.
   ENUM
+
+  # Indicates this type is an input object. \`inputFields\` is a valid field.
   INPUT_OBJECT
+
+  # Indicates this type is a list. \`ofType\` is a valid field.
   LIST
+
+  # Indicates this type is a non-null. \`ofType\` is a valid field.
   NON_NULL
 }
 SCHEMA
@@ -169,10 +333,54 @@ SCHEMA
   end
 
   describe ".print_schema" do
-    it "returns the schema as a string for the defined types" do
+    it "includes schema definition when query root name doesn't match convention" do
+      schema.query.name = 'MyQueryRoot'
+
+      expected = <<SCHEMA
+schema {
+  query: MyQueryRoot
+  mutation: Mutation
+  subscription: Subscription
+}
+SCHEMA
+
+      assert_match expected, GraphQL::Schema::Printer.print_schema(schema)
+    end
+
+    it "includes schema definition when mutation root name doesn't match convention" do
+      schema.mutation.name = 'MyMutationRoot'
+
+      expected = <<SCHEMA
+schema {
+  query: Query
+  mutation: MyMutationRoot
+  subscription: Subscription
+}
+SCHEMA
+
+      assert_match expected, GraphQL::Schema::Printer.print_schema(schema)
+    end
+
+    it "includes schema definition when subscription root name doesn't match convention" do
+      schema.subscription.name = 'MySubscriptionRoot'
+
       expected = <<SCHEMA
 schema {
   query: Query
+  mutation: Mutation
+  subscription: MySubscriptionRoot
+}
+SCHEMA
+
+      assert_match expected, GraphQL::Schema::Printer.print_schema(schema)
+    end
+
+    it "returns the schema as a string for the defined types" do
+      expected = <<SCHEMA
+type Audio {
+  id: ID!
+  name: String!
+  duration: Int!
 }
 
 enum Choice {
@@ -182,14 +390,46 @@ enum Choice {
   WOZ @deprecated
 }
 
+# A blog comment
 type Comment implements Node {
   id: ID!
 }
 
+# Autogenerated input type of CreatePost
+input CreatePostInput {
+  # A unique identifier for the client performing the mutation.
+  clientMutationId: String
+  title: String!
+  body: String!
+}
+
+# Autogenerated return type of CreatePost
+type CreatePostPayload {
+  # A unique identifier for the client performing the mutation.
+  clientMutationId: String
+  post: Post
+}
+
+type Image {
+  id: ID!
+  name: String!
+  width: Int!
+  height: Int!
+}
+
+# Media objects
+union Media = Image | Audio
+
+type Mutation {
+  # Create a blog post
+  createPost(input: CreatePostInput!): CreatePostPayload
+}
+
 interface Node {
   id: ID!
 }
 
+# A blog post
 type Post {
   id: ID!
   title: String!
@@ -198,12 +438,22 @@ type Post {
   comments_count: Int! @deprecated(reason: \"Use \\\"comments\\\".\")
 }
 
+# The query root of this schema
 type Query {
   post(id: ID!, varied: Varied = {id: \"123\", int: 234, float: 2.3, enum: FOO, sub: [{string: \"str\"}]}): Post
 }
 
+# Test
 input Sub {
+  # Something
   string: String
+
+  # Something
+  int: Int
+}
+
+type Subscription {
+  post(id: ID!): Post
 }
 
 input Varied {

data/spec/graphql/schema/rescue_middleware_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 class SpecExampleError < StandardError; end
 
 describe GraphQL::Schema::RescueMiddleware do
-  let(:error_middleware) { -> (next_middleware) { raise(error_class) } }
+  let(:error_middleware) { ->(next_middleware) { raise(error_class) } }
 
   let(:rescue_middleware) do
     middleware = GraphQL::Schema::RescueMiddleware.new

data/spec/graphql/schema/timeout_middleware_spec.rb

@@ -5,7 +5,7 @@ describe GraphQL::Schema::TimeoutMiddleware do
   let(:timeout_middleware) {  GraphQL::Schema::TimeoutMiddleware.new(max_seconds: max_seconds) }
   let(:timeout_schema) {
 
-    sleep_for_seconds_resolve = -> (obj, args, ctx) {
+    sleep_for_seconds_resolve = ->(obj, args, ctx) {
       sleep(args[:seconds])
       args[:seconds]
     }
@@ -13,7 +13,7 @@ describe GraphQL::Schema::TimeoutMiddleware do
     nested_sleep_type = GraphQL::ObjectType.define do
       name "NestedSleep"
       field :seconds, types.Float do
-        resolve -> (obj, args, ctx) { obj }
+        resolve ->(obj, args, ctx) { obj }
       end
 
       field :nestedSleep, -> { nested_sleep_type } do