Merge branch 'master' into load-jupyter-from-core

Author: Jolanrensen

.gitignore

@@ -9,3 +9,6 @@
 build
 .ipynb_checkpoints
 local.properties
+
+# macOS
+.DS_Store

README.md

@@ -2,7 +2,7 @@
 [![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![Kotlin component beta stability](https://img.shields.io/badge/project-beta-kotlin.svg?colorA=555555&colorB=DB3683&label=&logo=kotlin&logoColor=ffffff&logoWidth=10)](https://kotlinlang.org/docs/components-stability.html)
 [![Kotlin](https://img.shields.io/badge/kotlin-2.0.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
-[![Dynamic XML Badge](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Forg%2Fjetbrains%2Fkotlinx%2Fdataframe%2Fmaven-metadata.xml&query=%2F%2Fversion%5Bnot%28contains%28text%28%29%2C%22dev%22%29%29%20and%20not%28text%28%29%3D%221727%22%29%20%5D%5Blast%28%29%5D&label=Release%20version)](https://search.maven.org/artifact/org.jetbrains.kotlinx/dataframe)
+[![Dynamic XML Badge](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Forg%2Fjetbrains%2Fkotlinx%2Fdataframe%2Fmaven-metadata.xml&query=%2F%2Fversion%5Bnot%28contains%28text%28%29%2C%22dev%22%29%29%5D%5Blast%28%29%5D&label=Release%20version)](https://search.maven.org/artifact/org.jetbrains.kotlinx/dataframe)
 [![Dynamic XML Badge](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Forg%2Fjetbrains%2Fkotlinx%2Fdataframe%2Fmaven-metadata.xml&query=%2F%2Fversion%5Bcontains%28text%28%29%2C%22dev%22%29%5D%5Blast%28%29%5D&label=Dev%20version&color=yellow
 )](https://search.maven.org/artifact/org.jetbrains.kotlinx/dataframe)
 [![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)

build.gradle.kts

@@ -158,7 +158,7 @@ val modulesUsingJava11 = with(projects) {
         dataframeGeoJupyter,
         examples.ideaExamples.titanic,
         examples.ideaExamples.unsupportedDataSources,
-        tests,
+        samples,
         plugins.dataframeGradlePlugin,
     )
 }.map { it.path }

core/README.md

@@ -10,15 +10,29 @@ At the moment, these integrations are still part of the `:core` module:
 - (deprecated) csv/tsv
 - html
 
-### Korro code samples
+### KoDEx
+
+The code you're working on needs to be edited in [src](src), but the KDocs are processed by
+[KoDEx](https://github.com/Jolanrensen/kodex) when the project is published (or the task
+is run manually). The generated sources with adjusted KDocs will be overwritten
+in [generated-sources](generated-sources).
+See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more information.
+
+KDocs can also be exported to HTML, for them to be reused on the website.
+Elements annotated with `@ExportAsHtml` will have their generated content be copied over to
+[docs/StardustDocs/resources/snippets/kdocs](../docs/StardustDocs/resources/snippets/kdocs).
+
+### ~~Korro~~ (NOTE: This is being moved to [:samples](../samples))
+
+> [Should be removed and moved to `:samples` module](https://github.com/Kotlin/dataframe/issues/898).
+
+Tests in this module contain code samples used for import into documentation 
+using [Korro](https://github.com/devcrocod/korro).
 
-Code samples for the documentation website reside
-in [core/.../test/.../samples/api](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples that depend solely on `dataframe-core`),
-and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
-and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
-by [Korro](https://github.com/devcrocod/korro).
 
-### ~~Explainer dataframes~~ NOTE: This is being moved to [tests](../tests)
+### ~~Explainer dataframes~~ (NOTE: This is being moved to [:samples](../samples))
+
+> [Should be removed and migrated to SampleHelper](https://github.com/Kotlin/dataframe/issues/898).
 
 Aside from code samples, `@TransformDataFrameExpressions` annotated test functions also generate sample
 dataframe HTML files that can be used as iFrames on the documentation website.
@@ -31,15 +45,3 @@ retrieves the intermediate DataFrame expressions thanks to our "explainer" compi
 We can also generate "normal" DataFrame samples for the website. This can be done using the
 [OtherSamples class](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt). Generated
 HTML files will be stored in [docs/StardustDocs/resources/snippets/manual](../docs/StardustDocs/resources/snippets/manual).
-
-### KoDEx
-
-The code you're working on needs to be edited in [src](src), but the KDocs are processed by
-[KoDEx](https://github.com/Jolanrensen/kodex) when the project is published (or the task
-is run manually). The generated sources with adjusted KDocs will be overwritten
-in [generated-sources](generated-sources).
-See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more information.
-
-KDocs can also be exported to HTML, for them to be reused on the website.
-Elements annotated with `@ExportAsHtml` will have their generated content be copied over to
-[docs/StardustDocs/resources/snippets/kdocs](../docs/StardustDocs/resources/snippets/kdocs).

core/api/core.api

@@ -4502,6 +4502,7 @@ public final class org/jetbrains/kotlinx/dataframe/api/TypeConversionsKt {
 	public static final fun toColumnOf (Lorg/jetbrains/kotlinx/dataframe/columns/ColumnPath;)Lorg/jetbrains/kotlinx/dataframe/columns/ColumnAccessor;
 	public static final fun toDataFrame (Lorg/jetbrains/kotlinx/dataframe/DataRow;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
 	public static final fun toDataFrame (Lorg/jetbrains/kotlinx/dataframe/columns/BaseColumn;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
+	public static final fun toDataRow (Ljava/util/Map;)Lorg/jetbrains/kotlinx/dataframe/DataRow;
 	public static final fun toDoubleArray (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)[D
 	public static final fun toFloatArray (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)[F
 	public static final fun toFrameColumn (Ljava/lang/Iterable;Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/columns/FrameColumn;
@@ -6581,8 +6582,6 @@ public final class org/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords : j
 	public static final field EXTERNAL Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
 	public static final field FINAL Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
 	public static final field FUN Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
-	public static final field HEADER Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
-	public static final field IMPL Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
 	public static final field IN Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
 	public static final field INFIX Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
 	public static final field INLINE Lorg/jetbrains/kotlinx/dataframe/keywords/ModifierKeywords;
@@ -6636,8 +6635,6 @@ public final class org/jetbrains/kotlinx/dataframe/keywords/SoftKeywords : java/
 	public static final field FINAL Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
 	public static final field FINALLY Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
 	public static final field GET Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
-	public static final field HEADER Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
-	public static final field IMPL Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
 	public static final field IMPORT Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
 	public static final field INFIX Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;
 	public static final field INIT Lorg/jetbrains/kotlinx/dataframe/keywords/SoftKeywords;

core/build.gradle.kts

@@ -5,7 +5,6 @@ import nl.jolanrensen.kodex.gradle.creatingRunKodexTask
 import org.gradle.jvm.tasks.Jar
 import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-import xyz.ronella.gradle.plugin.simple.git.task.GitTask
 
 plugins {
     with(libs.plugins) {
@@ -16,7 +15,6 @@ plugins {
 //        alias(kover)
         alias(ktlint)
         alias(kodex)
-        alias(simpleGit)
         alias(buildconfig)
         alias(binary.compatibility.validator)
 
@@ -152,23 +150,13 @@ val clearSamplesOutputs by tasks.registering {
     }
 }
 
-val addSamplesToGit by tasks.registering(GitTask::class, fun GitTask.() {
-    directory = file(".")
-    command = "add"
-    args = listOf("-A", "../docs/StardustDocs/resources/snippets")
-})
-
 val copySamplesOutputs = tasks.register<JavaExec>("copySamplesOutputs") {
     group = "documentation"
     mainClass = "org.jetbrains.kotlinx.dataframe.explainer.SampleAggregatorKt"
 
     dependsOn(clearSamplesOutputs)
     dependsOn(samplesTest)
     classpath = sourceSets.test.get().runtimeClasspath
-
-    doLast {
-        addSamplesToGit.get().executeCommand()
-    }
 }
 
 tasks.withType<KorroTask> {

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnReferenceApi.kt

@@ -4,26 +4,37 @@ import org.jetbrains.kotlinx.dataframe.DataColumn
 import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
 import org.jetbrains.kotlinx.dataframe.columns.ValueColumn
 import org.jetbrains.kotlinx.dataframe.impl.asList
+import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
 import kotlin.reflect.typeOf
 
 internal val ColumnReference<*>.name: String get() = name()
 
+@Suppress("DEPRECATION_ERROR")
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public inline fun <reified T> ColumnReference<T>.withValues(vararg values: T): ValueColumn<T> =
     withValues(values.asIterable())
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public inline fun <reified T> ColumnReference<T>.withValues(values: Iterable<T>): ValueColumn<T> =
     DataColumn.createValueColumn(name(), values.asList(), typeOf<T>())
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public infix fun <C : Comparable<C>> ColumnReference<C>.gt(value: C): ColumnReference<Boolean> = map { it > value }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public infix fun <C : Comparable<C>> ColumnReference<C>.lt(value: C): ColumnReference<Boolean> = map { it < value }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public infix fun <C> ColumnReference<C>.eq(value: C): ColumnReference<Boolean> = map { it == value }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public infix fun <C> ColumnReference<C>.neq(value: C): ColumnReference<Boolean> = map { it != value }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public fun ColumnReference<String?>.length(): ColumnReference<Int> = map { it?.length ?: 0 }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public fun ColumnReference<String?>.lowercase(): ColumnReference<String?> = map { it?.lowercase() }
 
+@Deprecated(DEPRECATED_ACCESS_API, level = DeprecationLevel.ERROR)
 public fun ColumnReference<String?>.uppercase(): ColumnReference<String?> = map { it?.uppercase() }

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/add.kt

@@ -320,8 +320,10 @@ public class AddDsl<T>(
         add(dsl.columns.toColumnGroup(name))
     }
 
+    @Interpretable("AddDslAddGroup")
     public fun group(body: AddDsl<T>.() -> Unit): AddGroup<T> = AddGroup(body)
 
+    @Interpretable("AddDslAddGroupInto")
     public infix fun AddGroup<T>.into(groupName: String): Unit = group(groupName, body)
 
     @Deprecated(DEPRECATED_ACCESS_API)

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/any.kt

@@ -2,18 +2,51 @@ package org.jetbrains.kotlinx.dataframe.api
 
 import org.jetbrains.kotlinx.dataframe.DataColumn
 import org.jetbrains.kotlinx.dataframe.DataFrame
+import org.jetbrains.kotlinx.dataframe.DataRow
 import org.jetbrains.kotlinx.dataframe.Predicate
 import org.jetbrains.kotlinx.dataframe.RowFilter
 import org.jetbrains.kotlinx.dataframe.columns.values
 
 // region DataColumn
 
+/**
+ * Returns `true` if at least one element in this [DataColumn] satisfies the given [predicate].
+ *
+ * This is a convenience alias that delegates to [Iterable.any] on the column's [values].
+ *
+ * @param predicate A lambda function that takes a value from the column
+ * and returns `true` if it matches the condition.
+ * @return `true` if at least one element matches the [predicate], `false` otherwise.
+ * @see [DataColumn.all]
+ * @see [DataColumn.filter]
+ * @see [DataColumn.count]
+ */
 public fun <T> DataColumn<T>.any(predicate: Predicate<T>): Boolean = values.any(predicate)
 
 // endregion
 
 // region DataFrame
 
+/**
+ * Returns `true` if at least one row in this [DataFrame] satisfies the given [predicate].
+ *
+ * The [predicate] is a [RowFilter][org.jetbrains.kotlinx.dataframe.RowFilter] — a lambda that receives each [DataRow][org.jetbrains.kotlinx.dataframe.DataRow] as both `this` and `it`
+ * and is expected to return a [Boolean] value.
+ *
+ * It allows you to define conditions using the row's values directly,
+ * including through [extension properties][org.jetbrains.kotlinx.dataframe.documentation.ExtensionPropertiesAPIDocs] for convenient and type-safe access.
+ *
+ * ### Example
+ * ```kotlin
+ * // Check if there is at least one row where "age" is greater than 18
+ * val hasAdults = df.any { age > 18 }
+ * ```
+ *
+ * @param predicate A [RowFilter] lambda that takes a [DataRow] (as both `this` and `it`)
+ * and returns `true` if the row should be considered a match.
+ * @return `true` if at least one row satisfies the [predicate], `false` otherwise.
+ * @see [DataFrame.all]
+ */
 public inline fun <T> DataFrame<T>.any(predicate: RowFilter<T>): Boolean = rows().any { predicate(it, it) }
 
 // endregion

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/asIterable.kt

@@ -4,6 +4,11 @@ import org.jetbrains.kotlinx.dataframe.DataColumn
 
 // region DataColumn
 
+/**
+ * Returns an [Iterable] over the values of this [DataColumn].
+ *
+ * @see [asSequence]
+ */
 public fun <T> DataColumn<T>.asIterable(): Iterable<T> = values()
 
 // endregion