Change listener API

.github/CONTRIBUTING.md

@@ -1,22 +1,41 @@
 # Contributing
 
+## Prerequisites
+
+Install git pre-commit hook:
+
+```sh
+./gradlew build
+./gradlew installGitHooks
+```
+
+Pre-commit hook just formats code:
+
+- Kotlin files are formatted with Ktlint
+
+You can skip installing precomputes and format code in your IDE.
+
 ## Commit messages
+
 Before writing a commit message read [this article](https://chris.beams.io/posts/git-commit/).
 
 ## Build
+
 Before pushing any changes make sure project builds without errors with:
 
 ```
 ./gradlew build
 ```
 
 ## Unit tests
+
 This project uses [Kotest](https://kotest.io/) for testing.
 
 - please use the `Spec` suffix for new test classes
 - make sure tests clearly document new feature
 
 ## Validate changes locally
+
 Before submitting a pull request test your changes locally on a sample project.
 There are few ways for local testing:
 
@@ -25,6 +44,7 @@ There are few ways for local testing:
   via [`mavenLocal()`](https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:maven_local) repository
 
 ## Validating with snapshot release
+
 Snapshot release is triggered automatically after merge to the main branch.
 To use a released snapshot version make sure to register Sonatype snapshot repository in gradle with:
 
@@ -41,5 +61,6 @@ repositories {
 The snapshot version can be found in GitHub Action build log.
 
 ## Documentation
+
 If change adds new feature or modifies a new one
 update [documentation](https://github.com/coditory/klog/tree/master/samples).

build-logic/src/main/kotlin/build.git.gradle.kts

@@ -0,0 +1,11 @@
+require(project == rootProject) { "build.git is applicable to rootProject only" }
+
+tasks.register<Copy>("installGitHooks") {
+    inputs.files("scripts/git/pre-commit")
+    outputs.files(".git/hooks/pre-commit")
+    from("scripts/git") {
+        include("pre-commit")
+    }
+    into(".git/hooks")
+    fileMode = "755".toInt(8)
+}

build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     id("build.kotlin") apply false
     id("build.version")
+    id("build.git")
     alias(libs.plugins.kover)
     alias(libs.plugins.dokka)
     alias(libs.plugins.nexusPublish)

klog/src/main/kotlin/com/coditory/klog/EmittingKlogLogger.kt

@@ -79,31 +79,31 @@ internal class EmittingKlogLogger(
         event: LogEvent,
         async: Boolean,
     ) {
-        listener.onLogStart(event)
+        listener.onLogStarted(event)
         for (level in Level.higherLevelsOrEqual(event.level)) {
             for (stream in streams.getOrDefault(level, emptyList())) {
                 val emitted = stream.emit(event, async)
                 if (emitted && stream.stopOnMatch()) {
-                    listener.onLogEnd(event)
+                    listener.onLogEnded(event)
                     return
                 }
             }
         }
-        listener.onLogEnd(event)
+        listener.onLogEnded(event)
     }
 
     private suspend fun emitEventSuspending(event: LogEvent) {
-        listener.onLogStart(event)
+        listener.onLogStarted(event)
         for (level in Level.higherLevelsOrEqual(event.level)) {
             for (stream in streams.getOrDefault(level, emptyList())) {
                 val emitted = stream.emitSuspending(event)
                 if (emitted && stream.stopOnMatch()) {
-                    listener.onLogEnd(event)
+                    listener.onLogEnded(event)
                     return
                 }
             }
         }
-        listener.onLogEnd(event)
+        listener.onLogEnded(event)
     }
 
     private fun createEvent(

klog/src/main/kotlin/com/coditory/klog/LogListener.kt

@@ -3,55 +3,55 @@ package com.coditory.klog
 import com.coditory.klog.config.LogFilter
 
 interface LogListener {
-    fun onLogStart(event: LogEvent) {}
+    fun onLogStarted(event: LogEvent) {}
 
-    fun onLogEnd(event: LogEvent) {}
+    fun onLogEnded(event: LogEvent) {}
 
-    fun onStreamStart(
+    fun onStreamStarted(
         stream: LogStreamDescriptor,
         event: LogEvent,
     ) {
     }
 
-    fun onStreamEnd(
+    fun onStreamEnded(
         stream: LogStreamDescriptor,
         event: LogEvent,
     ) {
     }
 
-    fun onReceived(
+    fun onPublishStarted(
         publisher: LogPublisherDescriptor,
         event: LogEvent,
     ) {
     }
 
-    fun onReceived(
+    fun onPublishStarted(
         publisher: LogPublisherDescriptor,
         events: List<LogEvent>,
     ) {
     }
 
-    fun onDropped(
+    fun onPublishDropped(
         publisher: LogPublisherDescriptor,
         event: LogEvent,
         e: Throwable? = null,
     ) {
     }
 
-    fun onDropped(
+    fun onPublishDropped(
         publisher: LogPublisherDescriptor,
         events: List<LogEvent>,
         e: Throwable? = null,
     ) {
     }
 
-    fun onPublished(
+    fun onPublishEnded(
         publisher: LogPublisherDescriptor,
         event: LogEvent,
     ) {
     }
 
-    fun onPublished(
+    fun onPublishEnded(
         publisher: LogPublisherDescriptor,
         events: List<LogEvent>,
     ) {

klog/src/main/kotlin/com/coditory/klog/LogStream.kt

@@ -25,7 +25,7 @@ internal class LogStream(
         async: Boolean = true,
     ): Boolean {
         if (filter.matches(event.level, event.logger)) {
-            listener.onStreamStart(descriptor, event)
+            listener.onStreamStarted(descriptor, event)
             val eventWithPriority = setupPriority(event)
             for (publisher in publishers) {
                 if (async) {
@@ -34,20 +34,20 @@ internal class LogStream(
                     publisher.publishBlocking(eventWithPriority)
                 }
             }
-            listener.onStreamEnd(descriptor, event)
+            listener.onStreamEnded(descriptor, event)
             return stopOnMatch
         }
         return false
     }
 
     suspend fun emitSuspending(event: LogEvent): Boolean {
         if (filter.matches(event.level, event.logger)) {
-            listener.onStreamStart(descriptor, event)
+            listener.onStreamStarted(descriptor, event)
             val eventWithPriority = setupPriority(event)
             for (publisher in publishers) {
                 publisher.publishSuspending(eventWithPriority)
             }
-            listener.onStreamEnd(descriptor, event)
+            listener.onStreamEnded(descriptor, event)
             return stopOnMatch
         }
         return false

klog/src/main/kotlin/com/coditory/klog/publish/BlockingLogSink.kt

@@ -20,24 +20,24 @@ internal class BlockingLogSink(
     }
 
     override fun publishBlocking(event: LogEvent) {
-        listener.onReceived(descriptor, event)
+        listener.onPublishStarted(descriptor, event)
         try {
             publisher.publishBlocking(event)
-            listener.onPublished(descriptor, event)
+            listener.onPublishEnded(descriptor, event)
         } catch (e: Throwable) {
             klogErrLogger.logDropped(e)
-            listener.onDropped(descriptor, event, e)
+            listener.onPublishDropped(descriptor, event, e)
         }
     }
 
     override suspend fun publishSuspending(event: LogEvent) {
-        listener.onReceived(descriptor, event)
+        listener.onPublishStarted(descriptor, event)
         try {
             publisher.publishSuspending(event)
-            listener.onPublished(descriptor, event)
+            listener.onPublishEnded(descriptor, event)
         } catch (e: Throwable) {
             klogErrLogger.logDropped(e)
-            listener.onDropped(descriptor, event, e)
+            listener.onPublishDropped(descriptor, event, e)
         }
     }
 

klog/src/main/kotlin/com/coditory/klog/publish/LogPublisherListener.kt

@@ -12,12 +12,14 @@ internal interface LogPublisherListener {
     fun dropped(
         event: LogEvent,
         e: Throwable? = null,
-    ) {}
+    ) {
+    }
 
     fun dropped(
         events: List<LogEvent>,
         e: Throwable? = null,
-    ) {}
+    ) {
+    }
 
     fun published(event: LogEvent) {}
 
@@ -32,25 +34,25 @@ internal interface LogPublisherListener {
         ): LogPublisherListener {
             return object : LogPublisherListener {
                 override fun published(event: LogEvent) {
-                    listener.onPublished(publisher, event)
+                    listener.onPublishEnded(publisher, event)
                 }
 
                 override fun published(events: List<LogEvent>) {
-                    listener.onPublished(publisher, events)
+                    listener.onPublishEnded(publisher, events)
                 }
 
                 override fun dropped(
                     event: LogEvent,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, event, e)
+                    listener.onPublishDropped(publisher, event, e)
                 }
 
                 override fun dropped(
                     events: List<LogEvent>,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, events, e)
+                    listener.onPublishDropped(publisher, events, e)
                 }
             }
         }
@@ -64,14 +66,14 @@ internal interface LogPublisherListener {
                     event: LogEvent,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, event, e)
+                    listener.onPublishDropped(publisher, event, e)
                 }
 
                 override fun dropped(
                     events: List<LogEvent>,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, events, e)
+                    listener.onPublishDropped(publisher, events, e)
                 }
             }
         }
@@ -82,25 +84,25 @@ internal interface LogPublisherListener {
         ): LogPublisherListener {
             return object : LogPublisherListener {
                 override fun received(event: LogEvent) {
-                    listener.onReceived(publisher, event)
+                    listener.onPublishStarted(publisher, event)
                 }
 
                 override fun received(events: List<LogEvent>) {
-                    listener.onReceived(publisher, events)
+                    listener.onPublishStarted(publisher, events)
                 }
 
                 override fun dropped(
                     event: LogEvent,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, event, e)
+                    listener.onPublishDropped(publisher, event, e)
                 }
 
                 override fun dropped(
                     events: List<LogEvent>,
                     e: Throwable?,
                 ) {
-                    listener.onDropped(publisher, events, e)
+                    listener.onPublishDropped(publisher, events, e)
                 }
             }
         }