updating to Java named modules, Gradle 6, JUnit 5

build.gradle

@@ -1,214 +1,34 @@
 plugins {
-    id "org.sonarqube" version '2.8'
+    id "de.marcphilipp.nexus-publish" version "0.4.0"
     id "io.codearte.nexus-staging" version "0.21.1"
-    id "com.github.spotbugs" version "2.0.1"
-    id "org.xbib.gradle.plugin.asciidoctor" version "1.5.6.0.1"
 }
 
-asciidoctor {
+wrapper {
-    backends 'html5'
+    gradleVersion = "${project.property('gradle.wrapper.version')}"
-    outputDir = file("${rootProject.projectDir}/docs")
+    distributionType = Wrapper.DistributionType.ALL
-    separateOutputDirs = false
-    attributes 'source-highlighter': 'coderay',
-            toc: '',
-            idprefix: '',
-            idseparator: '-',
-            stylesheet: "${projectDir}/src/docs/asciidoc/css/foundation.css"
-}
-
-/*javadoc {
-    options.docletpath = configurations.asciidoclet.files.asType(List)
-    options.doclet = 'org.asciidoctor.Asciidoclet'
-    options.overview = "${rootProject.projectDir}/src/docs/asciidoclet/overview.adoc"
-    options.addStringOption "-base-dir", "${projectDir}"
-    options.addStringOption "-attribute",
-            "name=${project.name},version=${project.version},title-link=https://github.com/xbib/${project.name}"
-    options.destinationDirectory(file("${projectDir}/docs/javadoc"))
-    configure(options) {
-        noTimestamp = true
-    }
-}*/
-
-subprojects {
-    apply plugin: 'java'
-    apply plugin: 'maven'
-    apply plugin: 'pmd'
-    apply plugin: 'checkstyle'
-    apply plugin: "com.github.spotbugs"
-
-    dependencies {
-        testImplementation "org.junit.jupiter:junit-jupiter-api:${project.property('junit.version')}"
-        testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${project.property('junit.version')}"
-        testImplementation "org.xbib:bibliographic-character-sets:${project.property('xbib-bibliographic-character-sets.version')}"
-    }
-
-    compileJava {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
-    }
-
-    compileTestJava {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
-    }
-
-    tasks.withType(JavaCompile) {
-        options.compilerArgs << "-Xlint:all,-fallthrough"
-    }
-
-    clean {
-        delete 'out'
-    }
-
-    test {
-        useJUnitPlatform()
-        systemProperty 'java.util.logging.config.file', project.file('src/test/resources/logging.properties')
-        failFast = false
-        testLogging {
-            events 'STARTED', 'PASSED', 'FAILED', 'SKIPPED'
-        }
-        afterSuite { desc, result ->
-            if (!desc.parent) {
-                println "\nTest result: ${result.resultType}"
-                println "Test summary: ${result.testCount} tests, " +
-                        "${result.successfulTestCount} succeeded, " +
-                        "${result.failedTestCount} failed, " +
-                        "${result.skippedTestCount} skipped"
-            }
-        }
-    }
-
-    task sourcesJar(type: Jar, dependsOn: classes) {
-        classifier 'sources'
-        from sourceSets.main.allSource
-    }
-
-    task javadocJar(type: Jar, dependsOn: javadoc) {
-        classifier 'javadoc'
-    }
-
-    artifacts {
-        archives sourcesJar, javadocJar
 }
 
 ext {
     user = 'xbib'
-        projectName = 'cql'
+    name = 'cql'
-        projectDescription = 'Contextual Query Language compiler for Java'
+    description = 'Contextual Query Language compiler for Java'
-        scmUrl = 'https://github.com/xbib/cql'
+    inceptionYear = '2016'
-        scmConnection = 'scm:git:git://github.com/xbib/cql.git'
+    url = 'https://github.com/' + user + '/' + name
-        scmDeveloperConnection = 'scm:git:git://github.com/xbib/cql.git'
+    scmUrl = 'https://github.com/' + user + '/' + name
+    scmConnection = 'scm:git:git://github.com/' + user + '/' + name + '.git'
+    scmDeveloperConnection = 'scm:git:ssh://git@github.com:' + user + '/' + name + '.git'
+    issueManagementSystem = 'Github'
+    issueManagementUrl = ext.scmUrl + '/issues'
+    licenseName = 'The Apache License, Version 2.0'
+    licenseUrl = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
 }
 
-    spotbugs {
+subprojects {
-        toolVersion = '3.1.12'
+    apply plugin: 'java-library'
-        sourceSets = [sourceSets.main]
+    apply from: rootProject.file('gradle/ide/idea.gradle')
-        ignoreFailures = true
+    apply from: rootProject.file('gradle/compile/java.gradle')
-        effort = "max"
+    apply from: rootProject.file('gradle/test/junit5.gradle')
-        reportLevel = "high"
+    apply from: rootProject.file('gradle/publishing/publication.gradle')
 }
 
-    spotbugsMain.reports {
+apply from: rootProject.file('gradle/publishing/sonatype.gradle')
-        xml.enabled = false
-        html.enabled = true
-    }
-
-    spotbugsTest.reports {
-        xml.enabled = false
-        html.enabled = true
-    }
-
-    tasks.withType(Pmd) {
-        ignoreFailures = true
-        reports {
-            xml.enabled = true
-            html.enabled = true
-        }
-    }
-
-    tasks.withType(Checkstyle) {
-        ignoreFailures = true
-        reports {
-            xml.enabled = true
-            html.enabled = true
-        }
-    }
-
-    pmd {
-        toolVersion = '6.11.0'
-        ruleSets = ['category/java/bestpractices.xml']
-    }
-
-    checkstyle {
-        configFile = rootProject.file('config/checkstyle/checkstyle.xml')
-        ignoreFailures = true
-        showViolations = true
-    }
-
-    sonarqube {
-        properties {
-            property "sonar.projectName", "${project.group} ${project.name}"
-            property "sonar.sourceEncoding", "UTF-8"
-            property "sonar.tests", "src/test/java"
-            property "sonar.scm.provider", "git"
-            property "sonar.junit.reportsPath", "build/test-results/test/"
-        }
-    }
-
-    task sonatypeUpload(type: Upload, dependsOn: build) {
-        group = 'publish'
-        configuration = configurations.archives
-        uploadDescriptor = true
-        repositories {
-            if (project.hasProperty('ossrhUsername')) {
-                mavenDeployer {
-                    beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
-                    repository(url: uri(ossrhReleaseUrl)) {
-                        authentication(userName: ossrhUsername, password: ossrhPassword)
-                    }
-                    snapshotRepository(url: uri(ossrhSnapshotUrl)) {
-                        authentication(userName: ossrhUsername, password: ossrhPassword)
-                    }
-                    pom.project {
-                        groupId project.group
-                        artifactId project.name
-                        version project.version
-                        name project.name
-                        description projectDescription
-                        packaging 'jar'
-                        inceptionYear '2016'
-                        url scmUrl
-                        organization {
-                            name 'xbib'
-                            url 'http://xbib.org'
-                        }
-                        developers {
-                            developer {
-                                id user
-                                name 'Jörg Prante'
-                                email 'joergprante@gmail.com'
-                                url 'https://github.com/jprante'
-                            }
-                        }
-                        scm {
-                            url scmUrl
-                            connection scmConnection
-                            developerConnection scmDeveloperConnection
-                        }
-                        licenses {
-                            license {
-                                name 'The Apache License, Version 2.0'
-                                url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    nexusStaging {
-        packageGroup = "org.xbib"
-    }
-
-}

cql-common/build.gradle

@@ -1,4 +1,12 @@
 plugins {
-    id 'org.xbib.gradle.plugin.jflex' version '1.2.1'
+    id 'org.xbib.gradle.plugin.jflex' version '1.4.0'
-    id 'org.xbib.gradle.plugin.jacc' version '1.1.3'
+    id 'org.xbib.gradle.plugin.jacc' version '1.4.0'
+}
+
+sourceSets {
+    main {
+        java {
+            srcDirs += 'build/generated-src'
+        }
+    }
 }

cql-common/src/main/java/module-info.java

@@ -0,0 +1,6 @@
+module org.xbib.cql {
+    exports org.xbib.cql;
+    exports org.xbib.cql.model;
+    exports org.xbib.cql.model.breadcrumb;
+    exports org.xbib.cql.util;
+}

cql-common/src/test/resources/log4j2.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<configuration status="OFF">
-    <appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="[%d{ABSOLUTE}][%-5p][%-25c][%t] %m%n"/>
-        </Console>
-    </appenders>
-    <Loggers>
-        <Root level="info">
-            <AppenderRef ref="Console" />
-        </Root>
-    </Loggers>
-</configuration>

cql-elasticsearch/build.gradle

@@ -1,4 +1,4 @@
 dependencies {
-    compile project(':cql-common')
+    api project(':cql-common')
-    compile "org.xbib:content-core:${project.property('xbib-content.version')}"
+    api "org.xbib:content-core:${project.property('xbib-content.version')}"
 }

cql-elasticsearch/src/main/java/module-info.java

@@ -0,0 +1,7 @@
+module org.xbib.cql.elasticsearch {
+    exports org.xbib.cql.elasticsearch;
+    exports org.xbib.cql.elasticsearch.ast;
+    exports org.xbib.cql.elasticsearch.model;
+    requires org.xbib.cql;
+    requires org.xbib.content.core;
+}

cql-elasticsearch/src/main/java/org/xbib/cql/elasticsearch/ElasticsearchQueryGenerator.java

@@ -40,11 +40,11 @@ import java.util.Stack;
  */
 public class ElasticsearchQueryGenerator implements Visitor {
 
-    private ElasticsearchQueryModel model;
+    private final ElasticsearchQueryModel model;
 
-    private ElasticsearchFilterGenerator filterGenerator;
+    private final ElasticsearchFilterGenerator filterGenerator;
 
-    private Stack<Node> stack;
+    private final Stack<Node> stack;
 
     private int from;
 
@@ -58,9 +58,9 @@ public class ElasticsearchQueryGenerator implements Visitor {
 
     private String boostMode;
 
-    private SourceGenerator sourceGen;
+    private final SourceGenerator sourceGen;
 
-    private QueryGenerator queryGen;
+    private final QueryGenerator queryGen;
 
     private FilterGenerator filterGen;
 
@@ -68,20 +68,16 @@ public class ElasticsearchQueryGenerator implements Visitor {
 
     private XContentBuilder sort;
 
-    public ElasticsearchQueryGenerator() {
+    public ElasticsearchQueryGenerator() throws IOException {
         this.from = 0;
         this.size = 10;
         this.model = new ElasticsearchQueryModel();
         this.filterGenerator = new ElasticsearchFilterGenerator(model);
         this.stack = new Stack<>();
-        try {
         this.sourceGen = new SourceGenerator();
         this.queryGen = new QueryGenerator();
         this.filterGen = new FilterGenerator();
         this.facetGen = new FacetsGenerator();
-        } catch (IOException e) {
-            // ignore
-        }
     }
 
     public ElasticsearchQueryModel getModel() {
@@ -137,20 +133,15 @@ public class ElasticsearchQueryGenerator implements Visitor {
         return this;
     }
 
-    public String getQueryResult() {
+    public String getQueryResult() throws IOException {
         return queryGen.getResult().string();
     }
 
-
+    public String getFacetResult() throws IOException {
-    public String getFacetResult() {
-        try {
         return facetGen.getResult().string();
-        } catch (IOException e) {
-            return e.getMessage();
-        }
     }
 
-    public String getSourceResult() {
+    public String getSourceResult() throws IOException {
         return sourceGen.getResult().string();
     }
 

gradle.properties

@@ -1,9 +1,6 @@
 group = org.xbib
 name = cql
-version = 2.0.2
+version = 3.0.0
 
-xbib-content.version = 2.0.4
+gradle.wrapper.version = 6.4.1
-
+xbib-content.version = 2.2.0
-# test
-junit.version = 5.5.1
-xbib-bibliographic-character-sets.version = 1.0.0

gradle/compile/java.gradle

@@ -0,0 +1,35 @@
+
+apply plugin: 'java-library'
+
+java {
+    modularity.inferModulePath.set(true)
+}
+
+compileJava {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+}
+
+compileTestJava {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+}
+
+jar {
+    manifest {
+        attributes('Implementation-Version': project.version)
+    }
+}
+
+task sourcesJar(type: Jar, dependsOn: classes) {
+    classifier 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier 'javadoc'
+}
+
+artifacts {
+    archives sourcesJar, javadocJar
+}

gradle/documentation/asciidoc.gradle

@@ -0,0 +1,55 @@
+apply plugin: 'org.xbib.gradle.plugin.asciidoctor'
+
+configurations {
+    asciidoclet
+}
+
+dependencies {
+    asciidoclet "org.asciidoctor:asciidoclet:${project.property('asciidoclet.version')}"
+}
+
+
+asciidoctor {
+    backends 'html5'
+    outputDir = file("${rootProject.projectDir}/docs")
+    separateOutputDirs = false
+    attributes 'source-highlighter': 'coderay',
+            idprefix: '',
+            idseparator: '-',
+            toc: 'left',
+            doctype: 'book',
+            icons: 'font',
+            encoding: 'utf-8',
+            sectlink: true,
+            sectanchors: true,
+            linkattrs: true,
+            imagesdir: 'img',
+            stylesheet: "${projectDir}/src/docs/asciidoc/css/foundation.css"
+}
+
+
+/*javadoc {
+options.docletpath = configurations.asciidoclet.files.asType(List)
+options.doclet = 'org.asciidoctor.Asciidoclet'
+//options.overview = "src/docs/asciidoclet/overview.adoc"
+options.addStringOption "-base-dir", "${projectDir}"
+options.addStringOption "-attribute",
+        "name=${project.name},version=${project.version},title-link=https://github.com/xbib/${project.name}"
+configure(options) {
+    noTimestamp = true
+}
+}*/
+
+
+/*javadoc {
+    options.docletpath = configurations.asciidoclet.files.asType(List)
+    options.doclet = 'org.asciidoctor.Asciidoclet'
+    options.overview = "${rootProject.projectDir}/src/docs/asciidoclet/overview.adoc"
+    options.addStringOption "-base-dir", "${projectDir}"
+    options.addStringOption "-attribute",
+            "name=${project.name},version=${project.version},title-link=https://github.com/xbib/${project.name}"
+    options.destinationDirectory(file("${projectDir}/docs/javadoc"))
+    configure(options) {
+        noTimestamp = true
+    }
+}*/

gradle/ide/idea.gradle

@@ -0,0 +1,13 @@
+apply plugin: 'idea'
+
+idea {
+    module {
+        outputDir file('build/classes/java/main')
+        testOutputDir file('build/classes/java/test')
+    }
+}
+
+if (project.convention.findPlugin(JavaPluginConvention)) {
+    //sourceSets.main.output.classesDirs = file("build/classes/java/main")
+    //sourceSets.test.output.classesDirs = file("build/classes/java/test")
+}

gradle/publishing/publication.gradle

@@ -0,0 +1,54 @@
+
+apply plugin: "de.marcphilipp.nexus-publish"
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            from components.java
+            artifact sourcesJar
+            artifact javadocJar
+            pom {
+                name = project.name
+                description = rootProject.ext.description
+                url = rootProject.ext.url
+                inceptionYear = rootProject.ext.inceptionYear
+                packaging = 'jar'
+                organization {
+                    name = 'xbib'
+                    url = 'https://xbib.org'
+                }
+                developers {
+                    developer {
+                        id = 'jprante'
+                        name = 'Jörg Prante'
+                        email = 'joergprante@gmail.com'
+                        url = 'https://github.com/jprante'
+                    }
+                }
+                scm {
+                    url = rootProject.ext.scmUrl
+                    connection = rootProject.ext.scmConnection
+                    developerConnection = rootProject.ext.scmDeveloperConnection
+                }
+                issueManagement {
+                    system = rootProject.ext.issueManagementSystem
+                    url = rootProject.ext.issueManagementUrl
+                }
+                licenses {
+                    license {
+                        name = rootProject.ext.licenseName
+                        url = rootProject.ext.licenseUrl
+                        distribution = 'repo'
+                    }
+                }
+            }
+        }
+    }
+}
+
+if (project.hasProperty("signing.keyId")) {
+    apply plugin: 'signing'
+    signing {
+        sign publishing.publications.mavenJava
+    }
+}

gradle/publishing/sonatype.gradle

@@ -0,0 +1,21 @@
+
+if (project.hasProperty('ossrhUsername') && project.hasProperty('ossrhPassword')) {
+
+    apply plugin: 'io.codearte.nexus-staging'
+
+    nexusPublishing {
+        repositories {
+            sonatype {
+                username = project.property('ossrhUsername')
+                password = project.property('ossrhPassword')
+                packageGroup = "org.xbib"
+            }
+        }
+    }
+
+    nexusStaging {
+        username = project.property('ossrhUsername')
+        password = project.property('ossrhPassword')
+        packageGroup = "org.xbib"
+    }
+}

gradle/test/junit5.gradle

@@ -0,0 +1,27 @@
+
+def junitVersion = project.hasProperty('junit.version')?project.property('junit.version'):'5.6.2'
+def hamcrestVersion = project.hasProperty('hamcrest.version')?project.property('hamcrest.version'):'2.2'
+
+dependencies {
+    testImplementation "org.junit.jupiter:junit-jupiter-api:${junitVersion}"
+    testImplementation "org.junit.jupiter:junit-jupiter-params:${junitVersion}"
+    testImplementation "org.hamcrest:hamcrest-library:${hamcrestVersion}"
+    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junitVersion}"
+}
+
+test {
+    useJUnitPlatform()
+    failFast = true
+    testLogging {
+        events 'STARTED', 'PASSED', 'FAILED', 'SKIPPED'
+    }
+    afterSuite { desc, result ->
+        if (!desc.parent) {
+            println "\nTest result: ${result.resultType}"
+            println "Test summary: ${result.testCount} tests, " +
+                    "${result.successfulTestCount} succeeded, " +
+                    "${result.failedTestCount} failed, " +
+                    "${result.skippedTestCount} skipped"
+        }
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Sun Nov 10 16:46:54 CET 2019
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.4.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -82,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -129,6 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath
@@ -154,19 +156,19 @@ if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=$((i+1))
+        i=`expr $i + 1`
     done
     case $i in
-        (0) set -- ;;
+        0) set -- ;;
-        (1) set -- "$args0" ;;
+        1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
+        2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
     esac
 fi
 
@@ -175,14 +177,9 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"

gradlew.bat

@@ -29,6 +29,9 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
@@ -81,6 +84,7 @@ set CMD_LINE_ARGS=%*
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
 "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%