Merge pull request #324 from Kotlin/documentation-tables

Configure writerside to include tables

Author: koperagen

.github/workflows/main.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Build Writerside docs using Docker
-        uses: JetBrains/writerside-github-action@v3
+        uses: ./.github/writerside-build
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:

.github/writerside-build/Dockerfile

@@ -0,0 +1,10 @@
+# Container image that runs your code
+FROM registry.jetbrains.team/p/writerside/builder/writerside-builder:2.1.1256-p3333
+
+# Copies your code file from your action repository to the filesystem path `/` of the container
+COPY entrypoint.sh /entrypoint.sh
+
+RUN chmod +x /entrypoint.sh
+
+# Code file to execute when the docker container starts up (`entrypoint.sh`)
+ENTRYPOINT ["/entrypoint.sh"]

.github/writerside-build/action.yml

@@ -0,0 +1,6 @@
+name: Build Writerside docs using Docker
+description: Build Writerside documentation artifacts
+
+runs:
+    using: 'docker'
+    image: 'Dockerfile'

.github/writerside-build/entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+/opt/builder/bin/idea.sh helpbuilderinspect -source-dir . -product $PRODUCT --runner github -output-dir artifacts/ || true
+echo "Test existing of $ARTIFACT artifact"
+test -e artifacts/$ARTIFACT

core/build.gradle.kts

@@ -1,4 +1,5 @@
 import com.google.devtools.ksp.gradle.KspTaskJvm
+import com.google.devtools.ksp.gradle.KspTask
 import nl.jolanrensen.docProcessor.defaultProcessors.*
 import nl.jolanrensen.docProcessor.gradle.creatingProcessDocTask
 import org.gradle.jvm.tasks.Jar
@@ -33,9 +34,27 @@ repositories {
     maven(jupyterApiTCRepo)
 }
 
+kotlin.sourceSets {
+    main {
+        kotlin.srcDir("build/generated/ksp/main/kotlin/")
+    }
+    test {
+        kotlin.srcDir("build/generated/ksp/test/kotlin/")
+    }
+}
+
+sourceSets {
+    create("samples") {
+        kotlin.srcDir("src/test/kotlin")
+    }
+}
+
 dependencies {
+    val kotlinCompilerPluginClasspathSamples by configurations.getting
+
     api(libs.kotlin.reflect)
     implementation(libs.kotlin.stdlib)
+    kotlinCompilerPluginClasspathSamples(project(":plugins:expressions-converter"))
     implementation(libs.kotlin.stdlib.jdk8)
 
     api(libs.commonsCsv)
@@ -53,13 +72,69 @@ dependencies {
     testImplementation(libs.jsoup)
 }
 
-kotlin.sourceSets {
-    main {
-        kotlin.srcDir("build/generated/ksp/main/kotlin/")
+val samplesImplementation by configurations.getting {
+    extendsFrom(configurations.testImplementation.get())
+}
+
+val myKotlinCompileTask = tasks.named<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>("compileSamplesKotlin") {
+    friendPaths.from(sourceSets["main"].output.classesDirs)
+    source(sourceSets["test"].kotlin)
+    destinationDirectory.set(file("$buildDir/classes/testWithOutputs/kotlin"))
+}
+
+tasks.withType<KspTask> {
+    // "test" classpath is re-used, so repeated generation should be disabled
+    if (name == "kspSamplesKotlin") {
+        dependsOn("kspTestKotlin")
+        enabled = false
     }
-    test {
-        kotlin.srcDir("build/generated/ksp/test/kotlin/")
+}
+
+tasks.named("lintKotlinSamples") {
+    onlyIf { false }
+}
+
+val samplesTest = tasks.register<Test>("samplesTest") {
+    group = "Verification"
+    description = "Runs the custom tests."
+
+    dependsOn(myKotlinCompileTask)
+
+    doFirst {
+        delete {
+            delete(fileTree(File(buildDir, "dataframes")))
+        }
+    }
+
+    environment("DATAFRAME_SAVE_OUTPUTS", "")
+
+    filter {
+        includeTestsMatching("org.jetbrains.kotlinx.dataframe.samples.api.*")
     }
+
+    ignoreFailures = true
+
+    testClassesDirs = fileTree("$buildDir/classes/testWithOutputs/kotlin")
+    classpath = files("$buildDir/classes/testWithOutputs/kotlin") + configurations["samplesRuntimeClasspath"] + sourceSets["main"].runtimeClasspath
+}
+
+val clearSamplesOutputs by tasks.creating {
+    group = "documentation"
+
+    doFirst {
+        delete {
+            delete(fileTree(File(projectDir, "../docs/StardustDocs/snippets")))
+        }
+    }
+}
+
+val copySamplesOutputs = tasks.register<JavaExec>("copySamplesOutputs") {
+    group = "documentation"
+    mainClass.set("org.jetbrains.kotlinx.dataframe.explainer.SampleAggregatorKt")
+
+    dependsOn(samplesTest)
+    dependsOn(clearSamplesOutputs)
+    classpath = sourceSets.test.get().runtimeClasspath
 }
 
 val generatedSourcesFolderName = "generated-sources"
@@ -175,6 +250,7 @@ kotlinter {
         "filename",
         "comment-spacing",
         "curly-spacing",
+        "experimental:annotation-spacing"
     )
 }
 

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/html.kt

@@ -114,7 +114,7 @@ internal fun tableJs(columns: List<ColumnDataForJs>, id: Int, rootId: Int, nrow:
 }
 
 internal var tableInSessionId = 0
-internal val sessionId = (Random().nextInt() % 128) shl 24
+internal var sessionId = (Random().nextInt() % 128) shl 24
 internal fun nextTableId() = sessionId + (tableInSessionId++)
 
 internal fun AnyFrame.toHtmlData(
@@ -217,7 +217,11 @@ public fun <T> DataFrame<T>.toHTML(
  * Container for HTML page data in form of String
  * Can be used to compose rendered dataframe tables with additional HTML elements
  */
-public data class DataFrameHtmlData(val style: String = "", val body: String = "", val script: String = "") {
+public data class DataFrameHtmlData(
+    @Language("css") val style: String = "",
+    @Language("html", prefix = "<body>", suffix = "</body>") val body: String = "",
+    @Language("js") val script: String = ""
+) {
     @Language("html")
     override fun toString(): String = """
         <html>

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/Integration.kt

@@ -266,6 +266,7 @@ internal fun convertToDataFrame(dataframeLike: Any): AnyFrame =
         is PivotGroupBy<*> -> dataframeLike.frames()
         is ReducedPivotGroupBy<*> -> dataframeLike.values()
         is SplitWithTransform<*, *, *> -> dataframeLike.into()
+        is Split<*, *> -> dataframeLike.toDataFrame()
         is Merge<*, *, *> -> dataframeLike.into("merged")
         is Gather<*, *, *, *> -> dataframeLike.into("key", "value")
         is Update<*, *> -> dataframeLike.df