From ec413118d6fb21f0eeafab6d9c61daa95825c50f Mon Sep 17 00:00:00 2001
From: Filip Hrisafov <filip.hrisafov@gmail.com>
Date: Sun, 28 Oct 2018 21:39:35 +0100
Subject: [PATCH] Update build with latest dependencies and Java 8 baseline:
 (#1636)

* Do not use maven-processor-plugin and use the maven-compiler-plugin annotationProcessors instead
* Update NoPackageCyclesRule and exclude tests
* Update checkstyle to 8.14 and remove FIleContentsHolder module and move SuppressionCommentFilter to the TreeWalker
* Update assertj to 3.11.1 and replace usage of RuntimeIOException (from AssertJ) with UncheckedIOException (from java 8)
* Add how to import MapStruct into IntelliJ and Eclipse into the readme
---
 .../resources/build-config/checkstyle.xml     |  4 +-
 parent/pom.xml                                | 71 ++++++++-----------
 processor/pom.xml                             | 52 ++------------
 .../testutil/assertions/JavaFileAssert.java   |  4 +-
 readme.md                                     | 14 ++++
 5 files changed, 51 insertions(+), 94 deletions(-)

diff --git a/build-config/src/main/resources/build-config/checkstyle.xml b/build-config/src/main/resources/build-config/checkstyle.xml
index 1f371acd2..9051361d1 100644
--- a/build-config/src/main/resources/build-config/checkstyle.xml
+++ b/build-config/src/main/resources/build-config/checkstyle.xml
@@ -62,8 +62,6 @@
 
         <property name="cacheFile" value="${checkstyle.cache.file}"/>
 
-        <!-- Required for SuppressionCommentFilter -->
-        <module name="FileContentsHolder"/>
         <module name="SuppressWarningsHolder"/>
 
         <!-- Checks for Javadoc comments.                     -->
@@ -202,9 +200,9 @@
         <!-- <module name="TodoComment"/> -->
         <module name="UpperEll"/>
 
+        <module name="SuppressionCommentFilter"/>
     </module>
 
-    <module name="SuppressionCommentFilter"/>
     <module name="SuppressWarningsFilter"/>
 
 </module>
diff --git a/parent/pom.xml b/parent/pom.xml
index 0ac7060b0..7ac85a46f 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -22,15 +22,18 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <com.jolira.hickory.version>1.0.0</com.jolira.hickory.version>
-        <org.apache.maven.plugins.enforcer.version>1.2</org.apache.maven.plugins.enforcer.version>
-        <org.apache.maven.plugins.surefire.version>2.19.1</org.apache.maven.plugins.surefire.version>
-        <org.apache.maven.plugins.javadoc.version>3.0.0-M1</org.apache.maven.plugins.javadoc.version>
+        <org.apache.maven.plugins.enforcer.version>3.0.0-M2</org.apache.maven.plugins.enforcer.version>
+        <org.apache.maven.plugins.surefire.version>2.22.1</org.apache.maven.plugins.surefire.version>
+        <org.apache.maven.plugins.javadoc.version>3.0.1</org.apache.maven.plugins.javadoc.version>
         <org.springframework.version>4.0.3.RELEASE</org.springframework.version>
         <org.eclipse.tycho.compiler-jdt.version>0.26.0</org.eclipse.tycho.compiler-jdt.version>
-        <com.puppycrawl.tools.checkstyle.version>7.2</com.puppycrawl.tools.checkstyle.version>
+        <com.puppycrawl.tools.checkstyle.version>8.14</com.puppycrawl.tools.checkstyle.version>
         <add.release.arguments />
         <forkCount>1</forkCount>
-        <assertj.version>3.7.0</assertj.version>
+        <assertj.version>3.11.1</assertj.version>
+        <!-- automatically run annotation processors within the incremental compilation -->
+        <!-- Needed for the hickory processor-->
+        <m2e.apt.activation>jdt_apt</m2e.apt.activation>
     </properties>
 
     <licenses>
@@ -268,12 +271,12 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-assembly-plugin</artifactId>
-                    <version>2.4</version>
+                    <version>3.1.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-checkstyle-plugin</artifactId>
-                    <version>2.17</version>
+                    <version>3.0.0</version>
                     <configuration>
                         <configLocation>build-config/checkstyle.xml</configLocation>
                         <consoleOutput>true</consoleOutput>
@@ -305,7 +308,7 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-clean-plugin</artifactId>
-                    <version>2.5</version>
+                    <version>3.1.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
@@ -314,18 +317,17 @@
                     <configuration>
                         <source>1.8</source>
                         <target>1.8</target>
-                        <compilerArgument>-proc:none</compilerArgument>
                     </configuration>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-dependency-plugin</artifactId>
-                    <version>2.8</version>
+                    <version>3.1.1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-deploy-plugin</artifactId>
-                    <version>2.8.2</version>
+                    <version>3.0.0-M1</version>
                     <configuration>
                         <deployAtEnd>true</deployAtEnd>
                     </configuration>
@@ -343,14 +345,14 @@
                         <dependency>
                             <groupId>de.andrena.tools.nopackagecycles</groupId>
                             <artifactId>no-package-cycles-enforcer-rule</artifactId>
-                            <version>1.0.5</version>
+                            <version>1.0.9</version>
                         </dependency>
                     </dependencies>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.felix</groupId>
                     <artifactId>maven-bundle-plugin</artifactId>
-                    <version>3.0.1</version>
+                    <version>4.0.0</version>
                     <executions>
                         <execution>
                             <id>bundle-manifest</id>
@@ -364,12 +366,12 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-install-plugin</artifactId>
-                    <version>2.5.2</version>
+                    <version>3.0.0-M1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-jar-plugin</artifactId>
-                    <version>3.0.2</version>
+                    <version>3.1.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
@@ -398,7 +400,7 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-resources-plugin</artifactId>
-                    <version>2.6</version>
+                    <version>3.1.0</version>
                 </plugin>
                 <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -408,7 +410,7 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-site-plugin</artifactId>
-                    <version>3.6</version>
+                    <version>3.7.1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
@@ -419,13 +421,6 @@
                         <!-- Travis build workaround -->
                         <argLine>-Xms1024m -Xmx3072m</argLine>
                     </configuration>
-                    <dependencies>
-                        <dependency>
-                            <groupId>org.apache.maven.surefire</groupId>
-                            <artifactId>surefire-junit47</artifactId>
-                            <version>${org.apache.maven.plugins.surefire.version}</version>
-                        </dependency>
-                    </dependencies>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
@@ -437,25 +432,15 @@
                     <artifactId>maven-license-plugin</artifactId>
                     <version>1.10.b1</version>
                 </plugin>
-                <plugin>
-                    <groupId>org.bsc.maven</groupId>
-                    <artifactId>maven-processor-plugin</artifactId>
-                    <version>2.2.4</version>
-                </plugin>
-                <plugin>
-                    <groupId>org.codehaus.mojo</groupId>
-                    <artifactId>build-helper-maven-plugin</artifactId>
-                    <version>1.8</version>
-                </plugin>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>
                     <artifactId>animal-sniffer-maven-plugin</artifactId>
-                    <version>1.16</version>
+                    <version>1.17</version>
                     <dependencies>
                         <dependency>
                             <groupId>org.ow2.asm</groupId>
-                            <artifactId>asm-all</artifactId>
-                            <version>5.2</version>
+                            <artifactId>asm</artifactId>
+                            <version>6.2.1</version>
                         </dependency>
                     </dependencies>
                 </plugin>
@@ -513,12 +498,12 @@
                 <plugin>
                     <groupId>org.jacoco</groupId>
                     <artifactId>jacoco-maven-plugin</artifactId>
-                    <version>0.7.9</version>
+                    <version>0.8.2</version>
                 </plugin>
                 <plugin>
                     <groupId>org.jvnet.jaxb2.maven2</groupId>
                     <artifactId>maven-jaxb2-plugin</artifactId>
-                    <version>0.9.0</version>
+                    <version>0.14.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>
@@ -528,7 +513,7 @@
                 <plugin>
                     <groupId>de.thetaphi</groupId>
                     <artifactId>forbiddenapis</artifactId>
-                    <version>2.3</version>
+                    <version>2.6</version>
                     <configuration>
                         <signaturesFiles>
                             <signaturesFile>${project.basedir}/../etc/forbidden-apis.txt</signaturesFile>
@@ -538,7 +523,7 @@
                 <plugin>
                     <groupId>com.github.siom79.japicmp</groupId>
                     <artifactId>japicmp-maven-plugin</artifactId>
-                    <version>0.10.0</version>
+                    <version>0.13.0</version>
                     <executions>
                         <execution>
                             <phase>verify</phase>
@@ -660,7 +645,9 @@
                         <phase>test-compile</phase>
                         <configuration>
                             <rules>
-                                <NoPackageCyclesRule implementation="de.andrena.tools.nopackagecycles.NoPackageCyclesRule" />
+                                <NoPackageCyclesRule implementation="de.andrena.tools.nopackagecycles.NoPackageCyclesRule">
+                                    <includeTests>false</includeTests>
+                                </NoPackageCyclesRule>
                             </rules>
                         </configuration>
                     </execution>
diff --git a/processor/pom.xml b/processor/pom.xml
index f71ede86b..eb307ffa6 100644
--- a/processor/pom.xml
+++ b/processor/pom.xml
@@ -21,7 +21,6 @@
     <name>MapStruct Processor</name>
 
     <properties>
-        <prism.directory>${project.build.directory}/generated-sources/prims</prism.directory>
         <!-- Netbeans has a problem when we use late binding with @ in the surefire arg line.
             Therefore we set this empty property here-->
         <jacocoArgLine />
@@ -221,54 +220,13 @@
                 </executions>
             </plugin>
             <plugin>
-                <groupId>org.bsc.maven</groupId>
-                <artifactId>maven-processor-plugin</artifactId>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
-                    <defaultOutputDirectory>${prism.directory}</defaultOutputDirectory>
-                    <processors>
-                        <processor>net.java.dev.hickory.prism.internal.PrismGenerator
-                        </processor>
-                    </processors>
+                    <annotationProcessors>
+                        <annotationProcessor>net.java.dev.hickory.prism.internal.PrismGenerator</annotationProcessor>
+                    </annotationProcessors>
                 </configuration>
-                <executions>
-                    <execution>
-                        <id>process</id>
-                        <phase>generate-sources</phase>
-                        <goals>
-                            <goal>process</goal>
-                        </goals>
-                    </execution>
-                </executions>
-                <dependencies>
-                    <dependency>
-                        <groupId>com.jolira</groupId>
-                        <artifactId>hickory</artifactId>
-                        <version>${com.jolira.hickory.version}</version>
-                    </dependency>
-                    <dependency>
-                        <groupId>org.eclipse.tycho</groupId>
-                        <artifactId>tycho-compiler-jdt</artifactId>
-                        <version>${org.eclipse.tycho.compiler-jdt.version}</version>
-                    </dependency>
-                </dependencies>
-            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>build-helper-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>add-source</id>
-                        <phase>generate-sources</phase>
-                        <goals>
-                            <goal>add-source</goal>
-                        </goals>
-                        <configuration>
-                            <sources>
-                                <source>${prism.directory}</source>
-                            </sources>
-                        </configuration>
-                    </execution>
-                </executions>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
diff --git a/processor/src/test/java/org/mapstruct/ap/testutil/assertions/JavaFileAssert.java b/processor/src/test/java/org/mapstruct/ap/testutil/assertions/JavaFileAssert.java
index 8e8b4d0f7..9b374273f 100644
--- a/processor/src/test/java/org/mapstruct/ap/testutil/assertions/JavaFileAssert.java
+++ b/processor/src/test/java/org/mapstruct/ap/testutil/assertions/JavaFileAssert.java
@@ -9,6 +9,7 @@ import static java.lang.String.format;
 
 import java.io.File;
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -17,7 +18,6 @@ import java.util.List;
 import org.assertj.core.api.AbstractCharSequenceAssert;
 import org.assertj.core.api.Assertions;
 import org.assertj.core.api.FileAssert;
-import org.assertj.core.api.exception.RuntimeIOException;
 import org.assertj.core.error.ShouldHaveSameContent;
 import org.assertj.core.internal.Diff;
 import org.assertj.core.internal.Failures;
@@ -111,7 +111,7 @@ public class JavaFileAssert extends FileAssert {
             }
         }
         catch ( IOException e ) {
-            throw new RuntimeIOException( format(
+            throw new UncheckedIOException( format(
                 "Unable to compare contents of files:<%s> and:<%s>",
                 actual,
                 expected
diff --git a/readme.md b/readme.md
index 9e5d354e5..8260bcb2f 100644
--- a/readme.md
+++ b/readme.md
@@ -138,6 +138,20 @@ MapStruct uses Maven for its build. Java 8 is required for building MapStruct fr
 from the root of the project directory. To skip the distribution module, run 
 
     mvn clean install -DskipDistribution=true
+    
+## Importing into IDE
+
+MapStruct uses the hickory annotation processor to generate mapping prisms for it's own annotations.
+Therefore for seamless integration within an IDE annotation processing needs to be enabled.
+
+### IntelliJ 
+
+Make sure that you have at least IntelliJ 2018.2.x (needed since support for `annotationProcessors` from the `maven-compiler-plugin` is from that version).
+Enable annotation processing in IntelliJ (Build, Execution, Deployment -> Compiler -> Annotation Processors)
+
+### Eclipse
+
+Make sure that you have the [m2e_apt](https://marketplace.eclipse.org/content/m2e-apt) plugin installed.
 
 ## Links