Update: The current version is 0.8.0
Features
1. Simple And Direct
- No hard configuration
- No invasive annotations to data class
- Custom mapping
- Nullable Data Types
2. Primitive Types
- Short
- Int
- Long
- Float
- Double
- Boolean
- String
3. Support for Java 8 Date Time Apis
- LocalTime
- LocalDateTime
- LocalDate
- Custom Formatting
4. Support Custom Data Type Transformation
see documentation
Hello Everyone!!
Hi to those who love Kotlin
To this date, I haven't found one unique implementation on Kotlin CSV parser into Kotlin data class.
So I decided to create one, and it is now available on GitHub Kotlin-Grass.
Unlike some existing Java CSV parsers, it doesn't require to invade your data class with annotation to map CSV file columns to data class fields.
It requires another awesome Kotlin library for reading the CSV, namely Kotlin-CSV. Since this one is implemented in Kotlin Multiplatform I don't intend to reinvent the wheel for reading CSV File.
Let's get back to my Kotlin-Grass, a CSV to data class parser. It is already available at Maven Central for download.
repositories {
mavenCentral()
}
dependencies {
//doyaaaaaken's kotlin-csv
implementation("com.github.doyaaaaaken:kotlin-csv-jvm:0.15.2")
//kotlin-grass
implementation("io.github.blackmo18:kotlin-grass-core-jvm:1.0.0")
implementation("io.github.blackmo18:kotlin-grass-parser-jvm:0.8.0")")
}
Its usage is quite simple and direct nothing more than a plug and play
for example, we have a CSV file with the following data
short,int,long,float,double,boolean,string
0,1,2,3.0,4.0,true,hello
the data class would simply look like
data class PrimitiveTypes(
val short: Short,
val int: Int,
val long: Long,
val float: Float,
val double: Double,
val boolean: Boolean,
val string: String
)
Yes! No annotation is required. It will automatically map the first line as header to data class fields.
The usage is just like
val csvContents = csvReader().readAllWithHeader(file)
val dataClasses = grass<PrimitiveTypes>().harvest(csvContents)
or the other way
csvReader.open(file) {
val csvContents = readAllWithHeaderAsSequence()
val dataClasses = grass<PrimitiveTypes>().harvest(csvContents)
}
You get a list or sequence of object parsed into a data class.
Also your PRs and feature requests are much appreciated if you had any issues.
Happy Hacking
Top comments (7)
Cool, csv-parsing is a nice, self-contained but useful problem domain!
I recently wrote a csv to Kotlin data class parser for my work at 'Which?' as well 😅. I called my project KSV.
CSV contain some interesting corner cases that you might want to consider:
advanced features:
I thing those are the main additional features I can think of right now. How did you publish to jcenter? Is it free (for open source)? I tried to google a free jar repository, but ended up suggesting Gradle's source dependency mechanism
Hi, thanks and I really appreciate the key points you shared.
Regarding the custom delimiters, surrounded with quotes, Kotlin-Csv already handles the scenarios. That's why I mainly focused on my Kotlin-Grass as a parser itself.
Custom Mapping is also supported on initial release, instead of relying on annotation I resorted to DSL mappings.
which is I think neat and there is no need to annotate your data class
With the release of version 0.3.0, nullable values, and white spaces were already covered.
Publishing to jcenter I never thought would be just easy, although I have done so much research since my structure is for kotlin-multiplatform. You just need to create bintray account, then publish your library in there. Once your library is uploaded you can request to link your packages to jcenter.
Apply necessary plugin in Gradle build file, like maven publish. You can check my repo's build file, it is configured for publishing in bintray.
I'd propose an enhancement to the customKeyMap, or implementing another parameter for stating the mapping in more kotlin way with KProperty:
Nonetheless - great job 👍
I agree with your suggestion, ill keep this in mind in the future release.
github.com/blackmo18/kotlin-grass/...
cool, seems like you got all the features I can think of then 👍
Hi, are you planning to move this awesome project off jcenter and to maven central, given that jcenter is being deprecated? Thanks in advance.
Yes, this is already been moved, i haven't updated this post for a while but the GitHub is updated. I will update this one shortly