Merge branch 'develop'

Author: davidsusu

CHANGELOG.md

@@ -1,10 +1,38 @@
 # Changelog
 
+## Version 0.3.0
+
+Released on *2025-03-15*
+
+### Improved:
+
+- Removed all restrictions on executor services
+- Improved logging
+- Improved error handling in the REPL
+
+## Development:
+
+- Upgrade to gradle 8
+
+
+## Version 0.2.0
+
+Released on *2023-12-16*
+
+### Improved:
+
+- Added all minibase keywords to SqlRepl
+- Added module definition and utf-8 encoding explicitly
+
 ## Version 0.1.0
 
-Released on *2023-xx-xx*
+Released on *2023-01-11*
+
+### Migration:
+
+- Project migrated from the main `miniconnect` repo
+- Split to two projects: `repl` (a little neutral REPL framework) and `client`
 
-**Migration:**
+### Improved:
 
-- Project migrated from the main miniconnect repo
-- Splitted to two projects: `repl` (a little neutral REPL framework) and `client`
+- New `regexbee` version

README.md

@@ -1,3 +1,27 @@
 # MiniConnect client
 
-Command line client for miniConnect
+Command line REPL client for miniConnect
+
+## Installation
+
+[See the Releases page for downloadable artifacts](https://github.com/miniconnect/miniconnect-client/releases)
+
+Currently, there are two distributions available for download:
+
+- **fat jar**: standalone all-in-one jar file, can be executed with `java -jar <...>`
+- **debian package**: standard package for any Debian based OS,
+  installs `micl` and `miniconnect-client` binaries and their accessories
+
+## Usage
+
+You can connect to a miniConnect server with the `micl` (or `miniconnect-client`) command:
+
+```bash
+micl
+```
+
+In case of custom server and port:
+
+```bash
+micl server.local:9876
+```

build.gradle

@@ -32,8 +32,8 @@ allprojects {
     group 'hu.webarticum.miniconnect.client'
     version automaticVersion
 
-    ext.miniConnectApiVersion = '0.1.0-SNAPSHOT'
-    ext.miniConnectVersion = '0.3.1-SNAPSHOT'
+    ext.miniConnectApiVersion = '0.3.0'
+    ext.miniConnectVersion = '0.6.0'
 
     repositories {
         mavenCentral()
@@ -66,6 +66,7 @@ subprojects {
         }
 
         tasks.withType(JavaCompile) {
+            options.encoding = 'UTF-8'
             options.release = 8
         }
 
@@ -78,6 +79,16 @@ subprojects {
             options.addStringOption('Xdoclint:none', '-quiet')
         }
 
+        def moduleNamePrefix = 'hu.webarticum.miniconnect.'
+        def cleanProjectName = project.name.replaceAll(/\W/, ".")
+        def moduleName = "${moduleNamePrefix}${cleanProjectName}"
+        
+        jar {
+            manifest {
+                attributes('Automatic-Module-Name': moduleName)
+            }
+        }
+        
         test {
             useJUnitPlatform()
             testLogging {

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

gradlew

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

gradlew.bat

@@ -1,14 +1,29 @@
 plugins {
     id 'java-library'
     id 'application'
-    id 'eclipse'
     id 'com.github.johnrengelman.shadow' version '7.1.2'
+    id "com.netflix.nebula.ospackage" version "11.8.1"
 }
 
+apply from: 'helpers.gradle'
+
+import org.apache.tools.ant.filters.ReplaceTokens
+
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
-description "MiniConnect REPL"
+description "Command line database client for miniconnect"
+
+def deploymentName = 'miniconnect-client'
+def executableName = 'micl'
+def longExecutableName = deploymentName
+def maintainerName = 'Dávid Horváth'
+def maintainerEmail = 'horvath@webarticum.hu'
+def websiteUrl = 'https://github.com/miniconnect/miniconnect-client'
+def mainClassName = 'hu.webarticum.miniconnect.client.client.ClientMain'
+def longDescription = """Connects to the specified server via miniconnect protocol.
+It's basically a SQL REPL that you can use to run queries.
+It displays result sets and error responses in a friendly manner."""
 
 dependencies {
     implementation project(':repl')
@@ -24,9 +39,94 @@ dependencies {
 }
 
 application {
-    mainClass = "hu.webarticum.miniconnect.client.client.ClientMain"
+    mainClass = mainClassName
 }
 
 run {
     standardInput = System.in
 }
+
+
+task buildDebPackage(type: Deb, dependsOn: ['jar']) {
+    File jarFile = jar.archiveFile.getAsFile().get();
+    String jarFileName = jarFile.getName()
+    
+    doFirst {
+        mkdir 'build/deb-prepare'
+        
+        // TODO: generate from picocli
+        compressWithGzip9('packaging/deb/manpage', 'build/deb-prepare/manpage.gz')
+        
+        def changelogData = parseChangelogMarkdown('../../CHANGELOG.md')
+        buildDebianChangelog('build/deb-prepare/changelog', changelogData)
+        compressWithGzip9('build/deb-prepare/changelog', 'build/deb-prepare/changelog.Debian.gz')
+        
+        copy {
+            from (file('packaging/deb/copyright'))
+            into 'build/deb-prepare'
+            filteringCharset = 'UTF-8'
+            filter(ReplaceTokens, tokens: [
+                'CURRENT_YEAR': new Date().format('yyyy').toString(),
+            ])
+        }
+        
+        copy {
+            from (file('packaging/deb/start.sh'))
+            into 'build/deb-prepare'
+            filteringCharset = 'UTF-8'
+            filter(ReplaceTokens, tokens: [
+                'JAVA_ROOT': "/usr/share/${deploymentName}".toString(),
+                'JAR_FILENAME': jarFileName.toString(),
+                'MAIN_CLASS': mainClassName.toString(),
+            ])
+        }
+    }
+    
+    dirMode 0755
+    fileMode 0644
+    user "root"
+    permissionGroup "root"
+    
+    packageName = deploymentName
+    version =  project.version
+    release = null
+    maintainer = maintainerName + ' <' + maintainerEmail + '>'
+    url = websiteUrl
+    summary = project.description
+    packageDescription = longDescription
+    
+    
+    // TODO: that dependency should be set?
+    requires('default-jre').or('java8-runtime').or('java9-runtime')
+    requires('jarwrapper')
+    
+    from (jarFile) {
+        into "/usr/share/${deploymentName}"
+    }
+    
+    from (file('build/deb-prepare/copyright')) {
+        into "/usr/share/doc/${deploymentName}"
+    }
+    
+    from (file('build/deb-prepare/start.sh')) {
+        into '/usr/bin'
+        rename(/.*/, executableName)
+        fileMode 0755
+    }
+    
+    from (file('build/deb-prepare/manpage.gz')) {
+        into '/usr/share/man/man1'
+        rename(/.*/, "${deploymentName}.1.gz")
+    }
+    
+    from (file('build/deb-prepare/changelog.Debian.gz')) {
+        into "/usr/share/doc/${deploymentName}"
+    }
+    
+    link("/usr/bin/${longExecutableName}", executableName)
+    link("/usr/share/man/man1/${executableName}.1.gz", "${deploymentName}.1.gz")
+    
+    from (configurations.runtimeClasspath) {
+        into "/usr/share/${deploymentName}/lib"
+    }
+}