robstoll / niok Goto Github PK

Kotlin idiomatic API for java.nio.file

License: Apache License 2.0

Kotlin 99.73% Java 0.27%

niok's Introduction

Niok - java.nio.file for Kotlin

Niok provides a Kotlin idiomatic API for java.nio.file (the package for non-blocking I/O file operations). We believe that using Files decreases readability => extension functions to the rescue 😏

Next to providing delegations to Files it also delegates to Kotlin's built-in extension functions for File and provides additional functions.

Installation

Niok is published to maven central. Following an example how to use it

repositories { mavenCentral() }
dependencies {
    implementation("ch.tutteli.niok:niok:1.5.0")
}

Documentation

Visit https://robstoll.github.io/niok/kdoc.

Contribute

You found a bug, a delegation to Files is missing or there is something else you would like to improve? Please open an issue, contributions are more than welcome 👍

License

Niok is licensed under Apache 2.0.

niok's People

Contributors

Stargazers

Watchers

Forkers

jgleitz xjoewoo cybernetics

niok's Issues

Files#getFileAttributeView’s result might be `null`

If the returned result is null, Kotlin will raise an IllegalStateException. This happens for example when requesting an AclFileAttributeView on Linux.

Compatibility to Java 9

This library does not seem to be compatible to Java 9, (see https://travis-ci.org/robstoll/atrium/builds/575927779)

The error message is:

error: cannot access module-info

  bad class file: /home/travis/.gradle/caches/modules-2/files-2.1/ch.tutteli.niok/niok/0.3.0/eecfeb6c40253092a279e92c9618ddde052bb8b3/niok-0.3.0.jar(/module-info.class)

    class file has wrong version 55.0, should be 53.0

    Please remove or make sure it appears in the correct subdirectory of the classpath.

It seems like the target version should be set to at least Java 9 when compiling, but I am not sure about that.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/build-ubuntu.yml

actions/checkout v4

actions/setup-java v4

gradle/gradle-build-action v3.4.2

.github/workflows/build-windows.yml

actions/checkout v4

actions/setup-java v4

gradle/gradle-build-action v3.4.2

.github/workflows/validate-gradle-wrapper.yml

actions/checkout v4

gradle/wrapper-validation-action v3

gradle

settings.gradle.kts

build.gradle.kts

org.jetbrains.kotlin.jvm 2.0.0

org.jetbrains.dokka 1.9.20

ch.tutteli.gradle.plugins.dokka 5.0.1

ch.tutteli.gradle.plugins.kotlin.module.info 5.0.1

ch.tutteli.gradle.plugins.publish 5.0.1

ch.tutteli.gradle.plugins.spek 5.0.1

io.gitlab.arturbosch.detekt 1.23.6

io.github.gradle-nexus.publish-plugin 2.0.0

ch.tutteli.atrium:atrium-fluent 1.2.0

ch.tutteli.spek:tutteli-spek-extensions 1.2.1

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.8

Check this box to trigger a request for Renovate to run again on this repository

update to tutteli-spek-extensions 1.0.0

TODO:

update tutteli-spek-extensions in build.gradle
change the implementation of AbsolutePathAsStringSpec, remove TempFolder and use memoizedTempFolder instead (see https://github.com/robstoll/tutteli-spek-extensions/blob/master/README.md#usage)
change the implementation of FileAttributeViewSpec
change the implementation of RelativeToSpec

Please add a comment I'll work on this so that I can assign the task to you.

update the gradle wrapper

TODO:

update the gradle wrapper
rename the resulting gradlew back to gr/gr.bat

add Path.followSymLink

this would replace Files.readSymbolicLink(path)

Feature request: create file if not exists

While using your library to work with java.nio.file.Path instances I found myself missing a function to "just make sure a file exists".
With plain Java, the next best fix would be to create some helper class that handles the problem in a generic manner.
But with Kotlin, this can be an extension function 😄

My proposal is the addition of the following function to this library:

inline fun Path.createFileIfNotExists(vararg fileAttributes: FileAttribute<*>): Path =
    apply { try { createFile(fileAttributes) } catch (ignored: FileAlreadyExistsException) {} }

The longer (more readable form is the following:

inline fun Path.createFileIfNotExists(vararg fileAttributes: FileAttribute<*>): Path =
    this.also { path ->
        try {
            path.createFile(fileAttributes)
        } catch (ignored: FileAlreadyExistsException) {}
    }

The implementation uses another extension function provided by your library: Path.createFile().
It is of course possible to delegate directly to the java.nio.file.Files API which would change the semantics a bit and save an intermediate method call.

Also, the above proof of concept code is untested. Maybe inline functions have constraints that require a non-inline solution for this functionality.

I can provide a merge request if you are interested in this functionality.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.