Fixes to more accurately use the url mappings

This change re-introduces format. We let the url mappings dictate what parameters to use and what to note use.

(10)

Author: dilipkrish

springfox-grails-contract-tests/src/integration-test/resources/expected-service-description.json

@@ -7,11 +7,12 @@
 import org.springframework.web.method.HandlerMethod;
 import springfox.documentation.service.ResolvedMethodParameter;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Set;
 
 class ActionSpecification {
-  private final Set<RequestMethod> supportedMethods;
+  private final Collection<RequestMethod> supportedMethods;
   private final Set<MediaType> produces;
   private final Set<MediaType> consumes;
   private final List<ResolvedMethodParameter> parameters;
@@ -21,7 +22,7 @@ class ActionSpecification {
 
   public ActionSpecification(
       String path,
-      Set<RequestMethod> supportedMethods,
+      Collection<RequestMethod> supportedMethods,
       Set<MediaType> produces,
       Set<MediaType> consumes,
       HandlerMethod handlerMethod,
@@ -43,7 +44,7 @@ public String getPath() {
     return path;
   }
 
-  public Set<RequestMethod> getSupportedMethods() {
+  public Collection<RequestMethod> getSupportedMethods() {
     return supportedMethods;
   }
 

springfox-grails/src/main/java/springfox/documentation/grails/ActionSpecification.java

@@ -17,7 +17,7 @@ public CreateActionSpecificationFactory(TypeResolver resolver) {
   public ActionSpecification create(GrailsActionContext context) {
     return new ActionSpecification(
         context.path(),
-        Collections.singleton(context.getRequestMethod()),
+        context.getRequestMethods(),
         context.supportedMediaTypes(),
         context.supportedMediaTypes(),
         context.handlerMethod(),

springfox-grails/src/main/java/springfox/documentation/grails/CreateActionSpecificationFactory.java

@@ -2,10 +2,6 @@
 
 import com.fasterxml.classmate.TypeResolver;
 
-import java.util.Collections;
-
-import static springfox.documentation.grails.Parameters.*;
-
 class DeleteActionSpecificationFactory implements ActionSpecificationFactory {
   private final TypeResolver resolver;
 
@@ -17,15 +13,11 @@ public DeleteActionSpecificationFactory(TypeResolver resolver) {
   public ActionSpecification create(GrailsActionContext context) {
     return new ActionSpecification(
         context.path(),
-        Collections.singleton(context.getRequestMethod()),
+        context.getRequestMethods(),
         context.supportedMediaTypes(),
         context.supportedMediaTypes(),
         context.handlerMethod(),
-        Collections.singletonList(
-            pathParameter(
-                1,
-                "id",
-                resolver.resolve(idType(context.getDomainClass())))),
+        context.pathParameters(),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/main/java/springfox/documentation/grails/DeleteActionSpecificationFactory.java

@@ -2,12 +2,6 @@
 
 import com.fasterxml.classmate.TypeResolver;
 
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-
-import static springfox.documentation.grails.Parameters.*;
-
 class EditActionSpecificationFactory implements ActionSpecificationFactory {
   private final TypeResolver resolver;
 
@@ -19,13 +13,11 @@ public EditActionSpecificationFactory(TypeResolver resolver) {
   public ActionSpecification create(GrailsActionContext context) {
     return new ActionSpecification(
         context.path(),
-        Collections.singleton(context.getRequestMethod()),
+        context.getRequestMethods(),
         context.supportedMediaTypes(),
         context.supportedMediaTypes(),
         context.handlerMethod(),
-        new ArrayList<>(Arrays.asList(
-            pathParameter(1, "id", resolver.resolve(idType(context.getDomainClass()))),
-            bodyParameter(2, resolver.resolve(domainClass(context.getDomainClass()))))),
+        context.pathParameters(),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/main/java/springfox/documentation/grails/EditActionSpecificationFactory.java

@@ -6,20 +6,37 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.servlet.mvc.condition.RequestCondition;
 
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
+import static com.google.common.collect.Lists.*;
+import static springfox.documentation.builders.BuilderDefaults.*;
 import static springfox.documentation.grails.Actions.*;
 
 @Component
 class GrailsActionAttributes {
+  private static final List<RequestMethod> ALL_HTTP_METHODS = newArrayList(
+      RequestMethod.GET,
+      RequestMethod.POST,
+      RequestMethod.PUT,
+      RequestMethod.PATCH,
+      RequestMethod.DELETE,
+      RequestMethod.HEAD,
+      RequestMethod.OPTIONS,
+      RequestMethod.TRACE);
+
   public static Map<String, String> methodMap = ImmutableMap.<String, String>builder()
       .put("index", "GET")
       .put("show", "GET")
@@ -30,7 +47,7 @@ class GrailsActionAttributes {
       .put("patch", "PATCH")
       .put("delete", "DELETE")
       .build();
-  
+
   private final LinkGenerator linkGenerator;
   private final grails.web.mapping.UrlMappings urlMappings;
 
@@ -42,26 +59,37 @@ public GrailsActionAttributes(
     this.urlMappings = urlMappings;
   }
 
-  public Set<RequestMethod> httpMethod(GrailsActionContext context) {
+  public Collection<RequestMethod> httpMethods(GrailsActionContext context) {
     Set<RequestMethod> requestMethods = methodOverrides(context);
     if (requestMethods.isEmpty()) {
-      Set<RequestMethod> defaultMethods = Arrays.stream(urlMappings.getUrlMappings())
-          .filter(mapping ->
-              Objects.equals(mapping.getControllerName(), context.getController().getName())
-                  && Objects.equals(mapping.getActionName(), context.getAction()))
-          .map(mapping -> RequestMethod.valueOf(mapping.getHttpMethod()))
-          .collect(Collectors.toSet());
-      if (defaultMethods.isEmpty()) {
-        String defaultMethod = context.isRestfulController()
-                      ? methodMap.getOrDefault(context.getAction(), "POST")
-                      : "POST";
-        return Collections.singleton(RequestMethod.valueOf(defaultMethod));
-      }
-      return defaultMethods;
+      Stream<UrlMapping> sorted = Arrays.stream(urlMappings.getUrlMappings())
+          .filter(UrlMappings.selector(context, null))
+          .sorted(Comparator.comparing(this::score));
+      return sorted.findFirst()
+          .map(m -> httpMethods(defaultIfAbsent(m.getHttpMethod(), "*")))
+          .orElse(Collections.singleton(RequestMethod.OPTIONS));
     }
     return requestMethods;
   }
 
+  private Integer score(UrlMapping mapping) {
+    String method = defaultIfAbsent(mapping.getHttpMethod(), "*");
+    String action = Optional.ofNullable(mapping.getActionName())
+        .map(Object::toString)
+        .orElse("*");
+
+    int methodScore = method.equals("*") ? 1000 : 0;
+    int actionScore = action.equals("*") ? 1000 : 0;
+    return (actionScore * 10) + methodScore;
+  }
+
+  private Collection<RequestMethod> httpMethods(String httpMethod) {
+    if (Objects.equals(httpMethod, "*")) {
+      return ALL_HTTP_METHODS;
+    }
+    return Collections.singleton(RequestMethod.valueOf(httpMethod));
+  }
+
   public boolean isRestfulAction(String action) {
     return methodMap.containsKey(action);
   }
@@ -80,7 +108,6 @@ public String actionUrl(GrailsActionContext context, UrlMapping mapping) {
         "UTF-8")
         .replace("%7B", "{").replace("%7D", "}")
         .replace(linkGenerator.getServerBaseURL(), "")
-        .replace(".{format}", "")
         .toLowerCase();
   }
 

springfox-grails/src/main/java/springfox/documentation/grails/GrailsActionAttributes.java

@@ -10,6 +10,7 @@
 import org.springframework.web.method.HandlerMethod;
 import springfox.documentation.service.ResolvedMethodParameter;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -27,8 +28,9 @@ class GrailsActionContext {
   private final TypeResolver resolver;
   private final Optional<UrlMapping> urlMapping;
   private final boolean isRestfulController;
-  private final String method;
   private final Set<MediaType> mediaTypes;
+  private final Collection<RequestMethod> requestMethods;
+  private final boolean missingMapping;
 
   public GrailsActionContext(
       GrailsControllerClass controller,
@@ -42,11 +44,13 @@ public GrailsActionContext(
     this.action = action;
     this.resolver = resolver;
     this.isRestfulController = isRestfulController(controller, action);
-    this.method = urlProvider.httpMethod(this)
+    this.requestMethods = urlProvider.httpMethods(this);
+    String method = requestMethods
         .stream()
         .findFirst()
         .map(Enum::toString)
         .orElse(null);
+    this.missingMapping = requestMethods.isEmpty();
     this.urlMapping = urlProvider.urlMapping(selector(this, method));
     this.mediaTypes = mediaTypeOverrides(this);
     maybeAddDefaultMediaType(mediaTypes);
@@ -86,8 +90,8 @@ public List<ResolvedMethodParameter> pathParameters() {
         .orElse(newArrayList());
   }
 
-  public RequestMethod getRequestMethod() {
-    return RequestMethod.valueOf(method);
+  public Collection<RequestMethod> getRequestMethods() {
+    return requestMethods;
   }
 
   public HandlerMethod handlerMethod() {
@@ -103,6 +107,10 @@ public boolean isRestfulController() {
     return isRestfulController;
   }
 
+  public boolean isMissingMapping() {
+    return missingMapping;
+  }
+
   private boolean isRestfulController(GrailsControllerClass controller, String action) {
     try {
       Class<?> restfulController = Class.forName("grails.rest.RestfulController");

springfox-grails/src/main/java/springfox/documentation/grails/GrailsActionContext.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.classmate.ResolvedType;
 import com.google.common.base.Optional;
+import com.google.common.collect.ImmutableSet;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -65,7 +66,7 @@ public String getName() {
 
   @Override
   public Set<RequestMethod> supportedMethods() {
-    return actionSpecification.getSupportedMethods();
+    return ImmutableSet.copyOf(actionSpecification.getSupportedMethods());
   }
 
   @Override

springfox-grails/src/main/java/springfox/documentation/grails/GrailsRequestHandler.java

@@ -1,12 +1,9 @@
 package springfox.documentation.grails;
 
 import com.fasterxml.classmate.TypeResolver;
-import org.springframework.http.MediaType;
 import springfox.documentation.service.ResolvedMethodParameter;
 
-import java.util.Collections;
 import java.util.List;
-import java.util.Set;
 
 import static com.google.common.collect.Lists.*;
 import static springfox.documentation.grails.Parameters.*;
@@ -22,27 +19,22 @@ public IndexActionSpecificationFactory(TypeResolver resolver) {
   public ActionSpecification create(GrailsActionContext context) {
     return new ActionSpecification(
         context.path(),
-        Collections.singleton(context.getRequestMethod()),
+        context.getRequestMethods(),
         context.supportedMediaTypes(),
         context.supportedMediaTypes(),
         context.handlerMethod(),
-        parameters(context.supportedMediaTypes()),
+        parameters(context),
         resolver.resolve(List.class, domainClass(context.getDomainClass())));
   }
 
-  private List<ResolvedMethodParameter> parameters(Set<MediaType> mediaTypes) {
-    List<ResolvedMethodParameter> parameters = newArrayList(queryParameter(
-        0,
+  private List<ResolvedMethodParameter> parameters(GrailsActionContext context) {
+    List<ResolvedMethodParameter> parameters = newArrayList(context.pathParameters());
+    parameters.add(queryParameter(
+        1,
         "max",
         resolver.resolve(Integer.class),
         false,
         ""));
-    if (mediaTypes.size() > 1) {
-      parameters.add(pathParameter(
-          1,
-          "format",
-          resolver.resolve(String.class)));
-    }
     return parameters;
   }
 }

springfox-grails/src/main/java/springfox/documentation/grails/IndexActionSpecificationFactory.java

@@ -7,7 +7,6 @@
 import springfox.documentation.spring.web.readers.operation.HandlerMethodResolver;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 
 @Component
@@ -25,7 +24,7 @@ public ActionSpecification create(GrailsActionContext context) {
     methodParameters.addAll(handlerMethodResolver.methodParameters(context.handlerMethod()));
     return new ActionSpecification(
         context.path(),
-        Collections.singleton(context.getRequestMethod()),
+        context.getRequestMethods(),
         context.supportedMediaTypes(),
         context.supportedMediaTypes(),
         context.handlerMethod(),