Git Product home page Git Product logo

mutekt's Introduction

Mutekt

(Pronunciation: /mjuːˈteɪt/, 'k' is silent)

"Simplify mutating "immutable" state models"

Generates mutable models from immutable model definitions. It's based on Kotlin's Symbol Processor (KSP). This is inspired from the concept Redux and Immer from JS world that let you write simpler immutable update logic using "mutating" syntax which helps simplify most reducer implementations. So you just need to focus on actual development and Mutekt will write boilerplate for you! 😎

Like this ⬇️️

Mutekt Usage Example

Usage

Try out the example app to see it in action.

1. Apply annotation and generate model

Declare a state model as an interface and apply @GenerateMutableModel annotation to it.

Example:

@GenerateMutableModel
interface NotesState {
    val isLoading: Boolean
    val notes: List<String>
    val error: String?
}
// You can also apply annotation `@Immutable` if using for Jetpack Compose UI model.

Once done, 🔨Build project and mutable model will be generated for the immutable definition by KSP.

2. Simply mutate and get immutable state

The mutable model can be created with the factory function which is generated with the name of an interface with prefix Mutable. For example, if interface name is ExampleState then method name for creating mutable model will be MutableExampleState() and will have parameters in it which are declared as public properties in the interface.

/**
 * Instance of mutable model [MutableNotesState] which is generated with Mutekt.
 */
private val _state = MutableNotesState(isLoading = true, notes = emptyList(), error = null)

fun setLoading() {
    _state.isLoading = true
}

fun setNotes() {
    _state.update {
        isLoading = false
        notes = listOf("Lorem Ipsum")
    }
}

Note
Use method update{} on Mutable model instance to mutate multiple fields atomically.

3. Getting reactive immutable value updates

To get immutable instance with reactive state updates, use method asStateFlow() which returns instance of StateFlow<T>. Whenever any field of Mutable model is updated with new value, this StateFlow gets updated with new immutable state value.

val state: StateFlow<NotesState> = _state.asStateFlow()

Properties of immutable instance implemented by Mutekt:

  • Immutable model implementation promises to be truly Immutable i.e. once instance is created, its properties will never change.
  • Implementation is actually a data class under the hood i.e. having equals() and hashCode() already overridden.

Setting up Mutekt in the project

1.1 Enable KSP in module

In order to support code generation at compile time, enable KSP support in the module.

plugins {
    id 'com.google.devtools.ksp' version '1.7.10-1.0.6'
}

1.2 Add dependencies

1.2.1 Without Kotlin Multiplatform

In build.gradle of app module, include this dependency

repositories {
    mavenCentral()
}

dependencies {
    implementation("dev.shreyaspatil.mutekt:mutekt-core:$mutektVersion")
    ksp("dev.shreyaspatil.mutekt:mutekt-codegen:$mutektVersion")

    // Include kotlin coroutine to support usage of StateFlow 
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
}

1.2.2 With Kotlin Multiplatform

In build.gradle.kts of project module:

kotlin {
  sourceSets {
    val commonMain by getting {
      dependencies {
        implementation("dev.shreyaspatil.mutekt:mutekt-core:$mutektVersion")
      }
    }
  }
}

dependencies {
  add("kspCommonMainMetadata", "dev.shreyaspatil.mutekt:mutekt-codegen:$mutektVersion")
}

tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
  if (name != "kspCommonMainKotlinMetadata") {
    dependsOn("kspCommonMainKotlinMetadata")
  }
}

You can find the latest version and changelogs in the releases.

1.3 Include generated classes in sources

In order to make IDE aware of generated code, it's important to include KSP generated sources in the project source sets.

Include generated sources as follows:

1.3.1 Without Kotlin Multiplatform

Gradle (Groovy)
kotlin {
    sourceSets {
        main.kotlin.srcDirs += 'build/generated/ksp/main/kotlin'
        test.kotlin.srcDirs += 'build/generated/ksp/test/kotlin'
    }
}
Gradle (KTS)
kotlin {
    sourceSets.main {
        kotlin.srcDir("build/generated/ksp/main/kotlin")
    }
    sourceSets.test {
        kotlin.srcDir("build/generated/ksp/test/kotlin")
    }
}
Android (Gradle - Groovy)
android {
    applicationVariants.all { variant ->
        kotlin.sourceSets {
            def name = variant.name
            getByName(name) {
                kotlin.srcDir("build/generated/ksp/$name/kotlin")
            }
        }
    }
}
Android (Gradle - KTS)
android {
    applicationVariants.all {
        kotlin.sourceSets {
            getByName(name) {
                kotlin.srcDir("build/generated/ksp/$name/kotlin")
            }
        }
    }
}

1.3.2 With Kotlin Multiplatform

