support for primitive types (#118)

* support for primitive types

* regen html

* improvements

* more tests

* checking against jackson config

* default value in RequestParam

Author: jmisur

docs/index.html

@@ -1486,7 +1486,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 </div>
 <div id="footer">
 <div id="footer-text">
-    Last updated 2017-07-31 10:29:18 CEST
+    Last updated 2017-07-31 20:33:00 CEST
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/constraints/ConstraintAndGroupDescriptionResolver.java

@@ -50,7 +50,7 @@ public String resolveDescription(Constraint constraint) {
             constraintDescription = constraint.getName();
         }
 
-        List<Class> groups = getGroups(constraint);
+        List<Class<?>> groups = getGroups(constraint);
         if (groups.isEmpty()) {
             return constraintDescription;
         }
@@ -65,14 +65,14 @@ public String resolveDescription(Constraint constraint) {
     }
 
     @Override
-    public List<Class> getGroups(Constraint constraint) {
+    public List<Class<?>> getGroups(Constraint constraint) {
         Object rawGroups = constraint.getConfiguration().get(GROUPS);
         if (!(rawGroups instanceof Class[])) {
             return emptyList();
         }
-        Class[] groups = (Class[]) rawGroups;
+        Class<?>[] groups = (Class[]) rawGroups;
 
-        List<Class> result = new ArrayList<>();
+        List<Class<?>> result = new ArrayList<>();
         Collections.addAll(result, groups);
         return result;
     }

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/constraints/ConstraintReader.java

@@ -24,8 +24,6 @@ public interface ConstraintReader {
     String CONSTRAINTS_ATTRIBUTE = "constraints";
     String OPTIONAL_ATTRIBUTE = "optionals";
 
-    boolean isMandatory(Class<?> annotation);
-
     List<String> getConstraintMessages(Class<?> javaBaseClass, String javaFieldName);
 
     List<String> getConstraintMessages(MethodParameter param);

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/constraints/ConstraintReaderImpl.java

@@ -17,13 +17,10 @@
 package capital.scalable.restdocs.constraints;
 
 import static capital.scalable.restdocs.constraints.ConstraintAndGroupDescriptionResolver.VALUE;
-import static capital.scalable.restdocs.constraints.SkippableConstraintResolver
-        .MANDATORY_VALUE_ANNOTATIONS;
 import static capital.scalable.restdocs.util.ObjectUtil.arrayToString;
 import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
 import static java.util.Collections.singletonMap;
-import static org.apache.commons.lang3.ArrayUtils.contains;
 import static org.apache.commons.lang3.StringUtils.isBlank;
 import static org.springframework.util.ReflectionUtils.findField;
 
@@ -55,11 +52,6 @@ public List<String> getOptionalMessages(Class<?> javaBaseClass, String javaField
         return skippableConstraintResolver.getOptionalMessages(javaFieldName, javaBaseClass);
     }
 
-    @Override
-    public boolean isMandatory(Class<?> annotation) {
-        return contains(MANDATORY_VALUE_ANNOTATIONS, annotation);
-    }
-
     @Override
     public List<String> getConstraintMessages(Class<?> javaBaseClass, String javaFieldName) {
         ConstraintDescriptions constraints = new ConstraintDescriptions(javaBaseClass,

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/constraints/GroupDescriptionResolver.java

@@ -21,7 +21,7 @@
 import org.springframework.restdocs.constraints.Constraint;
 
 public interface GroupDescriptionResolver {
-    List<Class> getGroups(Constraint constraint);
+    List<Class<?>> getGroups(Constraint constraint);
 
-    String resolveGroupDescription(Class group, String constraintDescription);
+    String resolveGroupDescription(Class<?> group, String constraintDescription);
 }

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/constraints/SkippableConstraintResolver.java

@@ -78,7 +78,7 @@ public List<String> getOptionalMessages(String property, Class<?> clazz) {
 
         for (Constraint constraint : constraints) {
             if (isSkippable(constraint)) {
-                List<Class> groups = getGroups(constraint);
+                List<Class<?>> groups = getGroups(constraint);
 
                 if (groups.isEmpty()) {
                     defaultOptional = "false";
@@ -97,7 +97,7 @@ public List<String> getOptionalMessages(String property, Class<?> clazz) {
         return result;
     }
 
-    private List<Class> getGroups(Constraint constraint) {
+    private List<Class<?>> getGroups(Constraint constraint) {
         return descriptionResolver.getGroups(constraint);
     }
 

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/jackson/FieldDocumentationGenerator.java

@@ -21,6 +21,7 @@
 
 import capital.scalable.restdocs.constraints.ConstraintReader;
 import capital.scalable.restdocs.javadoc.JavadocReader;
+import com.fasterxml.jackson.databind.DeserializationConfig;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectWriter;
@@ -30,12 +31,16 @@
 public class FieldDocumentationGenerator {
 
     private final ObjectWriter writer;
+    private final DeserializationConfig deserializationConfig;
     private final JavadocReader javadocReader;
-    private ConstraintReader constraintReader;
+    private final ConstraintReader constraintReader;
 
-    public FieldDocumentationGenerator(ObjectWriter writer, JavadocReader javadocReader,
+    public FieldDocumentationGenerator(ObjectWriter writer,
+            DeserializationConfig deserializationConfig,
+            JavadocReader javadocReader,
             ConstraintReader constraintReader) {
         this.writer = writer;
+        this.deserializationConfig = deserializationConfig;
         this.javadocReader = javadocReader;
         this.constraintReader = constraintReader;
     }
@@ -47,7 +52,7 @@ public List<FieldDescriptor> generateDocumentation(Type type, TypeFactory typeFa
 
     public List<FieldDescriptor> generateDocumentation(JavaType type) throws JsonMappingException {
         FieldDocumentationVisitorWrapper visitorWrapper = FieldDocumentationVisitorWrapper.create(
-                javadocReader, constraintReader);
+                javadocReader, constraintReader, deserializationConfig);
         writer.acceptJsonFormatVisitor(type, visitorWrapper);
         return visitorWrapper.getContext().getFields();
     }

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/jackson/FieldDocumentationVisitorContext.java

@@ -20,6 +20,7 @@
 import static capital.scalable.restdocs.constraints.ConstraintReader.OPTIONAL_ATTRIBUTE;
 import static capital.scalable.restdocs.util.FieldUtil.fromGetter;
 import static capital.scalable.restdocs.util.FieldUtil.isGetter;
+import static capital.scalable.restdocs.util.TypeUtil.isPrimitive;
 import static org.apache.commons.lang3.StringUtils.isBlank;
 import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
 
@@ -28,18 +29,23 @@
 
 import capital.scalable.restdocs.constraints.ConstraintReader;
 import capital.scalable.restdocs.javadoc.JavadocReader;
+import com.fasterxml.jackson.databind.DeserializationConfig;
+import com.fasterxml.jackson.databind.DeserializationFeature;
 import org.springframework.restdocs.payload.FieldDescriptor;
 import org.springframework.restdocs.snippet.Attributes.Attribute;
 
 public class FieldDocumentationVisitorContext {
     private final List<FieldDescriptor> fields = new ArrayList<>();
-    private JavadocReader javadocReader;
-    private ConstraintReader constraintReader;
+    private final JavadocReader javadocReader;
+    private final ConstraintReader constraintReader;
+    private final DeserializationConfig deserializationConfig;
 
     public FieldDocumentationVisitorContext(JavadocReader javadocReader,
-            ConstraintReader constraintReader) {
+            ConstraintReader constraintReader,
+            DeserializationConfig deserializationConfig) {
         this.javadocReader = javadocReader;
         this.constraintReader = constraintReader;
+        this.deserializationConfig = deserializationConfig;
     }
 
     public List<FieldDescriptor> getFields() {
@@ -87,9 +93,16 @@ private Attribute optionalAttribute(Class<?> javaBaseClass, String javaFieldName
                 resolveOptionalMessages(javaBaseClass, javaFieldName));
     }
 
-    private List<String> resolveOptionalMessages(Class<?> javaBaseClass,
-            String javaFieldName) {
+    private List<String> resolveOptionalMessages(Class<?> javaBaseClass, String javaFieldName) {
         List<String> optionalMessages = new ArrayList<>();
+
+        if (isPrimitive(javaBaseClass, javaFieldName)) {
+            boolean failOnNullForPrimitives = deserializationConfig.hasDeserializationFeatures(
+                    DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES.getMask());
+            optionalMessages.add("" + !failOnNullForPrimitives);
+            return optionalMessages;
+        }
+
         optionalMessages.addAll(constraintReader.getOptionalMessages(javaBaseClass, javaFieldName));
 
         // fallback to field itself if we got a getter and no annotation on it

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/jackson/FieldDocumentationVisitorWrapper.java

@@ -18,6 +18,7 @@
 
 import capital.scalable.restdocs.constraints.ConstraintReader;
 import capital.scalable.restdocs.javadoc.JavadocReader;
+import com.fasterxml.jackson.databind.DeserializationConfig;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.SerializerProvider;
@@ -52,9 +53,10 @@ public class FieldDocumentationVisitorWrapper implements JsonFormatVisitorWrappe
     }
 
     public static FieldDocumentationVisitorWrapper create(JavadocReader javadocReader,
-            ConstraintReader constraintReader) {
+            ConstraintReader constraintReader, DeserializationConfig deserializationConfig) {
         return new FieldDocumentationVisitorWrapper(
-                new FieldDocumentationVisitorContext(javadocReader, constraintReader), "", null);
+                new FieldDocumentationVisitorContext(javadocReader, constraintReader,
+                        deserializationConfig), "", null);
     }
 
     @Override

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/payload/AbstractJacksonFieldSnippet.java

@@ -77,7 +77,7 @@ protected Collection<FieldDescriptor> createFieldDescriptors(Operation operation
         if (signatureType != null) {
             try {
                 for (Type type : resolveActualTypes(signatureType)) {
-                    resolveFieldDescriptors(fieldDescriptors, type, writer, typeFactory,
+                    resolveFieldDescriptors(fieldDescriptors, type, objectMapper,
                             javadocReader, constraintReader);
                 }
             } catch (JsonMappingException e) {
@@ -121,11 +121,13 @@ private Collection<Type> resolveActualTypes(Type type) {
     }
 
     private void resolveFieldDescriptors(Map<String, FieldDescriptor> fieldDescriptors,
-            Type type, ObjectWriter writer, TypeFactory typeFactory, JavadocReader javadocReader,
+            Type type, ObjectMapper objectMapper, JavadocReader javadocReader,
             ConstraintReader constraintReader) throws JsonMappingException {
-        FieldDocumentationGenerator generator = new FieldDocumentationGenerator(writer,
-                javadocReader, constraintReader);
-        List<FieldDescriptor> descriptors = generator.generateDocumentation(type, typeFactory);
+        FieldDocumentationGenerator generator = new FieldDocumentationGenerator(
+                objectMapper.writer(), objectMapper.getDeserializationConfig(), javadocReader,
+                constraintReader);
+        List<FieldDescriptor> descriptors = generator.generateDocumentation(type,
+                objectMapper.getTypeFactory());
         for (FieldDescriptor descriptor : descriptors) {
             if (fieldDescriptors.get(descriptor.getPath()) == null) {
                 fieldDescriptors.put(descriptor.getPath(), descriptor);