Merge pull request #2 from philips77/fixes

Minor improvements

README.md

@@ -22,7 +22,7 @@ artifacts to your project and use `slf4j` like before:
 ```kotlin
 import com.sun.org.slf4j.internal.LoggerFactory
 
-public class YourClass {
+class YourClass {
     private val logger = LoggerFactory.getLogger(YourClass::class.java)
 
     fun yourMethod() {
@@ -49,12 +49,12 @@ Download [the latest AAR][4] or grab it via Maven:
 or Gradle Kotlin DSL:
 
 ```kotlin
-implementation("com.arcao:slf4j2-timber:1.0")
+implementation("uk.kulikov:slf4j2-timber:1.0")
 ```
 or Gradle Groovy:
 
 ```groovy
-implementation 'com.arcao:slf4j2-timber:1.0'
+implementation 'uk.kulikov:slf4j2-timber:1.0'
 ```
 
 > Note: `timber` and `slf4j-api` are the transitive dependencies of `slf4j2-timber`,

slf4j2-timber/build.gradle.kts

@@ -35,8 +35,9 @@ android {
 }
 
 dependencies {
-    implementation(libs.slf4j)
-    implementation(libs.timber)
+    // Transitive dependencies
+    api(libs.slf4j)
+    api(libs.timber)
 
     testImplementation(libs.festandroid)
     testImplementation(libs.festassert)

slf4j2-timber/src/main/kotlin/uk/kulikov/slf4j2/timber/TimberLoggerAdapter.kt

@@ -7,47 +7,46 @@ import timber.log.Timber
 /**
  *
  * A simple implementation that delegates all log requests to the Timber
- * logging facilities. Note that this logger does not support [org.slf4j.Marker].
+ * logging facilities.
+ *
+ * Note that this logger does not support [org.slf4j.Marker].
+ *
  * Methods taking marker data as parameter simply invoke the eponymous method
  * without the Marker argument, discarding any marker data in the process.
  *
- *
  * The logging levels specified for SLF4J can be almost directly mapped to
  * the logging method that exist in Timber. The following table
  * shows the mapping implemented by this logger.
  *
- * <table border="1">
- * <tr><th>**SLF4J******</th><th>**Timber**</th></tr>
- * <tr><td>TRACE</td><td>Timber.v(...)</td></tr>
- * <tr><td>DEBUG</td><td>Timber.d(...)</td></tr>
- * <tr><td>INFO</td><td>Timber.i(...)</td></tr>
- * <tr><td>WARN</td><td>Timber.w(...)</td></tr>
- * <tr><td>ERROR</td><td>Timber.e(...)</td></tr>
-</table> *
+ *    | **SLF4J** | **Timber**    |
+ *    | ----------| ------------- |
+ *    | TRACE     | Timber.v(...) |
+ *    | DEBUG     | Timber.d(...) |
+ *    | INFO      | Timber.i(...) |
+ *    | WARN      | Timber.w(...) |
+ *    | ERROR     | Timber.e(...) |
  *
  *
  * Use loggers as usual:
  *
- *  *
- * Declare a logger<br></br>
- * `private static final Logger logger = LoggerFactory.getLogger(MyClass.class);`
- *
- *  *
- * Invoke logging methods, e.g.,<br></br>
- * `logger.debug("Some log message. Details: {}", someObject);`<br></br>
- * `logger.debug("Some log message with varargs. Details: {}, {}, {}", someObject1, someObject2, someObject3);`
- *
- *
- *
+ *  * Declare a logger:
+ *    ```java
+ *    private static final Logger logger = LoggerFactory.getLogger(MyClass.class);
+ *    ```
  *
+ *  * Invoke logging methods, e.g.:
+ *    ```java
+ *    logger.debug("Some log message. Details: {}", someObject);
+ *    logger.debug("Some log message with varargs. Details: {}, {}, {}", someObject1, someObject2, someObject3);
+ *    ```
  *
  * Logger instances created using the LoggerFactory are named either according to the name
  * or the fully qualified class name of the class given as a parameter.
- * Each logger name will be used as the tag for Timber if Timber has planted [timber.log.Timber.TaggedTree].
+ * Each logger name will be used as the tag for Timber if Timber has planted [timber.log.Timber.Tree].
  * If tag contains also class package, it will be removed (same way like in [timber.log.Timber.DebugTree]).
  *
- *
- * @author Martin Sloup <arcao></arcao>@arcao.com>
+ * @author Nikita Kulikov <a href="https://kulikov.uk">kulikov.uk</a>
+ * @author Martin Sloup <a href="https://arcao.com">arcao.com</a>
  */
 internal class TimberLoggerAdapter(tag: String?) : MarkerIgnoringBase() {
     private enum class LogType {
@@ -58,10 +57,6 @@ internal class TimberLoggerAdapter(tag: String?) : MarkerIgnoringBase() {
         ERROR
     }
 
-    /**
-     * Package access allows only [AndroidLoggerFactory] to instantiate
-     * SimpleLogger instances.
-     */
     init {
         this.name = tag
     }

slf4j2-timber/src/main/kotlin/uk/kulikov/slf4j2/timber/TimberLoggerFactory.kt

@@ -10,7 +10,8 @@ import java.util.regex.Pattern
  * TimberLoggerFactory is an implementation of [ILoggerFactory] returning
  * the appropriately named [org.slf4j.LoggerFactory] instance.
  *
- * @author Martin Sloup <arcao></arcao>@arcao.com>
+ * @author Nikita Kulikov <a href="https://kulikov.uk">kulikov.uk</a>
+ * @author Martin Sloup <a href="https://arcao.com">arcao.com</a>
  */
 class TimberLoggerFactory : ILoggerFactory {
     private val loggerMap: ConcurrentMap<String, Logger> = ConcurrentHashMap()

slf4j2-timber/src/main/kotlin/uk/kulikov/slf4j2/timber/TimberLoggerServiceProvider.kt

@@ -11,7 +11,8 @@ import org.slf4j.spi.SLF4JServiceProvider
  * The binding of [org.slf4j.LoggerFactory] class with an actual instance of
  * [ILoggerFactory] is performed using information returned by this class.
  *
- * @author Martin Sloup <arcao></arcao>@arcao.com>
+ * @author Nikita Kulikov <a href="https://kulikov.uk">kulikov.uk</a>
+ * @author Martin Sloup <a href="https://arcao.com">arcao.com</a>
  */
 class TimberLoggerServiceProvider : SLF4JServiceProvider {
     private val loggerFactory: ILoggerFactory = TimberLoggerFactory()

slf4j2-timber/src/test/kotlin/uk/kulikov/slf4j2/timber/TimberLoggerAdapterTest.kt

@@ -1,7 +1,7 @@
 package uk.kulikov.slf4j2.timber
 
+import android.util.Log
 import org.fest.assertions.api.Assertions.assertThat
-import java.util.List
 import org.junit.After
 import org.junit.Before
 import org.junit.Test
@@ -13,7 +13,6 @@ import org.robolectric.shadows.ShadowLog.LogItem
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import timber.log.Timber
-import android.util.Log
 
 @RunWith(RobolectricTestRunner::class)
 @Config(manifest = Config.NONE)