compiler plugin example fixes

Author: AndreiKingsley

examples/kotlin-dataframe-plugin-example/.editorconfig

@@ -0,0 +1,38 @@
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+max_line_length = 120
+
+[*.json]
+indent_size = 2
+
+[{*.yaml,*.yml}]
+indent_size = 2
+
+[*.ipynb]
+insert_final_newline = false
+
+[*.{kt,kts}]
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+
+#  Disable wildcard imports entirely
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = unset
+
+ktlint_code_style = ktlint_official
+ktlint_experimental = enabled
+ktlint_standard_filename = disabled
+ktlint_standard_no-empty-first-line-in-class-body = disabled
+ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_standard_chain-method-continuation = disabled
+ktlint_ignore_back_ticked_identifier = true
+ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_when-entry-bracing = disabled
+
+[{*/build/**/*,**/*keywords*/**,**/*.Generated.kt,**/*$Extensions.kt}]
+ktlint = disabled

examples/kotlin-dataframe-plugin-example/README.md

@@ -7,5 +7,4 @@ An IntelliJ IDEA project demonstrating the use of the
 > See [build.gradle.kts](build.gradle.kts) for details.
 
 For proper functionality in IntelliJ IDEA requires version 2025.2 or higher 
-(Currently available only in [IntelliJ IDEA EAP](https://www.jetbrains.com/idea/nextversion/?_gl=1*1ojxffu*_gcl_au*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*_ga*MTE0ODQ1MzY3OS4xNzM4OTY1NzM3*_ga_9J976DJZ68*czE3NDkyMTM4MzkkbzE5OCRnMSR0MTc0OTIxMzg0MSRqNTgkbDAkaDA.)
-).
+(Currently available only in [IntelliJ IDEA EAP](https://www.jetbrains.com/idea/nextversion/?_gl=1*1ojxffu*_gcl_au*MTk5NzUwODYzOS4xNzQ2NzkxMDMz*_ga*MTE0ODQ1MzY3OS4xNzM4OTY1NzM3*_ga_9J976DJZ68*czE3NDkyMTM4MzkkbzE5OCRnMSR0MTc0OTIxMzg0MSRqNTgkbDAkaDA.)).

examples/kotlin-dataframe-plugin-example/build.gradle.kts

@@ -1,4 +1,9 @@
+import org.gradle.kotlin.dsl.assign
+import org.gradle.kotlin.dsl.configure
+import org.jlleitschuh.gradle.ktlint.KtlintExtension
+
 plugins {
+    id("org.jlleitschuh.gradle.ktlint") version "12.3.0"
     kotlin("jvm") version "2.2.20-dev-3524"
     kotlin("plugin.dataframe") version "2.2.20-dev-3524"
 }
@@ -11,7 +16,6 @@ repositories {
     mavenCentral()
 }
 
-
 dependencies {
     implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2")
     testImplementation(kotlin("test"))
@@ -22,4 +26,9 @@ tasks.test {
 }
 kotlin {
     jvmToolchain(11)
-}
+}
+
+configure<KtlintExtension> {
+    version = "1.6.0"
+    // rules are set up through .editorconfig
+}

examples/kotlin-dataframe-plugin-example/gradle.properties

@@ -1,2 +1,4 @@
 kotlin.code.style=official
+# Disabling incremental compilation will no longer be necessary
+# when https://youtrack.jetbrains.com/issue/KT-66735 is resolved.
 kotlin.incremental=false

examples/kotlin-dataframe-plugin-example/settings.gradle.kts

@@ -8,4 +8,4 @@ pluginManagement {
 plugins {
     id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
 }
-rootProject.name = "kdf_plugin_example"
+rootProject.name = "kotlin-dataframe-plugin-example"

examples/kotlin-dataframe-plugin-example/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/plugin/Main.kt

@@ -1,38 +1,37 @@
 package org.jetbrains.kotlinx.dataframe.examples.plugin
 
 import org.jetbrains.kotlinx.dataframe.DataFrame
-import org.jetbrains.kotlinx.dataframe.annotations.ColumnName
 import org.jetbrains.kotlinx.dataframe.annotations.DataSchema
-import org.jetbrains.kotlinx.dataframe.api.*
+import org.jetbrains.kotlinx.dataframe.api.add
+import org.jetbrains.kotlinx.dataframe.api.convert
+import org.jetbrains.kotlinx.dataframe.api.convertTo
+import org.jetbrains.kotlinx.dataframe.api.filter
+import org.jetbrains.kotlinx.dataframe.api.into
+import org.jetbrains.kotlinx.dataframe.api.rename
+import org.jetbrains.kotlinx.dataframe.api.renameToCamelCase
+import org.jetbrains.kotlinx.dataframe.api.with
 import org.jetbrains.kotlinx.dataframe.io.readCsv
 import org.jetbrains.kotlinx.dataframe.io.writeCsv
 import java.net.URL
 
-/*
- * Declare data schema for the DataFrame from jetbrains_repositories.csv.
- */
+// Declare data schema for the DataFrame from jetbrains_repositories.csv.
 @DataSchema
 data class Repositories(
-    @ColumnName("full_name")
-    val fullName: String,
-    @ColumnName("html_url")
-    val htmlUrl: URL,
-    @ColumnName("stargazers_count")
-    val stargazersCount: Int,
+    val full_name: String,
+    val html_url: URL,
+    val stargazers_count: Int,
     val topics: String,
-    val watchers: Int
+    val watchers: Int,
 )
 
-/*
- * Define kinds of repositories:
- */
+// Define kinds of repositories.
 enum class RepoKind {
-    Kotlin, IntelliJ, Other
+    Kotlin,
+    IntelliJ,
+    Other,
 }
 
-/*
- * A rule for determining the kind of repository based on its name and topics.
- */
+// A rule for determining the kind of repository based on its name and topics.
 fun getKind(fullName: String, topics: List<String>): RepoKind {
     fun checkContains(name: String) = name in topics || fullName.lowercase().contains(name)
 
@@ -43,30 +42,45 @@ fun getKind(fullName: String, topics: List<String>): RepoKind {
     }
 }
 
-
 fun main() {
     val repos = DataFrame
         // Read DataFrame from the CSV file.
         .readCsv("https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv")
         // And convert it to match the `Repositories` schema.
         .convertTo<Repositories>()
 
-    // Rename columns to CamelCase
-    val reposUpdated = repos.renameToCamelCase()
+    // With Compiler Plugin, the DataFrame schema changes immediately after each operation:
+    // For example, if a new column is added or the old one is renamed (or its type is changed)
+    // during the operation, you can use the new name immediately in the following operations:
+    repos
+        // Add a new "name" column...
+        .add("name") { full_name.substringAfterLast("/") }
+        // ... and now we can use "name" extension in DataFrame operations, such as `filter`.
+        .filter { name.lowercase().contains("kotlin") }
+
+    // Let's update the DataFrame with some operations using these features.
+    val reposUpdated = repos
+        // Rename columns to CamelCase.
+        // Note that after that, in the following operations, extension properties will have
+        // new names corresponding to the column names.
+        .renameToCamelCase()
+        // Rename "stargazersCount" column to "stars".
+        .rename { stargazersCount }.into("stars")
+        // And we can immediately use the updated name in the filtering.
+        .filter { stars > 50 }
         // Convert values in the "topic" column (which were `String` initially)
         // to the list of topics.
         .convert { topics }.with {
-            val inner = it.removePrefix("[").removeSuffix("]")
+            val inner = it.removeSurrounding("[", "]")
             if (inner.isEmpty()) emptyList() else inner.split(',').map(String::trim)
         }
-        // Filter rows, keeping only repos with more than 150 stars.
-        .filter { it.stargazersCount > 150 }
+        // Now "topics" is a `List<String>` column.
         // Add a new column with the number of topics.
         .add("topicCount") { topics.size }
         // Add a new column with the kind of repository.
         .add("kind") { getKind(fullName, topics) }
 
-    // Write an updated DataFrame to a CSV file.
+    // Write the updated DataFrame to a CSV file.
     reposUpdated.writeCsv("jetbrains_repositories_new.csv")
 
     // TODO: Add Kandy Plot

settings.gradle.kts

@@ -11,6 +11,7 @@ include("plugins:dataframe-gradle-plugin")
 include("plugins:symbol-processor")
 include("plugins:expressions-converter")
 include("plugins:kotlin-dataframe")
+include("plugins:public-api-modifier")
 include("tests")
 include("dataframe-json")
 include("dataframe-arrow")
@@ -19,12 +20,16 @@ include("dataframe-excel")
 include("dataframe-jdbc")
 include("dataframe-csv")
 include("dataframe-jupyter")
+include("dataframe-geo")
+include("dataframe-openapi-generator")
 include("core")
+include("dataframe-compiler-plugin-core")
 
 include("examples:idea-examples:titanic")
 include("examples:idea-examples:movies")
 include("examples:idea-examples:youtube")
 include("examples:idea-examples:json")
+includeBuild("examples/kotlin-dataframe-plugin-example")
 
 val jupyterApiTCRepo: String by settings
 
@@ -44,11 +49,3 @@ pluginManagement {
 plugins {
     id("org.gradle.toolchains.foojay-resolver-convention") version "0.5.0"
 }
-include("dataframe-excel")
-include("core")
-include("dataframe-openapi-generator")
-include("dataframe-geo")
-include("plugins:public-api-modifier")
-include("dataframe-compiler-plugin-core")
-
-includeBuild("examples/kotlin-dataframe-plugin-example")