Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goncalossilva/kotlinx-resources
Kotlin Multiplatform (KMP) library for reading resources in tests
https://github.com/goncalossilva/kotlinx-resources
gradle-plugin kotlin-multiplatform resources testing
Last synced: about 19 hours ago
JSON representation
Kotlin Multiplatform (KMP) library for reading resources in tests
- Host: GitHub
- URL: https://github.com/goncalossilva/kotlinx-resources
- Owner: goncalossilva
- License: mit
- Created: 2021-12-06T17:01:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:59:01.000Z (about 2 months ago)
- Last Synced: 2024-09-17T22:16:25.324Z (about 2 months ago)
- Topics: gradle-plugin, kotlin-multiplatform, resources, testing
- Language: Kotlin
- Homepage:
- Size: 593 KB
- Stars: 109
- Watchers: 5
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin-multiplatform - kotlinx-resources - Multiplatform library for reading resources in tests. (Libraries / Test)
- kmp-awesome - Kotlinx-Resources - text resources manager (Libraries / 🛢 Resources)
README
# kotlinx-resources
[![badge-library-version]](https://search.maven.org/search?q=g:com.goncalossilva%20a:resources*)
[![badge-plugin-version]](https://plugins.gradle.org/plugin/com.goncalossilva.resources)
![badge-jvm][badge-jvm]
![badge-js][badge-js]
![badge-nodejs][badge-nodejs]
![badge-android][badge-android]
![badge-ios][badge-ios]
![badge-watchos][badge-watchos]
![badge-tvos][badge-tvos]
![badge-macos][badge-macos]
![badge-windows][badge-windows]
![badge-linux][badge-linux]
Kotlin Multiplatform (KMP) plugin and library that add support for reading resources in tests.
The plugin and a library work in tandem to provide a unified API across platforms for reading resources from each source set's `resources` folder.
## Setup
List the plugin in your `build.gradle.kts`:
```kotlin
plugins {
id("com.goncalossilva.resources") version ""
}
```
And add the dependency to your `commonTest` source set:
```kotlin
kotlin {
sourceSets {
val commonTest by getting {
dependencies {
implementation("com.goncalossilva:resources:")
}
}
}
}
```
> [!IMPORTANT]
> The latest version targets Kotlin 2.0 and is incompatible with Kotlin 1.9.
> On 2.0 and above, use the latest version available.
> On 1.9, use the latest version _below v0.9.0_.
## Usage
Once setup is done done, a `Resource` class becomes available in all test sources, with a simple API:
```kotlin
class Resource(path: String) {
fun exists(): Boolean
fun readText(): String
fun readBytes(): ByteArray
}
```
To setup resources correctly and avoid `FilNotFoundException` & co:
1. **Put them in the [resources folder](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.SourceSet.html#org.gradle.api.tasks.SourceSet:resources) of a source set.** For example, `src/commonTest/resources/` or `src/jsTest/resources/`.
2. **Specify the path relative to the project's directory.** For example, `src/commonTest/resources/a-folder/a-file.txt`.
With these in mind, you're ready to go.
## Example
Library tests use the library itself, so they serve as a practical example.
See [`ResourceTest`](resources-test/src/commonTest/kotlin/ResourceTest.kt) for example usage, and [`resources-test/src/commonTest/resources`](resources-library/src/commonTest/resources) for the associated folder structure for resources.
## Acknowledgements
This library is inspired by [this gist](https://gist.github.com/dellisd/a1df42787d42b41cd3ce16f573984674) by [@dellisd](https://gist.github.com/dellisd).
## License
Released under the [MIT License](https://opensource.org/licenses/MIT).
[badge-library-version]: https://img.shields.io/maven-central/v/com.goncalossilva/resources?style=flat
[badge-plugin-version]: https://img.shields.io/gradle-plugin-portal/v/com.goncalossilva.resources?style=flat
[badge-ios]: https://img.shields.io/badge/platform-ios-CDCDCD.svg?style=flat
[badge-js]: https://img.shields.io/badge/platform-js-F8DB5D.svg?style=flat
[badge-nodejs]: https://img.shields.io/badge/platform-nodejs-68a063.svg?style=flat
[badge-android]: https://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat
[badge-jvm]: https://img.shields.io/badge/platform-jvm-DB413D.svg?style=flat
[badge-linux]: https://img.shields.io/badge/platform-linux-2D3F6C.svg?style=flat
[badge-windows]: https://img.shields.io/badge/platform-windows-4D76CD.svg?style=flat
[badge-macos]: https://img.shields.io/badge/platform-macos-111111.svg?style=flat
[badge-watchos]: https://img.shields.io/badge/platform-watchos-C0C0C0.svg?style=flat
[badge-tvos]: https://img.shields.io/badge/platform-tvos-808080.svg?style=flat
[badge-wasm]: httpss://img.shields.io/badge/platform-wasm-624FE8.svg?style=flat