Apply Spotless for Kotlin (#3272)

This commit also applies its formatting.
micrometer-metrics · Jul 7, 2022 · e83d8c7 · e83d8c7
1 parent 13f388d
commit e83d8c7
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 38 deletions.
diff --git a/build.gradle b/build.gradle
@@ -19,6 +19,7 @@ buildscript {
         classpath 'me.champeau.gradle:japicmp-gradle-plugin:0.4.0'
         classpath 'de.undercouch:gradle-download-task:5.0.2'
         classpath 'io.spring.javaformat:spring-javaformat-gradle-plugin:0.0.34'
+        classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.8.0'
 
         constraints {
             classpath('org.ow2.asm:asm:7.3.1') {
@@ -48,6 +49,7 @@ allprojects {
 subprojects {
     apply plugin: 'signing'
     apply plugin: 'io.spring.javaformat'
+    apply plugin: 'com.diffplug.spotless'
 
     if (project.name != 'micrometer-bom') {
         if (project.name.contains('samples') || project.name.contains('benchmarks')) {
@@ -184,6 +186,12 @@ subprojects {
             exclude '**/*.json' // comments not supported
         }
 
+        spotless {
+            kotlin {
+                ktlint().editorConfigOverride([disabled_rules: "no-wildcard-imports"])
+            }
+        }
+
         // Publish resolved versions.
         plugins.withId('maven-publish') {
             sourceCompatibility = JavaVersion.VERSION_1_8

diff --git a/buildscript-gradle.lockfile b/buildscript-gradle.lockfile
diff --git a/...ore/instrument/kotlin/asContextElement.kt → ...ore/instrument/kotlin/AsContextElement.kt b/...ore/instrument/kotlin/asContextElement.kt → ...ore/instrument/kotlin/AsContextElement.kt
@@ -28,7 +28,7 @@ import kotlin.coroutines.CoroutineContext
  * @since 1.10.0
  */
 fun ObservationRegistry.asContextElement(): CoroutineContext {
-	return KotlinObservationContextElement(this, ContextRegistry.getInstance())
+    return KotlinObservationContextElement(this, ContextRegistry.getInstance())
 }
 
 /**
@@ -38,9 +38,9 @@ fun ObservationRegistry.asContextElement(): CoroutineContext {
  * @since 1.10.0
  */
 fun CoroutineContext.currentObservation(): Observation? {
-	val element = get(KotlinObservationContextElement.KEY)
-	if (element is KotlinObservationContextElement) {
-		return element.currentObservation
-	}
-	return null
+    val element = get(KotlinObservationContextElement.KEY)
+    if (element is KotlinObservationContextElement) {
+        return element.currentObservation
+    }
+    return null
 }
diff --git a/...eter-core/src/test/kotlin/io/micrometer/core/instrument/kotlin/AsContextElementKtTests.kt b/...eter-core/src/test/kotlin/io/micrometer/core/instrument/kotlin/AsContextElementKtTests.kt
@@ -25,41 +25,40 @@ import org.junit.jupiter.api.Test
 
 internal class AsContextElementKtTests {
 
-	@Test
-	fun `should return current observation from context`(): Unit = runBlocking {
-		val observationRegistry = ObservationRegistry.create()
-		observationRegistry.observationConfig().observationHandler { true }
-		val nextObservation = Observation.start("name", observationRegistry)
-		val inScope = nextObservation.openScope()
-		var observationInGlobalScopeLaunch: Observation? = null
-		var observationInGlobalScopeAsync: Observation? = null
-		val asContextElement = observationRegistry.asContextElement()
+    @Test
+    fun `should return current observation from context`(): Unit = runBlocking {
+        val observationRegistry = ObservationRegistry.create()
+        observationRegistry.observationConfig().observationHandler { true }
+        val nextObservation = Observation.start("name", observationRegistry)
+        val inScope = nextObservation.openScope()
+        var observationInGlobalScopeLaunch: Observation? = null
+        var observationInGlobalScopeAsync: Observation? = null
+        val asContextElement = observationRegistry.asContextElement()
 
-		@OptIn(DelicateCoroutinesApi::class)
-		GlobalScope.launch(asContextElement) {
-			observationInGlobalScopeLaunch = coroutineContext.currentObservation()
-		}
-		@OptIn(DelicateCoroutinesApi::class)
-		GlobalScope.async(asContextElement) {
-			observationInGlobalScopeAsync = coroutineContext.currentObservation()
-		}.await()
+        @OptIn(DelicateCoroutinesApi::class)
+        GlobalScope.launch(asContextElement) {
+            observationInGlobalScopeLaunch = coroutineContext.currentObservation()
+        }
+        @OptIn(DelicateCoroutinesApi::class)
+        GlobalScope.async(asContextElement) {
+            observationInGlobalScopeAsync = coroutineContext.currentObservation()
+        }.await()
 
-		inScope.close();
+        inScope.close()
 
-		then(observationInGlobalScopeLaunch).isSameAs(nextObservation)
-		then(observationInGlobalScopeAsync).isSameAs(nextObservation)
-	}
+        then(observationInGlobalScopeLaunch).isSameAs(nextObservation)
+        then(observationInGlobalScopeAsync).isSameAs(nextObservation)
+    }
 
-	@Test
-	fun `should return observation from coroutine context when KotlinContextElement present`(): Unit = runBlocking {
-		val observationRegistry = ObservationRegistry.create()
-		observationRegistry.observationConfig().observationHandler { true }
-		val nextObservation = Observation.start("name", observationRegistry)
-		val inScope = nextObservation.openScope()
-		val element = KotlinObservationContextElement(observationRegistry, ContextRegistry.getInstance())
-
-		then(element.currentObservation()).isSameAs(nextObservation)
-		inScope.close()
-	}
+    @Test
+    fun `should return observation from coroutine context when KotlinContextElement present`(): Unit = runBlocking {
+        val observationRegistry = ObservationRegistry.create()
+        observationRegistry.observationConfig().observationHandler { true }
+        val nextObservation = Observation.start("name", observationRegistry)
+        val inScope = nextObservation.openScope()
+        val element = KotlinObservationContextElement(observationRegistry, ContextRegistry.getInstance())
 
+        then(element.currentObservation()).isSameAs(nextObservation)
+        inScope.close()
+    }
 }