filterBy deprecated

Author: AndreiKingsley

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/filter.kt

@@ -24,6 +24,8 @@ import org.jetbrains.kotlinx.dataframe.impl.columns.TransformableColumnSet
 import org.jetbrains.kotlinx.dataframe.impl.getTrueIndices
 import org.jetbrains.kotlinx.dataframe.indices
 import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
+import org.jetbrains.kotlinx.dataframe.util.FILTER_BY
+import org.jetbrains.kotlinx.dataframe.util.FILTER_BY_REPLACE
 import kotlin.reflect.KProperty
 
 // region DataColumn
@@ -55,7 +57,6 @@ public inline fun <T> DataColumn<T>.filter(predicate: Predicate<T>): DataColumn<
  * For more information, see: {@include [DocumentationUrls.Filter]}
  *
  * See also:
- *  - [filterBy], which filters rows based on the values in a given [Boolean] column.
  *  - [drop][DataFrame.drop], which drops rows based on values within the row.
  *  - [distinct][DataFrame.distinct], which filters rows with duplicated values.
  *
@@ -109,6 +110,7 @@ internal interface FilterByDocs
  *               Only rows where the value in this column is `true` will be included.
  * @return A new [DataFrame] containing only the rows where the selected column is `true`.
  */
+@Deprecated(message = FILTER_BY, replaceWith = ReplaceWith(FILTER_BY_REPLACE), level = DeprecationLevel.ERROR)
 public fun <T> DataFrame<T>.filterBy(column: ColumnSelector<T, Boolean>): DataFrame<T> =
     getRows(getColumn(column).toList().getTrueIndices())
 
@@ -126,12 +128,16 @@ public fun <T> DataFrame<T>.filterBy(column: ColumnSelector<T, Boolean>): DataFr
  *               Only rows where the value in this column is `true` will be included.
  * @return A new [DataFrame] containing only the rows where the specified column is `true`.
  */
+@Suppress("DEPRECATION_ERROR")
+@Deprecated(message = FILTER_BY, replaceWith = ReplaceWith(FILTER_BY_REPLACE), level = DeprecationLevel.ERROR)
 public fun <T> DataFrame<T>.filterBy(column: String): DataFrame<T> = filterBy { column.toColumnOf() }
 
+@Suppress("DEPRECATION_ERROR")
 @Deprecated(DEPRECATED_ACCESS_API)
 @AccessApiOverload
 public fun <T> DataFrame<T>.filterBy(column: ColumnReference<Boolean>): DataFrame<T> = filterBy { column }
 
+@Suppress("DEPRECATION_ERROR")
 @Deprecated(DEPRECATED_ACCESS_API)
 @AccessApiOverload
 public fun <T> DataFrame<T>.filterBy(column: KProperty<Boolean>): DataFrame<T> = filterBy { column.toColumnAccessor() }

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt

@@ -110,6 +110,9 @@ internal const val CONVERT_TO_URL_REPLACE = "convertToUrl()"
 internal const val TO_URL = "This function is replaced by `toUrl()`. $MESSAGE_1_0"
 internal const val TO_URL_REPLACE = "toUrl()"
 
+internal const val FILTER_BY = "This function  is deprecated in favor of `filter { }`. $MESSAGE_1_0"
+internal const val FILTER_BY_REPLACE = "filter { column }"
+
 // endregion
 
 // region WARNING in 1.0, ERROR in 1.1

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Access.kt

@@ -20,7 +20,6 @@ import org.jetbrains.kotlinx.dataframe.api.dropNulls
 import org.jetbrains.kotlinx.dataframe.api.dropWhile
 import org.jetbrains.kotlinx.dataframe.api.fillNaNs
 import org.jetbrains.kotlinx.dataframe.api.filter
-import org.jetbrains.kotlinx.dataframe.api.filterBy
 import org.jetbrains.kotlinx.dataframe.api.first
 import org.jetbrains.kotlinx.dataframe.api.forEach
 import org.jetbrains.kotlinx.dataframe.api.gather
@@ -324,22 +323,6 @@ class Access : TestBase() {
         // SampleEnd
     }
 
-    @Test
-    @TransformDataFrameExpressions
-    fun filterBy_properties() {
-        // SampleStart
-        df.filterBy { isHappy }
-        // SampleEnd
-    }
-
-    @Test
-    @TransformDataFrameExpressions
-    fun filterBy_strings() {
-        // SampleStart
-        df.filterBy("isHappy")
-        // SampleEnd
-    }
-
     @Test
     @TransformDataFrameExpressions
     fun dropWhere_properties() {

docs/StardustDocs/topics/filter.md

@@ -22,28 +22,3 @@ df.filter { "age"<Int>() > 18 && "name"["firstName"]<String>().startsWith("A") }
 </tab></tabs>
 <inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Access.filter.html" width="100%"/>
 <!---END-->
-
-## filterBy
-
-Returns [`DataFrame`](DataFrame.md) with rows that have value `true` in the given column of type `Boolean`.
-
-See [column selectors](ColumnSelectors.md) for how to select the column for this operation.
-
-<!---FUN filterBy-->
-<tabs>
-<tab title="Properties">
-
-```kotlin
-df.filterBy { isHappy }
-```
-
-</tab>
-<tab title="Strings">
-
-```kotlin
-df.filterBy("isHappy")
-```
-
-</tab></tabs>
-<inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Access.filterBy.html" width="100%"/>
-<!---END-->