style: reformat grails-core per styling rules

Author: jdaugherty

etc/config/checkstyle/checkstyle.xml

@@ -97,12 +97,13 @@
     <module name="SuppressWarningsFilter"/>
 
     <!-- See http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter -->
-<!--    <module name="SuppressionFilter">-->
-<!--        <property name="file" value="${config_loc}/suppressions.xml"/>-->
-<!--        <property name="optional" value="false"/>-->
-<!--    </module>-->
+    <module name="SuppressionFilter">
+        <property name="file" value="${config_loc}/suppressions.xml"/>
+        <property name="optional" value="false"/>
+    </module>
 
     <module name="TreeWalker">
+        <module name="AvoidStarImport"/>
 
         <!-- Needed for SuppressWarningsFilter -->
         <module name="SuppressWarningsHolder"/>
@@ -177,7 +178,9 @@
         <!-- Checks for blocks. You know, those {}'s         -->
         <!-- See http://checkstyle.sf.net/config_blocks.html -->
         <module name="AvoidNestedBlocks"/>
-        <module name="EmptyBlock"/>
+        <module name="EmptyBlock">
+            <property name="option" value="text"/>
+        </module>
         <module name="LeftCurly"/>
         <module name="NeedBraces"/>
         <module name="RightCurly"/>
@@ -228,6 +231,8 @@
         <module name="TodoComment">
             <property name="severity" value="warning"/>
         </module>
+
+        <module name="SuppressionCommentFilter"/>
     </module>
 
 </module>

etc/config/checkstyle/suppressions.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!--
+  ~  Licensed to the Apache Software Foundation (ASF) under one
+  ~  or more contributor license agreements.  See the NOTICE file
+  ~  distributed with this work for additional information
+  ~  regarding copyright ownership.  The ASF licenses this file
+  ~  to you 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
+  ~
+  ~    https://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.
+  -->
+<!DOCTYPE suppressions PUBLIC
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
+<suppressions>
+    <suppress checks="FileLength"
+              files="GrailsDomainBinder.java|AbstractHibernateCriteriaBuilder.java|StreamCharBuffer.java"/>
+    <!-- Ignore until we decide what to do with these files -->
+    <!-- maybe replace with https://github.com/openjson/openjson -->
+    <suppress files=".*[\\/]grails-web-common[\\/]src[\\/]main[\\/]groovy[\\/]org[\\/]grails[\\/]web[\\/]json[\\/].*" checks=".*"/>
+    <suppress files=".*[\\/]grails-wrapper[\\/]src[\\/]main[\\/]java[\\/]grails[\\/]init[\\/]GrailsVersion.*" checks=".*"/>
+    <suppress files=".*[\\/]grails-wrapper[\\/]src[\\/]main[\\/]java[\\/]grails[\\/]init[\\/]GrailsWrapperHome.*" checks=".*"/>
+</suppressions>

gradle/style-enforcement-config.gradle

