https://github.com/ktoso/kaze-class
Like Case Class, but easier to bin-compat evolve
https://github.com/ktoso/kaze-class
codegen copy-paste scala
Last synced: about 1 year ago
JSON representation
Like Case Class, but easier to bin-compat evolve
- Host: GitHub
- URL: https://github.com/ktoso/kaze-class
- Owner: ktoso
- License: apache-2.0
- Created: 2016-04-06T22:27:40.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-11T13:05:00.000Z (over 7 years ago)
- Last Synced: 2025-05-13T02:08:40.984Z (about 1 year ago)
- Topics: codegen, copy-paste, scala
- Language: Scala
- Size: 38.1 KB
- Stars: 8
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kaze Class
==========
[](https://travis-ci.org/ktoso/kaze-class)
Yet another "like case class but easier to evolve in binary compatible way" source code generator.
**Specific use case:** when configuration objects where prototyped during experimental phase of a project
using case classes, and now need to be made stable API, thus having to resign
from using case classes – this project takes a `Class[T]` and generates a **KazeClass** from it,
which is a string representation of a "manual implementation" of the most basic features of case clases.
Naming
------
*Kaze* (風) means "wind" or "movement of air" in Japanese,
which reminded me of how we wanted to swiftly, and unhindered–like the wind–evolve these classes.
Usage
=====
Get the jar or [copy&paste the KazeClass](https://raw.githubusercontent.com/ktoso/kaze-class/master/src/main/scala/pl/project13/kaze/KazeClass.scala) into your project, then call:
```scala
val rendered: String = KazeClass.of[Person].render
```
or even (requires java.awt to be available...)
```scala
KazeClass.of[Person].toClipboard
```
to get a "desugared" case class, ready to replace your case class.
By default a `KazeClass` uses identity equality (not structural equality). To generate `hashCode` and `equals` methods for structural equality call `.withEqualsHashcode` before rendering.
There are a few more flags, which you may configure:
```scala
KazeClass.of[Person]
.withEqualsHashcode
.withConfig
.toClipboard
```
Use `withoutAkkaUtils` to generate conversion of `FiniteDuration` according to the [Java 8 compatibility lib](https://github.com/scala/scala-java8-compat#converters-between-scalaconcurrentdurationfiniteduration-and-javatimeduration).
Here is an [example output](src/test/scala/pl/project13/kaze/KazeClassSpec.scala).
Goals / Non-Goals
=================
Goal:
- One of the goals is to be able to just paste this one class (or include in REPL) to generate the source.
It must be small, trivial even, and have zero dependencies.
Non-Goal:
- Actually become a big fancy project that solves all things regarding helping evolve the classes.
Multiple people have attempted that, and eventually it always breaks down on some edge cases (or plain lack
of time), thus this code generator is dead simple and proud to be so.
- Cover all edge cases of what might go wrong, minor manual interaction is acceptable (feel free to submit PRs to minimize those though).
License
=======
Apache 2.0