Description
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! ๐
Navigate to the section "Why Mutekt?" to understand the need and advantages of using Mutekt.
Made with โค๏ธ for Kotliners.
Mutekt alternatives and similar packages
Based on the "Kotlin" category.
Alternatively, view mutekt alternatives based on common mentions on social networks and blogs.
-
android-youtube-player
YouTube Player library for Android and Chromecast, stable and customizable. -
CalendarView
A highly customizable calendar library for Android, powered by RecyclerView. -
Balloon
:balloon: Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android. -
Kotterknife
Android view injection writen in Kotlin based on ButterKnife -
kotlin-android-template
Android + Kotlin + Github Actions + ktlint + Detekt + Gradle Kotlin DSL + buildSrc = โค๏ธ -
Material Chip View
Material Chip view. Can be used as tags for categories, contacts or creating text clouds -
NotyKT ๐๏ธ
๐ NotyKT is a complete ๐Kotlin-stack (Backend + Android) ๐ฑ application built to demonstrate the use of Modern development tools with best practices implementation๐ฆธ. -
DrawableToolbox
๐ ๏ธ The missing drawable toolbox for Android. Create drawables programmatically and get rid of the boring and always repeated drawable.xml files. -
Navigation Toolbar for Android
:octocat: Navigation toolbar is a slide-modeled UI navigation controller made by @Ramotion -
MaterialTimelineView
With MaterialTimelineView you can easily create a material looking timeline. -
MaterialDrawerKt
A Kotlin DSL wrapper around the mikepenz/MaterialDrawer library. -
Android Kotlin Samples
Some basic samples of Kotlin for Android -
sliding-panel
Android sliding panel that is part of the view hierarchy, not above it. -
CrunchyCalendar โ awesome calendar widget for android apps
A beautiful material calendar with endless scroll, range selection and a lot more! -
Carousel Recyclerview
Carousel Recyclerview let's you create carousel layout with the power of recyclerview by creating custom layout manager. -
Pluto Debug Framework
Pluto is a on-device debugging framework for Android applications, which helps in inspection of HTTP requests/responses, capture Crashes and ANRs and manipulating application data on-the-go. -
Transition X
{ } Declarative Kotlin DSL for choreographing Android transitions -
Only
:bouquet: An easy way to persist and run code block only as many times as necessary on Android. -
Swagger Gradle Codegen
๐ซ A Gradle Plugin to generate your networking code from Swagger -
Pdf Viewer For Android
A Lightweight PDF Viewer Android library which only occupies around 125kb while most of the Pdf viewer occupies up to 16MB space. -
Capturable
๐Jetpack Compose utility library for capturing Composable content and transforming it into Bitmap Image๐ผ๏ธ -
SSCustomBottomNavigation
Animated TabBar with native control and Jetpack Navigation support..โจ๐๐ -
EasyPermissions-ktx
๐ Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher. -
Awesome Jetpack compose
A collaborative list of awesome jetpack compose resources. -
DeviceInfo-Sample
[Android Library] Get easy access to device information super fast, real quick -
SSComposeCookBook
A Collection of major Jetpack compose UI components which are commonly used.๐๐๐ -
Aimybox voice assistant
Embeddable custom voice assistant for Android applications -
Events Calendar
Events Calendar is a user-friendly library that helps you achieve a cool Calendar UI with events mapping. You can customise every pixel of the calendar as per your wish and still achieve in implementing all the functionalities of the native android calendar in addition with adding dots to the calendar which represents the presence of an event on the respective dates. It can be done easily, you are just a few steps away from implementing your own badass looking Calendar for your very own project! -
ZoomHelper
ZoomHelper will make any view to be zoomable just like Instagram pinch-to-zoom -
Maildroid
Maildroid is a small robust android library for sending emails using SMTP server -
Permission Flow for Android
Know about real-time state of a Android app Permissions with Kotlin Flow APIs. -
SSCustomEditTextOutLineBorder
Same as the Outlined text fields presented on the Material Design page but with some dynamic changes. ๐ ๐ -
Vanilla Place Picker
Simple(vanilla) yet 'Do it all' place picker for your place picking needs in Android -
Intro Showcase View
Highlight different features of the app using Jetpack Compose -
Nextflix-Composable
Includes jetpack compose, navigation, paging, hilt, retrofit, coil, coroutines, flow.. -
TimelineView
A customizable and easy-to-use Timeline View library for Android. Works as a RecyclerView decorator (ItemDecoration) -
Crowdin Android SDK
Crowdin Android SDK delivers all new translations from Crowdin project to the application immediately -
PopKorn
DI can be simple. Forget about modules and components. Just use it! -
Turtle ๐ข
Run shell commands from a Kotlin script or application with ease -
RecyclerView Presenter
RecyclerView Adapter Library with different models and different layouts as convenient as possible.
Appwrite - The Open Source Firebase alternative introduces iOS support
Do you think we are missing an alternative of Mutekt or a related project?
README
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! ๐
Navigate to the section "Why Mutekt?" to understand the need and advantages of using Mutekt.
Made with โค๏ธ for Kotliners.
Adding Mutekt to the project
You can check /example
directory which includes example application for demonstration.
1. Gradle setup
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
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")
}
You can find the latest version and changelogs in the releases.
1.3 Include generated classes in sources
Warning
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:
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")
}
}
}
}
Usage
Mutekt is very easy to use. Just apply annotation to the model and see the magic!
1. Apply annotation
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.
Note Checklist for applying annotation
- [x] Interface must have public visibility.
- [x] All members properties should have public visibility.
Once done, ๐จBuild project and mutable model will be generated for the immutable definition by KSP.
2. Simply mutate and get immutable state
Once project is built and models are generated, the mutable model can be created with the factory function: 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.
To get immutable instance with reactive state updates, use method asStateFlow()
which returns instance of StateFlow<>
.
Whenever any field of Mutable model is updated with new value, this StateFlow gets updated with new immutable state value.
Refer to the following example for complete usage
class NotesViewModel: ViewModel() {
/**
* Instance of mutable model [MutableNotesState] which is generated with Mutekt.
*/
private val _state = MutableNotesState(isLoading = false, notes = emptyList(), error = null)
/**
* Immutable (read-only) StateFlow of a [NotesState].
*/
val state: StateFlow<NotesState> = _state.asStateFlow()
fun loadNotes() {
_state.isLoading = true
try {
_state.notes = getNotes()
} catch (e: Throwable) {
_state.error = e.message ?: "Error occurred"
}
_state.isLoading = false
}
}
In this example, only ViewModel is allowed to mutate the state i.e. manage the state for UI. StateFlow<NotesState>
is
exposed to the UI layer which means UI won't be able to directly manipulate the state.
Why Mutekt?
Let's understand the reason for which Mutekt came to picture.
Taking inspiration from Redux's way of state management having immutable state model in Kotlin ecosystem, implementation in Kotlin needs a lot of care and boilerplate to properly handle the state.
Without Mutekt
Assume this is UI state model:
data class NotesState(val isLoading: Boolean, val notes: List<String>, val error: String?)
Here are well known popular opinionated approaches in the Kotlin community to implement a reducer pattern:
1. Copying State model
In this approach, a mutable state flow is created with initial state. Whenever state needs to be mutated, previous state is used to calculate next state i.e. it just copies the previous state.
class NotesViewModel: ViewModel() {
private val _state = MutableStateFlow(NotesState(false, emptyList(), null))
val state = _state.asStateFlow()
fun loadNotes() {
_state.update { it.copy(isLoading = true) }
val notes = getNotes()
_state.update { it.copy(notes = notes, isLoading = false) }
}
}
In this approach, following things needs to be taken care of:
- The new state should be updated atomically and with synchronization otherwise state inconsistency will occur
(i.e.
update{}
method of StateFlow). - By dev mistake, while updating new state if previous state is not copied (by
it.copy()
) the previous state will be lost.
2. Combining multiple states to form new one
class NotesViewModel: ViewModel() {
private val isLoading = MutableStateFlow(false)
private val notes = MutableStateFlow(emptyList<String>())
private val error = MutableStateFlow<String?>(null)
val state: StateFlow<NotesState> = combine(isLoading, notes, error) { isLoading, notes, error ->
NotesState(isLoading, notes, error)
}.stateIn(viewModelScope, WhileSubscribed(), NotesState(false, emptyList(), null))
fun loadNotes() {
isLoading.value = true
notes.value = getNotes()
isLoading.value = false
}
}
In this approach, there's no scope for mistakes but needs repeated boilerplate for each property of state model. As new state property is added in the codebase while development, refactoring is needed everytime to have proper state management.
With Mutekt
Mutekt solves the issues around the above-mentioned approaches and lets developer focus on the state manipulation instead of declaring each and every state field every time by generates required and common boilerplate at compile time by annotation processing.
Just by inspiring from very popular Immer (from JS world), it simplifies writing immutable updates with the "mutating" syntax that helps writing clean reducer implementations.
With Mutekt you just need to declare state model as interface and apply the annotation. Rest magic is done by the KSP (As you already saw example earlier).
Refer to this Wiki to know what code is generated under the hood by Mutekt.
๐จโ๐ป Development
Clone this repository and import in IntelliJ IDEA (any edition) or Android Studio.
Module details
mutekt-core
: Contain core annotation and interface for mutektmutekt-codegen
: Includes sources for generating mutekt code with KSPexample
: 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](CONTRIBUTING.md) 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.
*Note that all licence references and agreements mentioned in the Mutekt README section above
are relevant to that project's source code only.