@@ -24,11 +24,11 @@ apply plugin: 'io.spring.nohttp' // enforce https everywhere
 spotless {
     java {
         licenseHeaderFile(rootProject.file("etc/config/spotless/license.java"))
-        target('src/main/java/**/*.java')
+        target('src/main/java/**/*.java', 'src/main/groovy/**.java', 'grails-app/**.java')
     }
     groovy {
         licenseHeaderFile(rootProject.file("etc/config/spotless/license.java"))
-        target('src/main/groovy/**.groovy', 'src/main/groovy/**.java')
+        target('src/main/groovy/**.groovy', 'grails-app/**.groovy')
     }
     format 'javaMisc', {
         target('src/main/**/package-info.java', 'src/main/**/module-info.java')
@@ -37,7 +37,8 @@ spotless {
 }
 
 checkstyle {
-    configFile = project.rootProject.file('etc/config/checkstyle/checkstyle.xml')
+    configFile = project.rootProject.layout.projectDirectory.file('etc/config/checkstyle/checkstyle.xml').asFile
+    configDirectory = project.rootProject.layout.projectDirectory.dir('etc/config/checkstyle').asFile
 
     // Per submodule
     maxErrors = 1

grails-async/core/build.gradle

@@ -50,4 +50,5 @@ apply {
     from rootProject.layout.projectDirectory.file('gradle/docs-config.gradle')
     from rootProject.layout.projectDirectory.file('gradle/publish-config.gradle')
     from rootProject.layout.projectDirectory.file('gradle/test-config.gradle')
+    from rootProject.layout.projectDirectory.file('gradle/style-enforcement-config.gradle')
 }

grails-async/core/src/main/groovy/grails/async/DelegateAsync.groovy

@@ -18,14 +18,14 @@
  */
 package grails.async
 
+import org.codehaus.groovy.transform.GroovyASTTransformationClass
+
 import java.lang.annotation.Documented
 import java.lang.annotation.ElementType
 import java.lang.annotation.Retention
 import java.lang.annotation.RetentionPolicy
 import java.lang.annotation.Target
 
-import org.codehaus.groovy.transform.GroovyASTTransformationClass
-
 /**
  * An AST transformation that takes each method in the given class and adds a delegate method that returns a {@link grails.async.Promise} and executes the method asynchronously.
  * For example given the following class:
@@ -39,7 +39,7 @@ import org.codehaus.groovy.transform.GroovyASTTransformationClass
  * If the annotation is applied to a new class:
  *
  * <pre><code>
- * @DelegateAsync(BookApi)
+ * @DelegateAsync (BookApi)
  * class AsyncBookApi {}
  * </code></pre>
  *
@@ -65,5 +65,6 @@ import org.codehaus.groovy.transform.GroovyASTTransformationClass
 @Target([ElementType.TYPE, ElementType.FIELD])
 @GroovyASTTransformationClass("org.grails.async.transform.internal.DelegateAsyncTransformation")
 @interface DelegateAsync {
+
     Class value() default DelegateAsync
 }

grails-async/core/src/main/groovy/grails/async/PromiseFactory.groovy

@@ -50,15 +50,15 @@ interface PromiseFactory {
     /**
      * Creates a promise with a value pre-bound to it
      * @param value The value
-     * @param <T> The type of the value
+     * @param <T>    The type of the value
      * @return A Promise
      */
     <T> Promise<T> createBoundPromise(T value)
 
     /**
      * Creates an unfulfilled promise that returns the given type
      * @param returnType The return type
-     * @param <T> The type of the class
+     * @param <T>    The type of the class
      * @return The unfulfilled promise
      */
     <T> Promise<T> createPromise(Class<T> returnType)
@@ -76,23 +76,23 @@ interface PromiseFactory {
      * @param map The map
      * @return A promise
      */
-    <K,V> Promise<Map<K,V>> createPromise(Map<K, V> map)
+    <K, V> Promise<Map<K, V>> createPromise(Map<K, V> map)
 
     /**
      * Creates a promise from the given map where the values of the map are either closures or Promise instances
      *
      * @param map The map
      * @return A promise
      */
-    <K,V> Promise<Map<K,V>> createPromise(Map<K, V> map, List<PromiseDecorator> decorators)
+    <K, V> Promise<Map<K, V>> createPromise(Map<K, V> map, List<PromiseDecorator> decorators)
 
     /**
      * Creates a promise from one or more other promises
      *
      * @param promises The promises
      * @return The promise
      */
-    <T> Promise<List<T>> createPromise(Promise<T>...promises)
+    <T> Promise<List<T>> createPromise(Promise<T>... promises)
 
     /**
      * Creates a promise from one or many closures
@@ -132,7 +132,7 @@ interface PromiseFactory {
      * @param promises The promises
      * @return The list of bound values
      */
-    <T> List<T> waitAll(Promise<T>...promises)
+    <T> List<T> waitAll(Promise<T>... promises)
     /**
      * Synchronously waits for all promises to complete returning a list of values
      *

grails-async/core/src/main/groovy/grails/async/PromiseList.groovy

@@ -138,7 +138,7 @@ class PromiseList<T> implements Promise<List<T>> {
 
     @Override
     boolean isDone() {
-        return promises.every {promise -> promise.isDone() }
+        return promises.every { promise -> promise.isDone() }
     }
 
     @Override

grails-async/core/src/main/groovy/grails/async/PromiseMap.groovy

@@ -32,14 +32,14 @@ import java.util.concurrent.TimeUnit
  */
 @AutoFinal
 @CompileStatic
-class PromiseMap<K,V> implements Promise<Map<K,V>> {
+class PromiseMap<K, V> implements Promise<Map<K, V>> {
 
     protected LinkedHashMap<K, Promise<V>> promises = [:]
     protected LinkedHashMap<Promise<V>, K> promisesKeys = [:]
 
     PromiseMap() {}
 
-    PromiseMap(Map<K,V> values) {
+    PromiseMap(Map<K, V> values) {
         accept(values)
     }
 
@@ -55,11 +55,11 @@ class PromiseMap<K,V> implements Promise<Map<K,V>> {
 
     @Override
     boolean isDone() {
-        return promisesKeys.keySet().every {it.isDone() }
+        return promisesKeys.keySet().every { it.isDone() }
     }
 
     @Override
-    Promise<Map<K,V>> accept(Map<K,V> values) {
+    Promise<Map<K, V>> accept(Map<K, V> values) {
         values.each { K key, Object value ->
             if (value instanceof Promise) {
                 put(key, value as Promise<V>)
@@ -210,10 +210,10 @@ class PromiseMap<K,V> implements Promise<Map<K,V>> {
      *
      * @return A map where the values are obtained from the promises
      */
-    Map<K,V> get() throws Throwable {
+    Map<K, V> get() throws Throwable {
         def promises = promises.values()
-        Map<K,V> resultMap = [:]
-        for(Promise<V> promise : promises) {
+        Map<K, V> resultMap = [:]
+        for (Promise<V> promise : promises) {
             V value = promise.get()
             resultMap.put(promisesKeys.get(promise), value)
         }
@@ -224,28 +224,28 @@ class PromiseMap<K,V> implements Promise<Map<K,V>> {
      * Synchronously return the populated map with all values obtained from promises used
      * inside the populated map
      *
-     * @param  timeout The timeout period
+     * @param timeout The timeout period
      * @param units The timeout units
      * @return A map where the values are obtained from the promises
      */
-    Map<K,V> get(long timeout, TimeUnit units) throws Throwable {
+    Map<K, V> get(long timeout, TimeUnit units) throws Throwable {
         List<Promise<V>> promises = new ArrayList<Promise<V>>(promises.values())
         Promises.waitAll(promises, timeout, units)
-        Map<K,V> resultMap = [:]
-        for(Promise<V> promise : promises) {
+        Map<K, V> resultMap = [:]
+        for (Promise<V> promise : promises) {
             V value = promise.get()
             resultMap.put(promisesKeys.get(promise), value)
         }
         return resultMap
     }
 
     @Override
-    Promise<Map<K,V>> onComplete(Closure<Map<K,V>> callable) {
+    Promise<Map<K, V>> onComplete(Closure<Map<K, V>> callable) {
         List<Promise<V>> promises = new ArrayList<Promise<V>>(promises.values())
         Promises.onComplete(promises) { List<V> values ->
-            Map<K,V> resultMap = [:]
+            Map<K, V> resultMap = [:]
             int i = 0
-            for(V value in values) {
+            for (V value in values) {
                 Promise<V> promise = promises[i]
                 K key = promisesKeys.get(promise)
                 resultMap.put(key, value)
@@ -258,13 +258,13 @@ class PromiseMap<K,V> implements Promise<Map<K,V>> {
     }
 
     @Override
-    Promise<Map<K,V>> onError(Closure<Map<K,V>> callable) {
+    Promise<Map<K, V>> onError(Closure<Map<K, V>> callable) {
         Promises.onError(new ArrayList<Promise<V>>(promises.values()), callable)
         return this
     }
 
     @Override
-    Promise<Map<K, V>> then(Closure<Map<K,V>> callable) {
+    Promise<Map<K, V>> then(Closure<Map<K, V>> callable) {
         return onComplete(callable)
     }