Merge pull request #602 from PierreBtz/pbeitz/formatter

Author: PierreBtz

CONTRIBUTING.adoc

@@ -26,8 +26,9 @@ Unless code has shipped to users, the initial value of the `serialVersionUID` fi
 
 == Indentation
 
-1. **Use spaces.** Tabs are banned.
-2. **Java blocks are 4 spaces.** JavaScript blocks as for Java. **XML nesting is 2 spaces**
+The project relies on [https://github.com/diffplug/spotless/tree/main/plugin-maven](the Spotless Maven Plugin) to manage its formatting.
+The [https://github.com/google/google-java-format](google-java-format) project was chosen, check it, it contains links to plugins for various IDEs.
+You can also run the formatter from command line: `mvn spotless:apply`.
 
 == Field Naming Conventions
 
@@ -41,42 +42,6 @@ If you need more than three, you are likely doing something wrong and as such yo
 6. It is acceptable to use `e` for the exception in a `try...catch` block.
 7. You shall never use `l` (i.e. lower case `L`) as a variable name.
 
-== Line Length
-
-To the greatest extent possible, please wrap lines to ensure that they do not exceed 120 characters.
-
-== Maven POM file layout
-
-* The `pom.xml` file shall use the sequencing of elements as defined by the `mvn tidy:pom` command (after any indenting fix-up).
-* If you are introducing a property to the `pom.xml` the property must be used in at least two distinct places in the model or a comment justifying the use of a property shall be provided.
-* If the `<plugin>` is in the groupId `org.apache.maven.plugins` you shall omit the `<groupId>`.
-* All `<plugin>` entries shall have an explicit version defined unless inherited from the parent.
-
-== Java code style
-
-=== Modifiers
-
-* For fields, the order is:
-  . `public` / `protected` / `private`
-  . `static`
-  . `final`
-  . `transient`
-  . `volatile`
-* For methods, the order is:
-  . `public` / `protected` / `private`
-  . `abstract`
-  . `static`
-  . `final`
-  . `synchronized`
-  . `native`
-  . `strictfp`
-*  For classes, the order is:
-  .  `public` / `protected` / `private`
-  .  `abstract`
-  .  `static`
-  .  `final`
-  .  `strictfp`
-
 === Imports
 
 * For code in `src/main`:
@@ -89,11 +54,6 @@ To the greatest extent possible, please wrap lines to ensure that they do not ex
   . `import static org.hamcrest.Matchers.*`, `import static org.junit.Assert.*`, `import static org.junit.Assume.*` are expressly encouraged and permitted.
     Any other `static` `*` imports are discouraged unless code readability is significantly enhanced and the import is restricted to a single class.
 
-=== Annotation placement
-
-* Annotations on classes, interfaces, annotations, enums, methods, fields and local variables shall be on the lines immediately preceding the line where modifier(s) (e.g. `public` / `protected` / `private` / `final`, etc) would be appropriate.
-* Annotations on method arguments shall, to the largest extent possible, be on the same line as the method argument (and, if present, before the `final` modifier)
-
 === Javadoc
 
 * Each class shall have a Javadoc comment.
@@ -138,35 +98,6 @@ public void setWidgetCount(int widgetCount) {
   The version shall be `FIXME` to indicate that the person merging the change should replace the `FIXME` with the next release version number.
   The fields and methods within a class/interface (but not nested classes) will be assumed to have the `@since` annotation of their class/interface unless a different `@since` annotation is present.
 
-=== IDE Configuration
-
-* Eclipse, by and large the IDE defaults are acceptable with the following changes:
-** Tab policy to `Spaces only`
-** Indent statements within `switch` body
-** Maximum line width `120`
-** Line wrapping, ensure all to `wrap where necessary`
-** Organize imports alphabetically, no grouping
-* NetBeans, by and large the IDE defaults are acceptable with the following changes:
-** Tabs and Indents
-*** Change Right Margin to `120`
-*** Indent case statements in switch
-** Wrapping
-*** Change all the `Never` values to `If Long`
-*** Select the checkbox for Wrap After Assignment Operators
-* IntelliJ, by and large the IDE defaults are acceptable with the following changes:
-** Wrapping and Braces
-*** Change `Do not wrap` to `Wrap if long`
-*** Change `Do not force` to `Always`
-** Javadoc
-*** Disable generating `<p/>` on empty lines
-** Imports
-*** Class count to use import with '*': `9999`
-*** Names count to use static import with '*': `99999`
-*** Import Layout
-**** import all other imports
-**** blank line
-**** import static all other imports
-
 == Integration Tests
 
 This library has a set of integration tests in the class `src/test/java/org/zendesk/client/v2/RealSmokeTest.java`. These tests are used to validate the API calls with a real Zendesk instance. The project never got access to a specific sandbox provided by @zendesk thus we are using the sandbox used by CloudBees.

pom.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
   ~ Copyright 2013, CloudBees Inc.
   ~
@@ -13,7 +14,6 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
@@ -74,8 +74,8 @@
   <scm>
     <connection>scm:git:git://github.com/cloudbees-oss/zendesk-java-client.git</connection>
     <developerConnection>scm:git:[email protected]:cloudbees-oss/zendesk-java-client.git</developerConnection>
-    <url>http://github.com/cloudbees-oss/zendesk-java-client/tree/master/</url>
     <tag>HEAD</tag>
+    <url>http://github.com/cloudbees-oss/zendesk-java-client/tree/master/</url>
   </scm>
 
   <issueManagement>
@@ -91,6 +91,7 @@
   <properties>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+    <spotless.version>2.30.0</spotless.version>
   </properties>
 
   <dependencyManagement>
@@ -108,7 +109,7 @@
         <version>4.1.95.Final</version>
         <type>pom</type>
         <scope>import</scope>
-      </dependency>      
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
@@ -155,10 +156,10 @@
       <scope>test</scope>
     </dependency>
     <dependency>
-        <groupId>com.github.tomakehurst</groupId>
-        <artifactId>wiremock</artifactId>
-        <version>2.27.2</version>
-        <scope>test</scope>
+      <groupId>com.github.tomakehurst</groupId>
+      <artifactId>wiremock</artifactId>
+      <version>2.27.2</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.assertj</groupId>
@@ -203,6 +204,18 @@
         <configuration>
           <fail>true</fail>
         </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>animal-sniffer-enforcer-rule</artifactId>
+            <version>1.23</version>
+          </dependency>
+          <dependency>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>extra-enforcer-rules</artifactId>
+            <version>1.7.0</version>
+          </dependency>
+        </dependencies>
         <executions>
           <execution>
             <id>check-java-compat</id>
@@ -236,34 +249,59 @@
             </configuration>
           </execution>
         </executions>
-        <dependencies>
-          <dependency>
-            <groupId>org.codehaus.mojo</groupId>
-            <artifactId>animal-sniffer-enforcer-rule</artifactId>
-            <version>1.23</version>
-          </dependency>
-          <dependency>
-            <groupId>org.codehaus.mojo</groupId>
-            <artifactId>extra-enforcer-rules</artifactId>
-            <version>1.7.0</version>
-          </dependency>
-        </dependencies>
       </plugin>
       <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-jar-plugin</artifactId>
-          <version>3.3.0</version>
-          <configuration>
-              <archive>
-                  <manifestEntries>
-                      <Automatic-Module-Name>org.zendesk.client.v2</Automatic-Module-Name>
-                  </manifestEntries>
-              </archive>
-          </configuration>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>3.3.0</version>
+        <configuration>
+          <archive>
+            <manifestEntries>
+              <Automatic-Module-Name>org.zendesk.client.v2</Automatic-Module-Name>
+            </manifestEntries>
+          </archive>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <version>${spotless.version}</version>
+        <configuration>
+          <java>
+            <toggleOffOn>
+              <off>@formatter:off</off>
+              <on>@formatter:on</on>
+            </toggleOffOn>
+            <googleJavaFormat/>
+            <importOrder/>
+            <removeUnusedImports/>
+            <formatAnnotations/>
+          </java>
+          <pom>
+            <sortPom>
+              <expandEmptyElements>false</expandEmptyElements>
+            </sortPom>
+          </pom>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-release-plugin</artifactId>
+        <configuration>
+          <completionGoals>spotless:apply verify</completionGoals>
+          <preparationGoals>spotless:apply verify</preparationGoals>
+        </configuration>
       </plugin>
     </plugins>
   </build>
-  
+
   <profiles>
     <profile>
       <id>coverage</id>
@@ -291,6 +329,6 @@
         </plugins>
       </build>
     </profile>
-  </profiles>  
+  </profiles>
 
 </project>

src/main/java/org/zendesk/client/v2/FixedUri.java

@@ -6,14 +6,14 @@
  */
 class FixedUri extends Uri {
 
-    private final String uri;
+  private final String uri;
 
-    FixedUri(String uri) {
-        this.uri = uri;
-    }
+  FixedUri(String uri) {
+    this.uri = uri;
+  }
 
-    @Override
-    public String toString() {
-        return uri;
-    }
+  @Override
+  public String toString() {
+    return uri;
+  }
 }

src/main/java/org/zendesk/client/v2/TemplateUri.java

@@ -1,7 +1,6 @@
 package org.zendesk.client.v2;
 
 import com.damnhandy.uri.template.UriTemplate;
-
 import java.util.Date;
 import java.util.Map;
 
@@ -11,33 +10,33 @@
  */
 class TemplateUri extends Uri {
 
-    private final UriTemplate uri;
+  private final UriTemplate uri;
 
-    public TemplateUri(UriTemplate uri) {
-        this.uri = uri;
-    }
+  public TemplateUri(UriTemplate uri) {
+    this.uri = uri;
+  }
 
-    public TemplateUri(String uri) {
-        this.uri = UriTemplate.fromTemplate(uri);
-    }
+  public TemplateUri(String uri) {
+    this.uri = UriTemplate.fromTemplate(uri);
+  }
 
-    public TemplateUri set(Map<String, Object> values) {
-        uri.set(values);
-        return this;
-    }
+  public TemplateUri set(Map<String, Object> values) {
+    uri.set(values);
+    return this;
+  }
 
-    public TemplateUri set(String variableName, Date value) {
-        uri.set(variableName, value);
-        return this;
-    }
+  public TemplateUri set(String variableName, Date value) {
+    uri.set(variableName, value);
+    return this;
+  }
 
-    public TemplateUri set(String variableName, Object value) {
-        uri.set(variableName, value);
-        return this;
-    }
+  public TemplateUri set(String variableName, Object value) {
+    uri.set(variableName, value);
+    return this;
+  }
 
-    @Override
-    public String toString() {
-        return uri.expand();
-    }
+  @Override
+  public String toString() {
+    return uri.expand();
+  }
 }

src/main/java/org/zendesk/client/v2/Uri.java

@@ -5,6 +5,6 @@
  * @since 05/04/2013 10:05
  */
 abstract class Uri {
-    @Override
-    public abstract String toString();
+  @Override
+  public abstract String toString();
 }