Merge pull request #10 from qoomon/patch-1
feat: static loggers initialisation
diff --git a/log4j-api-kotlin/src/main/kotlin/org/apache/logging/log4j/kotlin/LoggingFactory.kt b/log4j-api-kotlin/src/main/kotlin/org/apache/logging/log4j/kotlin/LoggingFactory.kt
index d4ee57c..5548476 100644
--- a/log4j-api-kotlin/src/main/kotlin/org/apache/logging/log4j/kotlin/LoggingFactory.kt
+++ b/log4j-api-kotlin/src/main/kotlin/org/apache/logging/log4j/kotlin/LoggingFactory.kt
@@ -36,6 +36,24 @@
fun logger(name: String): KotlinLogger = KotlinLogger(LogManager.getContext(false).getLogger(name))
/**
+ * Returns normalized context name.
+ * * Execution within a class/object will return the full qualified class/object name,
+ * in case of nested classes/objects the most outer class/object is used.
+ * * Execution outside of any class/object will return the full qualified file name without `.kt suffix.
+ *
+ * Usage: `val LOG = logger(contextName {})`
+ * @param context should always be `{}`
+ * @return normalized context name
+ */
+fun contextName(context: () -> Unit) = with(context::class.java.name) {
+ when {
+ contains("Kt$") -> substringBefore("Kt$")
+ contains("$") -> substringBefore("$")
+ else -> this
+ }
+}
+
+/**
* @see [logger]
*/
@Deprecated("Replaced with logger(name)", replaceWith = ReplaceWith("logger"), level = DeprecationLevel.WARNING)
diff --git a/log4j-api-kotlin/src/test/kotlin/org.apache.logging.log4j.kotlin/LoggerContextNameTest.kt b/log4j-api-kotlin/src/test/kotlin/org.apache.logging.log4j.kotlin/LoggerContextNameTest.kt
new file mode 100644
index 0000000..519f2a6
--- /dev/null
+++ b/log4j-api-kotlin/src/test/kotlin/org.apache.logging.log4j.kotlin/LoggerContextNameTest.kt
@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache license, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the license for the specific language governing permissions and
+ * limitations under the license.
+ */
+package org.apache.logging.log4j.kotlin
+
+import org.junit.Test
+import kotlin.test.assertEquals
+
+private val CONTEXT_NAME = contextName {}
+
+private class FooClass {
+ val contextName = contextName {}
+
+ companion object {
+ val CONTEXT_NAME = contextName {}
+ }
+}
+
+class LoggerContextNameTest {
+
+ @Test
+ fun `contextName on top level return full qualified file name`() {
+ assertEquals("org.apache.logging.log4j.kotlin.LoggerContextNameTest", CONTEXT_NAME)
+ }
+
+ @Test
+ fun `contextName within class return full qualified class name`() {
+ assertEquals(FooClass::class.java.name, FooClass().contextName)
+ }
+
+ @Test
+ fun `contextName within companion object return full qualified class name of enclosing class`() {
+ assertEquals(FooClass::class.java.name, FooClass.CONTEXT_NAME)
+ }
+}
