Merge branch 'bug/6/fix-rendering'

This fixes generation of spurious grails/gorm properties not needed for
the actual service. The convention is introduced to support restful
services. For regular web endpoints the preferred route is to use
swagger annotations.

fixes #6

Author: dilipkrish

build.gradle

@@ -15,6 +15,7 @@ allprojects {
   }
 
   ext {
+    byteBuddyVersion = "1.6.10"
     cglib = "3.2.4"
     classmate = "1.3.3"
     groovy = "2.4.8"
@@ -35,6 +36,6 @@ allprojects {
     springPluginVersion = "1.2.0.RELEASE"
     swagger2Core = "1.5.12"
     springBoot = "1.4.4.RELEASE"
-    springfox = "2.6.1"
+    springfox = "2.7.0-SNAPSHOT"
   }
 }

springfox-grails-contract-tests/build.gradle

@@ -58,9 +58,13 @@ dependencies {
     compile "org.grails.plugins:views-json"
     compile "org.grails.plugins:views-json-templates"
     console "org.grails:grails-console"
+
     profile "org.grails.profiles:rest-api"
+
     provided "org.codehaus.groovy:groovy-ant"
+  
     runtime "com.h2database:h2"
+  
     testCompile "org.grails:grails-plugin-testing"
     testCompile "org.grails.plugins:geb"
     testCompile "org.grails:grails-datastore-rest-client"

springfox-grails-contract-tests/grails-app/controllers/grails/springfox/sample/AlbumController.groovy

@@ -1,10 +1,9 @@
 package grails.springfox.sample
 
-
-import grails.rest.*
-import grails.converters.*
+import grails.rest.RestfulController
 
 class AlbumController extends RestfulController {
+    static allowedMethods = [save: "POST", update: "PUT", delete: "DELETE"]
     static responseFormats = ['json', 'xml']
     AlbumController() {
         super(Album)

springfox-grails-contract-tests/grails-app/controllers/grails/springfox/sample/BookController.groovy

@@ -0,0 +1,127 @@
+package grails.springfox.sample
+
+import grails.transaction.Transactional
+import io.swagger.annotations.ApiImplicitParam
+import io.swagger.annotations.ApiImplicitParams
+import io.swagger.annotations.ApiOperation
+import springfox.documentation.annotations.ApiIgnore
+
+import static org.springframework.http.HttpStatus.*
+
+@Transactional(readOnly = true)
+class BookController {
+
+  static allowedMethods = [save: "POST", update: "PUT", delete: "DELETE"]
+
+  @ApiOperation(value = "index", httpMethod = "GET", notes="Creates a book")
+  def index(Integer max) {
+    params.max = Math.min(max ?: 10, 100)
+    respond Book.list(params), model:[bookCount: Book.count()]
+  }
+
+  @ApiIgnore
+  def show(Book book) {
+    respond book
+  }
+
+  @ApiOperation(value = "create", httpMethod = "POST", notes="Creates a book")
+  @ApiImplicitParams([
+      @ApiImplicitParam(name = "name", dataType = "string", required = true, paramType = "form",
+          value = "Name of the book")
+  ])
+  def create() {
+    respond new Book(params)
+  }
+
+  @Transactional
+  @ApiOperation(value = "save", httpMethod = "POST", notes="Saves a book")
+  def save(Book book) {
+    if (book == null) {
+      transactionStatus.setRollbackOnly()
+      notFound()
+      return
+    }
+
+    if (book.hasErrors()) {
+      transactionStatus.setRollbackOnly()
+      respond book.errors, view:'create'
+      return
+    }
+
+    book.save flush:true
+
+    request.withFormat {
+      form multipartForm {
+        flash.message = message(code: 'default.created.message', args: [message(code: 'book.label', default: 'Book'), book.id])
+        redirect book
+      }
+      '*' { respond book, [status: CREATED] }
+    }
+  }
+
+  @ApiIgnore
+  def edit(Book book) {
+    respond book
+  }
+
+  @Transactional
+  @ApiOperation(value = "update", httpMethod = "PUT", notes="Updates a book")
+  def update(Book book) {
+    if (book == null) {
+      transactionStatus.setRollbackOnly()
+      notFound()
+      return
+    }
+
+    if (book.hasErrors()) {
+      transactionStatus.setRollbackOnly()
+      respond book.errors, view:'edit'
+      return
+    }
+
+    book.save flush:true
+
+    request.withFormat {
+      form multipartForm {
+        flash.message = message(code: 'default.updated.message', args: [message(code: 'book.label', default: 'Book'), book.id])
+        redirect book
+      }
+      '*'{ respond book, [status: OK] }
+    }
+  }
+
+  @Transactional
+  @ApiOperation(value = "delete", httpMethod = "DELETE", notes="Deletes a book")
+  @ApiImplicitParams([
+      @ApiImplicitParam(name = "id", dataType = "long", required = true, paramType = "form",
+          value = "Id of the book")
+  ])
+  def delete(Book book) {
+
+    if (book == null) {
+      transactionStatus.setRollbackOnly()
+      notFound()
+      return
+    }
+
+    book.delete flush:true
+
+    request.withFormat {
+      form multipartForm {
+        flash.message = message(code: 'default.deleted.message', args: [message(code: 'book.label', default: 'Book'), book.id])
+        redirect action:"index", method:"GET"
+      }
+      '*'{ render status: NO_CONTENT }
+    }
+  }
+
+  protected void notFound() {
+    request.withFormat {
+      form multipartForm {
+        flash.message = message(code: 'default.not.found.message', args: [message(code: 'book.label', default: 'Book'), params.id])
+        redirect action: "index", method: "GET"
+      }
+      '*'{ render status: NOT_FOUND }
+    }
+  }
+}

springfox-grails-contract-tests/grails-app/domain/grails/springfox/sample/Book.groovy

@@ -0,0 +1,10 @@
+package grails.springfox.sample
+
+class Book {
+    Long id
+    String name
+
+    static constraints = {
+        name nullable: false
+    }
+}

springfox-grails-contract-tests/grails-app/init/grails/springfox/sample/Application.groovy

@@ -2,50 +2,79 @@ package grails.springfox.sample
 
 import grails.boot.GrailsApp
 import grails.boot.config.GrailsAutoConfiguration
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Import
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
+import springfox.documentation.grails.AlternateTypeRuleConvention
+import springfox.documentation.grails.DefaultGrailsPropertySelector
+import springfox.documentation.grails.DefaultGrailsPropertyTransformer
+import springfox.documentation.grails.DefaultGeneratedClassNamingStrategy
+import springfox.documentation.grails.GrailsPropertySelector
+import springfox.documentation.grails.GrailsPropertyTransformer
+import springfox.documentation.grails.GeneratedClassNamingStrategy
 import springfox.documentation.grails.SpringfoxGrailsIntegrationConfiguration
+import springfox.documentation.schema.AlternateTypeRule
 import springfox.documentation.spi.DocumentationType
 import springfox.documentation.spring.web.plugins.Docket
 import springfox.documentation.swagger2.annotations.EnableSwagger2
 
-import static com.google.common.base.Predicates.not
-import static springfox.documentation.builders.PathSelectors.ant
+import static com.google.common.base.Predicates.*
+import static springfox.documentation.builders.PathSelectors.*
 
 @EnableSwagger2
 @Import([SpringfoxGrailsIntegrationConfiguration])
 class Application extends GrailsAutoConfiguration {
-    static void main(String[] args) {
-        GrailsApp.run(Application, args)
-    }
+  static void main(String[] args) {
+    GrailsApp.run(Application, args)
+  }
 
-    @Bean
-    Docket api() {
-        new Docket(DocumentationType.SWAGGER_2)
-                .ignoredParameterTypes(MetaClass)
-                .select()
-                    .paths(not(ant("/error")))
-                    .build()
-    }
+  @Bean
+  @ConditionalOnMissingBean(GrailsPropertySelector)
+  GrailsPropertySelector propertySelector() {
+    new DefaultGrailsPropertySelector()
+  }
+
+  @Bean
+  @ConditionalOnMissingBean(GrailsPropertyTransformer)
+  GrailsPropertyTransformer propertyTransformer() {
+    new DefaultGrailsPropertyTransformer()
+  }
 
-    @Bean
-    static WebMvcConfigurerAdapter webConfigurer() {
-        new WebMvcConfigurerAdapter() {
-            @Override
-            void addResourceHandlers(ResourceHandlerRegistry registry) {
-                if (!registry.hasMappingForPattern("/webjars/**")) {
-                    registry
-                        .addResourceHandler("/webjars/**")
-                        .addResourceLocations("classpath:/META-INF/resources/webjars/")
-                }
-                if (!registry.hasMappingForPattern("/swagger-ui.html")) {
-                    registry
-                        .addResourceHandler("/swagger-ui.html")
-                        .addResourceLocations("classpath:/META-INF/resources/swagger-ui.html")
-                }
-            }
+  @Bean
+  @ConditionalOnMissingBean(GeneratedClassNamingStrategy)
+  GeneratedClassNamingStrategy namingStrategy() {
+    new DefaultGeneratedClassNamingStrategy()
+  }
+
+  @Bean
+  Docket api(AlternateTypeRuleConvention convention) {
+    def typeRules = convention.rules()
+    new Docket(DocumentationType.SWAGGER_2)
+        .ignoredParameterTypes(MetaClass)
+        .select()
+        .paths(not(ant("/error")))
+        .build()
+        .alternateTypeRules(typeRules.toArray(new AlternateTypeRule[typeRules.size()]))
+  }
+
+  @Bean
+  static WebMvcConfigurerAdapter webConfigurer() {
+    new WebMvcConfigurerAdapter() {
+      @Override
+      void addResourceHandlers(ResourceHandlerRegistry registry) {
+        if (!registry.hasMappingForPattern("/webjars/**")) {
+          registry
+              .addResourceHandler("/webjars/**")
+              .addResourceLocations("classpath:/META-INF/resources/webjars/")
+        }
+        if (!registry.hasMappingForPattern("/swagger-ui.html")) {
+          registry
+              .addResourceHandler("/swagger-ui.html")
+              .addResourceLocations("classpath:/META-INF/resources/swagger-ui.html")
         }
+      }
     }
+  }
 }

springfox-grails-contract-tests/src/integration-test/groovy/grails/springfox/sample/SpringFoxSpec.groovy

@@ -12,23 +12,22 @@ import static io.restassured.RestAssured.get
 
 @Integration
 class SpringFoxSpec extends Specification implements FileAccess {
-    @LocalServerPort
-    private int port
-    void "test something"() {
-      given:
-        def expected = fileContents("/expected-service-description.json")
-        def actual = get("http://localhost:$port/v2/api-docs").asString()
+  @LocalServerPort
+  private int port
 
-      expect:
-        try {
-          JSONAssert.assertEquals(
-              expected.replaceAll("__PORT__", "$port"),
-              actual,
-              JSONCompareMode.NON_EXTENSIBLE)
-        } catch (AssertionError e) {
-          Assert.fail("${e.getMessage()}${System.getProperty("line.separator")}${JsonOutput.prettyPrint(actual)}")
-        }
+  void "test something"() {
+    given:
+      def expected = fileContents("/expected-service-description.json")
+      def actual = get("http://localhost:$port/v2/api-docs").asString()
 
-
-    }
+    expect:
+      try {
+        JSONAssert.assertEquals(
+            expected.replaceAll("__PORT__", "$port"),
+            actual,
+            JSONCompareMode.NON_EXTENSIBLE)
+      } catch (AssertionError e) {
+        Assert.fail("${e.getMessage()}${System.getProperty("line.separator")}${JsonOutput.prettyPrint(actual)}")
+      }
+  }
 }