Merge pull request #217 from zalando/feature/java-9-module

Java 9+ compatibility

.github/workflows/build.yaml

@@ -24,7 +24,8 @@ jobs:
     - name: Set up JDK
       uses: actions/setup-java@v1
       with:
-        java-version: 1.8
+        # See comment on moditect-maven-plugin in pom.xml
+        java-version: 12
     - name: Compile
       run: ./mvnw clean test-compile -B
     - name: Test

.gitignore

@@ -2,6 +2,13 @@
 *.iml
 .idea/
 
+### VS Code ###
+.vscode
+.project
+.settings
+.classpath
+.factorypath
+
 ### Maven ###
 target/
 /.mvn/wrapper/*.jar

README.md

@@ -28,6 +28,7 @@ It's decoupled from any JSON library, but contains a separate module for Jackson
 - Java 8
 - Any build tool using Maven Central, or direct download
 - Jackson (optional)
+- Gson (optional)
 
 ## Installation
 
@@ -44,6 +45,24 @@ Add the following dependency to your project:
     <artifactId>jackson-datatype-problem</artifactId>
     <version>${problem.version}</version>
 </dependency>
+<dependency>
+    <groupId>org.zalando</groupId>
+    <artifactId>problem-gson</artifactId>
+    <version>${problem.version}</version>
+</dependency>
+```
+
+### Java Modules
+
+Even though the minimum requirement is still Java 8, all modules are Java 9 compatible:
+
+```java
+module org.example {
+    requires org.zalando.problem;
+    // pick needed dependencies
+    requires org.zalando.problem.jackson;
+    requires org.zalando.problem.gson;
+}
 ```
 
 ## Configuration

jackson-datatype-problem/pom.xml

@@ -11,6 +11,10 @@
     <artifactId>jackson-datatype-problem</artifactId>
     <properties>
         <jackson.version>2.10.1</jackson.version>
+        <module.name>org.zalando.problem.jackson</module.name>
+        <module.exports>
+            org.zalando.problem.jackson;
+        </module.exports>
     </properties>
     <dependencies>
         <dependency>

jackson-datatype-problem/src/main/java/org/zalando/problem/AbstractThrowableProblemMixIn.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/AbstractThrowableProblemMixIn.java

@@ -1,10 +1,14 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import javax.annotation.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.zalando.problem.AbstractThrowableProblem;
+import org.zalando.problem.StatusType;
+import org.zalando.problem.ThrowableProblem;
+
 import java.net.URI;
 
 abstract class AbstractThrowableProblemMixIn {

jackson-datatype-problem/src/main/java/org/zalando/problem/ExceptionalMixin.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/ExceptionalMixin.java

@@ -1,4 +1,4 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@@ -7,6 +7,8 @@
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
 
+import org.zalando.problem.ThrowableProblem;
+
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
 
 @JsonIgnoreProperties(ignoreUnknown = true)

jackson-datatype-problem/src/main/java/org/zalando/problem/ExceptionalWithoutStacktraceMixin.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/ExceptionalWithoutStacktraceMixin.java

@@ -1,4 +1,4 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

jackson-datatype-problem/src/main/java/org/zalando/problem/ProblemMixIn.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/ProblemMixIn.java

@@ -1,11 +1,15 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
+import org.zalando.problem.DefaultProblem;
+import org.zalando.problem.Problem;
+import org.zalando.problem.StatusType;
+
 import java.net.URI;
 import java.util.Map;
 

jackson-datatype-problem/src/main/java/org/zalando/problem/ProblemModule.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/ProblemModule.java

@@ -1,11 +1,17 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.core.Version;
 import com.fasterxml.jackson.core.util.VersionUtil;
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import org.apiguardian.api.API;
 
+import org.zalando.problem.DefaultProblem;
+import org.zalando.problem.Exceptional;
+import org.zalando.problem.Problem;
+import org.zalando.problem.Status;
+import org.zalando.problem.StatusType;
+
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
@@ -34,7 +40,7 @@ public ProblemModule() {
      * @throws IllegalArgumentException if there are duplicate status codes across all status types
      */
     @SafeVarargs
