Pr 600 michaelplavnik schema printer improvments (graphql-java#648)

bbakerman · web-flow · commit 465271bb2eff · 2017-08-28T17:05:08.000+10:00
* Allow subclasses of the types to be printed.

* Replace '-' character with one from cp1252

Documentaiton build on windows failed as '-' character was not from cp1252 code page (first 127 codes).

* Support instances of classes derived from schema classes

1. graphql-spqr generates schema out of GraphQL types subclasess and changes in this commit handle it correctly.

2. Empty discriptions are not printed out.

* Fixed * imports
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -8,7 +8,6 @@
 import graphql.schema.GraphQLFieldDefinition;
 import graphql.schema.GraphQLInputObjectField;
 import graphql.schema.GraphQLInputObjectType;
-import graphql.schema.GraphQLInputType;
 import graphql.schema.GraphQLInterfaceType;
 import graphql.schema.GraphQLList;
 import graphql.schema.GraphQLNonNull;
@@ -122,7 +121,6 @@ public String print(GraphQLSchema schema) {
         List<GraphQLType> typesAsList = new ArrayList<>(schema.getAllTypesAsList());
         typesAsList.sort(Comparator.comparing(GraphQLType::getName));
 
-        printType(out, typesAsList, GraphQLInputType.class, visibility);
         printType(out, typesAsList, GraphQLInterfaceType.class, visibility);
         printType(out, typesAsList, GraphQLUnionType.class, visibility);
         printType(out, typesAsList, GraphQLObjectType.class, visibility);
@@ -306,7 +304,7 @@ String typeString(GraphQLType rawType) {
     }
 
     String argsString(List<GraphQLArgument> arguments) {
-        boolean hasDescriptions = arguments.stream().filter(arg -> arg.getDescription() != null).count() > 0;
+        boolean hasDescriptions = arguments.stream().filter(arg -> !isNullOrEmpty(arg.getDescription())).count() > 0;
         String prefix = hasDescriptions ? "  " : "";
         int count = 0;
         StringBuilder sb = new StringBuilder();
@@ -320,7 +318,7 @@ String argsString(List<GraphQLArgument> arguments) {
                 sb.append("\n");
             }
             String description = argument.getDescription();
-            if (description != null) {
+            if (!isNullOrEmpty(description)) {
                 Stream<String> stream = Arrays.stream(description.split("\n"));
                 stream.map(s -> "  #" + s + "\n").forEach(sb::append);
             }
@@ -347,9 +345,15 @@ String argsString(List<GraphQLArgument> arguments) {
 
     @SuppressWarnings("unchecked")
     private <T> TypePrinter<T> printer(Class<?> clazz) {
-        TypePrinter typePrinter = printers.computeIfAbsent(clazz,
-                k -> (out, type, visibility) -> out.println("Type not implemented : " + type)
-        );
+        TypePrinter typePrinter = printers.computeIfAbsent(clazz, k -> {
+            Class<?> superClazz = clazz.getSuperclass();
+            TypePrinter result;
+            if (superClazz != Object.class)
+                result = printer(superClazz);
+            else
+                result = (out, type, visibility) -> out.println("Type not implemented : " + type);
+            return result;
+        });
         return (TypePrinter<T>) typePrinter;
     }
 
@@ -364,7 +368,7 @@ public String print(GraphQLType type) {
 
     private void printType(PrintWriter out, List<GraphQLType> typesAsList, Class typeClazz, GraphqlFieldVisibility visibility) {
         typesAsList.stream()
-                .filter(type -> type.getClass().equals(typeClazz))
+                .filter(type -> typeClazz.isAssignableFrom(type.getClass()))
                 .forEach(type -> printType(out, type, visibility));
     }
 
@@ -376,7 +380,7 @@ private void printType(PrintWriter out, GraphQLType type, GraphqlFieldVisibility
 
     private void printComments(PrintWriter out, Object graphQLType, String prefix) {
         String description = getDescription(graphQLType);
-        if (description == null) {
+        if (isNullOrEmpty(description)) {
             return;
         }
         Stream<String> stream = Arrays.stream(description.split("\n"));
@@ -408,4 +412,8 @@ private String getDescription(Object descriptionHolder) {
             return Assert.assertShouldNeverHappen();
         }
     }
+
+    private static boolean isNullOrEmpty(String s) {
+        return s == null || s.isEmpty();
+    }
 }
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -12,6 +12,7 @@ import graphql.schema.GraphQLInterfaceType
 import graphql.schema.GraphQLList
 import graphql.schema.GraphQLNonNull
 import graphql.schema.GraphQLObjectType
+import graphql.schema.GraphQLOutputType
 import graphql.schema.GraphQLScalarType
 import graphql.schema.GraphQLSchema
 import graphql.schema.GraphQLType
@@ -86,6 +87,13 @@ class SchemaPrinterTest extends Specification {
         schema
     }
 
+    static class MyGraphQLObjectType extends GraphQLObjectType {
+
+        MyGraphQLObjectType(String name, String description, List<GraphQLFieldDefinition> fieldDefinitions) {
+            super(name, description, fieldDefinitions, new ArrayList<GraphQLOutputType>())
+        }
+    }
+
     def "typeString"() {
 
         GraphQLType type1 = nonNull(list(nonNull(list(nonNull(Scalars.GraphQLInt)))))
@@ -267,7 +275,22 @@ type Query {
   field: String
 }
 """
+    }
+
+    def "does not print empty field description as comment"() {
+        given:
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
+                .name("field").description("").type(GraphQLString).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: String
+}
+"""
     }
 
     def "prints enum description as comment"() {
@@ -489,5 +512,22 @@ scalar Scalar
 
     }
 
+    def "prints derived object type"() {
+        given:
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition().name("field").type(GraphQLString).build()
+        def queryType = new MyGraphQLObjectType("Query", "About Query\nSecond Line", Arrays.asList(fieldDefinition))
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+
+        when:
+        def result = new SchemaPrinter().print(schema)
+
+        then:
+        result == """#About Query
+#Second Line
+type Query {
+  field: String
+}
+"""
+    }
 
 }
