Merge branch 'master' of https://github.com/graphql-java/graphql-java-annotations

Author: danieltaub96

README.md

@@ -54,6 +54,45 @@ GraphQLInterfaceType object = GraphQLAnnotations.iface(SomeInterface.class);
 An instance of the type resolver will be created from the specified class. If a `getInstance` method is present on the
 class, it will be used instead of the default constructor.
 
+## Defining Unions
+
+To have a union, you must annotate an interface with `@GraphQLUnion`. In the annotation, you must declare all the 
+possible types of the union, and a type resolver.
+If no type resolver is specified, `UnionTypeResovler` is used. It follows this algorithm:
+The resolver assumes the the DB entity's name is the same as  the API entity's name.
+ If so, it takes the result from the dataFetcher and decides to which
+API entity it should be mapped (according to the name). 
+Example: If you have a `Pet` union type, and the dataFetcher returns `Dog`, the typeResolver
+will check for each API entity if its name is equal to `Dog`, and returns if it finds something
+
+```java
+@GraphQLUnion(possibleTypes={Dog.class, Cat.class})
+public interface Pet {}
+``` 
+and an example with custom `TypeResovler`:
+```java
+@GraphQLUnion(possibleTypes={DogApi.class, Cat.class}, typeResolver = PetTypeResolver.class)
+public interface Pet {}
+
+
+public class PetTypeResolver implements TypeResolver {
+    @Override
+    GraphQLObjectType getType(TypeResolutionEnvironment env) {
+        Object obj = env.getObject();
+        if(obj instanceof DogDB) {
+            return (GraphQLObjectType) env.getSchema().getType("DogApi");
+        }
+        else {
+            return (GraphQLObjectType) env.getSchema().getType("Cat");
+        }
+      
+    }
+}
+```
+NOTE: you can have (but not mandatory) a type resolver with constructor that has `Class<?>[]` as the first parameter and
+`ProcessingElementsContainer` as the second. the `Class<?>[]` parameter contains the possibleTypes class
+and `ProcessingElementsContainer` has all sorts of utils (you can check `UnionTypeResolver` to see how we use it there)
+
 ## Fields
 
 In addition to specifying a field over a Java class field, a field can be defined over a method:
@@ -268,3 +307,17 @@ NOTE: because `PropertyDataFetcher` and `FieldDataFetcher` can't handle connecti
 By default, GraphQLAnnotations will use the `graphql.relay.Relay` class to create the Relay specific schema types (Mutations, Connections, Edges, PageInfo, ...).
 It is possible to set a custom implementation of the Relay class with `GraphQLAnnotations.setRelay` method. The class should inherit from `graphql.relay.Relay` and 
 can redefine methods that create Relay types.
+
+It is also possible to specify for every connection which relay do you want to use, by giving a value to the annotation: 
+`@GraphQLConnection(connectionType = customRelay.class)`. If you do that, please also give values to `connectionFetcher`
+and `validator`.
+
+There is also a support for simple paging, without "Nodes" and "Edges". To use it, annotate you connection like that:
+`@GraphQLConnection(connectionFetcher = SimplePaginatedDataConnectionFetcher.class, connectionType = SimpleRelay.class, validator = SimplePaginatedDataConnectionTypeValidator.class)`
+and the return type must be of type `SimplePaginatedData`.
+It has 2 methods:
+1. `getTotalCount` - how many elements are there in total
+2. `getData` - get the data
+
+For you convenience, there are two classes that you can use: `AbstractSimplePaginatedData` and `SimplePaginatedDataImpl`
+For examples, look at the tests

build.gradle

@@ -11,9 +11,9 @@ buildscript {
     }
 }
 plugins {
-    id "com.github.hierynomus.license" version "0.12.1"
     id "com.jfrog.bintray" version "1.7"
     id 'net.researchgate.release' version '2.3.4'
+    id "com.github.hierynomus.license" version "0.14.0"
 }
 
 apply plugin: 'java'
