shiirudo 
Generates DSL to simplify processing branching by when expressions in sealed class/interface.
Setup
Refer to the KSP quickstart guide to make KSP available for your project.
Installation
Repository is now Jitpack:
repositories {
maven { url "https://jitpack.io" }
}
Check the latest-version
implementation "com.tkhskt:shiirudo:[latest-version]"
ksp "com.tkhskt:shiirudo:[latest-version]"
Usage
Annotate the target sealed class/interface with the Shiirudo annotation.
@Shiirudo
sealed interface Event {
object ShowDialog : Event
object CloseDialog : Event
object ShowToast : Event
}
When the project is built, shiirudo methods corresponding to subclasses of the annotated class are generated.
The shiirudo method can be used as follows.
fun handleEvent(event: Event) {
event.shiirudo()
.isShowDialog {
}
.isCloseDialog {
}
.isElse {
}.execute()
}
// or
fun handleEvent(event: Event) {
eventShiirudo {
event
}.isShowDialog {
}.isCloseDialog {
}.isElse {
}.execute()
}
// or
fun handleEvent(event: Event) {
event.shiirudo {
isShowDialog {
}
isCloseDialog {
}
isElse {
}
}
}
Use with Flow
You can use shiirudo when you collect Flow as follows.
private suspend fun Flow<Event>.collectEvent(
handler: EventShiirudoBuilder.() -> Unit,
) {
collect {
it.shiirudo(handler)
}
}
fun handleEvent(eventFlow: Flow<Event>) {
eventFlow.collectEvent {
isShowDialog {
}
isCloseDialog {
}
}
}
Name Resolution
The code generated from the nested sealed class/interface and its subclasses is name resolved as follows.
class SampleViewModel : ViewModel() {
@Shiirudo
sealed interface Event {
interface Dialog {
object Show : Event
object Close : Event
}
object ShowToast : Event
}
}
fun handleEvent(event: SampleViewModel.Event) {
event.shiirudo {
isDialogShow {
}
isDialogClose {
}
isShowToast {
}
}
}
Examples
See the sample project.
License
MIT
17 Oct 12, 2022
0 Nov 23, 2021
0 Jan 14, 2022
8 Nov 29, 2022
0 Jan 18, 2022
1 Mar 7, 2022
2 May 26, 2022
14 Sep 8, 2022
2 Dec 15, 2021
21 Dec 3, 2022
22 Oct 26, 2022
236 Nov 30, 2022
17 Nov 17, 2022
12 Aug 23, 2022
33 Dec 23, 2022
121 Dec 26, 2022
1 Jan 14, 2022
1 Oct 11, 2021
28 Nov 14, 2022