Merge pull request #250 from Jennifer Strater

* gh-250: Polish "Add Grails sample app" (1338df9) Add Grails sample app

Author: wilkinsona

build.gradle

@@ -163,6 +163,10 @@ samples {
 dependOn 'spring-restdocs-mockmvc:install'
 dependOn 'spring-restdocs-restassured:install'
 
+restNotesGrails {
+workingDir "$projectDir/samples/rest-notes-grails"
+}
+
 restNotesSpringHateoas {
 workingDir "$projectDir/samples/rest-notes-spring-hateoas"
 }
@@ -183,6 +187,7 @@ samples {
 workingDir "$projectDir/samples/rest-notes-slate"
 build false
 }
+
 }
 
 task api (type: Javadoc) {

buildSrc/src/main/groovy/org/springframework/restdocs/build/SampleBuildConfigurer.groovy

@@ -61,6 +61,9 @@ public class SampleBuildConfigurer {
 replaceVersion(new File(this.workingDir, 'build.gradle'),
 "ext\\['spring-restdocs.version'\\] = '.*'",
 "ext['spring-restdocs.version'] = '${project.version}'")
+replaceVersion(new File(this.workingDir, 'build.gradle'),
+"restDocsVersion = \".*\"",
+"restDocsVersion = \"${project.version}\"")
 }
 }
 else if (new File(sampleDir, 'pom.xml').isFile()) {

docs/src/docs/asciidoc/getting-started.adoc

@@ -18,6 +18,10 @@ If you want to jump straight in, a number of sample applications are available:
 | Gradle
 | Demonstrates the use of Spring REST Docs with http://rest-assured.io[REST Assured].
 
+| {samples}/rest-notes-grails[Grails]
+| Gradle
+| Demonstrates the use of Spring REST docs with https://grails.org[Grails] and https://github.com/spockframework/spock[Spock]
+
 | {samples}/rest-notes-slate[Slate]
 | Gradle
 | Demonstrates the use of Spring REST Docs with Markdown and

samples/rest-notes-grails/.gitignore

@@ -0,0 +1,17 @@
+Thumbs.db
+.DS_Store
+.gradle
+build/
+classes/
+.idea
+*.iml
+*.ipr
+*.iws
+.project
+.settings
+.classpath
+gradlew*
+gradle/wrapper
+
+
+src/docs/generated-snippets

samples/rest-notes-grails/README.md

@@ -0,0 +1,2 @@
+# grails-spring-restdocs-example
+Example of using Spring REST Docs with Grails

samples/rest-notes-grails/build.gradle

@@ -0,0 +1,107 @@
+buildscript {
+ext {
+grailsVersion = project.grailsVersion
+}
+repositories {
+mavenLocal()
+maven { url "https://repo.grails.org/grails/core" }
+maven { url 'https://repo.spring.io/libs-snapshot' }
+}
+dependencies {
+classpath "org.grails:grails-gradle-plugin:$grailsVersion"
+classpath "org.grails.plugins:hibernate:4.3.10.5"
+classpath 'org.ajoberstar:gradle-git:1.1.0'
+}
+}
+
+plugins {
+id "io.spring.dependency-management" version "0.5.4.RELEASE"
+id 'org.asciidoctor.convert' version '1.5.3'
+}
+
+version "0.1"
+group "com.example"
+
+apply plugin: "spring-boot"
+apply plugin: "war"
+apply plugin: 'eclipse'
+apply plugin: 'idea'
+apply plugin: "org.grails.grails-web"
+
+ext {
+grailsVersion = project.grailsVersion
+gradleWrapperVersion = project.gradleWrapperVersion
+restDocsVersion = "1.1.0.BUILD-SNAPSHOT"
+snippetsDir = file('src/docs/generated-snippets')
+}
+
+repositories {
+mavenLocal()
+maven { url 'https://repo.spring.io/libs-snapshot' }
+maven { url "https://repo.grails.org/grails/core" }
+}
+
+dependencyManagement {
+dependencies {
+dependency "org.springframework.restdocs:spring-restdocs-restassured:$restDocsVersion"
+}
+imports {
+mavenBom "org.grails:grails-bom:$grailsVersion"
+}
+applyMavenExclusions false
+}
+
+dependencies {
+compile "org.springframework.boot:spring-boot-starter-logging"
+compile "org.springframework.boot:spring-boot-starter-actuator"
+compile "org.springframework.boot:spring-boot-autoconfigure"
+compile "org.springframework.boot:spring-boot-starter-tomcat"
+compile "org.grails:grails-plugin-url-mappings"
+compile "org.grails:grails-plugin-rest"
+compile "org.grails:grails-plugin-interceptors"
+compile "org.grails:grails-plugin-services"
+compile "org.grails:grails-plugin-datasource"
+compile "org.grails:grails-plugin-databinding"
+compile "org.grails:grails-plugin-async"
+compile "org.grails:grails-web-boot"
+compile "org.grails:grails-logging"
+
+compile "org.grails.plugins:hibernate"
+compile "org.grails.plugins:cache"
+compile "org.hibernate:hibernate-ehcache"
+
+runtime "com.h2database:h2"
+
+testCompile "org.grails:grails-plugin-testing"
+testCompile "org.grails.plugins:geb"
+testCompile 'org.springframework.restdocs:spring-restdocs-restassured'
+
+console "org.grails:grails-console"
+}
+
+task wrapper(type: Wrapper) {
+gradleVersion = gradleWrapperVersion
+}
+
+ext {
+snippetsDir = file('src/docs/generated-snippets')
+}
+
+task cleanTempDirs(type: Delete) {
+delete fileTree(dir: 'src/docs/generated-snippets')
+}
+
+test {
+dependsOn cleanTempDirs
+outputs.dir snippetsDir
+}
+
+asciidoctor {
+dependsOn integrationTest
+inputs.dir snippetsDir
+sourceDir = file('src/docs')
+separateOutputDirs = false
+attributes 'snippets': snippetsDir
+}
+
+build.dependsOn asciidoctor

samples/rest-notes-grails/gradle.properties

@@ -0,0 +1,2 @@
+grailsVersion=3.0.15
+gradleWrapperVersion=2.3

samples/rest-notes-grails/grails-app/conf/application.yml

@@ -0,0 +1,98 @@
+---
+grails:
+ profile: web-api
+ codegen:
+ defaultPackage: com.example
+info:
+ app:
+ name: '@info.app.name@'
+ version: '@info.app.version@'
+ grailsVersion: '@info.app.grailsVersion@'
+spring:
+ groovy:
+ template:
+ check-template-location: false
+
+---
+grails:
+ mime:
+ disable:
+ accept:
+ header:
+ userAgents:
+ - Gecko
+ - WebKit
+ - Presto
+ - Trident
+ types:
+ 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
+ rss: application/rss+xml
+ text: text/plain
+ hal:
+ - application/hal+json
+ - application/hal+xml
+ xml:
+ - text/xml
+ - application/xml
+ urlmapping:
+ cache:
+ maxsize: 1000
+ controllers:
+ defaultScope: singleton
+ converters:
+ encoding: UTF-8
+ hibernate:
+ cache:
+ queries: false
+
+---
+dataSource:
+ pooled: true
+ jmxExport: true
+ driverClassName: org.h2.Driver
+ username: sa
+ password:
+
+environments:
+ development:
+ dataSource:
+ dbCreate: create-drop
+ url: jdbc:h2:mem:devDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
+ test:
+ dataSource:
+ dbCreate: update
+ url: jdbc:h2:mem:testDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
+ production:
+ dataSource:
+ dbCreate: update
+ url: jdbc:h2:./prodDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
+ properties:
+ jmxEnabled: true
+ initialSize: 5
+ maxActive: 50
+ minIdle: 5
+ maxIdle: 25
+ maxWait: 10000
+ maxAge: 600000
+ timeBetweenEvictionRunsMillis: 5000
+ minEvictableIdleTimeMillis: 60000
+ validationQuery: SELECT 1
+ validationQueryTimeout: 3
+ validationInterval: 15000
+ testOnBorrow: true
+ testWhileIdle: true
+ testOnReturn: false
+ jdbcInterceptors: ConnectionState
+ defaultTransactionIsolation: 2 # TRANSACTION_READ_COMMITTED

samples/rest-notes-grails/grails-app/conf/logback.groovy

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2014-2016 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.
+ * 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.
+ */
+
+import grails.util.BuildSettings
+import grails.util.Environment
+
+// See http://logback.qos.ch/manual/groovy.html for details on configuration
+appender('STDOUT', ConsoleAppender) {
+encoder(PatternLayoutEncoder) {
+pattern = "%level %logger - %msg%n"
+}
+}
+
+root(ERROR, ['STDOUT'])
+
+def targetDir = BuildSettings.TARGET_DIR
+if (Environment.isDevelopmentMode() && targetDir) {
+appender("FULL_STACKTRACE", FileAppender) {
+file = "${targetDir}/stacktrace.log"
+append = true
+encoder(PatternLayoutEncoder) {
+pattern = "%level %logger - %msg%n"
+}
+}
+logger("StackTrace", ERROR, ['FULL_STACKTRACE'], false)
+}

samples/rest-notes-grails/grails-app/conf/spring/resources.groovy

@@ -0,0 +1,2 @@
+// Place your Spring DSL code here
+beans = {}