Merge pull request #32 from saschpe/cleanup

Various improvements, ktor documentation

Author: saschpe

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{kt,kts}]
+ktlint_standard_no-wildcard-imports = disabled

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow empty log messages if you only want to create a log entry about a function being called.
 - Dependency update:
   - [Kotlin 1.9.10](https://kotlinlang.org/docs/whatsnew19.html)
+  - [Gradle-8.7](https://docs.gradle.org/8.7/release-notes.html)
+  - [Android Gradle Plugin 8.2.2](https://developer.android.com/build/releases/past-releases/agp-8-2-0-release-notes)
 
 ## [1.2.3] - 2022-10-12
 ### Changed

build.gradle.kts

@@ -1,6 +1,4 @@
 plugins {
-    kotlin("jvm") version "1.9.10"
-    id("com.android.library") version "7.3.0" apply false
     id("com.diffplug.spotless") version "6.21.0"
     id("com.github.ben-manes.versions") version "0.48.0"
 }
@@ -11,9 +9,17 @@ spotless {
         propertiesFile("gradle.properties")
     }
     kotlin {
-        ktlint()
+        target("**/*.kt")
+        ktlint().setEditorConfigPath(".editorconfig")
     }
     kotlinGradle {
-        ktlint()
+        ktlint().setEditorConfigPath(".editorconfig")
+    }
+}
+
+tasks.withType<com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask> {
+    rejectVersionIf {
+        fun isStable(version: String) = Regex("^[0-9,.v-]+(-r)?$").matches(version)
+        !isStable(candidate.version) && isStable(currentVersion)
     }
 }

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
 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,13 +80,11 @@ 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##*/}
-
-# 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"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 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=SC2039,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=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,11 +198,15 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# 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"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

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%
 
@@ -42,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

gradlew.bat

@@ -7,7 +7,7 @@ plugins {
 
 kotlin {
     androidTarget { publishAllLibraryVariants() }
-    ios()
+    iosArm64()
     iosSimulatorArm64()
     js {
         nodejs()
@@ -18,51 +18,34 @@ kotlin {
     }
     jvm { testRuns["test"].executionTask.configure { useJUnitPlatform() } }
 
-    sourceSets["androidMain"].dependencies {
-        implementation("org.slf4j:slf4j-api:1.7.36")
-    }
-    sourceSets["commonMain"].dependencies {
-        implementation(project(":log4k"))
-    }
-    sourceSets["commonTest"].dependencies {
-        implementation(kotlin("test"))
-    }
-    sourceSets["iosSimulatorArm64Main"].dependsOn(sourceSets["iosMain"])
-    sourceSets["iosSimulatorArm64Test"].dependsOn(sourceSets["iosTest"])
-    sourceSets["jvmMain"].dependencies {
-        implementation("org.slf4j:slf4j-api:1.7.36")
-    }
+    applyDefaultHierarchyTemplate()
 
-    targets.withType(org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTargetWithSimulatorTests::class.java) {
-        testRuns["test"].deviceId = "iPhone 14"
+    sourceSets {
+        commonMain.dependencies { implementation(project(":log4k")) }
+        commonTest.dependencies { implementation(kotlin("test")) }
+        androidMain.dependencies { implementation("org.slf4j:slf4j-api:1.7.36") }
+        jvmMain.dependencies { implementation("org.slf4j:slf4j-api:1.7.36") }
     }
 }
 
+java.toolchain.languageVersion.set(JavaLanguageVersion.of(17))
+
 android {
-    buildToolsVersion = "33.0.0"
-    compileSdk = 33
+    namespace = "saschpe.log4k.slf4j"
 
     defaultConfig {
+        compileSdk = 33
         minSdk = 17
-        targetSdk = 33
     }
 
-    sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
-
-    testCoverage.jacocoVersion = "0.8.8"
+    testCoverage.jacocoVersion = "0.8.10"
 }
 
 group = "de.peilicke.sascha"
 version = "1.2.3"
 
-val javadocJar by tasks.registering(Jar::class) {
-    archiveClassifier.set("javadoc")
-}
-
 publishing {
     publications.withType<MavenPublication> {
-        artifact(javadocJar.get())
-
         pom {
             name.set("Log4K-SLF4J")
             description.set("Lightweight logging library for Kotlin/Multiplatform - SLF4J integration. Supports Android, iOS, JavaScript and plain JVM environments.")
@@ -109,4 +92,4 @@ signing {
         else -> useInMemoryPgpKeys(sonatypeGpgKey, sonatypeGpgKeyPassword)
     }
     sign(publishing.publications)
-}
+}

log4k-slf4j/build.gradle.kts

@@ -8,4 +8,4 @@ actual object MDC {
     actual fun remove(key: String) = org.slf4j.MDC.remove(key)
 
     actual fun clear() = org.slf4j.MDC.clear()
-}
+}

log4k-slf4j/src/androidMain/AndroidManifest.xml

@@ -22,4 +22,4 @@ actual class SLF4JLogger : Logger() {
                 Log.Level.Assert -> error(message, throwable)
             }
         }
-}
+}

log4k-slf4j/src/androidMain/kotlin/saschpe/log4k/slf4j/MDC.kt

@@ -8,4 +8,4 @@ expect object MDC {
     fun get(key: String): String?
     fun remove(key: String)
     fun clear()
-}
+}

log4k-slf4j/src/androidMain/kotlin/saschpe/log4k/slf4j/SLF4JLogger.kt

@@ -14,4 +14,4 @@ import saschpe.log4k.Logger
  *
  * On JVM or Android, SLF4J is used for logging. On JS or Apple platforms, console logging is used internally.
  */
-expect class SLF4JLogger : Logger
+expect class SLF4JLogger : Logger

log4k-slf4j/src/commonMain/kotlin/saschpe/log4k/slf4j/MDC.kt

@@ -14,4 +14,4 @@ actual object MDC {
     }
 
     actual fun clear() = context.clear()
-}
+}

