From f0c0f1799f174448be234ade630cdcf24ac6092a Mon Sep 17 00:00:00 2001
From: Thomas Peetz <thomas.peetz@thpeetz.de>
Date: Sun, 4 Sep 2022 17:32:19 +0000
Subject: [PATCH] Use Convention plugin - OP#241

---
 build.gradle                     |  61 +++++++++-
 config/checkstyle/checkstyle.xml | 197 -------------------------------
 2 files changed, 60 insertions(+), 198 deletions(-)
 delete mode 100644 config/checkstyle/checkstyle.xml

diff --git a/build.gradle b/build.gradle
index 6db2bad..a1d88a4 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,12 +1,23 @@
 plugins {
     id 'application'
     id 'jacoco-report-aggregation'
-    alias(versions.plugins.asciidoctorConvention)
+    id 'maven-publish'
     alias(versions.plugins.javaConvention)
     alias(versions.plugins.sonarqube)
+    //alias(versions.plugins.asciidoctorConvention)
+    alias(versions.plugins.asciidoctorPdf)
+    alias(versions.plugins.asciidoctorConvert)
+    alias(versions.plugins.asciidoctorGems)
+}
+
+repositories  {
+    ruby.gems()
 }
 
 dependencies {
+    asciidoctorGems "rubygems:rouge:3.15.0"
+    asciidoctorGems "rubygems:asciidoctor-diagram:2.2.2"
+
     implementation versions.slf4j
     implementation versions.commonscli
     testImplementation versions.junit
@@ -14,13 +25,37 @@ dependencies {
     spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0'
 }
 
+def pdfFile = layout.buildDirectory.file("docs/asciidocPdf/" + project.name + ".pdf")
+def pdfArtifact = artifacts.add('archives', pdfFile.get().asFile) {
+    type 'pdf'
+    builtBy asciidoctorPdf
+}
+
+group = 'de.thpeetz'
+
 publishing {
     publications {
+        docs(MavenPublication) {
+            groupId = group + '.docs'
+            artifactId = project.name
+            artifact pdfArtifact
+        }
         application(MavenPublication) {
             groupId = group
             from components.java
         }
     }
+    repositories {
+        maven {
+            def releasesRepoUrl = "https://nexus.thpeetz.de/nexus/content/repositories/releases/"
+            def snapshotsRepoUrl = "https://nexus.thpeetz.de/nexus/content/repositories/snapshots/"
+            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
+            credentials {
+                username "thpeetz-buildservice"
+                password "w4wrcRtWvS5QcQsn"
+            }
+        }
+    }
 }
 
 final BUILD_DATE = new Date().format('dd.MM.yyyy').toString()
@@ -61,6 +96,30 @@ tasks.named('sonarqube').configure {
     dependsOn test
 }
 
+asciidoctorPdf {
+    dependsOn asciidoctorGemsPrepare
+
+    baseDirFollowsSourceFile()
+
+    asciidoctorj {
+        //requires 'rouge', 'asciidoctor-diagram'
+        requires 'rouge'
+        attributes 'build-gradle':       file('build.gradle'),
+                   'endpoint-url':       'https://www.thpeetz.de',
+                   'source-highlighter': 'rouge',
+                   'imagesdir':          './images',
+                   'toc':                'left',
+                   'toc-title':          'Inhaltsverzeichnis',
+                   'revdate':            BUILD_DATE,
+                   'revnumber':          { project.version.toString() },
+                   'revremark':          'Entwurf',
+                   'chapter-label':      '',
+                   'icons':              'font',
+                   'idprefix':           'id_',
+                   'idseparator':        '-',
+                   'docinfo1':           ''
+    }
+}
 
 wrapper {
     gradleVersion = "7.5"
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
deleted file mode 100644
index b88ef28..0000000
--- a/config/checkstyle/checkstyle.xml
+++ /dev/null
@@ -1,197 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE module PUBLIC
-          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
-          "https://checkstyle.org/dtds/configuration_1_3.dtd">
-
-<!--
-
-  Checkstyle configuration that checks the sun coding conventions from:
-
-    - the Java Language Specification at
-      https://docs.oracle.com/javase/specs/jls/se11/html/index.html
-
-    - the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
-
-    - the Javadoc guidelines at
-      https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
-
-    - the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
-
-    - some best practices
-
-  Checkstyle is very configurable. Be sure to read the documentation at
-  https://checkstyle.org (or in your downloaded distribution).
-
-  Most Checks are configurable, be sure to consult the documentation.
-
-  To completely disable a check, just comment it out or delete it from the file.
-  To suppress certain violations please review suppression filters.
-
-  Finally, it is worth reading the documentation.
-
--->
-
-<module name="Checker">
-  <!--
-      If you set the basedir property below, then all reported file
-      names will be relative to the specified directory. See
-      https://checkstyle.org/config.html#Checker
-
-      <property name="basedir" value="${basedir}"/>
-  -->
-  <property name="severity" value="error"/>
-
-  <property name="fileExtensions" value="java, properties, xml"/>
-
-  <!-- Excludes all 'module-info.java' files              -->
-  <!-- See https://checkstyle.org/config_filefilters.html -->
-  <module name="BeforeExecutionExclusionFileFilter">
-    <property name="fileNamePattern" value="module\-info\.java$"/>
-  </module>
-
-  <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
-  <module name="SuppressionFilter">
-    <property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
-              default="checkstyle-suppressions.xml" />
-    <property name="optional" value="true"/>
-  </module>
-
-  <!-- Checks that a package-info.java file exists for each package.     -->
-  <!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
-  <module name="JavadocPackage"/>
-
-  <!-- Checks whether files end with a new line.                        -->
-  <!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
-  <module name="NewlineAtEndOfFile"/>
-
-  <!-- Checks that property files contain the same keys.         -->
-  <!-- See https://checkstyle.org/config_misc.html#Translation -->
-  <module name="Translation"/>
-
-  <!-- Checks for Size Violations.                    -->
-  <!-- See https://checkstyle.org/config_sizes.html -->
-  <module name="FileLength"/>
-  <module name="LineLength">
-    <property name="fileExtensions" value="java"/>
-  </module>
-
-  <!-- Checks for whitespace                               -->
-  <!-- See https://checkstyle.org/config_whitespace.html -->
-  <module name="FileTabCharacter"/>
-
-  <!-- Miscellaneous other checks.                   -->
-  <!-- See https://checkstyle.org/config_misc.html -->
-  <module name="RegexpSingleline">
-    <property name="format" value="\s+$"/>
-    <property name="minimum" value="0"/>
-    <property name="maximum" value="0"/>
-    <property name="message" value="Line has trailing spaces."/>
-  </module>
-
-  <!-- Checks for Headers                                -->
-  <!-- See https://checkstyle.org/config_header.html   -->
-  <!-- <module name="Header"> -->
-  <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
-  <!--   <property name="fileExtensions" value="java"/> -->
-  <!-- </module> -->
-
-  <module name="TreeWalker">
-
-    <!-- Checks for Javadoc comments.                     -->
-    <!-- See https://checkstyle.org/config_javadoc.html -->
-    <module name="InvalidJavadocPosition"/>
-    <module name="JavadocMethod"/>
-    <module name="JavadocType"/>
-    <module name="JavadocVariable"/>
-    <module name="JavadocStyle"/>
-    <module name="MissingJavadocMethod"/>
-
-    <!-- Checks for Naming Conventions.                  -->
-    <!-- See https://checkstyle.org/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 https://checkstyle.org/config_imports.html -->
-    <module name="AvoidStarImport"/>
-    <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
-    <module name="RedundantImport"/>
-    <module name="UnusedImports">
-      <property name="processJavadoc" value="false"/>
-    </module>
-
-    <!-- Checks for Size Violations.                    -->
-    <!-- See https://checkstyle.org/config_sizes.html -->
-    <module name="MethodLength"/>
-    <module name="ParameterNumber"/>
-
-    <!-- Checks for whitespace                               -->
-    <!-- See https://checkstyle.org/config_whitespace.html -->
-    <module name="EmptyForIteratorPad"/>
-    <module name="GenericWhitespace"/>
-    <module name="MethodParamPad"/>
-    <module name="NoWhitespaceAfter"/>
-    <module name="NoWhitespaceBefore"/>
-    <module name="OperatorWrap"/>
-    <module name="ParenPad"/>
-    <module name="TypecastParenPad"/>
-    <module name="WhitespaceAfter"/>
-    <module name="WhitespaceAround"/>
-
-    <!-- Modifier Checks                                    -->
-    <!-- See https://checkstyle.org/config_modifiers.html -->
-    <module name="ModifierOrder"/>
-    <module name="RedundantModifier"/>
-
-    <!-- Checks for blocks. You know, those {}'s         -->
-    <!-- See https://checkstyle.org/config_blocks.html -->
-    <module name="AvoidNestedBlocks"/>
-    <module name="EmptyBlock"/>
-    <module name="LeftCurly"/>
-    <module name="NeedBraces"/>
-    <module name="RightCurly"/>
-
-    <!-- Checks for common coding problems               -->
-    <!-- See https://checkstyle.org/config_coding.html -->
-    <module name="EmptyStatement"/>
-    <module name="EqualsHashCode"/>
-    <module name="HiddenField"/>
-    <module name="IllegalInstantiation"/>
-    <module name="InnerAssignment"/>
-    <module name="MagicNumber"/>
-    <module name="MissingSwitchDefault"/>
-    <module name="MultipleVariableDeclarations"/>
-    <module name="SimplifyBooleanExpression"/>
-    <module name="SimplifyBooleanReturn"/>
-
-    <!-- Checks for class design                         -->
-    <!-- See https://checkstyle.org/config_design.html -->
-    <module name="DesignForExtension"/>
-    <module name="FinalClass"/>
-    <module name="HideUtilityClassConstructor"/>
-    <module name="InterfaceIsType"/>
-    <module name="VisibilityModifier"/>
-
-    <!-- Miscellaneous other checks.                   -->
-    <!-- See https://checkstyle.org/config_misc.html -->
-    <module name="ArrayTypeStyle"/>
-    <module name="FinalParameters"/>
-    <module name="TodoComment"/>
-    <module name="UpperEll"/>
-
-    <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
-    <module name="SuppressionXpathFilter">
-      <property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
-                default="checkstyle-xpath-suppressions.xml" />
-      <property name="optional" value="true"/>
-    </module>
-
-  </module>
-</module>