@@ -69,7 +69,7 @@ gradle.projectsEvaluated {
 
 dependencies {
     compile 'javax.validation:validation-api:1.1.0.Final'
-    compile 'com.graphql-java:graphql-java:7.0'
+    compile 'com.graphql-java:graphql-java:8.0'
 
     // OSGi
     compileOnly 'org.osgi:org.osgi.core:6.0.0'
@@ -78,6 +78,7 @@ dependencies {
     compileOnly 'biz.aQute.bnd:biz.aQute.bndlib:3.2.0'
 
     testCompile 'org.testng:testng:6.9.10'
+    testCompile 'org.hamcrest:hamcrest-all:1.3'
 }
 
 test.useTestNG()

gradle.properties

@@ -7,3 +7,4 @@ org.gradle.jvmargs=-Dfile.encoding=UTF-8
 
 bintray.user=DUMMY_USER
 bintray.key=DUMMY_KEY
+version = 5.2

src/main/java/graphql/annotations/GraphQLFieldDefinitionWrapper.java

@@ -18,11 +18,13 @@
 import graphql.schema.DataFetcherFactories;
 import graphql.schema.GraphQLFieldDefinition;
 
-public  class GraphQLFieldDefinitionWrapper extends GraphQLFieldDefinition {
+public class GraphQLFieldDefinitionWrapper extends GraphQLFieldDefinition {
 
     public GraphQLFieldDefinitionWrapper(GraphQLFieldDefinition fieldDefinition) {
         super(fieldDefinition.getName(), fieldDefinition.getDescription(), fieldDefinition.getType(),
-                DataFetcherFactories.useDataFetcher((DataFetcher<?>)fieldDefinition.getDataFetcher()), fieldDefinition.getArguments(), fieldDefinition.getDeprecationReason(),
+                DataFetcherFactories.useDataFetcher((DataFetcher<?>) fieldDefinition.getDataFetcher()),
+                fieldDefinition.getArguments(), fieldDefinition.getDeprecationReason(),
+                fieldDefinition.getDirectives(),
                 fieldDefinition.getDefinition());
     }
 

src/main/java/graphql/annotations/annotationTypes/GraphQLUnion.java

@@ -14,6 +14,9 @@
  */
 package graphql.annotations.annotationTypes;
 
+import graphql.annotations.typeResolvers.UnionTypeResolver;
+import graphql.schema.TypeResolver;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -23,4 +26,6 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface GraphQLUnion {
     Class<?>[] possibleTypes();
+
+    Class<? extends TypeResolver> typeResolver() default UnionTypeResolver.class;
 }

src/main/java/graphql/annotations/connection/FakeRelay.java

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2016 Yurii Rashkovskii
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ */
+package graphql.annotations.connection;
+
+import graphql.relay.Relay;
+
+/**
+ * This class is just for the library to know whether to use the relay in the container or not
+ */
+public final class FakeRelay extends Relay {
+}

src/main/java/graphql/annotations/connection/GraphQLConnection.java

@@ -15,6 +15,8 @@
 package graphql.annotations.connection;
 
 
+import graphql.relay.Relay;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -27,7 +29,7 @@
  *
  * At the moment, the only allowed type for such field is <code>List&lt;?&gt;</code>
  */
-@Target({ElementType.FIELD, ElementType.METHOD})
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface GraphQLConnection {
     /**
@@ -37,7 +39,7 @@
      * your own connection validator
      * @return a connection class
      */
-    Class<? extends ConnectionFetcher> connection() default PaginatedDataConnectionFetcher.class;
+    Class<? extends ConnectionFetcher> connectionFetcher() default PaginatedDataConnectionFetcher.class;
 
     /**
      * By default, wrapped type's name is used for naming TypeConnection, but can be overridden
@@ -59,4 +61,12 @@
      * @return if async fetching to be used.
      */
     boolean async() default false;
+
+    /**
+     * By default, the relay connection that the container has is used. If you want to change the way connection works
+     * (For example, you don't want edges and nodes), override the {@link Relay} class and specify it.
+     *
+     * @return a class that represents the connection type
+     */
+    Class<? extends Relay> connectionType() default FakeRelay.class;
 }

src/main/java/graphql/annotations/connection/SimplePaginatedData.java renamed to src/main/java/graphql/annotations/connection/NaivePaginatedData.java

@@ -19,15 +19,15 @@
 
 import static java.util.Base64.getEncoder;
 
-public class SimplePaginatedData<T> extends AbstractPaginatedData<T> {
+public class NaivePaginatedData<T> extends AbstractPaginatedData<T> {
     private static final String DUMMY_CURSOR_PREFIX = "simple-cursor";
     private final String prefix;
 
-    public SimplePaginatedData(boolean hasPreviousPage, boolean hasNextPage, Iterable<T> data) {
+    public NaivePaginatedData(boolean hasPreviousPage, boolean hasNextPage, Iterable<T> data) {
         this(hasPreviousPage, hasNextPage, data, DUMMY_CURSOR_PREFIX);
     }
 
-    public SimplePaginatedData(boolean hasPreviousPage, boolean hasNextPage, Iterable<T> data, String prefix) {
+    public NaivePaginatedData(boolean hasPreviousPage, boolean hasNextPage, Iterable<T> data, String prefix) {
         super(hasPreviousPage, hasNextPage, data);
         this.prefix = prefix;
     }

src/main/java/graphql/annotations/connection/PaginatedDataConnectionTypeValidator.java

@@ -16,6 +16,7 @@
 
 
 import graphql.annotations.annotationTypes.GraphQLDataFetcher;
+import graphql.annotations.connection.exceptions.GraphQLConnectionException;
 
 import java.lang.reflect.AccessibleObject;
 import java.lang.reflect.Field;

src/main/java/graphql/annotations/connection/GraphQLConnectionException.java renamed to src/main/java/graphql/annotations/connection/exceptions/GraphQLConnectionException.java

@@ -12,11 +12,11 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  */
-package graphql.annotations.connection;
+package graphql.annotations.connection.exceptions;
 
-class GraphQLConnectionException extends RuntimeException {
+public class GraphQLConnectionException extends RuntimeException {
 
-    GraphQLConnectionException(String error) {
+    public GraphQLConnectionException(String error) {
         super(error);
     }
 }