rewrite of API with expect-actual and removing of redundant platform-specific factory names

0.1.1

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.2.0
+
+* Full rewrite of API
+
+## 0.1.1
+
+* Changes in `JVM` levels
+* Fixes in TagLogger
+
+## 0.1.0
+
+* All the platform specific logged factories has been renamed
+
 ## 0.0.3
 
 * Fixes in `JVM` logging

gradle.properties

@@ -9,5 +9,5 @@ android.enableJetifier=true
 # Project data
 
 group=dev.inmo
-version=0.0.3
-android_code_version=3
+version=0.2.0
+android_code_version=6

src/commonMain/kotlin/KSLog.kt

@@ -2,12 +2,12 @@ package dev.inmo.kslog.common
 
 
 enum class LogLevel {
+    DEBUG,
     VERBOSE,
     INFO,
     WARNING,
     ERROR,
     ASSERT,
-    DEBUG
 }
 
 interface KSLog {
@@ -36,32 +36,39 @@ class CallbackKSLog(
     override fun performLog(level: LogLevel, tag: String?, message: String, throwable: Throwable?) = performLogCallback(level, tag, message, throwable)
 }
 
-
 expect fun KSLog(
     defaultTag: String,
-    filter: (l: LogLevel, t: String, m: String, Throwable?) -> Boolean
+    filter: MessageFilter = { _, _, _, _ -> true },
+    messageFormatter: MessageFormatter = defaultMessageFormatter
 ): KSLog
 
 fun KSLog(
     defaultTag: String,
-    levels: Iterable<LogLevel>
+    levels: Iterable<LogLevel>,
+    messageFormatter: MessageFormatter = defaultMessageFormatter
 ): KSLog {
     val levels = levels.toSet()
-    return KSLog (defaultTag) { l, _, _, _ ->
+    return KSLog (defaultTag, { l, _, _, _ ->
         l in levels
+    }, messageFormatter)
 }
-}
-
-inline fun KSLog(
-    defaultTag: String,
-    firstLevel: LogLevel,
-    secondLevel: LogLevel,
-    vararg otherLevels: LogLevel
-): KSLog = KSLog(defaultTag, setOf(firstLevel, secondLevel, *otherLevels))
 
 fun KSLog(
     defaultTag: String,
-    minLoggingLevel: LogLevel = LogLevel.VERBOSE
-): KSLog = KSLog (defaultTag) { l, _, _, _ ->
+    firstLevel: LogLevel,
+    secondLevel: LogLevel,
+    vararg otherLevels: LogLevel,
+    messageFormatter: MessageFormatter = defaultMessageFormatter,
+): KSLog = KSLog(defaultTag, setOf(firstLevel, secondLevel, *otherLevels), messageFormatter)
+
+fun KSLog(
+    defaultTag: String,
+    minLoggingLevel: LogLevel,
+    messageFormatter: MessageFormatter = defaultMessageFormatter,
+): KSLog = KSLog (
+    defaultTag,
+    { l, _, _, _ ->
         minLoggingLevel.ordinal <= l.ordinal
-}
+    },
+    messageFormatter
+)

src/commonMain/kotlin/KSLogTypealiases.kt

@@ -0,0 +1,6 @@
+package dev.inmo.kslog.common
+
+typealias MessageFormatter = (l: LogLevel, t: String, m: String, Throwable?) -> String
+typealias MessageFilter = (l: LogLevel, t: String?, m: String, Throwable?) -> Boolean
+val defaultMessageFormatter: MessageFormatter = { l, t, m, _ -> "[$l] $t - $m" }
+

src/commonMain/kotlin/TagLogger.kt

@@ -5,6 +5,6 @@ import kotlin.jvm.JvmInline
 @JvmInline
 value class TagLogger(val tag: String) : KSLog {
     override fun performLog(level: LogLevel, tag: String?, message: String, throwable: Throwable?) {
-        KSLog.performLog(level, tag ?: tag, message, throwable)
+        KSLog.performLog(level, tag ?: this.tag, message, throwable)
     }
 }

src/jsMain/kotlin/ActualLogger.kt

@@ -1,30 +1,21 @@
 package dev.inmo.kslog.common
 
