spotless

CHANGELOG.md

@@ -1,3 +1,11 @@
+# v1.1.2
+## Build Versions
+* JVM: 11
+* Gradle: 7.2
+* Kotlin: 1.5.31
+## Changes
+* Typesafe versions of `KON` and `KObject` to improve extensibility and allow restricting value types.
+
 # v1.1.1
 ## Changes
 * New safe array setter `"key".to[1]` that works with single int arrays

build.gradle.kts

@@ -15,38 +15,31 @@ gradleEnterprise {
 }
 
 kotlin {
-  sourceSets {
-    commonMain {
-      dependencies {
-        api(project(":lib:kon-core"))
-      }
-    }
-  }
-  val serializationTargets = setOf(
-    linuxX64(),
-    linuxArm64(),
-    linuxArm32Hfp(),
-    iosArm32(),
-    iosArm64(),
-    iosX64(),
-    iosSimulatorArm64(),
-    watchosArm32(),
-    watchosArm64(),
-    watchosX86(),
-    watchosX64(),
-    watchosSimulatorArm64(),
-    tvosArm64(),
-    tvosX64(),
-    tvosSimulatorArm64(),
-    macosX64(),
-    macosArm64(),
-    mingwX86(),
-    mingwX64(),
-  )
-
+  sourceSets { commonMain { dependencies { api(project(":lib:kon-core")) } } }
+  val serializationTargets =
+      setOf(
+          linuxX64(),
+          linuxArm64(),
+          linuxArm32Hfp(),
+          iosArm32(),
+          iosArm64(),
+          iosX64(),
+          iosSimulatorArm64(),
+          watchosArm32(),
+          watchosArm64(),
+          watchosX86(),
+          watchosX64(),
+          watchosSimulatorArm64(),
+          tvosArm64(),
+          tvosX64(),
+          tvosSimulatorArm64(),
+          macosX64(),
+          macosArm64(),
+          mingwX86(),
+          mingwX64(),
+      )
+
   serializationTargets.map {
-    it.compilations["main"].defaultSourceSet.dependencies {
-      api(project(":lib:kon-serialization"))
-    }
+    it.compilations["main"].defaultSourceSet.dependencies { api(project(":lib:kon-serialization")) }
   }
 }

buildSrc/build.gradle.kts

@@ -13,7 +13,7 @@ dependencies {
   implementation("com.android.library:com.android.library.gradle.plugin:_")
   implementation("org.jetbrains.dokka:dokka-gradle-plugin:_")
   implementation("org.jetbrains.kotlin:kotlin-serialization:_")
-  implementation("com.ncorti.ktfmt.gradle:plugin:_")
+  implementation("com.diffplug.spotless:spotless-plugin-gradle:_")
   implementation("io.github.gradle-nexus:publish-plugin:_")
   implementation("dev.petuska:klip-gradle-plugin:_")
   implementation("com.github.jakemarsden:git-hooks-gradle-plugin:_")

buildSrc/src/main/kotlin/plugin.common.gradle.kts

@@ -2,7 +2,7 @@ import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompile
 import org.jetbrains.kotlin.gradle.tasks.KotlinTest
 
 plugins {
-  id("com.ncorti.ktfmt.gradle")
+  id("com.diffplug.spotless")
   idea
 }
 
@@ -18,15 +18,14 @@ idea {
   }
 }
 