kotlin {
  sourceSets {
    val commonMain by getting {
      kotlin.srcDirs("build/generated/ksp/metadata/commonMain/kotlin")
    }
  }
}

See also

👨‍💻 Development

Clone this repository and import in IntelliJ IDEA (any edition) or Android Studio.

Module details

  • mutekt-core: Contain core annotation and interface for mutekt
  • mutekt-codegen: Includes sources for generating mutekt code with KSP
  • example: Example application which demonstrates usage of this library.

Verify build

  • To verify whether project building or not: ./gradlew build.
  • To verify code formatting: ./gradlew spotlessCheck.
  • To reformat code with Spotless: ./gradlew spotlessApply.

🙋‍♂️ Contribute

Read contribution guidelines for more information regarding contribution.

💬 Discuss

Have any questions, doubts or want to present your opinions, views? You're always welcome. You can start discussions.

📝 License

Copyright 2022 Shreyas Patil

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

mutekt's People

Contributors

dependabot[bot] avatar dvdandroid avatar jisungbin avatar patilshreyas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mutekt's Issues

KMP support

This library can be easily converted to a multiplatform one since it uses kotlinx-coroutines (with 100% multiplatform support) and KSP that can generate common code. So, it will be possible to use the same code for multiple platforms such as:

  • Android
  • JVM (ex: Jetbrains Compose applications)
  • JS (ex: React or Jetbrains Compose applications)
  • iOS (shared view model with Android)

Global Recomposition Triggered When Using Compose Following a Tutorial

Hello,

I recently came across an issue while working with Jetpack Compose, which I discovered after watching a tutorial on YouTube (link to tutorial). The problem arose when I was inspecting the layout using Layout Inspector. I noticed that whenever I modify a state variable within a specific Composable, it causes a global recomposition of all Composables that use state management in my project.

This behavior seems inefficient, especially for larger projects where only a portion of the UI should update in response to state changes. My question is, is there a way to improve this? Specifically, can we limit the recomposition to only the Composables that need updating, rather than triggering a global update across all managed states?

I'm looking for advice or solutions that could help optimize the recomposition process and make it more selective. Any guidance or insights would be greatly appreciated.

Thank you for your time and assistance.

@HiltViewModel
class CarViewModel @Inject constructor() : BaseVM() {
private val stateStore = StateStore(CarState.initialState.mutable())
fun setState(update: MutableCarState.() -> Unit) = stateStore.setState(update)
override val state: StateFlow = stateStore.state

}
@GenerateMutableModel
@immutable
interface CarState : State {
val isLocked: Boolean
val isShowNumber: Boolean
}

CarLockedBtn(Modifier.clickable{
vm.setState {
isLocked = !isLocked
}
})

@OptIn(ExperimentalFoundationApi::class)
@composable
fun TopBar(vm: CarViewModel) {
val state by vm.collectState()
val interaction = remember { MutableInteractionSource() }
val batteryStr = if (state.isShowNumber) "100%" else "693km"
Row{
Text(batteryStr )
BatteryImage()
}
}

ShareFlow ???

Hi Mutekt Teams,
Thanks for your nice tool.
How can use SharedFlow inside Mutekt ? If i suppose i have some variables in this forms:

private val _xx = MutableSharedFlow(false)
val xx = _xx.asSharedFlow()

_xx.emit(true)

Thanks for helping me

How do you do atomic update with this ?

Like the reddit comment in this.

This seems like it could break data invariants since it pushes updates on every data field update.

Eg if you depend on a data model being in either state A or B, now it can be both or neither since you must account for intermediary steps

A question about setting multiple parameters

Greetings!

Let's assume we have:

interface HomeScreenState {
val isLoading: Boolean
val title: String
val avatar: String
val items: List
val selectedItem: Any?
}

and a method like

fun update() {
_state.isLoading = true
val data = getSomeData()
_state.title = data.title
_state.avatar = data.avatar
_state.items = data.items
_state.selectedItem = data.items.firstOrNull()
}

or

fun update() {
_state.isLoading = true
val data = getSomeData()
_state.apply {
title = data.title
avatar = data.avatar
items = data.items
selectedItem = data.items.firstOrNull()
}
}

How many times would state.collect {} block be called in a view/widget in both cases?

Incorrectly generated code using a typealias as a type paramter.

Invalid code is generated when an interface uses a typealias as a type paramter.

typealias SomeTypeAlias = TypeA<out TypeB>

@GenerateMutableModel
interface UiState {
    val list: List<SomeTypeAlias>
}

Generated code

public fun MutableUiState(
    list: List<SomeTypeAlias<out TypeB>>
)

Expected

public fun MutableUiState(
    list: List<SomeTypeAlias>
)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.