tinygql 0.1.2 → 0.1.3

data/bin/bench.rb

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
-$:.unshift(File.expand_path("../lib", __dir__))
 require "tinygql"
-require "benchmark"
+require "benchmark/ips"
 
 source = File.read(File.expand_path("../test/kitchen-sink.graphql", __dir__))
 
-Benchmark.bm do |x|
-  x.report { 10_000.times { TinyGQL::Parser.new(source).parse } }
+files = Dir[File.join(File.expand_path("../benchmark", __dir__), "**/*")].select { |f| File.file? f }
+
+Benchmark.ips do |x|
+  x.report "kitchen-sink" do
+    TinyGQL.parse source
+  end
+
+  files.each do |file_name|
+    data = File.read file_name
+    name = File.basename(file_name, File.extname(file_name))
+    x.report name do
+      TinyGQL.parse data
+    end
+  end
 end

data/bin/profile.rb

@@ -0,0 +1,5 @@
+require "vernier"
+
+Vernier.trace(out: "time_profile.json") {
+  require_relative "bench"
+}

data/lib/tinygql/nodes.rb

@@ -538,9 +538,10 @@ module TinyGQL
       end
     end
     class SchemaDefinition < Node
-      attr_reader :directives, :root_operation_definitions
+      attr_reader :description, :directives, :root_operation_definitions
 
-      def initialize directives, root_operation_definitions
+      def initialize description, directives, root_operation_definitions
+        @description = description
         @directives = directives
         @root_operation_definitions = root_operation_definitions
       end

data/lib/tinygql/nodes.yml

@@ -115,12 +115,13 @@ nodes:
 
   - name: SchemaDefinition
     fields:
+      - description?
       - directives?: list
       - root_operation_definitions: list
 
   - name: FieldDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - arguments_definition?: list
       - type
@@ -128,7 +129,7 @@ nodes:
 
   - name: InputValueDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - type
       - default_value?
@@ -136,7 +137,7 @@ nodes:
 
   - name: ObjectTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - implements_interfaces?: list
       - directives?: list
@@ -144,40 +145,40 @@ nodes:
 
   - name: InterfaceTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - directives?: list
       - fields_definition?: list
 
   - name: UnionTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - directives?: list
       - union_member_types?: list
 
   - name: ScalarTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - directives?: list
 
   - name: EnumValueDefinition
     fields:
-      - description?: literal
+      - description?
       - enum_value
       - directives?: list
 
   - name: EnumTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - directives?: list
       - enum_value_definition?: list
 
   - name: InputObjectTypeDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - directives?: list
       - input_fields_definition?: list
@@ -199,7 +200,7 @@ nodes:
 
   - name: DirectiveDefinition
     fields:
-      - description?: literal
+      - description?
       - name: literal
       - arguments_definition?: list
       - directive_locations: list

data/lib/tinygql/parser.rb

@@ -7,7 +7,9 @@ module TinyGQL
   class Parser
     class UnexpectedToken < StandardError; end
 
-    attr_reader :token_name
+    def self.parse doc
+      new(doc).parse
+    end
 
     def initialize doc
       @lexer = Lexer.new doc
@@ -21,6 +23,8 @@ module TinyGQL
 
     private
 
+    attr_reader :token_name
+
     def document
       Nodes::Document.new definition_list
     end
@@ -40,7 +44,9 @@ module TinyGQL
       when :EXTEND
         type_system_extension
       else
-        type_system_definition
+        desc = if at?(:STRING); string_value; end
+
+        type_system_definition desc
       end
     end
 
@@ -62,12 +68,12 @@ module TinyGQL
       Nodes::ObjectTypeExtension.new(name, implements_interfaces, directives, fields_definition)
     end
 
-    def type_system_definition
+    def type_system_definition desc
       case token_name
-      when :SCHEMA then schema_definition
-      when :DIRECTIVE then directive_defintion(nil)
+      when :SCHEMA then schema_definition(desc)
+      when :DIRECTIVE then directive_defintion(desc)
       else
-        type_definition(nil)
+        type_definition(desc)
       end
     end
 
@@ -91,9 +97,11 @@ module TinyGQL
     end
 
     def directive_location
-      case token_name
+      directive = expect_token_value :IDENTIFIER
+
+      case directive
       when "QUERY", "MUTATION", "SUBSCRIPTION", "FIELD", "FRAGMENT_DEFINITION", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"
-        Nodes::ExecutableDirectiveLocation.new(accept_token_value)
+        Nodes::ExecutableDirectiveLocation.new(directive)
       when "SCHEMA",
         "SCALAR",
         "OBJECT",
@@ -105,9 +113,9 @@ module TinyGQL
         "ENUM_VALUE",
         "INPUT_OBJECT",
         "INPUT_FIELD_DEFINITION"
-        Nodes::TypeSystemDirectiveLocation.new(accept_token_value)
+        Nodes::TypeSystemDirectiveLocation.new(directive)
       else
-        expect_token(:IDENTIFIER); nil # error
+        raise UnexpectedToken, "Expected directive #{directive}"
       end
     end
 
@@ -161,7 +169,7 @@ module TinyGQL
     end
 
     def enum_value_definition
-      description = if at?(:STRING); accept_token_value; end
+      description = if at?(:STRING); string_value; end
       enum_value = self.enum_value
       directives = if at?(:DIR_SIGN); self.directives; end
       Nodes::EnumValueDefinition.new(description, enum_value, directives)
@@ -221,7 +229,7 @@ module TinyGQL
     end
 
     def field_definition
