Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bennyhuo/kotlindeepcopy
DeepCopy extensions for Kotlin Data class. Provide Reflection, Apt, Ksp and Kcp implementations.
https://github.com/bennyhuo/kotlindeepcopy
apt dataclass deepcopy kcp kotlin ksp reflection
Last synced: 2 days ago
JSON representation
DeepCopy extensions for Kotlin Data class. Provide Reflection, Apt, Ksp and Kcp implementations.
- Host: GitHub
- URL: https://github.com/bennyhuo/kotlindeepcopy
- Owner: bennyhuo
- License: mit
- Created: 2018-11-08T22:37:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T03:12:21.000Z (12 months ago)
- Last Synced: 2025-01-13T11:09:14.259Z (9 days ago)
- Topics: apt, dataclass, deepcopy, kcp, kotlin, ksp, reflection
- Language: Kotlin
- Homepage:
- Size: 426 KB
- Stars: 285
- Watchers: 7
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE) [](https://maven-badges.herokuapp.com/maven-central/com.bennyhuo.kotlin/deepcopy-reflect)
# KotlinDeepCopy
Provide an easy way to generate `DeepCopy` function for `data class`. DeepCopy only takes effect on the component members i.e. the members declared in the primary constructor.
## Reflection
Use Kotlin Reflection to provide an extension function for `DeepCopyable` so that any data class which implements `DeepCopyable` can simply call `deepCopy()` to copy itsself.
See the test code below:
```kotlin
data class Speaker(val name: String, val age: Int): DeepCopyable
data class Talk(val name: String, val speaker: Speaker): DeepCopyable
class DeepCopyTest {
@Test
fun test() {
val talk = Talk("DataClass in Action", Speaker("Benny Huo", 30))
val newTalk = talk.deepCopy()
assert(talk == newTalk)
assert(talk !== newTalk)
}
}
```
`talk` equals `newTalk` since the values of their members are equal while they do not ref to the same object.
### How to Setup
This library has been deloyed to maven center.
```gradle
implementation("com.bennyhuo.kotlin:deepcopy-reflect:")
```
## Apt & Ksp
If you concern about the runtime efficiency, apt may be the solution. You can simply annotate the data class you want to deep copy with a `DeepCopy` annotation:
```kotlin
@DeepCopy
data class Speaker(val name: String, val age: Int)
@DeepCopy
data class Talk(val name: String, val speaker: Speaker)
```
Extension function `deepCopy` will be generated according to the components:
```kotlin
fun Talk.deepCopy(name: String = this.name, speaker: Speaker = this.speaker): Talk = Talk(name, speaker.deepCopy())
fun Speaker.deepCopy(
name: String = this.name,
age: Int = this.age,
company: Company = this.company
): Speaker = Speaker(name, age, company.deepCopy())
```
Notice that `deepCopy` is called recursively if the member type is also a `data class` annotated with a `DeepCopy` annotation. Hence, if you remove the annotation for `Speaker`, generated function would be like:
```kotlin
fun Talk.deepCopy(name: String = this.name, speaker: Speaker = this.speaker): Talk = Talk(name, speaker)
//And no deepCopy for Speaker.
```
### How to Setup
The artifacts have been deployed to maven central repository. Set up your project by adding these lines:
```gradle
plugins {
id("com.google.devtools.ksp") version "1.9.20-1.0.14" // ksp
id "org.jetbrains.kotlin.kapt" // kapt
}
...
dependencies {
ksp("com.bennyhuo.kotlin:deepcopy-compiler-ksp:")) // ksp
kapt("com.bennyhuo.kotlin:deepcopy-compiler-kapt:") // kapt
implementation("com.bennyhuo.kotlin:deepcopy-runtime:")
}
```
## KCP
This is a nearly perfect version I think. It works like `copy` does. You can install this IntelliJ plugin: [DeepCopy](https://plugins.jetbrains.com/plugin/19915-deepcopy-for-kotlin-data-class) and setup your project like this:
```gradle
plugins {
kotlin("jvm") version "1.9.20"
id("com.bennyhuo.kotlin.plugin.deepcopy") version ""
}
dependencies {
implementation("com.bennyhuo.kotlin:deepcopy-runtime:")
}
```
And then try to call the `deepCopy` function directly!
# Change Log
See [releases](https://github.com/bennyhuo/KotlinDeepCopy/releases).
# License
[MIT License](LICENSE)
Copyright (c) 2018 Bennyhuo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.