Split openapi support in two modules, to avoid adding dependencies needed only for code-generation to project runtime classpath

Author: koperagen

build.gradle.kts

@@ -53,7 +53,7 @@ dependencies {
  api(project(":core"))
  api(project(":dataframe-arrow"))
  api(project(":dataframe-excel"))
- api(project(":dataframe-openapi"))
+ api(project(":dataframe-openapi-runtime"))
  api(project(":dataframe-jdbc"))
 
  kover(project(":core"))

dataframe-openapi-runtime/build.gradle.kts

@@ -0,0 +1,29 @@
+plugins {
+ alias(libs.plugins.kotlin.jvm)
+ alias(libs.plugins.ktlint)
+ alias(libs.plugins.publisher)
+ alias(libs.plugins.jupyter.api)
+}
+
+group = "org.jetbrains.kotlinx"
+
+repositories {
+ mavenCentral()
+}
+
+dependencies {
+ api(project(":core"))
+}
+
+kotlinPublications {
+ publication {
+ publicationName = "dataframeOpenApiRuntime"
+ artifactId = project.name
+ description = "OpenAPI support for Kotlin Dataframe"
+ packageName = artifactId
+ }
+}
+
+kotlin {
+ explicitApi()
+}

dataframe-openapi-runtime/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/AdditionalProperty.kt

@@ -0,0 +1,19 @@
+package org.jetbrains.kotlinx.dataframe.io
+
+import org.jetbrains.kotlinx.dataframe.annotations.DataSchema
+import org.jetbrains.kotlinx.dataframe.api.KeyValueProperty
+
+/**
+ * A [DataSchema] interface can implement this if it represents a map-like data schema (so key: value).
+ * Used in OpenAPI to represent objects with 'just' additionalProperties of a certain type.
+ */
+public interface AdditionalProperty<T> : KeyValueProperty<T> {
+
+ /** Key of the property. */
+ override val key: String
+
+ /** Value of the property. */
+ override val value: T
+
+ public companion object
+}

dataframe-openapi/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/convertDataRowsWithOpenApi.kt renamed to dataframe-openapi-runtime/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/convertDataRowsWithOpenApi.kt

@@ -21,6 +21,7 @@ repositories {
 
 dependencies {
  api(project(":core"))
+ api(project(":dataframe-openapi-runtime"))
 
  implementation(libs.sl4j)
  implementation(libs.kotlinLogging)
@@ -42,7 +43,7 @@ kotlinPublications {
  publication {
  publicationName = "dataframeOpenApi"
  artifactId = project.name
- description = "OpenAPI support for Kotlin Dataframe"
+ description = "OpenAPI code generation support for Kotlin Dataframe"
  packageName = artifactId
  }
 }

dataframe-openapi/build.gradle.kts

@@ -1,47 +1,30 @@
 package org.jetbrains.kotlinx.dataframe.io
 
-import org.jetbrains.kotlinx.dataframe.annotations.DataSchema
-import org.jetbrains.kotlinx.dataframe.api.KeyValueProperty
 import org.jetbrains.kotlinx.dataframe.codeGen.FieldType
 import org.jetbrains.kotlinx.dataframe.codeGen.Marker
 import org.jetbrains.kotlinx.dataframe.codeGen.MarkerVisibility
 import org.jetbrains.kotlinx.dataframe.codeGen.ValidFieldName
 
-/**
- * A [DataSchema] interface can implement this if it represents a map-like data schema (so key: value).
- * Used in OpenAPI to represent objects with 'just' additionalProperties of a certain type.
- */
-public interface AdditionalProperty<T> : KeyValueProperty<T> {
-
- /** Key of the property. */
- override val key: String
-
- /** Value of the property. */
- override val value: T
-
- public companion object {
- internal fun getMarker(typeArguments: List<String>) =
- Marker(
- name = AdditionalProperty::class.qualifiedName!!,
- isOpen = false,
- fields = listOf(
- generatedFieldOf(
- fieldName = ValidFieldName.of(AdditionalProperty<*>::key.name),
- columnName = AdditionalProperty<*>::key.name,
- overrides = false,
- fieldType = FieldType.ValueFieldType(String::class.qualifiedName!!),
- ),
- generatedFieldOf(
- fieldName = ValidFieldName.of(AdditionalProperty<*>::`value`.name),
- columnName = AdditionalProperty<*>::`value`.name,
- overrides = false,
- fieldType = FieldType.ValueFieldType(Any::class.qualifiedName!! + "?"),
- ),
- ),
- superMarkers = emptyList(),
- visibility = MarkerVisibility.EXPLICIT_PUBLIC,
- typeParameters = emptyList(),
- typeArguments = typeArguments,
- )
- }
-}
+internal fun AdditionalProperty.Companion.getMarker(typeArguments: List<String>) =
+ Marker(
+ name = AdditionalProperty::class.qualifiedName!!,
+ isOpen = false,
+ fields = listOf(
+ generatedFieldOf(
+ fieldName = ValidFieldName.of(AdditionalProperty<*>::key.name),
+ columnName = AdditionalProperty<*>::key.name,
+ overrides = false,
+ fieldType = FieldType.ValueFieldType(String::class.qualifiedName!!),
+ ),
+ generatedFieldOf(
+ fieldName = ValidFieldName.of(AdditionalProperty<*>::`value`.name),
+ columnName = AdditionalProperty<*>::`value`.name,
+ overrides = false,
+ fieldType = FieldType.ValueFieldType(Any::class.qualifiedName!! + "?"),
+ ),
+ ),
+ superMarkers = emptyList(),
+ visibility = MarkerVisibility.EXPLICIT_PUBLIC,
+ typeParameters = emptyList(),
+ typeArguments = typeArguments,
+ )

dataframe-openapi/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/AdditionalProperty.kt

@@ -117,6 +117,7 @@ val integrationTestTask = task<Test>("integrationTest") {
  dependsOn(":dataframe-excel:publishToMavenLocal")
  dependsOn(":dataframe-jdbc:publishToMavenLocal")
  dependsOn(":dataframe-openapi:publishToMavenLocal")
+ dependsOn(":dataframe-openapi-runtime:publishToMavenLocal")
  dependsOn(":publishApiPublicationToMavenLocal")
  dependsOn(":dataframe-arrow:publishDataframeArrowPublicationToMavenLocal")
  dependsOn(":dataframe-excel:publishDataframeExcelPublicationToMavenLocal")

plugins/dataframe-gradle-plugin/build.gradle.kts

@@ -41,3 +41,4 @@ plugins {
 }
 include("dataframe-excel")
 include("core")
+include("dataframe-openapi-runtime")