feat(#5): add example project to demonstrate GraphQL Annotations support

Author: BlasiusSecundus

example-graphql-annotations/build.gradle

@@ -0,0 +1,22 @@
+apply plugin: "org.springframework.boot"
+
+dependencies {
+    implementation(project(":graphql-spring-boot-starter"))
+    implementation(project(":graphql-kickstart-spring-boot-starter-graphql-annotations"))
+    implementation "io.reactivex.rxjava2:rxjava"
+    runtimeOnly(project(":graphiql-spring-boot-starter"))
+    runtimeOnly(project(":playground-spring-boot-starter"))
+    runtimeOnly(project(":voyager-spring-boot-starter"))
+
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    runtimeOnly("com.h2database:h2")
+
+    testImplementation "org.springframework.boot:spring-boot-starter-test"
+    testImplementation(project(":graphql-spring-boot-starter-test"))
+}
+
+jar.enabled = false
+uploadArchives.enabled = false
+bintrayUpload.enabled = false
+publishToMavenLocal.enabled = false

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/GraphQLAnnotationsSampleApplication.java

@@ -0,0 +1,13 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class GraphQLAnnotationsSampleApplication {
+
+    public static void main(final String[] args) {
+        SpringApplication.run(GraphQLAnnotationsSampleApplication.class, args);
+    }
+
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/directives/UpperCaseDirective.java

@@ -0,0 +1,18 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.directives;
+
+import graphql.annotations.annotationTypes.GraphQLDescription;
+import graphql.annotations.annotationTypes.GraphQLName;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
+import graphql.introspection.Introspection;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+@GraphQLName("upperCase")
+@GraphQLDescription("This directive makes a string uppercase")
+@GraphQLDirectiveDefinition(wiring = UpperCaseDirectiveWiring.class)
+@DirectiveLocations({Introspection.DirectiveLocation.FIELD_DEFINITION})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface UpperCaseDirective {
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/directives/UpperCaseDirectiveWiring.java

@@ -0,0 +1,23 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.directives;
+
+import graphql.annotations.directives.AnnotationsDirectiveWiring;
+import graphql.annotations.directives.AnnotationsWiringEnvironment;
+import graphql.annotations.processor.util.CodeRegistryUtil;
+import graphql.schema.GraphQLFieldDefinition;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor
+public class UpperCaseDirectiveWiring implements AnnotationsDirectiveWiring {
+
+    @Override
+    public GraphQLFieldDefinition onField(final AnnotationsWiringEnvironment environment) {
+        final GraphQLFieldDefinition field = (GraphQLFieldDefinition) environment.getElement();
+        CodeRegistryUtil.wrapDataFetcher(field, environment, (((dataFetchingEnvironment, value) -> {
+            if (value instanceof String) {
+                return ((String) value).toUpperCase();
+            }
+            return value;
+        })));
+        return field;
+    }
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/extension/PersonExtension.java

@@ -0,0 +1,22 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.extension;
+
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLNonNull;
+import graphql.annotations.annotationTypes.GraphQLTypeExtension;
+import graphql.kickstart.spring.boot.graphql.annotations.example.model.type.Person;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+@GraphQLTypeExtension(Person.class)
+public class PersonExtension {
+
+    private final Person person;
+
+    @GraphQLField
+    @GraphQLNonNull
+    public String fullName() {
+        return String.format("%s, %s", person.getLastName(), person.getFirstName());
+    }
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/input/CreatePerson.java

@@ -0,0 +1,28 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.input;
+
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLNonNull;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.time.LocalDate;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class CreatePerson {
+
+    @GraphQLField
+    @GraphQLNonNull
+    private String firstName;
+
+    @GraphQLField
+    @GraphQLNonNull
+    private String lastName;
+
+    @GraphQLField
+    private LocalDate dateOfBirth;
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/scalar/LocalDateScalarConfiguration.java

@@ -0,0 +1,57 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.scalar;
+
+import graphql.language.StringValue;
+import graphql.schema.Coercing;
+import graphql.schema.CoercingParseLiteralException;
+import graphql.schema.CoercingParseValueException;
+import graphql.schema.CoercingSerializeException;
+import graphql.schema.GraphQLScalarType;
+import lombok.NoArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.time.LocalDate;
+import java.time.format.DateTimeParseException;
+
+@Configuration
+@NoArgsConstructor
+public class LocalDateScalarConfiguration {
+
+    @Bean
+    public GraphQLScalarType localDateScalar() {
+        return GraphQLScalarType.newScalar()
+            .name("Date")
+            .description("LocalDate as GraphQL scalar.")
+            .coercing(new Coercing<LocalDate, String>() {
+                @Override
+                public String serialize(Object dataFetcherResult) throws CoercingSerializeException {
+                    if (!(dataFetcherResult instanceof LocalDate)) {
+                        throw new CoercingSerializeException("LocalDate expected.");
+                    }
+                    return String.valueOf(dataFetcherResult);
+                }
+
+                @Override
+                public LocalDate parseValue(Object input) throws CoercingParseValueException {
+                    try {
+                        return LocalDate.parse(String.valueOf(input));
+                    } catch (DateTimeParseException e) {
+                        throw new CoercingParseValueException(e);
+                    }
+                }
+
+                @Override
+                public LocalDate parseLiteral(Object input) throws CoercingParseLiteralException {
+                    try {
+                        if (!(input instanceof StringValue)) {
+                            throw new CoercingParseLiteralException("String value expected.");
+                        }
+                        return LocalDate.parse(((StringValue) input).getValue());
+                    } catch (DateTimeParseException e) {
+                        throw new CoercingParseLiteralException("Failed to parse date literal", e);
+                    }
+                }
+            })
+            .build();
+    }
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/model/type/Person.java

@@ -0,0 +1,44 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.model.type;
+
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLID;
+import graphql.annotations.annotationTypes.GraphQLNonNull;
+import graphql.kickstart.spring.boot.graphql.annotations.example.model.directives.UpperCaseDirective;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+import javax.persistence.Transient;
+import java.time.LocalDate;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Entity
+public class Person {
+
+    @Id
+    @GraphQLID
+    @GraphQLField
+    @GraphQLNonNull
+    @UpperCaseDirective
+    private String id;
+
+    @Column(nullable = false)
+    @GraphQLField
+    @GraphQLNonNull
+    private String firstName;
+
+    @Column(nullable = false)
+    @GraphQLField
+    @GraphQLNonNull
+    private String lastName;
+
+    @GraphQLField
+    private LocalDate dateOfBirth;
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/repository/PersonRepository.java

@@ -0,0 +1,7 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.repository;
+
+import graphql.kickstart.spring.boot.graphql.annotations.example.model.type.Person;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface PersonRepository extends JpaRepository<Person, String> {
+}

example-graphql-annotations/src/main/java/graphql/kickstart/spring/boot/graphql/annotations/example/resolvers/Mutations.java

@@ -0,0 +1,45 @@
+package graphql.kickstart.spring.boot.graphql.annotations.example.resolvers;
+
+import graphql.annotations.annotationTypes.GraphQLDescription;
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLNonNull;
+import graphql.kickstart.spring.boot.graphql.annotations.example.model.input.CreatePerson;
+import graphql.kickstart.spring.boot.graphql.annotations.example.model.type.Person;
+import graphql.kickstart.spring.boot.graphql.annotations.example.repository.PersonRepository;
+import graphql.kickstart.tools.GraphQLMutationResolver;
+import lombok.NoArgsConstructor;
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.stereotype.Service;
+
+import java.util.UUID;
+
+/**
+ * Same restrictions / considerations apply as for the query resolver.
+ * @see Queries
+ */
+@Service
+@NoArgsConstructor
+public class Mutations implements GraphQLMutationResolver, ApplicationContextAware {
+
+    private static PersonRepository personRepository;
+
+    @GraphQLField
+    @GraphQLNonNull
+    @GraphQLDescription("Creates a new person.")
+    public static Person createPerson(final @GraphQLNonNull CreatePerson createPerson) {
+        final Person newPerson = Person.builder()
+            .firstName(createPerson.getFirstName())
+            .lastName(createPerson.getLastName())
+            .dateOfBirth(createPerson.getDateOfBirth())
+            .id(String.valueOf(UUID.randomUUID()))
+            .build();
+        return personRepository.save(newPerson);
+    }
+
+    @Override
+    public void setApplicationContext(final ApplicationContext applicationContext) throws BeansException {
+        personRepository = applicationContext.getBean(PersonRepository.class);
+    }
+}