Skip to content

Commit 964317a

Browse files
Merge pull request #1071 from Kotlin/move_rename
Move toLeft -> toStart, toRight -> toEnd, add move KDocs
2 parents 835f242 + 9ca8334 commit 964317a

File tree

22 files changed

+1622
-133
lines changed

22 files changed

+1622
-133
lines changed

core/api/core.api

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6277,6 +6277,10 @@ public final class org/jetbrains/kotlinx/dataframe/api/MoveKt {
62776277
public static final fun moveTo (Lorg/jetbrains/kotlinx/dataframe/DataFrame;I[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62786278
public static final fun moveTo (Lorg/jetbrains/kotlinx/dataframe/DataFrame;I[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62796279
public static final fun moveTo (Lorg/jetbrains/kotlinx/dataframe/DataFrame;I[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6280+
public static final fun moveToEnd (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6281+
public static final fun moveToEnd (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6282+
public static final fun moveToEnd (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6283+
public static final fun moveToEnd (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62806284
public static final fun moveToLeft (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62816285
public static final fun moveToLeft (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62826286
public static final fun moveToLeft (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
@@ -6285,9 +6289,15 @@ public final class org/jetbrains/kotlinx/dataframe/api/MoveKt {
62856289
public static final fun moveToRight (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62866290
public static final fun moveToRight (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62876291
public static final fun moveToRight (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6292+
public static final fun moveToStart (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6293+
public static final fun moveToStart (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6294+
public static final fun moveToStart (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6295+
public static final fun moveToStart (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62886296
public static final fun to (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;I)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6297+
public static final fun toEnd (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62896298
public static final fun toLeft (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62906299
public static final fun toRight (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
6300+
public static final fun toStart (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62916301
public static final fun toTop (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62926302
public static synthetic fun toTop$default (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
62936303
public static final fun under (Lorg/jetbrains/kotlinx/dataframe/api/MoveClause;Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;

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

Lines changed: 991 additions & 19 deletions
Large diffs are not rendered by default.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
88
import org.jetbrains.kotlinx.dataframe.annotations.Refine
99
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
1010
import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
11-
import org.jetbrains.kotlinx.dataframe.documentation.DocumentationUrls.Select
1211
import org.jetbrains.kotlinx.dataframe.impl.api.removeImpl
1312
import org.jetbrains.kotlinx.dataframe.util.MINUS
1413
import org.jetbrains.kotlinx.dataframe.util.MINUS_REPLACE

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,18 @@ internal const val IS_URL_IMPORT = "org.jetbrains.kotlinx.dataframe.io.isUrl"
6060
internal const val MINUS = "This minus overload will be removed in favor of `remove`. $MESSAGE_0_16"
6161
internal const val MINUS_REPLACE = "this.remove(columns)"
6262

63+
internal const val MOVE_TO_LEFT = "This `moveToLeft` overload will be removed in favor of `moveToStart`. $MESSAGE_0_16"
64+
internal const val MOVE_TO_LEFT_REPLACE = "this.moveToStart(columns)"
65+
66+
internal const val MOVE_TO_RIGHT = "This `moveToRight` overload will be removed in favor of `moveToEnd`. $MESSAGE_0_16"
67+
internal const val MOVE_TO_RIGHT_REPLACE = "this.moveToEnd(columns)"
68+
69+
internal const val TO_LEFT = "This `toLeft` overload will be removed in favor of `toStart`. $MESSAGE_0_16"
70+
internal const val TO_LEFT_REPLACE = "this.toStart()"
71+
72+
internal const val TO_RIGHT = "This `toRight` overload will be removed in favor of `toEnd`. $MESSAGE_0_16"
73+
internal const val TO_RIGHT_REPLACE = "this.toEnd()"
74+
6375
// endregion
6476

6577
// region WARNING in 0.16, ERROR in 0.17

core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Modify.kt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ import org.jetbrains.kotlinx.dataframe.api.split
8888
import org.jetbrains.kotlinx.dataframe.api.sum
8989
import org.jetbrains.kotlinx.dataframe.api.to
9090
import org.jetbrains.kotlinx.dataframe.api.toFloat
91-
import org.jetbrains.kotlinx.dataframe.api.toLeft
91+
import org.jetbrains.kotlinx.dataframe.api.toStart
9292
import org.jetbrains.kotlinx.dataframe.api.toMap
9393
import org.jetbrains.kotlinx.dataframe.api.toPath
9494
import org.jetbrains.kotlinx.dataframe.api.toTop
@@ -114,7 +114,6 @@ import org.junit.Test
114114
import java.net.URL
115115
import java.time.format.DateTimeFormatter
116116
import java.util.*
117-
import kotlin.streams.toList
118117

119118
@Suppress("ktlint:standard:chain-method-continuation", "ktlint:standard:argument-list-wrapping")
120119
class Modify : TestBase() {
@@ -340,7 +339,7 @@ class Modify : TestBase() {
340339
@TransformDataFrameExpressions
341340
fun move() {
342341
// SampleStart
343-
df.move { age }.toLeft()
342+
df.move { age }.toStart()
344343

345344
df.move { weight }.to(1)
346345

core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTests.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ import org.jetbrains.kotlinx.dataframe.api.minOf
107107
import org.jetbrains.kotlinx.dataframe.api.minus
108108
import org.jetbrains.kotlinx.dataframe.api.move
109109
import org.jetbrains.kotlinx.dataframe.api.moveTo
110-
import org.jetbrains.kotlinx.dataframe.api.moveToLeft
111-
import org.jetbrains.kotlinx.dataframe.api.moveToRight
110+
import org.jetbrains.kotlinx.dataframe.api.moveToEnd
111+
import org.jetbrains.kotlinx.dataframe.api.moveToStart
112112
import org.jetbrains.kotlinx.dataframe.api.name
113113
import org.jetbrains.kotlinx.dataframe.api.named
114114
import org.jetbrains.kotlinx.dataframe.api.notNull
@@ -142,11 +142,11 @@ import org.jetbrains.kotlinx.dataframe.api.toColumnAccessor
142142
import org.jetbrains.kotlinx.dataframe.api.toColumnOf
143143
import org.jetbrains.kotlinx.dataframe.api.toDataFrame
144144
import org.jetbrains.kotlinx.dataframe.api.toDouble
145+
import org.jetbrains.kotlinx.dataframe.api.toEnd
145146
import org.jetbrains.kotlinx.dataframe.api.toInt
146147
import org.jetbrains.kotlinx.dataframe.api.toList
147148
import org.jetbrains.kotlinx.dataframe.api.toListOf
148149
import org.jetbrains.kotlinx.dataframe.api.toMap
149-
import org.jetbrains.kotlinx.dataframe.api.toRight
150150
import org.jetbrains.kotlinx.dataframe.api.toStr
151151
import org.jetbrains.kotlinx.dataframe.api.toValueColumn
152152
import org.jetbrains.kotlinx.dataframe.api.transpose
@@ -689,14 +689,14 @@ class DataFrameTests : BaseTest() {
689689

690690
@Test
691691
fun `move several columns to left`() {
692-
val moved = typed.moveToLeft { weight and age }
692+
val moved = typed.moveToStart { weight and age }
693693
val expected = typed.select { cols(weight, age, name, city) }
694694
moved shouldBe expected
695695
}
696696

697697
@Test
698698
fun `move several columns to right`() {
699-
val moved = typed.moveToRight { weight and name }
699+
val moved = typed.moveToEnd { weight and name }
700700
val expected = typed.select { cols(age, city, weight, name) }
701701
moved shouldBe expected
702702
}
@@ -1130,7 +1130,7 @@ class DataFrameTests : BaseTest() {
11301130
val cities = filtered.city.toList().map { it!!.lowercase() }
11311131
val gathered =
11321132
res.gather { colsOf<Boolean> { cities.contains(it.name()) } }.where { it }.keysInto("city")
1133-
val expected = filtered.select { name and age and city.map { it!!.lowercase() } }.moveToRight { city }
1133+
val expected = filtered.select { name and age and city.map { it!!.lowercase() } }.moveToEnd { city }
11341134
gathered shouldBe expected
11351135
}
11361136

@@ -2273,7 +2273,7 @@ class DataFrameTests : BaseTest() {
22732273

22742274
df.remove { city }.convertTo<Target>() shouldBe
22752275
df.update { city }.withNull()
2276-
.move { city }.toRight()
2276+
.move { city }.toEnd()
22772277

22782278
shouldThrow<IllegalArgumentException> {
22792279
df.remove { age }.convertTo<Target>()
@@ -2283,7 +2283,7 @@ class DataFrameTests : BaseTest() {
22832283
fill { age }.with { -1 }
22842284
} shouldBe
22852285
df.update { age }.with { -1 }
2286-
.move { age }.toRight()
2286+
.move { age }.toEnd()
22872287

22882288
shouldThrow<TypeConversionException> {
22892289
df.update { name }.at(2).withNull()

core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTreeTests.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ import org.jetbrains.kotlinx.dataframe.api.maxBy
7272
import org.jetbrains.kotlinx.dataframe.api.median
7373
import org.jetbrains.kotlinx.dataframe.api.move
7474
import org.jetbrains.kotlinx.dataframe.api.moveTo
75-
import org.jetbrains.kotlinx.dataframe.api.moveToLeft
76-
import org.jetbrains.kotlinx.dataframe.api.moveToRight
75+
import org.jetbrains.kotlinx.dataframe.api.moveToEnd
76+
import org.jetbrains.kotlinx.dataframe.api.moveToStart
7777
import org.jetbrains.kotlinx.dataframe.api.pathOf
7878
import org.jetbrains.kotlinx.dataframe.api.perRowCol
7979
import org.jetbrains.kotlinx.dataframe.api.pivot
@@ -554,7 +554,7 @@ class DataFrameTreeTests : BaseTest() {
554554
.remove { it[groupCol]["city"] }
555555
.ungroup(groupCol)
556556
.sortBy { name and age }
557-
res shouldBe typed.sortBy { name and age }.moveToLeft { city }
557+
res shouldBe typed.sortBy { name and age }.moveToStart { city }
558558
}
559559

560560
@Test
@@ -567,7 +567,7 @@ class DataFrameTreeTests : BaseTest() {
567567
.remove { it[groupCol]["city"] }
568568
.ungroup(groupCol)
569569
.sortBy { name and age }
570-
res shouldBe typed.sortBy { name and age }.moveToLeft { city }
570+
res shouldBe typed.sortBy { name and age }.moveToStart { city }
571571
}
572572

573573
@Test
@@ -592,7 +592,7 @@ class DataFrameTreeTests : BaseTest() {
592592
@Test
593593
fun `join with right path`() {
594594
val joined = typed.remove { city }.join(typed2.remove { weight }) { name.match(right.nameAndCity.name) and age }
595-
val expected = typed.moveToRight { city }.move { city }.under("nameAndCity")
595+
val expected = typed.moveToEnd { city }.move { city }.under("nameAndCity")
596596
joined shouldBe expected
597597
}
598598

0 commit comments

Comments
 (0)