Skip to content

Bumped deprecations of startsWith and endsWith in CS DSL to Error #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2024
Merged

Bumped deprecations of startsWith and endsWith in CS DSL to Error #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 59 additions & 23 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnNameFilters.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
import org.jetbrains.kotlinx.dataframe.documentation.Indent
import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
import org.jetbrains.kotlinx.dataframe.impl.columns.TransformableColumnSet
import org.jetbrains.kotlinx.dataframe.util.COL_ENDS_WITH
import org.jetbrains.kotlinx.dataframe.util.COL_ENDS_WITH_REPLACE
import org.jetbrains.kotlinx.dataframe.util.COL_STARTS_WITH
import org.jetbrains.kotlinx.dataframe.util.COL_STARTS_WITH_REPLACE
import org.jetbrains.kotlinx.dataframe.util.ENDS_WITH
import org.jetbrains.kotlinx.dataframe.util.ENDS_WITH_REPLACE
import org.jetbrains.kotlinx.dataframe.util.STARTS_WITH
import org.jetbrains.kotlinx.dataframe.util.STARTS_WITH_REPLACE
import kotlin.reflect.KProperty

// region ColumnsSelectionDsl
Expand Down Expand Up @@ -339,17 +347,6 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
@ExcludeFromSources
private interface CommonNameStartsWithDocs

@Deprecated("Use nameStartsWith instead", ReplaceWith("this.nameStartsWith(prefix)"))
public fun <C> ColumnSet<C>.startsWith(prefix: CharSequence): TransformableColumnSet<C> = nameStartsWith(prefix)

@Deprecated("Use nameStartsWith instead", ReplaceWith("this.nameStartsWith(prefix)"))
public fun ColumnsSelectionDsl<*>.startsWith(prefix: CharSequence): TransformableColumnSet<*> =
nameStartsWith(prefix)

@Deprecated("Use colsNameStartsWith instead", ReplaceWith("this.colsNameStartsWith(prefix)"))
public fun SingleColumn<DataRow<*>>.startsWith(prefix: CharSequence): TransformableColumnSet<*> =
colsNameStartsWith(prefix)

/**
* @include [CommonNameStartsWithDocs]
* @set [CommonNameStartsEndsDocs.ExampleArg]
Expand Down Expand Up @@ -436,18 +433,6 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
@ExcludeFromSources
private interface CommonNameEndsWithDocs

@Deprecated("Use nameEndsWith instead", ReplaceWith("this.nameEndsWith(suffix)"))
@Suppress("UNCHECKED_CAST")
public fun <C> ColumnSet<C>.endsWith(suffix: CharSequence): TransformableColumnSet<C> =
colsInternal { it.name.endsWith(suffix) } as TransformableColumnSet<C>

@Deprecated("Use nameEndsWith instead", ReplaceWith("this.nameEndsWith(suffix)"))
public fun ColumnsSelectionDsl<*>.endsWith(suffix: CharSequence): TransformableColumnSet<*> = nameEndsWith(suffix)

@Deprecated("Use colsNameEndsWith instead", ReplaceWith("this.colsNameEndsWith(suffix)"))
public fun SingleColumn<DataRow<*>>.endsWith(suffix: CharSequence): TransformableColumnSet<*> =
this.ensureIsColumnGroup().colsInternal { it.name.endsWith(suffix) }

/**
* @include [CommonNameEndsWithDocs]
* @set [CommonNameStartsEndsDocs.ExampleArg]
Expand Down Expand Up @@ -514,6 +499,57 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
): TransformableColumnSet<*> = columnGroup(this).colsNameEndsWith(suffix, ignoreCase)

// endregion

// region deprecations

@Deprecated(
message = STARTS_WITH,
replaceWith = ReplaceWith(STARTS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
public fun <C> ColumnSet<C>.startsWith(prefix: CharSequence): TransformableColumnSet<C> = nameStartsWith(prefix)

@Deprecated(
message = STARTS_WITH,
replaceWith = ReplaceWith(STARTS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
public fun ColumnsSelectionDsl<*>.startsWith(prefix: CharSequence): TransformableColumnSet<*> =
nameStartsWith(prefix)

@Deprecated(
message = COL_STARTS_WITH,
replaceWith = ReplaceWith(COL_STARTS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
public fun SingleColumn<DataRow<*>>.startsWith(prefix: CharSequence): TransformableColumnSet<*> =
colsNameStartsWith(prefix)

@Deprecated(
message = ENDS_WITH,
replaceWith = ReplaceWith(ENDS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
@Suppress("UNCHECKED_CAST")
public fun <C> ColumnSet<C>.endsWith(suffix: CharSequence): TransformableColumnSet<C> =
colsInternal { it.name.endsWith(suffix) } as TransformableColumnSet<C>

@Deprecated(
message = ENDS_WITH,
replaceWith = ReplaceWith(ENDS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
public fun ColumnsSelectionDsl<*>.endsWith(suffix: CharSequence): TransformableColumnSet<*> = nameEndsWith(suffix)

@Deprecated(
message = COL_ENDS_WITH,
replaceWith = ReplaceWith(COL_ENDS_WITH_REPLACE),
level = DeprecationLevel.ERROR,
)
public fun SingleColumn<DataRow<*>>.endsWith(suffix: CharSequence): TransformableColumnSet<*> =
this.ensureIsColumnGroup().colsInternal { it.name.endsWith(suffix) }

// endregion
}

// endregion
16 changes: 16 additions & 0 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ package org.jetbrains.kotlinx.dataframe.util
* Level.ERROR -> Remove
*/

// region WARNING in 0.14, ERROR in 0.15

private const val MESSAGE_0_15 = "Will be ERROR in 0.15."

internal const val STARTS_WITH = "Use nameStartsWith() instead. $MESSAGE_0_15"
internal const val STARTS_WITH_REPLACE = "this.nameStartsWith(prefix)"

internal const val COL_STARTS_WITH = "Use colsNameStartsWith() instead. $MESSAGE_0_15"
internal const val COL_STARTS_WITH_REPLACE = "this.colsNameStartsWith(prefix)"

internal const val ENDS_WITH = "Use nameEndsWith() instead. $MESSAGE_0_15"
internal const val ENDS_WITH_REPLACE = "this.nameEndsWith(suffix)"

internal const val COL_ENDS_WITH = "Use colsNameEndsWith() instead. $MESSAGE_0_15"
internal const val COL_ENDS_WITH_REPLACE = "this.colsNameEndsWith(suffix)"

// region WARNING in 0.15, ERROR in 0.16

private const val MESSAGE_0_16 = "Will be ERROR in 0.16."
Expand Down
Loading