log4k-slf4j/src/commonMain/kotlin/saschpe/log4k/slf4j/SLF4JLogger.kt

@@ -9,4 +9,4 @@ actual class SLF4JLogger : Logger() {
 
     override fun print(level: Log.Level, tag: String, message: String?, throwable: Throwable?) =
         logger.log(level, tag, message, throwable)
-}
+}

log4k-slf4j/src/iosMain/kotlin/saschpe/log4k/slf4j/MDC.kt

@@ -14,4 +14,4 @@ actual object MDC {
     }
 
     actual fun clear() = context.clear()
-}
+}

log4k-slf4j/src/iosMain/kotlin/saschpe/log4k/slf4j/SLF4JLogger.kt

@@ -9,4 +9,4 @@ actual class SLF4JLogger : Logger() {
 
     override fun print(level: Log.Level, tag: String, message: String?, throwable: Throwable?) =
         logger.log(level, tag, message, throwable)
-}
+}

log4k-slf4j/src/jsMain/kotlin/saschpe/log4k/slf4j/MDC.kt

@@ -8,4 +8,4 @@ actual object MDC {
     actual fun remove(key: String) = org.slf4j.MDC.remove(key)
 
     actual fun clear() = org.slf4j.MDC.clear()
-}
+}

log4k-slf4j/src/jsMain/kotlin/saschpe/log4k/slf4j/SLF4JLogger.kt

@@ -16,4 +16,4 @@ actual class SLF4JLogger : Logger() {
                 Log.Level.Assert -> error(message, throwable)
             }
         }
-}
+}

log4k-slf4j/src/jvmMain/kotlin/saschpe/log4k/slf4j/MDC.kt

@@ -7,7 +7,7 @@ plugins {
 
 kotlin {
     androidTarget { publishAllLibraryVariants() }
-    ios()
+    iosArm64()
     iosSimulatorArm64()
     js {
         nodejs()
@@ -18,42 +18,31 @@ kotlin {
     }
     jvm { testRuns["test"].executionTask.configure { useJUnitPlatform() } }
 
-    sourceSets["commonTest"].dependencies {
-        implementation(kotlin("test"))
-    }
-    sourceSets["iosSimulatorArm64Main"].dependsOn(sourceSets["iosMain"])
-    sourceSets["iosSimulatorArm64Test"].dependsOn(sourceSets["iosTest"])
+    applyDefaultHierarchyTemplate()
 
-    targets.withType(org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTargetWithSimulatorTests::class.java) {
-        testRuns["test"].deviceId = "iPhone 14"
+    sourceSets {
+        commonTest.dependencies { implementation(kotlin("test")) }
     }
 }
 
+java.toolchain.languageVersion.set(JavaLanguageVersion.of(17))
+
 android {
-    buildToolsVersion = "33.0.0"
-    compileSdk = 33
+    namespace = "saschpe.log4k"
 
     defaultConfig {
+        compileSdk = 33
         minSdk = 17
-        targetSdk = 33
     }
 
-    sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
-
-    testCoverage.jacocoVersion = "0.8.8"
+    testCoverage.jacocoVersion = "0.8.10"
 }
 
 group = "de.peilicke.sascha"
 version = "1.2.3"
 
-val javadocJar by tasks.registering(Jar::class) {
-    archiveClassifier.set("javadoc")
-}
-
 publishing {
     publications.withType<MavenPublication> {
-        artifact(javadocJar.get())
-
         pom {
             name.set("Log4K")
             description.set("Lightweight logging library for Kotlin/Multiplatform. Supports Android, iOS, JavaScript and plain JVM environments.")
@@ -100,4 +89,4 @@ signing {
         else -> useInMemoryPgpKeys(sonatypeGpgKey, sonatypeGpgKeyPassword)
     }
     sign(publishing.publications)
-}
+}