Better support for ModelAttribute (#368)

* feat: better support for ModelAttribute Annotation

* fix: only not simple classes are automatcally modelattribute

* fix: removed unused imports

* fix: changed negated allMatch to noneMatch

* fix: moved getTranslationKeys to ModelAttributeSnippet

Author: AnWeber

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

@@ -24,13 +24,18 @@
 import capital.scalable.restdocs.misc.AuthorizationSnippet;
 import capital.scalable.restdocs.misc.DescriptionSnippet;
 import capital.scalable.restdocs.misc.MethodAndPathSnippet;
+import capital.scalable.restdocs.payload.JacksonModelAttributeSnippet;
 import capital.scalable.restdocs.payload.JacksonRequestFieldSnippet;
 import capital.scalable.restdocs.payload.JacksonResponseFieldSnippet;
 import capital.scalable.restdocs.request.PathParametersSnippet;
 import capital.scalable.restdocs.request.RequestHeaderSnippet;
 import capital.scalable.restdocs.request.RequestParametersSnippet;
 import capital.scalable.restdocs.section.SectionBuilder;
+
+import java.util.Collection;
+
 import org.springframework.restdocs.snippet.Snippet;
+import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 
 public abstract class AutoDocumentation {
 
@@ -41,6 +46,10 @@ public static JacksonRequestFieldSnippet requestFields() {
         return new JacksonRequestFieldSnippet();
     }
 
+    public static JacksonModelAttributeSnippet modelAttribute(Collection<HandlerMethodArgumentResolver> handlerMethodArgumentResolvers) {
+        return new JacksonModelAttributeSnippet(handlerMethodArgumentResolvers, false);
+    }
+
     public static JacksonResponseFieldSnippet responseFields() {
         return new JacksonResponseFieldSnippet();
     }

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

@@ -33,6 +33,7 @@ public class SnippetRegistry {
     public static final String AUTO_PATH_PARAMETERS = "auto-path-parameters";
     public static final String AUTO_REQUEST_HEADERS = "auto-request-headers";
     public static final String AUTO_REQUEST_PARAMETERS = "auto-request-parameters";
+    public static final String AUTO_MODELATTRIBUTE = "auto-modelattribute";
     public static final String AUTO_REQUEST_FIELDS = "auto-request-fields";
     public static final String AUTO_RESPONSE_FIELDS = "auto-response-fields";
     public static final String AUTO_LINKS = "auto-links";
@@ -101,7 +102,7 @@ public String getFileName() {
         }
 
         @Override
-        public String getHeaderKey() {
+        public String getHeaderKey(Operation operation) {
             return headerKey;
         }
 

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/hypermedia/EmbeddedSnippet.java

@@ -24,6 +24,8 @@
 import java.lang.reflect.Type;
 
 import capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet;
+
+import org.springframework.restdocs.operation.Operation;
 import org.springframework.web.method.HandlerMethod;
 
 public class EmbeddedSnippet extends AbstractJacksonFieldSnippet {
@@ -55,7 +57,7 @@ protected Type getType(HandlerMethod method) {
     }
 
     @Override
-    public String getHeaderKey() {
+    public String getHeaderKey(Operation operation) {
         return "embedded";
     }
 

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/hypermedia/LinksSnippet.java

@@ -24,6 +24,7 @@
 import java.lang.reflect.Type;
 
 import capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet;
+import org.springframework.restdocs.operation.Operation;
 import org.springframework.web.method.HandlerMethod;
 
 public class LinksSnippet extends AbstractJacksonFieldSnippet {
@@ -54,7 +55,7 @@ protected Type getType(HandlerMethod method) {
     }
 
     @Override
-    public String getHeaderKey() {
+    public String getHeaderKey(Operation operation) {
         return "hypermedia-links";
     }
 

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/misc/AuthorizationSnippet.java

@@ -68,7 +68,7 @@ public String getFileName() {
     }
 
     @Override
-    public String getHeaderKey() {
+    public String getHeaderKey(Operation operation) {
         return "authorization";
     }
 

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

@@ -7,9 +7,9 @@
  * 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.
@@ -80,7 +80,7 @@ protected FieldDescriptors createFieldDescriptors(Operation operation,
                     javadocReader, constraintReader, typeMapping, translationResolver);
 
             if (shouldFailOnUndocumentedFields()) {
-                assertAllDocumented(fieldDescriptors.values(), translationResolver.translate(getHeaderKey()).toLowerCase());
+                assertAllDocumented(fieldDescriptors.values(), translationResolver.translate(getHeaderKey(operation)).toLowerCase());
             }
             return fieldDescriptors;
         } catch (JsonMappingException e) {
@@ -101,7 +101,7 @@ protected Type firstGenericType(MethodParameter param) {
             } else if (actualArgument instanceof TypeVariable) {
                 TypeVariable typeVariable = (TypeVariable)actualArgument;
                 return findTypeFromTypeVariable(typeVariable, param.getContainingClass());
-            }             
+            }
             return ((ParameterizedType) type).getActualTypeArguments()[0];
         } else {
             return Object.class;

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

@@ -0,0 +1,143 @@
+/*-
+ * #%L
+ * Spring Auto REST Docs Core
+ * %%
+ * Copyright (C) 2015 - 2020 Scalable Capital GmbH
+ * %%
+ * 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
+ * limitations under the License.
+ * #L%
+ */
+
+package capital.scalable.restdocs.payload;
+
+import java.lang.reflect.GenericArrayType;
+import java.lang.reflect.Type;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Map;
+
+import org.springframework.beans.BeanUtils;
+import org.springframework.core.MethodParameter;
+import org.springframework.restdocs.operation.Operation;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.method.HandlerMethod;
+import org.springframework.web.method.support.HandlerMethodArgumentResolver;
+
+import capital.scalable.restdocs.OperationAttributeHelper;
+import capital.scalable.restdocs.i18n.SnippetTranslationResolver;
+import capital.scalable.restdocs.jackson.FieldDescriptors;
+import capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet;
+import capital.scalable.restdocs.request.RequestParametersSnippet;
+import capital.scalable.restdocs.util.HandlerMethodUtil;
+
+import static capital.scalable.restdocs.SnippetRegistry.AUTO_MODELATTRIBUTE;
+
+public class JacksonModelAttributeSnippet extends AbstractJacksonFieldSnippet {
+    private final boolean failOnUndocumentedFields;
+    private final Collection<HandlerMethodArgumentResolver> handlerMethodArgumentResolvers;
+
+    public JacksonModelAttributeSnippet() {
+        this(null, false);
+    }
+
+    public JacksonModelAttributeSnippet(Collection<HandlerMethodArgumentResolver> handlerMethodArgumentResolvers, boolean failOnUndocumentedFields) {
+        super(AUTO_MODELATTRIBUTE, null);
+        this.failOnUndocumentedFields = failOnUndocumentedFields;
+        this.handlerMethodArgumentResolvers = handlerMethodArgumentResolvers;
+    }
+
+    @Override
+    protected Type getType(HandlerMethod method) {
+        for (MethodParameter param : method.getMethodParameters()) {
+            if (isModelAttribute(param) || hasNoHandlerMethodArgumentResolver(param)) {
+                return getType(param);
+            }
+        }
+        return null;
+    }
+
+
+    private boolean isModelAttribute(MethodParameter param) {
+        return param.getParameterAnnotation(ModelAttribute.class) != null;
+    }
+
+    private boolean hasNoHandlerMethodArgumentResolver(MethodParameter param) {
+        return !BeanUtils.isSimpleProperty(param.getParameterType())
+            &&  this.handlerMethodArgumentResolvers != null
+            && this.handlerMethodArgumentResolvers
+            .stream()
+            .noneMatch(obj -> obj.supportsParameter(param));
+    }
+
+
+    private Type getType(final MethodParameter param) {
+        if (isCollection(param.getParameterType())) {
+            return (GenericArrayType) () -> firstGenericType(param);
+        } else {
+            return param.getParameterType();
+        }
+    }
+
+    /**
+     * is request method get supported
+     * @param method
+     * @return
+     */
+    protected boolean isRequestMethodGet(HandlerMethod method) {
+        RequestMapping requestMapping = method.getMethodAnnotation(RequestMapping.class);
+        return requestMapping == null
+        || requestMapping.method() == null
+        || Arrays.stream(requestMapping.method()).anyMatch(requestMethod -> {
+            return requestMethod == RequestMethod.GET;
+        });
+    }
+
+    @Override
+    protected void enrichModel(Map<String, Object> model, HandlerMethod handlerMethod,
+            FieldDescriptors fieldDescriptors, SnippetTranslationResolver translationResolver) {
+        boolean isPageRequest = HandlerMethodUtil.isPageRequest(handlerMethod);
+        model.put("isPageRequest", isPageRequest);
+        if (isPageRequest) {
+            model.put("noContent", false);
+        }
+    }
+
+    @Override
+    protected boolean shouldFailOnUndocumentedFields() {
+        return failOnUndocumentedFields;
+    }
+
+    @Override
+    public String getHeaderKey(Operation operation) {
+        HandlerMethod method = OperationAttributeHelper.getHandlerMethod(operation);
+        if (method != null && this.isRequestMethodGet(method)) {
+            return "request-parameters";
+        }
+        return "request-fields";
+    }
+
+    @Override
+    protected String[] getTranslationKeys() {
+        return new String[]{
+            "th-parameter",
+            "th-type",
+            "th-optional",
+            "th-description",
+            "pagination-request-adoc",
+            "pagination-request-md",
+            "no-params"
+        };
+    }
+}

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

@@ -7,9 +7,9 @@
  * 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.
@@ -25,7 +25,7 @@
 import java.lang.reflect.Type;
 
 import org.springframework.core.MethodParameter;
-import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.restdocs.operation.Operation;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.method.HandlerMethod;
 
@@ -59,7 +59,7 @@ protected Type getType(HandlerMethod method) {
         }
 
         for (MethodParameter param : method.getMethodParameters()) {
-            if (isRequestBody(param) || isModelAttribute(param)) {
+            if (isRequestBody(param)) {
                 return getType(param);
             }
         }
@@ -70,10 +70,6 @@ private boolean isRequestBody(MethodParameter param) {
         return param.getParameterAnnotation(RequestBody.class) != null;
     }
 
-    private boolean isModelAttribute(MethodParameter param) {
-        return param.getParameterAnnotation(ModelAttribute.class) != null;
-    }
-
     private Type getType(final MethodParameter param) {
         if (isCollection(param.getParameterType())) {
             return (GenericArrayType) () -> firstGenericType(param);
@@ -83,7 +79,7 @@ private Type getType(final MethodParameter param) {
     }
 
     @Override
-    public String getHeaderKey() {
+    public String getHeaderKey(Operation operation) {
         return "request-fields";
     }
 

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

@@ -33,6 +33,7 @@
 import capital.scalable.restdocs.i18n.SnippetTranslationResolver;
 import capital.scalable.restdocs.jackson.FieldDescriptors;
 import org.springframework.http.HttpEntity;
+import org.springframework.restdocs.operation.Operation;
 import org.springframework.web.method.HandlerMethod;
 
 public class JacksonResponseFieldSnippet extends AbstractJacksonFieldSnippet {
@@ -118,7 +119,7 @@ private boolean isPageResponse(HandlerMethod handlerMethod) {
     }
 
     @Override
-    public String getHeaderKey() {
+    public String getHeaderKey(Operation operation) {
         return "response-fields";
     }
 

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/request/AbstractParameterSnippet.java

@@ -74,7 +74,7 @@ protected FieldDescriptors createFieldDescriptors(Operation operation,
         }
 
         if (shouldFailOnUndocumentedParams()) {
-            assertAllDocumented(fieldDescriptors.values(), translationResolver.translate(getHeaderKey()).toLowerCase());
+            assertAllDocumented(fieldDescriptors.values(), translationResolver.translate(getHeaderKey(operation)).toLowerCase());
         }
 
         return fieldDescriptors;