Enhancing logger builder

eliasmeireles · eliasmeireles · commit 41e73d9ce914 · 2023-02-11T08:31:05.000-03:00
diff --git a/README.md b/README.md
@@ -4,11 +4,23 @@
 
 ```kotlin
 val error = IllegalArgumentException("test error log message")
-JsonLog(logger())
+logger.jsonLog
     .add("test-key", "test-value")
     .error(error)
+    .level(Level.INFO)
+    .printStackTracker(true)
     .message("this is a test log message created in {} of lib version {}", LocalDate.of(2022, 8, 12), "1.0.0")
-    .run(Level.ERROR, true)
+    .run()
+```
+
+```java
+JsonLoggerKt.getJsonLog(log)
+		.add("test-key","test-value")
+		.error(error)
+		.level(Level.INFO)
+		.printStackTracker(true)
+		.message("this is a test log message created in {} of lib version {}",LocalDate.of(2022,8,12),"1.0.0")
+		.run()
 ```
 
 ```json
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -17,7 +17,7 @@ java {
     withSourcesJar()
 }
 
-val apiVersion = "0.0.3"
+val apiVersion = "0.0.4"
 
 
 group = "com.softwareplace"
diff --git a/src/main/kotlin/com/softwareplace/json/logger/log/JsonLogger.kt b/src/main/kotlin/com/softwareplace/json/logger/log/JsonLogger.kt
@@ -7,7 +7,8 @@ import org.slf4j.LoggerFactory
 import org.slf4j.event.Level
 
 
-inline fun <reified T : Any> T.logger(): Logger = LoggerFactory.getLogger(T::class.java)
+inline val <reified T : Any> T.logger: Logger get() = LoggerFactory.getLogger(T::class.java)
+val Logger.jsonLog: JsonLog get() = JsonLog(this)
 
 private data class LoggerModel(
     val message: String?,
@@ -19,13 +20,25 @@ data class JsonLog(private val logger: Logger) {
     private var message: String? = null
     private var properties: HashMap<String, Any>? = null
     private var error: Throwable? = null
+    private var printStackTraceEnable: Boolean = false
+    private var level: Level = Level.TRACE
 
 
+    fun level(level: Level): JsonLog {
+        this.level = level
+        return this
+    }
+
     fun error(error: Throwable?): JsonLog {
         this.error = error
         return this
     }
 
+    fun printStackTracker(value: Boolean): JsonLog {
+        this.printStackTraceEnable = value
+        return this
+    }
+
     fun message(message: String, vararg args: Any?): JsonLog {
         this.message = String.format(message.replace("{}", "%s"), *args)
         return this
@@ -40,37 +53,51 @@ data class JsonLog(private val logger: Logger) {
     }
 
     fun run(
-        level: Level,
-        printStackTraceEnable: Boolean = false,
         mapper: ObjectMapper = getObjectMapper()
-    ) {
+    ): Logger {
         val loggerMessage = mapper.writeValueAsString(
             LoggerModel(
                 message = message,
                 properties = properties,
                 errorMessage = error?.message
             )
         )
-        if (printStackTraceEnable) {
+
+        return if (printStackTraceEnable) {
             logger.run(level, loggerMessage, error)
         } else {
             logger.run(level, loggerMessage)
         }
     }
-}
 
+    fun run(): Logger {
+        val loggerMessage = getObjectMapper().writeValueAsString(
+            LoggerModel(
+                message = message,
+                properties = properties,
+                errorMessage = error?.message
+            )
+        )
+        return if (printStackTraceEnable) {
+            logger.run(level, loggerMessage, error)
+        } else {
+            logger.run(level, loggerMessage)
+        }
+    }
+}
 
 fun Logger.run(
     level: Level = Level.INFO,
     message: String,
     error: Throwable? = null
-) {
+): Logger {
     when (level) {
         Level.DEBUG -> debug(message, error)
         Level.TRACE -> trace(message, error)
         Level.WARN -> warn(message, error)
         Level.ERROR -> error(message, error)
         else -> info(message, error)
     }
+    return this
 }
 
diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml
@@ -3,9 +3,7 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>
-                %boldMagenta(%d{dd-MM-yyyy HH:mm:ss.SSS}) - [%boldGreen(%thread)] - %highlight(%-5level) %boldMagenta(%logger{36}.%M) - %boldYellow(%msg%n)
-            </pattern>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
         </encoder>
     </appender>
 
diff --git a/src/test/kotlin/com/softwareplace/json/logger/log/JsonLogTestExt.kt b/src/test/kotlin/com/softwareplace/json/logger/log/JsonLogTestExt.kt
@@ -11,13 +11,14 @@ import java.time.LocalDate
 
 @Suppress("KotlinPlaceholderCountMatchesArgumentCount")
 @ExtendWith(MockKExtension::class)
-class JsonLogTest {
+class JsonLogTestExt {
     @Test
     fun `must to call logger with expected json`() {
-        val logger = spyk(logger())
-        JsonLog(logger)
+        val logger = spyk(logger)
+            .jsonLog
             .add("test-key", "test-value")
-            .run(Level.INFO)
+            .level(Level.INFO)
+            .run()
 
         verify {
             logger.run(Level.INFO, "{\"properties\":{\"test-key\":\"test-value\"}}")
@@ -27,10 +28,11 @@ class JsonLogTest {
 
     @Test
     fun `must to call log debug with expected json`() {
-        val logger = spyk(logger())
+        val logger = spyk(logger)
         JsonLog(logger)
             .add("test-key", "test-value")
-            .run(Level.DEBUG)
+            .level(Level.DEBUG)
+            .run()
 
         verify {
             logger.run(Level.DEBUG, "{\"properties\":{\"test-key\":\"test-value\"}}")
@@ -40,10 +42,11 @@ class JsonLogTest {
 
     @Test
     fun `must to call log warn with expected json`() {
-        val logger = spyk(logger())
+        val logger = spyk(logger)
         JsonLog(logger)
             .add("test-key", "test-value")
-            .run(Level.WARN)
+            .level(Level.WARN)
+            .run()
 
         verify {
             logger.run(Level.WARN, "{\"properties\":{\"test-key\":\"test-value\"}}")
@@ -53,12 +56,14 @@ class JsonLogTest {
 
     @Test
     fun `must to call logger with error message`() {
-        val logger = spyk(logger())
+        val logger = spyk(logger)
         val error = IllegalArgumentException("test error log message")
         JsonLog(logger)
             .add("test-key", "test-value")
             .error(error)
-            .run(Level.INFO, true)
+            .level(Level.INFO)
+            .printStackTracker(true)
+            .run()
 
         verify {
             logger.run(Level.INFO, "{\"properties\":{\"test-key\":\"test-value\"},\"errorMessage\":\"test error log message\"}", error)
@@ -68,11 +73,12 @@ class JsonLogTest {
 
     @Test
     fun `must to call logInfo with message`() {
-        val logger = spyk(logger())
+        val logger = spyk(logger)
         JsonLog(logger)
             .add("test-key", "test-value")
             .message("this is a test log message created in {} of lib version {}", LocalDate.of(2022, 8, 12), "1.0.0")
-            .run(Level.INFO)
+            .level(Level.INFO)
+            .run()
 
         verify {
             logger.run(
@@ -88,13 +94,15 @@ class JsonLogTest {
 
     @Test
     fun `must to call log error with message`() {
-        val logger = spyk(logger())
+        val logger = spyk(logger)
         val error = IllegalArgumentException("test error log message")
         JsonLog(logger)
             .add("test-key", "test-value")
             .error(error)
             .message("this is a test log message created in {} of lib version {}", LocalDate.of(2022, 8, 12), "1.0.0")
-            .run(Level.ERROR, true)
+            .level(Level.ERROR)
+            .printStackTracker(true)
+            .run()
 
         verify {
             logger.run(

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ java {`
`17`	`17`	`withSourcesJar()`
`18`	`18`	`}`
`19`	`19`
`20`		`-val apiVersion = "0.0.3"`
	`20`	`+val apiVersion = "0.0.4"`
`21`	`21`
`22`	`22`
`23`	`23`	`group = "com.softwareplace"`