Polish (#171)

* Remove unused code and fix copyright year

* Cover all cases for the required flag for path parameters

* Simplify control flow

* Remove unnecessary method calls and type casts

* Fix typos

* Fix typo

* Use new request mapping annotations

Author: fbenz

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

@@ -11,7 +11,7 @@ public class SnippetRegistry {
     public static final String DESCRIPTION = "auto-description";
     public static final String METHOD_PATH = "auto-method-path";
     public static final String PATH_PARAMETERS = "auto-path-parameters";
-    public static final String REQUEST_HEADRERS = "auto-request-headers";
+    public static final String REQUEST_HEADERS = "auto-request-headers";
     public static final String REQUEST_PARAMETERS = "auto-request-parameters";
     public static final String REQUEST_FIELDS = "auto-request-fields";
     public static final String RESPONSE_FIELDS = "auto-response-fields";

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

@@ -28,11 +28,9 @@
 
 class SkippableConstraintResolver implements MethodParameterConstraintResolver {
     public static final Collection<String> MANDATORY_VALUE_ANNOTATIONS = Arrays.asList(
-            new String[]{
-                    "javax.validation.constraints.NotNull",
-                    "org.hibernate.validator.constraints.NotBlank",
-                    "org.hibernate.validator.constraints.NotEmpty"
-            });
+            "javax.validation.constraints.NotNull",
+            "org.hibernate.validator.constraints.NotBlank",
+            "org.hibernate.validator.constraints.NotEmpty");
 
     private final MethodParameterConstraintResolver delegate;
     private final GroupDescriptionResolver descriptionResolver;

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

@@ -188,6 +188,6 @@ private boolean topLevelPath() {
     }
 
     private String toString(JavaType type) {
-        return ((Class) type.getRawClass()).getSimpleName();
+        return type.getRawClass().getSimpleName();
     }
 }

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

@@ -11,7 +11,7 @@ private JavadocUtil() {
     }
 
     public static String convertFromJavadoc(String javadoc, TemplateFormatting templateFormatting) {
-        String converted = javadoc.toString()
+        String converted = javadoc
                 // line breaks in javadoc are ignored
                 .replace("\n", "")
                 // will be replaced with forced line break
@@ -35,7 +35,7 @@ public static String convertFromJavadoc(String javadoc, TemplateFormatting templ
 
         String res = trimAndFixLineBreak(converted, FORCED_LB, templateFormatting.getLineBreak());
         res = trimAndFixLineBreak(res, LB, "\n");
-        return res.toString();
+        return res;
     }
 
     private static String trimAndFixLineBreak(String text, String separator, String newSeparator) {

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

@@ -36,8 +36,6 @@
 import capital.scalable.restdocs.snippet.StandardTableSnippet;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.ObjectWriter;
-import com.fasterxml.jackson.databind.type.TypeFactory;
 import org.springframework.core.MethodParameter;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.payload.FieldDescriptor;
@@ -62,8 +60,6 @@ protected AbstractJacksonFieldSnippet(String snippetName, Map<String, Object> at
     protected Collection<FieldDescriptor> createFieldDescriptors(Operation operation,
             HandlerMethod handlerMethod) {
         ObjectMapper objectMapper = getObjectMapper(operation);
-        ObjectWriter writer = objectMapper.writer();
-        TypeFactory typeFactory = objectMapper.getTypeFactory();
 
         JavadocReader javadocReader = getJavadocReader(operation);
         ConstraintReader constraintReader = getConstraintReader(operation);

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

@@ -39,9 +39,8 @@ public PathParametersSnippet failOnUndocumentedParams(boolean failOnUndocumented
 
     @Override
     protected boolean isRequired(MethodParameter param, PathVariable annot) {
-        return param.getParameterType().isPrimitive()
-                ? true // spring disallows null for primitive
-                : annot.required();
+        // Spring disallows null for primitive types
+        return param.getParameterType().isPrimitive() || annot.required();
     }
 
     @Override

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,9 +39,8 @@ public RequestHeaderSnippet failOnUndocumentedParams(boolean failOnUndocumentedP
 
     @Override
     protected boolean isRequired(MethodParameter param, RequestHeader annot) {
-        return param.getParameterType().isPrimitive()
-                ? true // spring disallows null for primitive
-                : annot.required();
+        // Spring disallows null for primitive types
+        return param.getParameterType().isPrimitive() || annot.required();
     }
 
     @Override

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

@@ -23,7 +23,6 @@
 import static capital.scalable.restdocs.constraints.ConstraintReader.OPTIONAL_ATTRIBUTE;
 import static capital.scalable.restdocs.javadoc.JavadocUtil.convertFromJavadoc;
 import static capital.scalable.restdocs.util.FormatUtil.addDot;
-import static java.util.Collections.emptyList;
 import static org.apache.commons.lang3.StringUtils.capitalize;
 import static org.apache.commons.lang3.StringUtils.join;
 import static org.apache.commons.lang3.StringUtils.trimToEmpty;
@@ -54,11 +53,9 @@ protected Map<String, Object> createModel(Operation operation) {
             return model;
         }
 
-        Collection<FieldDescriptor> fieldDescriptors = emptyList();
-        fieldDescriptors = createFieldDescriptors(operation, handlerMethod);
-
+        Collection<FieldDescriptor> fieldDescriptors =
+                createFieldDescriptors(operation, handlerMethod);
         TemplateFormatting templateFormatting = determineTemplateFormatting(operation);
-
         return createModel(handlerMethod, model, fieldDescriptors, templateFormatting);
     }
 

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

@@ -71,7 +71,7 @@ public static boolean isPrimitive(Class<?> javaBaseClass, String javaFieldName)
         if (field == null && isGetter(javaFieldName)) {
             field = ReflectionUtils.findField(javaBaseClass, fromGetter(javaFieldName));
         }
-        return field != null ? field.getType().isPrimitive() : false;
+        return field != null && field.getType().isPrimitive();
     }
 
     public static List<JavaType> resolveAllTypes(JavaType javaType, TypeFactory typeFactory) {
@@ -97,7 +97,7 @@ private static List<JavaType> resolveNonArrayTypes(JavaType javaType, TypeFactor
         types.add(javaType);
 
         Class<?> rawClass = javaType.getRawClass();
-        JsonSubTypes jsonSubTypes = (JsonSubTypes) rawClass.getAnnotation(JsonSubTypes.class);
+        JsonSubTypes jsonSubTypes = rawClass.getAnnotation(JsonSubTypes.class);
         if (jsonSubTypes != null) {
             for (JsonSubTypes.Type subType : jsonSubTypes.value()) {
                 JavaType javaSubType = typeFactory.constructType(subType.value());

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/jackson/FieldDocumentationGeneratorTest.java

@@ -34,7 +34,6 @@
 import java.lang.reflect.Type;
 import java.math.BigDecimal;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 
@@ -459,10 +458,10 @@ private ExtendedFieldDescriptor descriptor(String path, Object fieldType,
                 .type(fieldType)
                 .description(comment);
         fieldDescriptor.attributes(
-                new Attribute(OPTIONAL_ATTRIBUTE, Arrays.asList(optional)));
+                new Attribute(OPTIONAL_ATTRIBUTE, singletonList(optional)));
         if (constraints != null) {
             fieldDescriptor.attributes(
-                    new Attribute(CONSTRAINTS_ATTRIBUTE, Arrays.asList(constraints)));
+                    new Attribute(CONSTRAINTS_ATTRIBUTE, asList(constraints)));
         }
         return new ExtendedFieldDescriptor(fieldDescriptor);
     }