-    public <E extends Enum & StatusType> ProblemModule(final Class<? extends E>... types)
+    public <E extends Enum<?> & StatusType> ProblemModule(final Class<? extends E>... types)
             throws IllegalArgumentException {
 
         this(false, buildIndex(types));
@@ -76,7 +82,7 @@ public void setupModule(final SetupContext context) {
     }
 
     @SafeVarargs
-    private static <E extends Enum & StatusType> Map<Integer, StatusType> buildIndex(
+    private static <E extends Enum<?> & StatusType> Map<Integer, StatusType> buildIndex(
             final Class<? extends E>... types) {
         final Map<Integer, StatusType> index = new HashMap<>();
 

jackson-datatype-problem/src/main/java/org/zalando/problem/ProblemTypeConverter.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/ProblemTypeConverter.java

@@ -1,7 +1,9 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.databind.util.StdConverter;
 
+import org.zalando.problem.Problem;
+
 import java.net.URI;
 
 final class ProblemTypeConverter extends StdConverter<URI, URI> {

jackson-datatype-problem/src/main/java/org/zalando/problem/StatusTypeDeserializer.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/StatusTypeDeserializer.java

@@ -1,10 +1,12 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonDeserializer;
 
-import javax.annotation.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.zalando.problem.StatusType;
+
 import java.io.IOException;
 import java.util.Map;
 

jackson-datatype-problem/src/main/java/org/zalando/problem/StatusTypeSerializer.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/StatusTypeSerializer.java

@@ -1,9 +1,11 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.SerializerProvider;
 
+import org.zalando.problem.StatusType;
+
 import java.io.IOException;
 
 final class StatusTypeSerializer extends JsonSerializer<StatusType> {

problem/src/main/java/org/zalando/problem/UnknownStatus.java → jackson-datatype-problem/src/main/java/org/zalando/problem/jackson/UnknownStatus.java

@@ -1,8 +1,7 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
-import javax.annotation.concurrent.Immutable;
+import org.zalando.problem.StatusType;
 
-@Immutable
 final class UnknownStatus implements StatusType {
 
     private final int statusCode;

jackson-datatype-problem/src/main/resources/META-INF/services/com.fasterxml.jackson.databind.Module

@@ -1 +1 @@
-org.zalando.problem.ProblemModule
+org.zalando.problem.jackson.ProblemModule

jackson-datatype-problem/src/test/java/org/zalando/problem/BusinessException.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/BusinessException.java

@@ -1,4 +1,4 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 abstract class BusinessException extends Exception {
 

problem-gson/src/test/java/org/zalando/problem/CustomStatus.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/CustomStatus.java

@@ -1,4 +1,6 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
+
+import org.zalando.problem.StatusType;
 
 enum CustomStatus implements StatusType {
 

jackson-datatype-problem/src/test/java/org/zalando/problem/EnforceCoverageTest.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/EnforceCoverageTest.java

@@ -1,16 +1,13 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
-import com.google.gag.annotation.remark.Hack;
-import com.google.gag.annotation.remark.OhNoYouDidnt;
 import org.junit.jupiter.api.Test;
+import org.zalando.problem.AbstractThrowableProblem;
 
 import java.net.URI;
 
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.zalando.problem.Status.BAD_REQUEST;
 
-@Hack
-@OhNoYouDidnt
 final class EnforceCoverageTest {
 
     @Test

jackson-datatype-problem/src/test/java/org/zalando/problem/IOProblem.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/IOProblem.java

@@ -1,9 +1,13 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 
+import org.zalando.problem.Exceptional;
+import org.zalando.problem.StatusType;
+import org.zalando.problem.ThrowableProblem;
+
 import java.io.IOException;
 import java.net.URI;
 

jackson-datatype-problem/src/test/java/org/zalando/problem/InsufficientFundsProblem.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/InsufficientFundsProblem.java

@@ -1,9 +1,11 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 
+import org.zalando.problem.AbstractThrowableProblem;
+
 import java.net.URI;
 
 import static org.zalando.problem.Status.BAD_REQUEST;

jackson-datatype-problem/src/test/java/org/zalando/problem/JacksonStackTraceProcessor.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/JacksonStackTraceProcessor.java

@@ -1,4 +1,4 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import org.zalando.problem.spi.StackTraceProcessor;
 
@@ -16,7 +16,11 @@ public Collection<StackTraceElement> process(final Collection<StackTraceElement>
         final ArrayList<StackTraceElement> elements = new ArrayList<>(collection);
 
         return elements.stream()
-                .filter(startsWith("sun.reflect", "java.lang.reflect", "com.fasterxml.jackson").negate())
+                .filter(startsWith(
+                        "sun.reflect", 
+                        "java.lang.reflect", 
+                        "jdk.internal.reflect",
+                        "com.fasterxml.jackson").negate())
                 .findFirst()
                 .map(elements::indexOf)
                 .map(subList(elements))

jackson-datatype-problem/src/test/java/org/zalando/problem/OutOfStockException.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/OutOfStockException.java

@@ -1,9 +1,13 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 
+import org.zalando.problem.Exceptional;
+import org.zalando.problem.StatusType;
+import org.zalando.problem.ThrowableProblem;
+
 import java.net.URI;
 
 import static org.zalando.problem.Status.BAD_REQUEST;

jackson-datatype-problem/src/test/java/org/zalando/problem/ProblemMixInTest.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/ProblemMixInTest.java

@@ -1,8 +1,14 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
+import org.zalando.problem.DefaultProblem;
+import org.zalando.problem.Exceptional;
+import org.zalando.problem.Problem;
+import org.zalando.problem.Status;
+import org.zalando.problem.StatusType;
+import org.zalando.problem.ThrowableProblem;
 
 import java.io.IOException;
 import java.io.PrintWriter;
@@ -245,7 +251,7 @@ void shouldDeserializeWithProcessedStackTrace() throws IOException {
         final String stackTrace = getStackTrace(problem);
         final String[] stackTraceElements = stackTrace.split("\n");
 
-        assertThat(stackTraceElements[1], startsWith("\tat org.zalando.problem.ProblemMixInTest"));
+        assertThat(stackTraceElements[1], startsWith("\tat " + ProblemMixInTest.class.getName()));
     }
 
     private String getStackTrace(final Throwable throwable) {

jackson-datatype-problem/src/test/java/org/zalando/problem/ProblemModuleTest.java → jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/ProblemModuleTest.java

@@ -1,6 +1,7 @@
-package org.zalando.problem;
+package org.zalando.problem.jackson;
 
 import org.junit.jupiter.api.Test;
+import org.zalando.problem.Status;
 
 import static org.junit.jupiter.api.Assertions.assertThrows;
 

jackson-datatype-problem/src/test/java/org/zalando/problem/jackson/UnknownStatusTest.java

@@ -0,0 +1,17 @@
+package org.zalando.problem.jackson;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class UnknownStatusTest {
+
+    @Test
+    void shouldReturnCodeAndPhrase() {
+        final int code = 8080;
+        final UnknownStatus status = new UnknownStatus(code);
+        assertEquals(8080, status.getStatusCode());
+        assertEquals("Unknown", status.getReasonPhrase());
+    }
+
+}

jackson-datatype-problem/src/test/resources/META-INF/services/org.zalando.problem.spi.StackTraceProcessor

@@ -1 +1 @@
-org.zalando.problem.JacksonStackTraceProcessor
+org.zalando.problem.jackson.JacksonStackTraceProcessor