Add initial comment support [resurrected] (#26)

* Add initial comment support * add multiline comment test * expression body for properties and methods * \r\n fix * \r\n -> Environment.NewLine
graphql-dotnet · Mar 20, 2019 · de9ffa2 · de9ffa2
1 parent 6b5a980
commit de9ffa2
Show file tree

Hide file tree

Showing 44 changed files with 216 additions and 288 deletions.
diff --git a/src/GraphQLParser.Tests/LexerTests.cs b/src/GraphQLParser.Tests/LexerTests.cs
@@ -1,10 +1,13 @@
 namespace GraphQLParser.Tests
 {
     using GraphQLParser;
+    using System;
     using Xunit;
 
     public class LexerTests
     {
+        private static readonly string NL = Environment.NewLine;
+
         [Fact]
         public void Lex_ATPunctuation_HasCorrectEnd()
         {
@@ -297,28 +300,28 @@ public void Lex_MultipleDecimalsIntToken_HasIntKind()
         public void Lex_NameTokenWithComments_HasCorrectEnd()
         {
             var token = GetSingleNameTokenLexerWithComments();
-            Assert.Equal(13, token.End);
+            Assert.Equal(10, token.End);
         }
 
         [Fact]
         public void Lex_NameTokenWithComments_HasCorrectStart()
         {
             var token = GetSingleNameTokenLexerWithComments();
-            Assert.Equal(10, token.Start);
+            Assert.Equal(1, token.Start);
         }
 
         [Fact]
         public void Lex_NameTokenWithComments_HasCorrectValue()
         {
             var token = GetSingleNameTokenLexerWithComments();
-            Assert.Equal("foo", token.Value);
+            Assert.Equal("comment", token.Value);
         }
 
         [Fact]
         public void Lex_NameTokenWithComments_HasNameKind()
         {
             var token = GetSingleNameTokenLexerWithComments();
-            Assert.Equal(TokenKind.NAME, token.Kind);
+            Assert.Equal(TokenKind.COMMENT, token.Kind);
         }
 
         [Fact]
@@ -1062,12 +1065,12 @@ private static Token GetSingleNameSurroundedByCommasTokenLexer()
 
         private static Token GetSingleNameTokenLexerSurroundedWithWhitespaces()
         {
-            return new Lexer().Lex(new Source("\r\n        foo\r\n\r\n    "));
+            return new Lexer().Lex(new Source($"{NL}        foo{NL}{NL}    "));
         }
 
         private static Token GetSingleNameTokenLexerWithComments()
         {
-            return new Lexer().Lex(new Source("\r\n#comment\r\nfoo#comment"));
+            return new Lexer().Lex(new Source($"{NL}#comment{NL}foo#comment"));
         }
 
         private static Token GetSingleNameWithBOMHeaderTokenLexer()

diff --git a/src/GraphQLParser.Tests/ParserTests.cs b/src/GraphQLParser.Tests/ParserTests.cs
@@ -1,15 +1,15 @@
-
-
-namespace GraphQLParser.Tests
+namespace GraphQLParser.Tests
 {
-    using System.Linq;
     using GraphQLParser;
     using GraphQLParser.AST;
+    using System;
+    using System.Linq;
     using Xunit;
 
-
     public class ParserTests
     {
+        private static readonly string NL = Environment.NewLine;
+
         [Fact]
         public void Parse_FieldInput_HasCorrectEndLocationAttribute()
         {
@@ -125,7 +125,13 @@ public void Parse_FieldWithOperationTypeAndNameInput_SelectionSetContainsSingleF
         [Fact]
         public void Parse_KitchenSink_DoesNotThrowError()
         {
-            new Parser(new Lexer()).Parse(new Source(LoadKitchenSink()));
+            var document = new Parser(new Lexer()).Parse(new Source(LoadKitchenSink()));
+            if (document != null)
+            {
+                var typeDef = document.Definitions.OfType<GraphQLObjectTypeDefinition>().First(d => d.Name.Value == "Foo");
+                var fieldDef = typeDef.Fields.First(d => d.Name.Value == "three");
+                Assert.Equal($" multiline comments{NL} with very importand description #{NL} # and symbol # and ##", fieldDef.Comment.Text);
+            }
         }
 
         [Fact]
@@ -227,15 +233,20 @@ private static string LoadKitchenSink()
 # LICENSE file in the root directory of this source tree. An additional grant
 # of patent rights can be found in the PATENTS file in the same directory.
 
-    schema {
+schema {
   query: QueryType
   mutation: MutationType
 }
 
 type Foo implements Bar
 {
-    one: Type
+  # comment 1
+  one: Type
+  # comment 2
   two(argument: InputType!): Type
+  # multiline comments
+  # with very importand description #
+  # # and symbol # and ##
   three(argument: InputType, other: String): Int
   four(argument: String = ""string""): String
   five(argument: [String] = [""string"", ""string""]): String
@@ -244,6 +255,7 @@ private static string LoadKitchenSink()
 
 type AnnotatedObject @onObject(arg: ""value"")
 {
+    # a comment
     annotatedField(arg: Type = ""default"" @onArg): Type @onField
 }
 

diff --git a/src/GraphQLParser/AST/ASTNode.cs b/src/GraphQLParser/AST/ASTNode.cs
@@ -4,5 +4,6 @@ public abstract class ASTNode
     {
         public abstract ASTNodeKind Kind { get; }
         public GraphQLLocation Location { get; set; }
+        public GraphQLComment Comment { get; set; }
     }
 }
diff --git a/src/GraphQLParser/AST/Enums.cs b/src/GraphQLParser/AST/Enums.cs
@@ -2,6 +2,7 @@
 {
     public enum ASTNodeKind
     {
+        Comment,
         Name,
         Document,
         OperationDefinition,

diff --git a/src/GraphQLParser/AST/GraphQLArgument.cs b/src/GraphQLParser/AST/GraphQLArgument.cs
@@ -2,15 +2,10 @@
 {
     public class GraphQLArgument : ASTNode
     {
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.Argument;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.Argument;
 
         public GraphQLName Name { get; set; }
+
         public GraphQLValue Value { get; set; }
     }
 }
diff --git a/src/GraphQLParser/AST/GraphQLComment.cs b/src/GraphQLParser/AST/GraphQLComment.cs
@@ -0,0 +1,11 @@
+namespace GraphQLParser.AST
+{
+    public class GraphQLComment : ASTNode
+    {
+        public GraphQLComment(string text) => Text = text;
+
+        public override ASTNodeKind Kind => ASTNodeKind.Comment;
+
+        public string Text { get; set; }
+    }
+}
diff --git a/src/GraphQLParser/AST/GraphQLDirective.cs b/src/GraphQLParser/AST/GraphQLDirective.cs
@@ -6,13 +6,7 @@ public class GraphQLDirective : ASTNode
     {
         public IEnumerable<GraphQLArgument> Arguments { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.Directive;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.Directive;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLDirectiveDefinition.cs b/src/GraphQLParser/AST/GraphQLDirectiveDefinition.cs
@@ -7,13 +7,7 @@ public class GraphQLDirectiveDefinition : GraphQLTypeDefinition
         public IEnumerable<GraphQLInputValueDefinition> Arguments { get; set; }
         public IEnumerable<GraphQLInputValueDefinition> Definitions { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.DirectiveDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.DirectiveDefinition;
 
         public IEnumerable<GraphQLName> Locations { get; set; }
         public GraphQLName Name { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLDocument.cs b/src/GraphQLParser/AST/GraphQLDocument.cs
@@ -6,12 +6,6 @@ public class GraphQLDocument : ASTNode
     {
         public IEnumerable<ASTNode> Definitions { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.Document;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.Document;
     }
 }
diff --git a/src/GraphQLParser/AST/GraphQLEnumTypeDefinition.cs b/src/GraphQLParser/AST/GraphQLEnumTypeDefinition.cs
@@ -6,13 +6,7 @@ public class GraphQLEnumTypeDefinition : GraphQLTypeDefinition
     {
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.EnumTypeDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.EnumTypeDefinition;
 
         public GraphQLName Name { get; set; }
         public IEnumerable<GraphQLEnumValueDefinition> Values { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLEnumValueDefinition.cs b/src/GraphQLParser/AST/GraphQLEnumValueDefinition.cs
@@ -6,13 +6,7 @@ public class GraphQLEnumValueDefinition : GraphQLTypeDefinition
     {
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.EnumValueDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.EnumValueDefinition;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLFieldDefinition.cs b/src/GraphQLParser/AST/GraphQLFieldDefinition.cs
@@ -8,13 +8,7 @@ public class GraphQLFieldDefinition : GraphQLTypeDefinition
 
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.FieldDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.FieldDefinition;
 
         public GraphQLName Name { get; set; }
         public GraphQLType Type { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLFieldSelection.cs b/src/GraphQLParser/AST/GraphQLFieldSelection.cs
@@ -10,13 +10,7 @@ public class GraphQLFieldSelection : ASTNode
 
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.Field;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.Field;
 
         public GraphQLName Name { get; set; }
         public GraphQLSelectionSet SelectionSet { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLFragmentDefinition.cs b/src/GraphQLParser/AST/GraphQLFragmentDefinition.cs
@@ -2,13 +2,7 @@
 {
     public class GraphQLFragmentDefinition : GraphQLInlineFragment
     {
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.FragmentDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.FragmentDefinition;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLFragmentSpread.cs b/src/GraphQLParser/AST/GraphQLFragmentSpread.cs
@@ -6,13 +6,7 @@ public class GraphQLFragmentSpread : ASTNode
     {
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.FragmentSpread;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.FragmentSpread;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLInlineFragment.cs b/src/GraphQLParser/AST/GraphQLInlineFragment.cs
@@ -6,13 +6,7 @@ public class GraphQLInlineFragment : ASTNode
     {
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.InlineFragment;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.InlineFragment;
 
         public GraphQLSelectionSet SelectionSet { get; set; }
         public GraphQLNamedType TypeCondition { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLInputObjectTypeDefinition.cs b/src/GraphQLParser/AST/GraphQLInputObjectTypeDefinition.cs
@@ -8,13 +8,7 @@ public class GraphQLInputObjectTypeDefinition : GraphQLTypeDefinition
 
         public IEnumerable<GraphQLInputValueDefinition> Fields { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.InputObjectTypeDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.InputObjectTypeDefinition;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLInputValueDefinition.cs b/src/GraphQLParser/AST/GraphQLInputValueDefinition.cs
@@ -8,13 +8,7 @@ public class GraphQLInputValueDefinition : GraphQLTypeDefinition
 
         public IEnumerable<GraphQLDirective> Directives { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.InputValueDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.InputValueDefinition;
 
         public GraphQLName Name { get; set; }
         public GraphQLType Type { get; set; }

diff --git a/src/GraphQLParser/AST/GraphQLInterfaceTypeDefinition.cs b/src/GraphQLParser/AST/GraphQLInterfaceTypeDefinition.cs
@@ -8,13 +8,7 @@ public class GraphQLInterfaceTypeDefinition : GraphQLTypeDefinition
 
         public IEnumerable<GraphQLFieldDefinition> Fields { get; set; }
 
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.InterfaceTypeDefinition;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.InterfaceTypeDefinition;
 
         public GraphQLName Name { get; set; }
     }

diff --git a/src/GraphQLParser/AST/GraphQLListType.cs b/src/GraphQLParser/AST/GraphQLListType.cs
@@ -2,19 +2,10 @@
 {
     public class GraphQLListType : GraphQLType
     {
-        public override ASTNodeKind Kind
-        {
-            get
-            {
-                return ASTNodeKind.ListType;
-            }
-        }
+        public override ASTNodeKind Kind => ASTNodeKind.ListType;
 
         public GraphQLType Type { get; set; }
 
-        public override string ToString()
-        {
-            return $"[{this.Type}]";
-        }
+        public override string ToString() => $"[{Type}]";
     }
 }