-ktfmt {
-//  googleStyle()
+spotless {
+  kotlin { ktfmt() }
+  kotlinGradle { ktfmt() }
 }
 
 tasks {
-  withType<Test> {
-    useJUnitPlatform()
-  }
-
+  withType<Test> { useJUnitPlatform() }
+
   afterEvaluate {
     if (tasks.findByName("compile") == null) {
       register("compile") {

buildSrc/src/main/kotlin/plugin.git-hooks.gradle.kts

@@ -5,8 +5,8 @@ plugins {
 gitHooks {
   setHooks(
     mapOf(
-      "pre-commit" to "ktfmtFormat",
-      "pre-push" to "ktfmtCheck"
+      "pre-commit" to "spotlessApply",
+      "pre-push" to "spotlessCheck"
     )
   )
 }

lib/kon-core/src/commonMain/kotlin/KObject.kt

@@ -3,20 +3,10 @@ package dev.petuska.kon
 import dev.petuska.kon.util.toJson
 
 /** A [MutableMap] to represent a JSON object. */
-public typealias KON = MutableMap<String, Any?>
+public typealias KON = TypedKON<Any?>
 
 /** A wrapper around [MutableMap] to represent a JSON object */
-public interface KObject : KON {
-  /**
-   * Adds a field
-   * @receiver field name
-   * @param value field value
-   */
-  @KONSetterDsl
-  public infix fun String.to(value: Any?) {
-    this@KObject[this] = value
-  }
-
+public interface KObject : TypedKObject<Any?>, KON {
   /**
    * Adds an object field
    * @receiver field name

lib/kon-core/src/commonMain/kotlin/TypedKObject.kt

@@ -0,0 +1,33 @@
+package dev.petuska.kon
+
+import dev.petuska.kon.util.toJson
+
+/** A [MutableMap] to represent a JSON object. */
+public typealias TypedKON<V> = MutableMap<String, V>
+
+/** A wrapper around [MutableMap] to represent a JSON object */
+public interface TypedKObject<V> : TypedKON<V> {
+  /**
+   * Adds a field
+   * @receiver field name
+   * @param value field value
+   */
+  @KONSetterDsl
+  public infix fun String.to(value: V) {
+    this@TypedKObject[this] = value
+  }
+}
+
+/**
+ * Builds an object. Overrides [Any::toString] to return JSON object notation.
+ * @param obj object builder
+ */
+@KONBuilderDsl
+public inline fun <V> kobj(
+    base: TypedKON<V> = mutableMapOf(),
+    obj: TypedKObject<V>.() -> Unit = {}
+): TypedKObject<V> =
+    object : TypedKObject<V>, TypedKON<V> by base {
+          override fun toString(): String = toJson()
+        }
+        .apply(obj)

lib/kon-core/src/commonMain/kotlin/annotations.kt

@@ -1,7 +1,7 @@
 package dev.petuska.kon
 
 /** Marks DSLs with side effects that build and sets entities */
-@DslMarker @Retention(AnnotationRetention.SOURCE) public annotation class KONSetterDsl
+@DslMarker @Retention(AnnotationRetention.SOURCE) internal annotation class KONSetterDsl
 
 /** Marks DSLs with no side effects that build entities */
-@DslMarker @Retention(AnnotationRetention.SOURCE) public annotation class KONBuilderDsl
+@DslMarker @Retention(AnnotationRetention.SOURCE) internal annotation class KONBuilderDsl

lib/kon-serialization/build.gradle.kts

@@ -5,12 +5,4 @@ plugins {
 
 description = "KON interop with kotlinx-serialization"
 
-kotlin {
-  sourceSets {
-    commonMain {
-      dependencies {
-        api(project(":lib:kon-core"))
-      }
-    }
-  }
-}
+kotlin { sourceSets { commonMain { dependencies { api(project(":lib:kon-core")) } } } }

sandbox/build.gradle.kts

@@ -6,7 +6,6 @@ plugins {
 repositories {
   mavenCentral()
   google()
-  maven("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev")
 }
 
 description = "Local consumer sandbox"

settings.gradle.kts

@@ -4,12 +4,12 @@ plugins {
 }
 
 rootProject.name = "kon"
+
 include(":test")
+
 include(
-  ":lib:kon-core",
-  ":lib:kon-serialization",
+    ":lib:kon-core",
+    ":lib:kon-serialization",
 )
 
-refreshVersions {
-  extraArtifactVersionKeyRules(rootDir.resolve("versions.rules"))
-}
+refreshVersions { extraArtifactVersionKeyRules(rootDir.resolve("versions.rules")) }

test/build.gradle.kts

@@ -1,6 +1,4 @@
-plugins {
-  id("plugin.library-mpp")
-}
+plugins { id("plugin.library-mpp") }
 
 description = "Local test utilities"
 
@@ -14,28 +12,18 @@ kotlin {
         api("dev.petuska:klip:_")
       }
     }
-    named("jvmMain") {
-      dependencies {
-        api(kotlin("test-junit5"))
-      }
-    }
-    named("jsMain") {
-      dependencies {
-        api(kotlin("test-js"))
-      }
-    }
+    named("jvmMain") { dependencies { api(kotlin("test-junit5")) } }
+    named("jsMain") { dependencies { api(kotlin("test-js")) } }
   }
 
-  val targetsWithCoroutines = util.KotlinTargetDetails.values()
-    .filter(util.KotlinTargetDetails::hasCoroutines)
-    .map(util.KotlinTargetDetails::presetName)
+  val targetsWithCoroutines =
+      util.KotlinTargetDetails.values()
+          .filter(util.KotlinTargetDetails::hasCoroutines)
+          .map(util.KotlinTargetDetails::presetName)
 
-  targets.filter { it.preset?.name in targetsWithCoroutines }
-    .forEach {
-      it.compilations["main"].defaultSourceSet {
-        dependencies {
-          api("org.jetbrains.kotlinx:kotlinx-coroutines-core:_")
-        }
-      }
+  targets.filter { it.preset?.name in targetsWithCoroutines }.forEach {
+    it.compilations["main"].defaultSourceSet {
+      dependencies { api("org.jetbrains.kotlinx:kotlinx-coroutines-core:_") }
     }
+  }
 }

versions.properties

@@ -6,25 +6,14 @@
 ####
 #### suppress inspection "SpellCheckingInspection" for whole file
 #### suppress inspection "UnusedProperty" for whole file
-
 #======================================= Plugins ========================================
 plugin.android=7.0.3
-
-plugin.com.github.jakemarsden.git-hooks=0.0.2
-
+version.com.diffplug.spotless..spotless-plugin-gradle=5.17.0
 version.com.github.jakemarsden..git-hooks-gradle-plugin=0.0.2
-
-version.com.ncorti.ktfmt.gradle..plugin=0.7.0
-
 version.io.github.gradle-nexus..publish-plugin=1.1.0
-
 version.org.jetbrains.dokka..dokka-gradle-plugin=1.5.31
-
 #====================================== Libraries =======================================
- version.klip=0.2.2
-
+version.klip=0.2.2
 version.kotlinx.serialization=1.3.0
-
 version.kotlin=1.5.31
-
 version.kotlinx.coroutines=1.5.2