Merge branch '2.3.x' of github.com:grails/grails-core into 2.3.x

Author: graemerocher

grails-plugin-mimetypes/src/main/groovy/org/codehaus/groovy/grails/plugins/web/api/MimeTypesApiSupport.groovy

@@ -49,8 +49,7 @@ class MimeTypesApiSupport {
         String format = lookupFormat(formatProvider)
         if (formats) {
             if (format == 'all') {
-                def firstKey = formats.keySet().iterator().next()
-                result = getResponseForFormat(formats[firstKey], firstKey, formatProvider)
+                result = resolveAllFormat(formatProvider, formats)
             }
             else {
                 // if the format has been specified then use that
@@ -69,8 +68,7 @@ class MimeTypesApiSupport {
                         else {
                             if (mime.extension == 'all') {
                                 matchFound = true
-                                def firstKey = formats.keySet().iterator().next()
-                                result = getResponseForFormat(formats[firstKey], firstKey, formatProvider)
+                                result = resolveAllFormat(formatProvider, formats)
                                 break
                             }
                         }
@@ -84,6 +82,27 @@ class MimeTypesApiSupport {
         return result
     }
 
+    /**
+     * implementation for resolving "all" format
+     * 
+     * @param formatProvider
+     * @param formats
+     * @return
+     */
+    protected Object resolveAllFormat(formatProvider, LinkedHashMap<String, Object> formats) {
+        def formatKey
+        def format
+        if(formats.containsKey('*')) {
+            formatKey = '*'
+            format = 'all'
+        } else {
+            // choose first key
+            formatKey = formats.keySet().iterator().next()
+            format = formatKey
+        }
+        getResponseForFormat(formats[formatKey], format, formatProvider)
+    }
+
     @CompileStatic(TypeCheckingMode.SKIP)
     protected MimeType[] lookupMimeTypes(formatProvider) {
         formatProvider.mimeTypes

grails-plugin-mimetypes/src/test/groovy/org/codehaus/groovy/grails/plugins/web/api/RequestAndResponseMimeTypesApiSpec.groovy

@@ -5,6 +5,8 @@ import javax.servlet.http.HttpServletRequest
 import org.codehaus.groovy.grails.commons.DefaultGrailsApplication
 import org.codehaus.groovy.grails.commons.metaclass.MetaClassEnhancer
 import org.codehaus.groovy.grails.plugins.web.mimes.MimeTypesFactoryBean
+
+import spock.lang.Issue;
 import spock.lang.Specification
 import javax.servlet.http.HttpServletResponse
 import org.springframework.mock.web.MockHttpServletRequest
@@ -43,13 +45,13 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
             response.format == 'all'
     }
 
-    void "Test format property is valid for CONTENT_TYPE and ACCEPT header"() {
+    void "Test format property is valid for CONTENT_TYPE and Accept header"() {
         when: "The request CONTENT_TYPE header is 'text/xml'"
             final webRequest = GrailsWebUtil.bindMockWebRequest()
             MockHttpServletRequest request = webRequest.currentRequest
             def response = webRequest.currentResponse
             request.contentType = "text/xml"
-            request.addHeader('ACCEPT', 'text/json')
+            request.addHeader('Accept', 'text/json')
 
         then: "The request format should be 'xml'"
             requestMimeTypesApi.getFormat(request) == "xml"
@@ -58,17 +60,17 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
             response.format == 'json'
     }
 
-   void "Test format property is valid for ACCEPT header only"() {
+   void "Test format property is valid for Accept header only"() {
         when: "The request CONTENT_TYPE header is 'text/xml'"
             final webRequest = GrailsWebUtil.bindMockWebRequest()
             MockHttpServletRequest request = webRequest.currentRequest
             def response = webRequest.currentResponse
-            request.addHeader('ACCEPT', 'text/json')
+            request.addHeader('Accept', 'text/json')
 
         then: "The request format should be 'xml'"
-            requestMimeTypesApi.getFormat(request) == "html"
-            requestMimeTypesApi.getFormat(request) == "html" // call twice to test cached value
-            request.format == 'html'
+            requestMimeTypesApi.getFormat(request) == "all"
+            requestMimeTypesApi.getFormat(request) == "all" // call twice to test cached value
+            request.format == 'all'
             response.format == 'json'
     }
 
@@ -95,8 +97,8 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
 
     }
 
-    void "Test withFormat method with ACCEPT header only"() {
-        when: "The request ACCEPT header is 'text/xml' and withFormat is used"
+    void "Test withFormat method with Accept header only"() {
+        when: "The request Accept header is 'text/xml' and withFormat is used"
             final webRequest = GrailsWebUtil.bindMockWebRequest()
             def request = webRequest.currentRequest
             def response = webRequest.currentResponse
@@ -118,7 +120,7 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
             requestResult == 'got html'
             responseResult == 'got xml'
 
-        when:"The ACCEPT header is JSON and there is a catch-all"
+        when:"The Accept header is JSON and there is a catch-all"
             webRequest = GrailsWebUtil.bindMockWebRequest()
             request = webRequest.currentRequest
             response = webRequest.currentResponse
@@ -132,8 +134,23 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
             responseResult == 'got everything'
 
     }
-
-
+    
+    @Issue("GRAILS-10973")
+    void "request.withFormat should choose wildcard choice when format == all"() {
+        when:
+            final webRequest = GrailsWebUtil.bindMockWebRequest()
+            def request = webRequest.currentRequest
+            def response = webRequest.currentResponse
+            def requestResult = request.withFormat {
+                    html { 'got html' }
+                    xml { 'got xml' }
+                    '*' { 'got everything' }
+                }
+        then: 'format is all'
+            request.format == 'all'
+        then: 'The * closure is invoked'
+            requestResult == 'got everything'
+    }
 
     void "Test withFormat returns first block if no format provided"() {
         when: "No Accept header, URI extension or format param"
@@ -198,15 +215,16 @@ class RequestAndResponseMimeTypesApiSpec extends Specification{
         s.parse '''
 grails.mime.file.extensions = true // enables the parsing of file extensions from URLs into the request format
 grails.mime.use.accept.header = true
-grails.mime.types = [ html: ['text/html','application/xhtml+xml'],
+grails.mime.types = [ 
+                      all: '*/*',
+                      html: ['text/html','application/xhtml+xml'],
                       xml: ['text/xml', 'application/xml'],
                       text: 'text/plain',
                       js: 'text/javascript',
                       rss: 'application/rss+xml',
                       atom: 'application/atom+xml',
                       css: 'text/css',
                       csv: 'text/csv',
-                      all: '*/*',
                       json: ['application/json','text/json'],
                       form: 'application/x-www-form-urlencoded',
                       multipartForm: 'multipart/form-data'

grails-resources/src/grails/grails-app/conf/Config.groovy

@@ -15,13 +15,13 @@ grails.project.groupId = appName // change this to alter the default package nam
 
 // The ACCEPT header will not be used for content negotiation for user agents containing the following strings (defaults to the 4 major rendering engines)
 grails.mime.disable.accept.header.userAgents = ['Gecko', 'WebKit', 'Presto', 'Trident']
-grails.mime.types = [
+grails.mime.types = [ // the first one is the default format
+    html:          ['text/html','application/xhtml+xml'],
     all:           '*/*',
     atom:          'application/atom+xml',
     css:           'text/css',
     csv:           'text/csv',
     form:          'application/x-www-form-urlencoded',
-    html:          ['text/html','application/xhtml+xml'],
     js:            'text/javascript',
     json:          ['application/json', 'text/json'],
     multipartForm: 'multipart/form-data',