Modularize: separate the core SLF4J binding from the optional handlers

README.md

@@ -14,10 +14,14 @@ repositories {
 and then declare a dependency inside a module:
 ```groovy
 dependencies {
-    compile('com.github.bright:slf4android:0.1.6'){
-      transitive = true
-    }
-    //other dependencies
+    // just SLF4J binding
+    implementation("com.github.bright.slf4android:slf4android:$slf4androidVersion")
+
+    // (optional) a handler for file logging 
+    implementation("com.github.bright.slf4android:slf4android-handler-file-log:$slf4androidVersion")
+
+    // (optional) a handler for notifying the developer in case of an error 
+    implementation("com.github.bright.slf4android:slf4android-handler-notify-developer:$slf4androidVersion")
 }
 ```
 As with any slf4j compatible implementation using slf4android looks like this:
@@ -77,7 +81,7 @@ Note that we remove a default logcat handler since Crashlytics will push message
 ### Logging to a file
 To print messages to a separate file just add:
 ```java
-FileLogHandlerConfiguration fileHandler = LoggerConfiguration.fileLogHandler(this);
+FileLogHandlerConfiguration fileHandler = FileLogHandlerConfiguration.create(this);
 LoggerConfiguration.configuration().addHandlerToRootLogger(fileHandler);
 String logFileName = fileHandler.getCurrentFileName();
 // logFileName contains full path to logged file
@@ -86,7 +90,7 @@ inside your custom `android.app.Application` `onCreate` method. This will create
 
 To change the location of log file you can use:
 ```java
-FileLogHandlerConfiguration fileHandler = LoggerConfiguration.fileLogHandler(this);
+FileLogHandlerConfiguration fileHandler = FileLogHandlerConfiguration.create(this);
 
 fileHandler.setFullFilePathPattern("/sdcard/your.package/my_log.%g.%u.log");
 

build.gradle

@@ -5,7 +5,7 @@ buildscript {
         google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.2.0'
+        classpath 'com.android.tools.build:gradle:8.4.0'
         //classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
     }
 }

core/.gitignore

@@ -0,0 +1 @@
+/build

core/build.gradle

@@ -0,0 +1,64 @@
+plugins {
+    id 'com.android.library'
+    id 'maven-publish'
+}
+
+android {
+    namespace 'pl.brightinventions.slf4android'
+    compileSdk 34
+
+    defaultConfig {
+        minSdk 14
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles "consumer-rules.pro"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    publishing {
+        singleVariant('release') {
+            withSourcesJar()
+        }
+    }
+
+    java {
+        toolchain {
+            languageVersion = JavaLanguageVersion.of(17)
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+dependencies {
+    api 'org.slf4j:slf4j-api:1.7.36'
+
+    testImplementation('junit:junit:4.13.2')
+    testImplementation 'org.hamcrest:hamcrest-core:1.3'
+    testImplementation 'org.hamcrest:hamcrest-library:1.3'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
+}
+
+publishing {
+    publications {
+        release(MavenPublication) {
+            groupId = 'com.github.bright.slf4android'
+            artifactId = 'slf4android'
+            version = '1.0'
+
+            afterEvaluate {
+                from components.release
+            }
+        }
+    }
+}

core/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

app/src/androidTest/java/pl/brightinventions/slf4android/androidTest/LoggerAdapterTests.java → core/src/androidTest/java/pl/brightinventions/slf4android/LoggerAdapterTests.java

@@ -1,4 +1,4 @@
-package pl.brightinventions.slf4android.androidTest;
+package pl.brightinventions.slf4android;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
@@ -13,9 +13,6 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
 
-import pl.brightinventions.slf4android.LogLevel;
-import pl.brightinventions.slf4android.LoggerConfiguration;
-
 public class LoggerAdapterTests {
 
     public static final String LOGGER_NAME = "ApplicationTest";
@@ -141,7 +138,7 @@ public void test_error_message_printed_when_level_is_set_to_debug() {
     @Test
     public void test_warning_message_printed_when_level_is_set_to_debug() {
         setLevelTo(LogLevel.DEBUG);
-        getLogger().error("new warning message with exception", new NullPointerException("Bad"));
+        getLogger().warn("new warning message with exception", new NullPointerException("Bad"));
         assertThat(getLastMessage(), containsString("new warning message with exception"));
     }
 }

core/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest />

app/src/main/java/pl/brightinventions/slf4android/HandlerFormatterCompiler.java → core/src/main/java/pl/brightinventions/slf4android/HandlerFormatterCompiler.java

@@ -3,7 +3,7 @@
 public class HandlerFormatterCompiler {
     private final LoggerPatternConfiguration configuration;
 
-    public HandlerFormatterCompiler(LoggerPatternConfiguration configuration) {
+    HandlerFormatterCompiler(LoggerPatternConfiguration configuration) {
         this.configuration = configuration;
     }
 

app/src/main/java/pl/brightinventions/slf4android/LogLevel.java → core/src/main/java/pl/brightinventions/slf4android/LogLevel.java

@@ -33,7 +33,7 @@ public boolean isSmallerOrEqualTo(Level level) {
     }
 
     /**
-     * Converts a {@link pl.brightinventions.slf4android.LogLevel} logging level into an Android one.
+     * Converts a {@link LogLevel} logging level into an Android one.
      *
      * @return The resulting Android logging level.
      */
@@ -42,9 +42,9 @@ public int getAndroidLevel() {
     }
 
     /**
-     * Converts a {@link pl.brightinventions.slf4android.LogLevel} logging level into a {@link java.util.logging.Level}.
+     * Converts a {@link LogLevel} logging level into a {@link Level}.
      *
-     * @return The resulting {@link java.util.logging.Level}.
+     * @return The resulting {@link Level}.
      */
     public Level getUtilLogLevel() {
         return utilLogLevel;