print enum descriptions

andimarek · bbakerman · commit 0f006c488c88 · 2017-06-05T09:32:20.000+10:00
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -148,8 +148,10 @@ private TypePrinter<GraphQLEnumType> enumPrinter() {
             if (isIntrospectionType(type)) {
                 return;
             }
+            printComments(out, type, "");
             out.format("enum %s {\n", type.getName());
             for (GraphQLEnumValueDefinition enumValueDefinition : type.getValues()) {
+                printComments(out, enumValueDefinition, "   ");
                 out.format("   %s\n", enumValueDefinition.getName());
             }
             out.format("}\n\n");
@@ -193,7 +195,7 @@ private TypePrinter<GraphQLObjectType> objectPrinter() {
             if (isIntrospectionType(type)) {
                 return;
             }
-            printComments(out, type);
+            printComments(out, type, "");
             out.format("type %s {\n", type.getName());
             type.getFieldDefinitions().forEach(fd -> {
                 printComments(out, fd, "   ");
@@ -335,27 +337,25 @@ private void printType(PrintWriter out, GraphQLType type) {
         printer.print(out, type);
     }
 
-    void printComments(PrintWriter out, GraphQLFieldDefinition fieldDefinition, String prefix) {
-        String description = fieldDefinition.getDescription();
-        if (description == null) {
-            return;
-        }
-        Stream<String> stream = Arrays.stream(description.split("\n"));
-        stream.map(s -> prefix + "#" + s + "\n").forEach(out::write);
-    }
 
-    void printComments(PrintWriter out, GraphQLType graphQLType) {
+    private void printComments(PrintWriter out, Object graphQLType, String prefix) {
         String description = getDescription(graphQLType);
         if (description == null) {
             return;
         }
         Stream<String> stream = Arrays.stream(description.split("\n"));
-        stream.map(s -> "#" + s + "\n").forEach(out::write);
+        stream.map(s -> prefix + "#" + s + "\n").forEach(out::write);
     }
 
-    String getDescription(GraphQLType graphQLType) {
-        if (graphQLType instanceof GraphQLObjectType) {
-            return ((GraphQLObjectType) graphQLType).getDescription();
+    private String getDescription(Object descriptionHolder) {
+        if (descriptionHolder instanceof GraphQLObjectType) {
+            return ((GraphQLObjectType) descriptionHolder).getDescription();
+        } else if (descriptionHolder instanceof GraphQLEnumType) {
+            return ((GraphQLEnumType) descriptionHolder).getDescription();
+        } else if (descriptionHolder instanceof GraphQLFieldDefinition) {
+            return ((GraphQLFieldDefinition) descriptionHolder).getDescription();
+        } else if (descriptionHolder instanceof GraphQLEnumValueDefinition) {
+            return ((GraphQLEnumValueDefinition) descriptionHolder).getDescription();
         } else {
             return Assert.assertShouldNeverHappen();
         }
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -4,6 +4,7 @@ import graphql.Scalars
 import graphql.TypeResolutionEnvironment
 import graphql.schema.Coercing
 import graphql.schema.GraphQLArgument
+import graphql.schema.GraphQLEnumType
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLList
 import graphql.schema.GraphQLNonNull
@@ -260,6 +261,35 @@ type Query {
    field : String
 }
 
+"""
+
+    }
+
+    def "prints enum description as comment"() {
+        given:
+        GraphQLEnumType graphQLEnumType = GraphQLEnumType.newEnum()
+                .name("Enum")
+                .description("About enum")
+                .value("value", "value", "value desc")
+                .build()
+        GraphQLFieldDefinition fieldDefinition = GraphQLFieldDefinition.newFieldDefinition()
+                .name("field").type(graphQLEnumType).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+        when:
+        def result = new SchemaPrinter().print(schema)
+
+        then:
+        result == """type Query {
+   field : Enum
+}
+
+#About enum
+enum Enum {
+   #value desc
+   value
+}
+
 """
 
     }
