Rename to PrettyAstPrinter; improve tests; add javadoc

felipe-gdr · felipe-gdr · commit 923a034e82e6 · 2022-08-11T08:34:52.000+10:00
diff --git a/src/main/java/graphql/language/PrettyAstPrinter.java b/src/main/java/graphql/language/PrettyAstPrinter.java
@@ -23,15 +23,15 @@
  * @see AstPrinter
  */
 @PublicApi
-public class PrettyPrinter extends AstPrinter {
+public class PrettyAstPrinter extends AstPrinter {
     private final CommentParser commentParser;
     private final PrettyPrinterOptions options;
 
-    public PrettyPrinter(NodeToRuleCapturingParser.ParserContext parserContext) {
+    public PrettyAstPrinter(NodeToRuleCapturingParser.ParserContext parserContext) {
         this(parserContext, PrettyPrinterOptions.defaultOptions);
     }
 
-    public PrettyPrinter(NodeToRuleCapturingParser.ParserContext parserContext, PrettyPrinterOptions options) {
+    public PrettyAstPrinter(NodeToRuleCapturingParser.ParserContext parserContext, PrettyPrinterOptions options) {
         super(false);
         this.commentParser = new CommentParser(parserContext);
         this.options = options;
@@ -68,7 +68,7 @@ public static String print(String schemaDefinition, PrettyPrinterOptions options
         NodeToRuleCapturingParser parser = new NodeToRuleCapturingParser();
         Document document = parser.parseDocument(schemaDefinition);
 
-        return new PrettyPrinter(parser.getParserContext(), options).print(document);
+        return new PrettyAstPrinter(parser.getParserContext(), options).print(document);
     }
 
     private NodePrinter<Document> document() {
diff --git a/src/main/java/graphql/parser/GraphqlAntlrToLanguage.java b/src/main/java/graphql/parser/GraphqlAntlrToLanguage.java
@@ -94,15 +94,37 @@ public class GraphqlAntlrToLanguage {
 
     private final Map<Node<?>, ParserRuleContext> nodeToRuleMap;
 
+    /**
+     * @param tokens            the token stream
+     * @param multiSourceReader the source of the query document
+     */
     public GraphqlAntlrToLanguage(CommonTokenStream tokens, MultiSourceReader multiSourceReader) {
         this(tokens, multiSourceReader, null);
     }
 
+    /**
+     * @param tokens            the token stream
+     * @param multiSourceReader the source of the query document
+     * @param parserOptions     the parser options
+     */
     public GraphqlAntlrToLanguage(CommonTokenStream tokens, MultiSourceReader multiSourceReader, ParserOptions parserOptions) {
         this(tokens, multiSourceReader, parserOptions, null);
     }
 
-    public GraphqlAntlrToLanguage(CommonTokenStream tokens, MultiSourceReader multiSourceReader, ParserOptions parserOptions, @Nullable Map<Node<?>, ParserRuleContext> nodeToRuleMap) {
+    /**
+     * @param tokens            the token stream
+     * @param multiSourceReader the source of the query document
+     * @param parserOptions     the parser options
+     * @param nodeToRuleMap     a map that will be used to accumulate the ParserRuleContext associated with each node.
+     *                          This information can be used after the parsing process is done to access some elements
+     *                          that are usually lost during parsing. If the map is "null", no accumulation will be performed.
+     */
+    public GraphqlAntlrToLanguage(
+            CommonTokenStream tokens,
+            MultiSourceReader multiSourceReader,
+            ParserOptions parserOptions,
+            @Nullable Map<Node<?>, ParserRuleContext> nodeToRuleMap
+    ) {
         this.tokens = tokens;
         this.multiSourceReader = multiSourceReader;
         this.parserOptions = ofNullable(parserOptions).orElse(ParserOptions.getDefaultParserOptions());
diff --git a/src/test/groovy/graphql/language/PrettyAstPrinterTest.groovy b/src/test/groovy/graphql/language/PrettyAstPrinterTest.groovy
@@ -1,9 +1,8 @@
 package graphql.language
 
-import graphql.parser.NodeToRuleCapturingParser
 import spock.lang.Specification
 
-class PrettyPrinterTest extends Specification {
+class PrettyAstPrinterTest extends Specification {
 
     def "can print type with comments"() {
         given:
@@ -504,26 +503,19 @@ a: A, b: B): Type
 }
 '''
         when:
-        def options = PrettyPrinter.PrettyPrinterOptions
+        def options = PrettyAstPrinter.PrettyPrinterOptions
                 .builder()
-                .indentType(PrettyPrinter.PrettyPrinterOptions.IndentType.TAB)
+                .indentType(PrettyAstPrinter.PrettyPrinterOptions.IndentType.TAB)
                 .indentWith(1)
                 .build()
 
-        def parser = new NodeToRuleCapturingParser()
-        def document = parser.parseDocument(input)
-
-        def result = new PrettyPrinter(parser.parserContext, options).print(document)
+        def result = PrettyAstPrinter.print(input, options)
 
         then:
         result == expected
     }
 
     private static String print(String input) {
-        def parser = new NodeToRuleCapturingParser()
-        def document = parser.parseDocument(input)
-        def parserContext = parser.parserContext
-
-        return new PrettyPrinter(parserContext).print(document)
+        return PrettyAstPrinter.print(input, PrettyAstPrinter.PrettyPrinterOptions.defaultOptions())
     }
 }
