Skip to content

Commit 2f2f184

Browse files
aSemyaSemy
authored
#26 named tuples (#27)
- implement labelled tuple elements, add tests, fix existing - simplify 'TSProperty', it only needs to be one class - TSCompile tests passed ✅
1 parent 700917f commit 2f2f184

File tree

10 files changed

+257
-98
lines changed

10 files changed

+257
-98
lines changed

‎docs/code/example/example-tuple-02.kt‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,33 @@ import dev.adamko.kxstsgen.*
66
import dev.adamko.kxstsgen.core.experiments.TupleSerializer
77
import kotlinx.serialization.*
88

9-
@Serializable(with = OptionalFields.Serializer::class)
10-
data class OptionalFields(
11-
val requiredString: String,
12-
val optionalString: String = "",
13-
val nullableString: String?,
14-
val nullableOptionalString: String? = "",
9+
@Serializable(with = PostalAddressUSA.Serializer::class)
10+
data class PostalAddressUSA(
11+
@SerialName("num") // 'SerialName' will be ignored in 'Tuple' form
12+
val houseNumber: String,
13+
val streetName: String,
14+
val postcode: String,
1515
) {
16-
object Serializer : TupleSerializer<OptionalFields>(
17-
"OptionalFields",
16+
object Serializer : TupleSerializer<PostalAddressUSA>(
17+
"PostalAddressUSA",
1818
{
19-
element(OptionalFields::requiredString)
20-
element(OptionalFields::optionalString)
21-
element(OptionalFields::nullableString)
22-
element(OptionalFields::nullableOptionalString)
19+
element(PostalAddressUSA::houseNumber)
20+
// custom labels for 'streetName', 'postcode'
21+
element("street", PostalAddressUSA::streetName)
22+
element("zip", PostalAddressUSA::postcode)
2323
}
2424
) {
25-
override fun tupleConstructor(elements: Iterator<*>): OptionalFields {
26-
val iter = elements.iterator()
27-
return OptionalFields(
28-
iter.next() as String,
29-
iter.next() as String,
30-
iter.next() as String,
31-
iter.next() as String,
25+
override fun tupleConstructor(elements: Iterator<*>): PostalAddressUSA {
26+
return PostalAddressUSA(
27+
elements.next() as String,
28+
elements.next() as String,
29+
elements.next() as String,
3230
)
3331
}
3432
}
3533
}
3634

3735
fun main() {
3836
val tsGenerator = KxsTsGenerator()
39-
println(tsGenerator.generate(OptionalFields.serializer()))
37+
println(tsGenerator.generate(PostalAddressUSA.serializer()))
4038
}

‎docs/code/example/example-tuple-03.kt‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,35 @@ import dev.adamko.kxstsgen.*
66
import dev.adamko.kxstsgen.core.experiments.TupleSerializer
77
import kotlinx.serialization.*
88

9-
@Serializable(with = Coordinates.Serializer::class)
10-
data class Coordinates(
11-
val x: Int,
12-
val y: Int,
13-
val z: Int,
9+
@Serializable(with = OptionalFields.Serializer::class)
10+
data class OptionalFields(
11+
val requiredString: String,
12+
val optionalString: String = "",
13+
val nullableString: String?,
14+
val nullableOptionalString: String? = "",
1415
) {
15-
object Serializer : TupleSerializer<Coordinates>(
16-
"Coordinates",
16+
object Serializer : TupleSerializer<OptionalFields>(
17+
"OptionalFields",
1718
{
18-
element(Coordinates::x)
19-
element(Coordinates::y)
20-
element(Coordinates::z)
19+
element(OptionalFields::requiredString)
20+
element(OptionalFields::optionalString)
21+
element(OptionalFields::nullableString)
22+
element(OptionalFields::nullableOptionalString)
2123
}
2224
) {
23-
override fun tupleConstructor(elements: Iterator<*>): Coordinates {
24-
return Coordinates(
25-
elements.next() as Int,
26-
elements.next() as Int,
27-
elements.next() as Int,
25+
override fun tupleConstructor(elements: Iterator<*>): OptionalFields {
26+
val iter = elements.iterator()
27+
return OptionalFields(
28+
iter.next() as String,
29+
iter.next() as String,
30+
iter.next() as String,
31+
iter.next() as String,
2832
)
2933
}
3034
}
3135
}
3236

3337
fun main() {
3438
val tsGenerator = KxsTsGenerator()
35-
println(tsGenerator.generate(Coordinates.serializer()))
39+
println(tsGenerator.generate(OptionalFields.serializer()))
3640
}

‎docs/code/example/example-tuple-04.kt‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,31 @@ import dev.adamko.kxstsgen.*
66
import dev.adamko.kxstsgen.core.experiments.TupleSerializer
77
import kotlinx.serialization.*
88

9-
import dev.adamko.kxstsgen.example.exampleTuple03.Coordinates
10-
11-
@Serializable
12-
class GameLocations(
13-
val homeLocation: Coordinates,
14-
val allLocations: List<Coordinates>,
15-
val namedLocations: Map<String, Coordinates>,
16-
)
9+
@Serializable(with = Coordinates.Serializer::class)
10+
data class Coordinates(
11+
val x: Int,
12+
val y: Int,
13+
val z: Int,
14+
) {
15+
object Serializer : TupleSerializer<Coordinates>(
16+
"Coordinates",
17+
{
18+
element(Coordinates::x)
19+
element(Coordinates::y)
20+
element(Coordinates::z)
21+
}
22+
) {
23+
override fun tupleConstructor(elements: Iterator<*>): Coordinates {
24+
return Coordinates(
25+
elements.next() as Int,
26+
elements.next() as Int,
27+
elements.next() as Int,
28+
)
29+
}
30+
}
31+
}
1732

1833
fun main() {
1934
val tsGenerator = KxsTsGenerator()
20-
println(tsGenerator.generate(GameLocations.serializer()))
35+
println(tsGenerator.generate(Coordinates.serializer()))
2136
}

‎docs/code/example/example-tuple-05.kt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// This file was automatically generated from tuples.md by Knit tool. Do not edit.
2+
@file:Suppress("PackageDirectoryMismatch", "unused")
3+
package dev.adamko.kxstsgen.example.exampleTuple05
4+
5+
import dev.adamko.kxstsgen.*
6+
import dev.adamko.kxstsgen.core.experiments.TupleSerializer
7+
import kotlinx.serialization.*
8+
9+
import dev.adamko.kxstsgen.example.exampleTuple04.Coordinates
10+
11+
@Serializable
12+
class GameLocations(
13+
val homeLocation: Coordinates,
14+
val allLocations: List<Coordinates>,
15+
val namedLocations: Map<String, Coordinates>,
16+
)
17+
18+
fun main() {
19+
val tsGenerator = KxsTsGenerator()
20+
println(tsGenerator.generate(GameLocations.serializer()))
21+
}

‎docs/code/test/TuplesTest.kt‎

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ class TuplesTest : FunSpec({
2020
actual.shouldBe(
2121
// language=TypeScript
2222
"""
23-
|export type SimpleTypes = [string, number, number | null, boolean, string];
23+
|export type SimpleTypes = [
24+
| aString: string,
25+
| anInt: number,
26+
| aDouble: number | null,
27+
| bool: boolean,
28+
| privateMember: string,
29+
|];
2430
""".trimMargin()
2531
.normalize()
2632
)
@@ -40,7 +46,11 @@ class TuplesTest : FunSpec({
4046
actual.shouldBe(
4147
// language=TypeScript
4248
"""
43-
|export type OptionalFields = [string, string, string | null, string | null];
49+
|export type PostalAddressUSA = [
50+
| houseNumber: string, // @SerialName("num") was ignored
51+
| street: string, // custom name
52+
| zip: string, // custom name
53+
|];
4454
""".trimMargin()
4555
.normalize()
4656
)
@@ -60,7 +70,12 @@ class TuplesTest : FunSpec({
6070
actual.shouldBe(
6171
// language=TypeScript
6272
"""
63-
|export type Coordinates = [number, number, number];
73+
|export type OptionalFields = [
74+
| requiredString: string,
75+
| optionalString: string,
76+
| nullableString: string | null,
77+
| nullableOptionalString: string | null,
78+
|];
6479
""".trimMargin()
6580
.normalize()
6681
)
@@ -76,6 +91,30 @@ class TuplesTest : FunSpec({
7691
dev.adamko.kxstsgen.example.exampleTuple04.main()
7792
}.normalizeJoin()
7893

94+
test("expect actual matches TypeScript") {
95+
actual.shouldBe(
96+
// language=TypeScript
97+
"""
98+
|export type Coordinates = [
99+
| x: number,
100+
| y: number,
101+
| z: number,
102+
|];
103+
""".trimMargin()
104+
.normalize()
105+
)
106+
}
107+
108+
test("expect actual compiles").config(tags = tsCompile) {
109+
actual.shouldTypeScriptCompile()
110+
}
111+
}
112+
113+
context("ExampleTuple05") {
114+
val actual = captureOutput("ExampleTuple05") {
115+
dev.adamko.kxstsgen.example.exampleTuple05.main()
116+
}.normalizeJoin()
117+
79118
test("expect actual matches TypeScript") {
80119
actual.shouldBe(
81120
// language=TypeScript
@@ -86,7 +125,11 @@ class TuplesTest : FunSpec({
86125
| namedLocations: { [key: string]: Coordinates };
87126
|}
88127
|
89-
|export type Coordinates = [number, number, number];
128+
|export type Coordinates = [
129+
| x: number,
130+
| y: number,
131+
| z: number,
132+
|];
90133
""".trimMargin()
91134
.normalize()
92135
)

0 commit comments

Comments
 (0)