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.
-
Balloon
:balloon: Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android. -
kotlin-android-template
Android + Kotlin + Github Actions + ktlint + Detekt + Gradle Kotlin DSL + buildSrc = โค๏ธ -
NotyKT ๐๏ธ
๐ NotyKT is a complete ๐Kotlin-stack (Backend + Android) ๐ฑ application built to demonstrate the use of Modern development tools with best practices implementation๐ฆธ. -
Material Chip View
Material Chip view. Can be used as tags for categories, contacts or creating text clouds -
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 -
Capturable
๐Jetpack Compose utility library for capturing Composable content and transforming it into Bitmap Image๐ผ๏ธ -
Pdf Viewer For Android
A Lightweight PDF Viewer Android library which only occupies around 80kb while most of the Pdf viewer occupies up to 16MB space. -
Carousel Recyclerview
Carousel Recyclerview let's you create carousel layout with the power of recyclerview by creating custom layout manager. -
CrunchyCalendar โ awesome calendar widget for android apps
A beautiful material calendar with endless scroll, range selection and a lot more! -
SSComposeCookBook
A Collection of major Jetpack compose UI components which are commonly used.๐๐๐ -
Pluto Debug Framework
Android Pluto is a on-device debugging framework for Android applications, which helps intercept Network calls, capture Crashes & ANRs, manipulate application data on-the-go, and much more. -
Permission Flow for Android
Know about real-time state of a Android app Permissions with Kotlin Flow APIs. -
SSCustomBottomNavigation
Animated TabBar with native control and Jetpack Navigation support..โจ๐๐ -
Only
:bouquet: An easy way to persist and run code block only as many times as necessary on Android. -
Nextflix-Composable
Includes jetpack compose, navigation, paging, hilt, retrofit, coil, coroutines, flow.. -
EasyPermissions-ktx
๐ Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher. -
Compose Compiler Reports to HTML Generator
A utility (Gradle Plugin + CLI) to convert Jetpack Compose compiler metrics and reports to beautified HTML page. -
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! -
MidJourney Images Compose Multiplatform Mobile Application
This application is developed to display the images created by MidJourney. The application is developed with Compose Multiplatform and works on many platforms including Android and iOS platforms. -
SSCustomEditTextOutLineBorder
Same as the Outlined text fields presented on the Material Design page but with some dynamic changes. ๐ ๐ -
TimelineView
A customizable and easy-to-use Timeline View library for Android. Works as a RecyclerView decorator (ItemDecoration) -
Vanilla Place Picker
Simple(vanilla) yet 'Do it all' place picker for your place picking needs in Android -
FlowMVI
A Kotlin Multiplatform MVI library based on coroutines with a rich DSL and a powerful plugin system.
InfluxDB - Power Real-Time Data Analytics at Scale
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! ๐
Like this โฌ๏ธ๏ธ
[Mutekt Usage Example](mutekt-usage.gif)
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.apply {
isLoading = false
notes = listOf("Lorem Ipsum")
}
}
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:
- [x] Immutable model implementation promises to be truly Immutable i.e. once instance is created, its properties will never change.
- [x] Implementation is actually a data class under the hood i.e. having
equals()
andhashCode()
already overridden.
Setting up Mutekt in the project
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
Note
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")
}
}
}
}
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 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.