-      description = if at?(:STRING); accept_token_value; end
+      description = if at?(:STRING); string_value; end
       name = self.name
       arguments_definition = if at?(:LPAREN); self.arguments_definition; end
       expect_token :COLON
@@ -242,7 +250,7 @@ module TinyGQL
     end
 
     def input_value_definition
-      description = if at?(:STRING); accept_token_value; end
+      description = if at?(:STRING); string_value; end
       name = self.name
       expect_token :COLON
       type = self.type
@@ -262,14 +270,14 @@ module TinyGQL
       list
     end
 
-    def schema_definition
+    def schema_definition desc
       expect_token :SCHEMA
 
       directives = if at?(:DIR_SIGN); self.directives; end
       expect_token :LCURLY
       defs = root_operation_type_definition
       expect_token :RCURLY
-      Nodes::SchemaDefinition.new(directives, defs)
+      Nodes::SchemaDefinition.new(desc, directives, defs)
     end
 
     def root_operation_type_definition

data/lib/tinygql/version.rb

@@ -1,3 +1,3 @@
 module TinyGQL
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/tinygql/visitors.rb

@@ -100,12 +100,18 @@ module TinyGQL
             obj.named_type.accept self
       end
       def handle_schema_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
             obj.root_operation_definitions.each { |v| v.accept self }
       end
       def handle_field_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.arguments_definition
             obj.arguments_definition.each { |v| v.accept self }
         end
@@ -115,6 +121,9 @@ module TinyGQL
         end
       end
       def handle_input_value_definition obj
+        if obj.description
+            obj.description.accept self
+        end
             obj.type.accept self
         if obj.default_value
             obj.default_value.accept self
@@ -124,6 +133,9 @@ module TinyGQL
         end
       end
       def handle_object_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.implements_interfaces
             obj.implements_interfaces.each { |v| v.accept self }
         end
@@ -135,6 +147,9 @@ module TinyGQL
         end
       end
       def handle_interface_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
@@ -143,6 +158,9 @@ module TinyGQL
         end
       end
       def handle_union_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
@@ -151,17 +169,26 @@ module TinyGQL
         end
       end
       def handle_scalar_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
       end
       def handle_enum_value_definition obj
+        if obj.description
+            obj.description.accept self
+        end
             obj.enum_value.accept self
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
       end
       def handle_enum_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
@@ -170,6 +197,9 @@ module TinyGQL
         end
       end
       def handle_input_object_type_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.directives
             obj.directives.each { |v| v.accept self }
         end
@@ -193,6 +223,9 @@ module TinyGQL
       def handle_type_system_directive_location obj
       end
       def handle_directive_definition obj
+        if obj.description
+            obj.description.accept self
+        end
         if obj.arguments_definition
             obj.arguments_definition.each { |v| v.accept self }
         end
@@ -325,6 +358,9 @@ module TinyGQL
         seed
       end
       def handle_schema_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
@@ -332,6 +368,9 @@ module TinyGQL
         seed
       end
       def handle_field_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.arguments_definition
             obj.arguments_definition.each { |v| seed = v.fold(self, seed) }
         end
@@ -342,6 +381,9 @@ module TinyGQL
         seed
       end
       def handle_input_value_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
             seed = obj.type.fold self, seed
         if obj.default_value
             seed = obj.default_value.fold self, seed
@@ -352,6 +394,9 @@ module TinyGQL
         seed
       end
       def handle_object_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.implements_interfaces
             obj.implements_interfaces.each { |v| seed = v.fold(self, seed) }
         end
@@ -364,6 +409,9 @@ module TinyGQL
         seed
       end
       def handle_interface_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
@@ -373,6 +421,9 @@ module TinyGQL
         seed
       end
       def handle_union_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
@@ -382,12 +433,18 @@ module TinyGQL
         seed
       end
       def handle_scalar_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
         seed
       end
       def handle_enum_value_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
             seed = obj.enum_value.fold self, seed
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
@@ -395,6 +452,9 @@ module TinyGQL
         seed
       end
       def handle_enum_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
@@ -404,6 +464,9 @@ module TinyGQL
         seed
       end
       def handle_input_object_type_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.directives
             obj.directives.each { |v| seed = v.fold(self, seed) }
         end
@@ -431,6 +494,9 @@ module TinyGQL
         seed
       end
       def handle_directive_definition obj, seed
+        if obj.description
+            seed = obj.description.fold self, seed
+        end
         if obj.arguments_definition
             obj.arguments_definition.each { |v| seed = v.fold(self, seed) }
         end

data/test/parser_test.rb

@@ -161,5 +161,31 @@ eod
       node = ast.find(&:object_type_definition?).first
       assert_equal ["a", "b", "c"], node.implements_interfaces.map(&:name)
     end
+
+    def test_schemas_have_descriptions
+      doc = <<-eod
+"foo bar"
+schema {
+  query: QueryType
+  mutation: MutationType
+}
+      eod
+      ast = TinyGQL::Parser.parse doc
+      node = ast.find(&:schema_definition?)
+      assert node
+      assert_equal "foo bar", node.description.value
+    end
+
+    def test_directives_have_descriptions
+      doc = <<-eod
+"""neat!"""
+directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+      eod
+      ast = TinyGQL::Parser.parse doc
+      node = ast.find(&:directive_definition?)
+      assert node
+      assert_equal "neat!", node.description.value
+      assert_equal ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"], node.directive_locations.map(&:name)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinygql
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -51,7 +51,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/fixtures/negotiate.gql
 - bin/bench.rb
+- bin/profile.rb
 - lib/tinygql.rb
 - lib/tinygql/lexer.rb
 - lib/tinygql/nodes.rb