graphql 0.19.3 → 0.19.4

data/lib/graphql/language/parser.rb

@@ -44,6 +44,25 @@ def next_token
   end
 end
 
+def get_description(token)
+  comments = []
+
+  loop do
+    prev_token = token
+    token = token.prev_token
+
+    break if token.nil?
+    break if token.name != :COMMENT
+    break if prev_token.line != token.line + 1
+
+    comments.unshift(token.to_s.sub(/^#\s*/, ""))
+  end
+
+  return nil if comments.empty?
+
+  comments.join("\n")
+end
+
 def on_error(parser_token_id, lexer_token, vstack)
   if lexer_token == "$"
     raise GraphQL::ParseError.new("Unexpected end of document", nil, nil, @query_string)
@@ -1046,21 +1065,21 @@ module_eval(<<'.,.,', 'parser.y', 103)
 
 module_eval(<<'.,.,', 'parser.y', 146)
   def _reduce_58(val, _values, result)
-     return [val[0].to_s]
+     return [make_node(:TypeName, name: val[0])] 
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.y', 147)
   def _reduce_59(val, _values, result)
-     val[0] << val[1].to_s 
+     val[0] << make_node(:TypeName, name: val[1]) 
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.y', 150)
   def _reduce_60(val, _values, result)
-     return make_node(:EnumValueDefinition, name: val[0], directives: val[1]) 
+     return make_node(:EnumValueDefinition, name: val[0], directives: val[1], description: get_description(val[0])) 
     result
   end
 .,.,
@@ -1371,14 +1390,14 @@ module_eval(<<'.,.,', 'parser.y', 262)
 
 module_eval(<<'.,.,', 'parser.y', 272)
   def _reduce_113(val, _values, result)
-     return make_node(:ScalarTypeDefinition, name: val[1], directives: val[2]) 
+     return make_node(:ScalarTypeDefinition, name: val[1], directives: val[2], description: get_description(val[0])) 
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.y', 276)
   def _reduce_114(val, _values, result)
-            return make_node(:ObjectTypeDefinition, name: val[1], interfaces: val[2], directives: val[3], fields: val[5])
+            return make_node(:ObjectTypeDefinition, name: val[1], interfaces: val[2], directives: val[3], fields: val[5], description: get_description(val[0]))
       
     result
   end
@@ -1400,7 +1419,7 @@ module_eval(<<'.,.,', 'parser.y', 281)
 
 module_eval(<<'.,.,', 'parser.y', 285)
   def _reduce_117(val, _values, result)
-            return make_node(:InputValueDefinition, name: val[0], type: val[2], default_value: val[3], directives: val[4])
+            return make_node(:InputValueDefinition, name: val[0], type: val[2], default_value: val[3], directives: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1436,7 +1455,7 @@ module_eval(<<'.,.,', 'parser.y', 294)
 
 module_eval(<<'.,.,', 'parser.y', 298)
   def _reduce_122(val, _values, result)
-            return make_node(:FieldDefinition, name: val[0], arguments: val[1], type: val[3], directives: val[4])
+            return make_node(:FieldDefinition, name: val[0], arguments: val[1], type: val[3], directives: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1458,7 +1477,7 @@ module_eval(<<'.,.,', 'parser.y', 303)
 
 module_eval(<<'.,.,', 'parser.y', 307)
   def _reduce_125(val, _values, result)
-            return make_node(:InterfaceTypeDefinition, name: val[1], directives: val[2], fields: val[4])
+            return make_node(:InterfaceTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1466,21 +1485,21 @@ module_eval(<<'.,.,', 'parser.y', 307)
 
 module_eval(<<'.,.,', 'parser.y', 311)
   def _reduce_126(val, _values, result)
-     return [val[0].to_s]
+     return [make_node(:TypeName, name: val[0])]
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.y', 312)
   def _reduce_127(val, _values, result)
-     val[0] << val[2].to_s 
+     val[0] << make_node(:TypeName, name: val[2]) 
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.y', 316)
   def _reduce_128(val, _values, result)
-            return make_node(:UnionTypeDefinition, name: val[1], directives: val[2], types: val[4])
+            return make_node(:UnionTypeDefinition, name: val[1], directives: val[2], types: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1488,7 +1507,7 @@ module_eval(<<'.,.,', 'parser.y', 316)
 
 module_eval(<<'.,.,', 'parser.y', 321)
   def _reduce_129(val, _values, result)
-             return make_node(:EnumTypeDefinition, name: val[1], directives: val[2], values: val[4])
+             return make_node(:EnumTypeDefinition, name: val[1], directives: val[2], values: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1496,7 +1515,7 @@ module_eval(<<'.,.,', 'parser.y', 321)
 
 module_eval(<<'.,.,', 'parser.y', 326)
   def _reduce_130(val, _values, result)
-            return make_node(:InputObjectTypeDefinition, name: val[1], directives: val[2], fields: val[4])
+            return make_node(:InputObjectTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]))
       
     result
   end
@@ -1504,7 +1523,7 @@ module_eval(<<'.,.,', 'parser.y', 326)
 
 module_eval(<<'.,.,', 'parser.y', 331)
   def _reduce_131(val, _values, result)
-            return make_node(:DirectiveDefinition, name: val[2], arguments: val[3], locations: val[5])
+            return make_node(:DirectiveDefinition, name: val[2], arguments: val[3], locations: val[5], description: get_description(val[0]))
       
     result
   end

data/lib/graphql/language/parser.y

@@ -144,11 +144,11 @@ rule
     | schema_keyword
 
   name_list:
-      name             { return [val[0].to_s]}
-    | name_list name   { val[0] << val[1].to_s }
+      name             { return [make_node(:TypeName, name: val[0])] }
+    | name_list name   { val[0] << make_node(:TypeName, name: val[1]) }
 
   enum_value_definition:
-    enum_name directives_list_opt { return make_node(:EnumValueDefinition, name: val[0], directives: val[1]) }
+    enum_name directives_list_opt { return make_node(:EnumValueDefinition, name: val[0], directives: val[1], description: get_description(val[0])) }
 
   enum_value_definitions:
       enum_value_definition                        { return [val[0]] }
@@ -270,11 +270,11 @@ rule
     | enum_type_definition
     | input_object_type_definition
 
-  scalar_type_definition: SCALAR name directives_list_opt { return make_node(:ScalarTypeDefinition, name: val[1], directives: val[2]) }
+  scalar_type_definition: SCALAR name directives_list_opt { return make_node(:ScalarTypeDefinition, name: val[1], directives: val[2], description: get_description(val[0])) }
 
   object_type_definition:
       TYPE name implements_opt directives_list_opt LCURLY field_definition_list RCURLY {
-        return make_node(:ObjectTypeDefinition, name: val[1], interfaces: val[2], directives: val[3], fields: val[5])
+        return make_node(:ObjectTypeDefinition, name: val[1], interfaces: val[2], directives: val[3], fields: val[5], description: get_description(val[0]))
       }
 
   implements_opt:
@@ -283,7 +283,7 @@ rule
 
   input_value_definition:
       name COLON type default_value_opt directives_list_opt {
-        return make_node(:InputValueDefinition, name: val[0], type: val[2], default_value: val[3], directives: val[4])
+        return make_node(:InputValueDefinition, name: val[0], type: val[2], default_value: val[3], directives: val[4], description: get_description(val[0]))
       }
 
   input_value_definition_list:
@@ -296,7 +296,7 @@ rule
 
   field_definition:
       name arguments_definitions_opt COLON type directives_list_opt {
-        return make_node(:FieldDefinition, name: val[0], arguments: val[1], type: val[3], directives: val[4])
+        return make_node(:FieldDefinition, name: val[0], arguments: val[1], type: val[3], directives: val[4], description: get_description(val[0]))
       }
 
   field_definition_list:
@@ -305,31 +305,31 @@ rule
 
   interface_type_definition:
       INTERFACE name directives_list_opt LCURLY field_definition_list RCURLY {
-        return make_node(:InterfaceTypeDefinition, name: val[1], directives: val[2], fields: val[4])
+        return make_node(:InterfaceTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]))
       }
 
   union_members:
-      name                    { return [val[0].to_s]}
-    | union_members PIPE name { val[0] << val[2].to_s }
+      name                    { return [make_node(:TypeName, name: val[0])]}
+    | union_members PIPE name { val[0] << make_node(:TypeName, name: val[2]) }
 
   union_type_definition:
       UNION name directives_list_opt EQUALS union_members {
-        return make_node(:UnionTypeDefinition, name: val[1], directives: val[2], types: val[4])
+        return make_node(:UnionTypeDefinition, name: val[1], directives: val[2], types: val[4], description: get_description(val[0]))
       }
 
   enum_type_definition:
       ENUM name directives_list_opt LCURLY enum_value_definitions RCURLY {
-         return make_node(:EnumTypeDefinition, name: val[1], directives: val[2], values: val[4])
+         return make_node(:EnumTypeDefinition, name: val[1], directives: val[2], values: val[4], description: get_description(val[0]))
       }
 
   input_object_type_definition:
       INPUT name directives_list_opt LCURLY input_value_definition_list RCURLY {
-        return make_node(:InputObjectTypeDefinition, name: val[1], directives: val[2], fields: val[4])
+        return make_node(:InputObjectTypeDefinition, name: val[1], directives: val[2], fields: val[4], description: get_description(val[0]))
       }
 
   directive_definition:
       DIRECTIVE DIR_SIGN name arguments_definitions_opt ON directive_locations {
-        return make_node(:DirectiveDefinition, name: val[2], arguments: val[3], locations: val[5])
+        return make_node(:DirectiveDefinition, name: val[2], arguments: val[3], locations: val[5], description: get_description(val[0]))
       }
 
   directive_locations:
@@ -372,6 +372,25 @@ def next_token
   end
 end
 
+def get_description(token)
+  comments = []
+
+  loop do
+    prev_token = token
+    token = token.prev_token
+
+    break if token.nil?
+    break if token.name != :COMMENT
+    break if prev_token.line != token.line + 1
+
+    comments.unshift(token.to_s.sub(/^#\s*/, ""))
+  end
+
+  return nil if comments.empty?
+
+  comments.join("\n")
+end
+
 def on_error(parser_token_id, lexer_token, vstack)
   if lexer_token == "$"
     raise GraphQL::ParseError.new("Unexpected end of document", nil, nil, @query_string)

data/lib/graphql/language/parser_tests.rb

@@ -275,6 +275,90 @@ module GraphQL
               end
             end
 
+            describe "schema with comments" do
+              let(:query_string) {%|
+                # Schema at beginning of file
+
+                schema {
+                  query: Hello
+                }
+
+                # Comment between two definitions are omitted
+
+                # This is a directive
+                directive @foo(
+                  # It has an argument
+                  arg: Int
+                ) on FIELD
+
+                # Multiline comment
+                #
+                # With an enum
+                enum Color {
+                  RED
+
+                  # Not a creative color
+                  GREEN
+                  BLUE
+                }
+
+                #Comment without preceding space
+                type Hello {
+                  # And a field to boot
+                  str: String
+                }
+
+                # Comment for input object types
+                input Car {
+                  # Color of the car
+                  color: String!
+                }
+
+                # Comment for interface definitions
+                interface Vehicle {
+                  # Amount of wheels
+                  wheels: Int!
+                }
+
+                # Comment at the end of schema
+              |}
+
+              it "parses successfully" do
+                document = subject.parse(query_string)
+
+                assert_equal 6, document.definitions.size
+
+                schema_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::SchemaDefinition, schema_definition.class
+
+                directive_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::DirectiveDefinition, directive_definition.class
+                assert_equal 'This is a directive', directive_definition.description
+
+                enum_type_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::EnumTypeDefinition, enum_type_definition.class
+                assert_equal "Multiline comment\n\nWith an enum", enum_type_definition.description
+
+                assert_nil enum_type_definition.values[0].description
+                assert_equal 'Not a creative color', enum_type_definition.values[1].description
+
+                object_type_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::ObjectTypeDefinition, object_type_definition.class
+                assert_equal 'Comment without preceding space', object_type_definition.description
+                assert_equal 'And a field to boot', object_type_definition.fields[0].description
+
+                input_object_type_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::InputObjectTypeDefinition, input_object_type_definition.class
+                assert_equal 'Comment for input object types', input_object_type_definition.description
+                assert_equal 'Color of the car', input_object_type_definition.fields[0].description
+
+                interface_type_definition = document.definitions.shift
+                assert_equal GraphQL::Language::Nodes::InterfaceTypeDefinition, interface_type_definition.class
+                assert_equal 'Comment for interface definitions', interface_type_definition.description
+                assert_equal 'Amount of wheels', interface_type_definition.fields[0].description
+              end
+            end
+
             describe "schema" do
               it "parses the test schema" do
                 schema = DummySchema
@@ -319,7 +403,7 @@ module GraphQL
                 type = document.definitions.first
                 assert_equal GraphQL::Language::Nodes::ObjectTypeDefinition, type.class
                 assert_equal 'Comment', type.name
-                assert_equal ['Node'], type.interfaces
+                assert_equal ['Node'], type.interfaces.map(&:name)
                 assert_equal ['id'], type.fields.map(&:name)
                 assert_equal [], type.fields[0].arguments
                 assert_equal 'ID', type.fields[0].type.of_type.name
@@ -335,7 +419,7 @@ module GraphQL
                 type = document.definitions.first
                 assert_equal GraphQL::Language::Nodes::ObjectTypeDefinition, type.class
                 assert_equal 'Comment', type.name
-                assert_equal ['Node'], type.interfaces
+                assert_equal ['Node'], type.interfaces.map(&:name)
                 assert_equal ['id'], type.fields.map(&:name)
                 assert_equal [], type.fields[0].arguments
                 assert_equal 'ID', type.fields[0].type.of_type.name

data/lib/graphql/language/token.rb

@@ -4,13 +4,14 @@ module GraphQL
     # Contains type, value and position data.
     class Token
       # @return [Symbol] The kind of token this is
-      attr_reader :name
+      attr_reader :name, :prev_token, :line
 
-      def initialize(value:, name:, line:, col:)
+      def initialize(value:, name:, line:, col:, prev_token:)
         @name = name
         @value = value
         @line = line
         @col = col
+        @prev_token = prev_token
       end
 
       def to_s; @value; end

data/lib/graphql/language/visitor.rb

@@ -6,9 +6,9 @@ module GraphQL
     #   total_field_count = 0
     #   visitor = GraphQL::Language::Visitor.new(document)
     #   # Whenever you find a field, increment the field count:
-    #   visitor[GraphQL::Language::Nodes::Field] << -> (node) { total_field_count += 1 }
+    #   visitor[GraphQL::Language::Nodes::Field] << ->(node) { total_field_count += 1 }
     #   # When we finish, print the field count:
-    #   visitor[GraphQL::Language::Nodes::Document].leave << -> (node) { p total_field_count }
+    #   visitor[GraphQL::Language::Nodes::Document].leave << ->(node) { p total_field_count }
     #   visitor.visit
     #   # => 6
     #
@@ -34,7 +34,7 @@ module GraphQL
       # @return [NodeVisitor]
       #
       # @example Run a hook whenever you enter a new Field
-      #   visitor[GraphQL::Language::Nodes::Field] << -> (node, parent) { p "Here's a field" }
+      #   visitor[GraphQL::Language::Nodes::Field] << ->(node, parent) { p "Here's a field" }
       def [](node_class)
         @visitors[node_class] ||= NodeVisitor.new
       end

data/lib/graphql/object_type.rb

@@ -12,7 +12,7 @@ module GraphQL
   #     field :cast, CastType
   #     field :starring, types[PersonType] do
   #       argument :limit, types.Int
-  #       resolve -> (object, args, ctx) {
+  #       resolve ->(object, args, ctx) {
   #         stars = object.cast.stars
   #         args[:limit] && stars = stars.limit(args[:limit])
   #         stars

data/lib/graphql/query/arguments.rb

@@ -11,7 +11,8 @@ module GraphQL
         @argument_values = values.inject({}) do |memo, (inner_key, inner_value)|
           string_key = inner_key.to_s
           arg_defn = argument_definitions[string_key]
-          memo[string_key] = wrap_value(inner_value, arg_defn.type)
+          arg_value = wrap_value(inner_value, arg_defn.type)
+          memo[string_key] = ArgumentValue.new(string_key, arg_value, arg_defn)
           memo
         end
       end
@@ -19,7 +20,7 @@ module GraphQL
       # @param key [String, Symbol] name or index of value to access
       # @return [Object] the argument at that key
       def [](key)
-        @argument_values[key.to_s]
+        @argument_values.fetch(key.to_s, NULL_ARGUMENT_VALUE).value
       end
 
       # @param key [String, Symbol] name of value to access
@@ -36,8 +37,28 @@ module GraphQL
 
       def_delegators :string_key_values, :keys, :values, :each
 
+      # Access each key, value and type for the arguments in this set.
+      # @yield [argument_value] The {ArgumentValue} for each argument
+      # @yieldparam argument_value [ArgumentValue]
+      def each_value
+        @argument_values.each_value do |argument_value|
+          yield(argument_value)
+        end
+      end
+
       private
 
+      class ArgumentValue
+        attr_reader :key, :value, :definition
+        def initialize(key, value, definition)
+          @key = key
+          @value = value
+          @definition = definition
+        end
+      end
+
+      NULL_ARGUMENT_VALUE = ArgumentValue.new(nil, nil, nil)
+
       def wrap_value(value, arg_defn_type)
         case value
         when Array