From ccb5f3d191a38a59a7cead01fc2403790d2874e0 Mon Sep 17 00:00:00 2001
From: Paul-Christian Volkmer <mail@pcvolkmer.de>
Date: Sun, 13 Sep 2015 15:58:43 +0200
Subject: [PATCH] Configure the build to use Checkstyle

This commit adds checkstyle plugin and provides a simple config file.

Closes gh-125
---
 build.gradle                                  |  5 +
 checkstyle.xml                                | 92 +++++++++++++++++++
 .../com/example/ExampleApplicationTests.java  |  4 +-
 3 files changed, 99 insertions(+), 2 deletions(-)
 create mode 100644 checkstyle.xml

diff --git a/build.gradle b/build.gradle
index a849cd98..7f849e63 100644
--- a/build.gradle
+++ b/build.gradle
@@ -47,6 +47,7 @@ subprojects {
 	apply plugin: 'propdeps-eclipse'
 	apply plugin: 'propdeps-maven'
 	apply plugin: 'maven'
+	apply plugin: 'checkstyle'
 	apply from: "${rootProject.projectDir}/gradle/publish-maven.gradle"
 
 	sourceCompatibility = 1.7
@@ -72,6 +73,10 @@ subprojects {
 		}
 	}
 
+	checkstyle {
+		configFile = rootProject.file('checkstyle.xml')
+	}
+
 	configurations {
 		jacoco
 	}
diff --git a/checkstyle.xml b/checkstyle.xml
new file mode 100644
index 00000000..4e7653a2
--- /dev/null
+++ b/checkstyle.xml
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<!-- A simple set of Checkstyle rules -->
+<module name="Checker">
+
+	<!-- Checks whether files end with a new line. -->
+	<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+<!-- 	<module name="NewlineAtEndOfFile"/> -->
+
+	<module name="FileLength" />
+
+	<module name="RegexpSingleline">
+		<property name="format" value="System\.(out|err)\.print" />
+		<property name="message"
+			value="System.out.println and System.err.println are not allowed. Using logging instead." />
+	</module>
+	<module name="RegexpSingleline">
+		<property name="format" value="\.printStackTrace\(\)" />
+		<property name="message"
+			value="Calls to Throwable.printStackTrace() are not allowed. Log the exception instead." />
+	</module>
+
+	<module name="TreeWalker">
+
+		<!-- Checks for Naming Conventions. -->
+		<!-- See http://checkstyle.sf.net/config_naming.html -->
+		<module name="ConstantName" />
+		<module name="LocalFinalVariableName" />
+		<module name="LocalVariableName" />
+		<module name="MemberName" />
+		<module name="MethodName" />
+		<module name="PackageName" />
+		<module name="ParameterName" />
+		<module name="StaticVariableName" />
+		<module name="TypeName" />
+
+		<!-- Checks for imports -->
+		<!-- See http://checkstyle.sf.net/config_import.html -->
+		<module name="AvoidStarImport" />
+		<module name="IllegalImport" /> <!-- defaults to sun.* packages -->
+<!-- 		<module name="RedundantImport" /> -->
+<!-- 		<module name="UnusedImports" /> -->
+
+		<!-- Checks for Size Violations. -->
+		<!-- Size checks - http://checkstyle.sourceforge.net/config_sizes.html -->
+		<module name="MethodLength" />
+		<module name="ParameterNumber" />
+<!-- 		<module name="LineLengthCheck"> -->
+<!-- 			<property name="max" value="120" /> -->
+<!-- 			<property name="tabWidth" value="4" /> -->
+<!-- 			<property name="ignorePattern" value="^import" /> -->
+<!-- 		</module> -->
+
+		<!-- Block checks - http://checkstyle.sourceforge.net/config_blocks.html -->
+		<module name="LeftCurly" />
+<!-- 		<module name="RightCurly"/> -->
+		<module name="NeedBraces" />
+
+		<!-- Metrics checks - http://checkstyle.sourceforge.net/config_metrics.html -->
+		<module name="JavaNCSS">
+			<property name="methodMaximum" value="32" />
+			<property name="classMaximum" value="500" />
+		</module>
+		<module name="CyclomaticComplexity">
+			<property name="max" value="10" />
+		</module>
+		<module name="NPathComplexity">
+			<property name="max" value="32" />
+		</module>
+
+		<!-- Coding checks http://checkstyle.sourceforge.net/config_coding.html -->
+		<module name="EmptyStatement" />
+		<module name="EqualsHashCode" />
+		<module name="IllegalInstantiation" />
+		<module name="InnerAssignment" />
+		<module name="MissingSwitchDefault" />
+		<module name="SimplifyBooleanExpression" />
+		<module name="SimplifyBooleanReturn" />
+		<module name="StringLiteralEquality" />
+		<module name="NestedIfDepth">
+			<property name="max" value="2" />
+		</module>
+		<module name="NestedTryDepth">
+			<property name="max" value="2" />
+		</module>
+		<module name="NoFinalizer" />
+
+	</module>
+
+</module>
diff --git a/docs/src/test/java/com/example/ExampleApplicationTests.java b/docs/src/test/java/com/example/ExampleApplicationTests.java
index cc6c6406..d94622f5 100644
--- a/docs/src/test/java/com/example/ExampleApplicationTests.java
+++ b/docs/src/test/java/com/example/ExampleApplicationTests.java
@@ -27,7 +27,7 @@ import org.springframework.web.context.WebApplicationContext;
 import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
 
 public class ExampleApplicationTests {
-	
+
 	// tag::mock-mvc-setup[]
 	@Rule
 	public final RestDocumentation restDocumentation = new RestDocumentation("build/generated-snippets");
@@ -44,4 +44,4 @@ public class ExampleApplicationTests {
 				.build();
 	}
 	// end::mock-mvc-setup[]
-}
\ No newline at end of file
+}