-fun KSLog(
-    messageFormatter: (l: LogLevel, t: String?, m: String, Throwable?) -> String,
-    filter: (l: LogLevel, t: String?, m: String, Throwable?) -> Boolean
-) = KSLog { l, t, m, e ->
+actual fun KSLog(
+    defaultTag: String,
+    filter: MessageFilter,
+    messageFormatter: MessageFormatter
+): KSLog = KSLog { l, t, m, e ->
     if (!filter(l, t, m, e)) return@KSLog
-    val text = messageFormatter(l,t,m,e)
+    val text = messageFormatter(l, t?:defaultTag, m, e)
     val args = e ?.let {
         arrayOf(text, e)
     } ?: arrayOf(text)
     when (l) {
+        LogLevel.DEBUG -> console.log(*args)
         LogLevel.VERBOSE,
         LogLevel.INFO -> console.info(*args)
         LogLevel.WARNING -> console.warn(*args)
         LogLevel.ERROR,
         LogLevel.ASSERT -> console.error(*args)
-        LogLevel.DEBUG -> console.log(*args)
     }
 }
-
-actual fun KSLog(
-    defaultTag: String,
-    filter: (l: LogLevel, t: String, m: String, Throwable?) -> Boolean
-): KSLog {
-    return KSLog(
-        { l, t, m, _ -> "[$l] ${t ?: defaultTag} - $m" },
-        { l, t, m, e -> filter(l, t ?: defaultTag, m, e) }
-    )
-}

src/jvmMain/kotlin/ActualLogger.kt

@@ -1,22 +1,24 @@
 package dev.inmo.kslog.common
 
 import java.util.logging.Level
+import java.util.logging.Logger
 
 fun KSLog(
-    logger: java.util.logging.Logger,
-    filter: (l: LogLevel, t: String?, m: String, Throwable?) -> Boolean,
-    messageFormatter: (l: LogLevel, t: String?, m: String, Throwable?) -> String
+    defaultTag: String,
+    logger: Logger,
+    filter: MessageFilter = { _, _, _, _ -> true },
+    messageFormatter: MessageFormatter = defaultMessageFormatter
 ) = KSLog { l, t, m, e ->
     if (!filter(l, t, m, e)) return@KSLog
-    val text = messageFormatter(l,t,m,e)
+    val text = messageFormatter(l,t ?: defaultTag,m,e)
     logger.log(
         when(l) {
-            LogLevel.VERBOSE -> Level.FINEST
+            LogLevel.DEBUG -> Level.FINEST
+            LogLevel.VERBOSE -> Level.FINE
             LogLevel.INFO -> Level.INFO
             LogLevel.WARNING -> Level.WARNING
             LogLevel.ERROR -> Level.SEVERE
-            LogLevel.ASSERT -> Level.OFF
-            LogLevel.DEBUG -> Level.ALL
+            LogLevel.ASSERT -> Level.SEVERE
         },
         text,
         e
@@ -25,22 +27,36 @@ fun KSLog(
 
 fun KSLog(
     defaultTag: String,
-    logger: java.util.logging.Logger,
-    filter: (l: LogLevel, t: String, m: String, Throwable?) -> Boolean = { _, _, _, _ -> true }
+    logger: Logger,
+    levels: Iterable<LogLevel>,
+    messageFormatter: MessageFormatter = defaultMessageFormatter
 ): KSLog {
-    return KSLog(
-        logger,
-        { l, t, m, e -> filter(l, t ?: defaultTag, m, e) }
-    ) { _, t, m, _ -> "${t ?: defaultTag} - $m" }
+    val levels = levels.toSet()
+    return KSLog (defaultTag, logger, { l, _, _, _ ->
+        l in levels
+    }, messageFormatter)
 }
 
+fun KSLog(
+    defaultTag: String,
+    logger: Logger,
+    firstLevel: LogLevel,
+    secondLevel: LogLevel,
+    vararg otherLevels: LogLevel,
+    messageFormatter: MessageFormatter = defaultMessageFormatter,
+): KSLog = KSLog (defaultTag, logger, setOf(firstLevel, secondLevel, *otherLevels), messageFormatter)
+
+fun KSLog(
+    defaultTag: String,
+    logger: Logger,
+    minLoggingLevel: LogLevel = LogLevel.values().first(),
+    messageFormatter: MessageFormatter = defaultMessageFormatter
+): KSLog = KSLog (defaultTag, logger, { l, _, _, _ ->
+    minLoggingLevel.ordinal <= l.ordinal
+}, messageFormatter)
+
 actual fun KSLog(
     defaultTag: String,
-    filter: (l: LogLevel, t: String, m: String, Throwable?) -> Boolean
-): KSLog {
-    return KSLog(
-        defaultTag,
-        logger = java.util.logging.Logger.getAnonymousLogger(),
-        filter = { l, t, m, e -> filter(l, t, m, e) }
-    )
-}
+    filter: MessageFilter,
+    messageFormatter: MessageFormatter
+): KSLog = KSLog(defaultTag, Logger.getLogger("KSLog"), filter, messageFormatter)

src/main/kotlin/ActualLogger.kt

@@ -4,18 +4,18 @@ import android.util.Log
 
 actual fun KSLog(
     defaultTag: String,
-    filter: (l: LogLevel, t: String, m: String, Throwable?) -> Boolean
-): KSLog {
-    return KSLog { l, t, m, e ->
-        val tag = t ?: defaultTag
+    filter: MessageFilter,
+    messageFormatter: MessageFormatter
+): KSLog = KSLog { l, t, m, e ->
     if (!filter(l, t ?: defaultTag, m, e)) return@KSLog
+    val tag = t ?: defaultTag
+    val text = messageFormatter(l, tag, m, e)
     when(l) {
-            LogLevel.VERBOSE -> Log.v(tag, m, e)
-            LogLevel.INFO -> Log.i(tag, m, e)
-            LogLevel.WARNING -> Log.w(tag, m, e)
-            LogLevel.ERROR -> Log.e(tag, m, e)
-            LogLevel.ASSERT -> Log.wtf(tag, m, e)
-            LogLevel.DEBUG -> Log.d(tag, m, e)
-        }
+        LogLevel.DEBUG -> Log.d(tag, text, e)
+        LogLevel.VERBOSE -> Log.v(tag, text, e)
+        LogLevel.INFO -> Log.i(tag, text, e)
+        LogLevel.WARNING -> Log.w(tag, text, e)
+        LogLevel.ERROR -> Log.e(tag, text, e)
+        LogLevel.ASSERT -> Log.wtf(tag, text, e)
     }
 }