New Log Methods

* Added `Logger#debug` method
* Added `Logger#severe(String, Exception)` method

Author: Francisco Solis

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.2 - Snapshot
+* Added `Logger#debug` method
+* Added `Logger#severe(String, Exception)` method
+
 ## v0.2.1 - Snapshot
 * Updated Dependencies
 

build.gradle

@@ -1,13 +1,13 @@
 import org.apache.tools.ant.filters.ReplaceTokens
 
 plugins {
-    id 'org.jetbrains.kotlin.jvm' version '1.6.10'
+    id 'org.jetbrains.kotlin.jvm' version '1.6.21'
     id 'maven-publish'
     id 'com.github.johnrengelman.shadow' version '7.1.2'
-    id 'org.jetbrains.dokka' version '1.6.0'
+    id 'org.jetbrains.dokka' version '1.6.21'
 }
 
-def projectVersion = (System.getenv("VERSION") ?: '0.2.1-SNAPSHOT').replaceFirst("v", "").replace('/', '')
+def projectVersion = (System.getenv("VERSION") ?: '0.2.2-SNAPSHOT').replaceFirst("v", "").replace('/', '')
 
 group 'xyz.theprogramsrc'
 version projectVersion
@@ -26,13 +26,13 @@ repositories {
 }
 
 dependencies {
-    compileOnly 'org.jetbrains.kotlin:kotlin-stdlib:1.6.10'
+    implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.6.21'
     compileOnly 'org.spigotmc:spigot-api:1.18.1-R0.1-SNAPSHOT'
     compileOnly 'net.md-5:bungeecord-api:1.18-R0.1-SNAPSHOT'
-    compileOnly 'xyz.theprogramsrc:simplecoreapi:0.1.12-SNAPSHOT'
+    compileOnly 'xyz.theprogramsrc:simplecoreapi:0.3.5-SNAPSHOT'
 
-    compileOnly 'org.apache.logging.log4j:log4j-api:2.17.1'
-    compileOnly 'org.apache.logging.log4j:log4j-core:2.17.1'
+    compileOnly 'org.apache.logging.log4j:log4j-api:2.17.2'
+    compileOnly 'org.apache.logging.log4j:log4j-core:2.17.2'
 
     testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
 }

src/main/kotlin/xyz/theprogramsrc/loggingmodule/Logger.kt

@@ -6,6 +6,13 @@ import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
 import java.util.logging.Level
 
+/**
+ * Represents a logger for the logging module.
+ * @param name The name of the logger
+ *
+ * How's this different from other loggers?
+ * This logger will store the data in isolated folders
+ */
 class Logger(name: String) {
 
     private val javaLogger = java.util.logging.Logger.getLogger(name)
@@ -31,35 +38,81 @@ class Logger(name: String) {
         logFile.appendText("[$now] [${level.name}] $message\n")
     }
 
+    /**
+     * Logs a message at the [Level.INFO] level.
+     * @param message The message to log
+     */
     fun info(message: String){
         javaLogger.info(message)
         writeToFile(Level.INFO, message)
     }
 
+    /**
+     * Logs a message at the [Level.WARNING] level.
+     * @param message The message to log
+     */
     fun warning(message: String){
         javaLogger.warning(message)
         writeToFile(Level.WARNING, message)
     }
 
+    /**
+     * Logs a message at the [Level.SEVERE] level.
+     * @param message The message to log
+     */
     fun severe(message: String){
         javaLogger.severe(message)
         writeToFile(Level.SEVERE, message)
     }
 
+    /**
+     * Logs a message at the [Level.SEVERE] level with an exception.
+     * @param message The message to log
+     * @param exception The throwable to log
+     */
+    fun severe(message: String, exception: Exception) {
+        val newMessage = "$message\n${Utils.getStackTrace(exception)}"
+        javaLogger.severe(newMessage)
+        writeToFile(Level.SEVERE, newMessage)
+    }
+
+    /**
+     * Logs a message at the [Level.FINE] level.
+     * @param message The message to log
+     */
     fun fine(message: String){
         javaLogger.fine(message)
         writeToFile(Level.FINE, message)
     }
 
+    /**
+     * Logs a message at the [Level.FINER] level.
+     * @param message The message to log
+     */
     fun finer(message: String){
         javaLogger.finer(message)
         writeToFile(Level.FINER, message)
     }
 
+    /**
+     * Logs a message at the [Level.FINEST] level.
+     * @param message The message to log
+     */
     fun finest(message: String){
         javaLogger.finest(message)
         writeToFile(Level.FINEST, message)
     }
 
+    /**
+     * Logs a message at the [Level.ALL] level with the prefix '[DEBUG]'.
+     * @param message The message to log
+     */
+    fun debug(message: String) {
+        writeToFile(Level.ALL, "[DEBUG] $message")
+        if(File(".loggingmodule_debug").exists()) {
+            javaLogger.log(Level.ALL, "[DEBUG] $message")
+        }
+    }
+
 
 }

src/main/kotlin/xyz/theprogramsrc/loggingmodule/Utils.kt

@@ -0,0 +1,16 @@
+package xyz.theprogramsrc.loggingmodule
+
+import java.io.PrintWriter
+import java.io.StringWriter
+
+object Utils  {
+
+    private val cache = mutableMapOf<String, String>()
+
+    fun getStackTrace(e: Exception): String = cache.computeIfAbsent(e.toString()) {
+        val sw = StringWriter()
+        e.printStackTrace(PrintWriter(sw))
+        sw.toString()
+    }
+
+}