v1.5.0

robstoll · Mar 5, 2024 · 65f3876 · 65f3876
1 parent 0414263
commit 65f3876
Show file tree

Hide file tree

Showing 85 changed files with 433 additions and 426 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,16 @@
 <!-- for main -->
-
-[![Download](https://img.shields.io/badge/Download-1.4.7-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.4.7/jar)
+<!--
+[![Download](https://img.shields.io/badge/Download-1.5.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.5.0/jar)
 [![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
 [![Build Status Ubuntu](https://github.com/robstoll/niok/workflows/Ubuntu/badge.svg?event=push)](https://github.com/robstoll/niok/actions?query=workflow%3AUbuntu+branch%3Amain)
 [![Build Status Windows](https://github.com/robstoll/niok/workflows/Windows/badge.svg?event=push)](https://github.com/robstoll/niok/actions?query=workflow%3AWindows+branch%3Amain)
 [![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=robstoll_niok&metric=alert_status)](https://sonarcloud.io/dashboard?id=robstoll_niok)
-
+-->
 <!-- for a specific release -->
-<!--
-[![Download](https://img.shields.io/badge/Download-1.4.7-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.4.7/jar)
+
+[![Download](https://img.shields.io/badge/Download-1.5.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.5.0/jar)
 [![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
--->
+
 
 # Niok - java.nio.file for Kotlin
 
@@ -27,7 +27,7 @@ Niok is published to maven central. Following an example how to use it
 ```
 repositories { mavenCentral() }
 dependencies {
-    implementation("ch.tutteli.niok:niok:1.4.7")
+    implementation("ch.tutteli.niok:niok:1.5.0")
 }
 ```
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -3,7 +3,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 buildscript {
     // needs to be defined in here because otherwise tutteli-publish plugin does not have this information when applied
     rootProject.group = "ch.tutteli.niok"
-    rootProject.version = "1.5.0-SNAPSHOT"
+    rootProject.version = "1.5.0"
     rootProject.description = "API for java.nio.file in a Kotlin idiomatic way"
 }
 
@@ -81,18 +81,18 @@ nexusPublishing {
 Release & deploy a commit
 --------------------------------
 1. generate dokka
-a) gr dokka
+a) gr dokkaHtml
 b) check if output/links are still good (use intellij's http server via -> right click -> open in -> browser)
 
 2. update main:
 
 Either use the following commands or the manual steps below
 
-export NIOK_PREVIOUS_VERSION=1.4.7
-export NIOK_VERSION=1.4.8
+export NIOK_PREVIOUS_VERSION=1.5.0
+export NIOK_VERSION=1.5.0
 find ./ -name "*.md" | xargs perl -0777 -i \
    -pe "s@$NIOK_PREVIOUS_VERSION@$NIOK_VERSION@g;" \
-   -pe "s@tree/v1.4.7@tree/v$NIOK_VERSION@g;"
+   -pe "s@tree/v1.5.0@tree/v$NIOK_VERSION@g;"
 perl -0777 -i \
   -pe "s@$NIOK_PREVIOUS_VERSION@$NIOK_VERSION@g;" \
   -pe "s/rootProject.version = \"$NIOK_VERSION-SNAPSHOT\"/rootProject.version = \"$NIOK_VERSION\"/;" \
@@ -125,10 +125,10 @@ alternatively the manual steps:
 Prepare next dev cycle
 -----------------------
 
-export NIOK_VERSION=1.4.7
+export NIOK_VERSION=1.5.0
 export NIOK_NEXT_VERSION=1.4.8
 find ./ -name "*.md" | xargs perl -0777 -i \
-   -pe "s@tree/v$NIOK_VERSION@tree/v1.4.7@g;";
+   -pe "s@tree/v$NIOK_VERSION@tree/v1.5.0@g;";
 perl -0777 -i \
   -pe "s/rootProject.version = \"$NIOK_VERSION\"/rootProject.version = \"$NIOK_NEXT_VERSION-SNAPSHOT\"/;" \
   -pe "s/NIOK_VERSION=$NIOK_VERSION/NIOK_VERSION=$NIOK_NEXT_VERSION/;" \

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-[![Download](https://img.shields.io/badge/Download-1.4.7-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.4.7/jar)
+[![Download](https://img.shields.io/badge/Download-1.5.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.5.0/jar)
 [![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
 
 # Niok - java.nio.file for Kotlin
@@ -16,7 +16,7 @@ Niok is published to maven central. Following an example how to use it
 ```
 repositories { mavenCentral() }
 dependencies {
-    implementation("ch.tutteli.niok:niok:1.4.7")
+    implementation("ch.tutteli.niok:niok:1.5.0")
 }
 ```
 

diff --git a/docs/kdoc/images/docs_logo.svg b/docs/kdoc/images/docs_logo.svg
diff --git a/docs/kdoc/images/homepage.svg b/docs/kdoc/images/homepage.svg
diff --git a/docs/kdoc/index.html b/docs/kdoc/index.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.4.7            </div>
+1.5.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -88,7 +88,7 @@ <h2 class="">Packages</h2>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/kdoc/navigation.html b/docs/kdoc/navigation.html
@@ -115,7 +115,7 @@
     </div>
     <div class="sideMenuPart" id="niok-nav-submenu-0-37" pageId="niok::ch.tutteli.niok//nameWithoutExtension/java.nio.file.Path#/PointingToDeclaration//769193423">
       <div class="overview"><a href="niok/ch.tutteli.niok/name-without-extension.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon val"></span><span class="nav-link-child">
-              <strike><span>name</span><wbr></wbr><span>Without</span><wbr></wbr><span><span>Extension</span></span></strike>
+              <strike class="strikethrough"><span>name</span><wbr></wbr><span>Without</span><wbr></wbr><span><span>Extension</span></span></strike>
             </span></span></a></div>
     </div>
     <div class="sideMenuPart" id="niok-nav-submenu-0-38" pageId="niok::ch.tutteli.niok//newBufferedReader/java.nio.file.Path#java.nio.charset.Charset/PointingToDeclaration//769193423">

diff --git a/docs/kdoc/niok/ch.tutteli.niok/absolute-path-as-string.html b/docs/kdoc/niok/ch.tutteli.niok/absolute-path-as-string.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.4.7            </div>
+1.5.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -66,10 +66,10 @@
   <div class="cover ">
     <h1 class="cover"><span>absolute</span><wbr></wbr><span>Path</span><wbr></wbr><span>As</span><wbr></wbr><span><span>String</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="absolute-path-as-string.html">absolutePathAsString</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.4.7/src/main/kotlin/ch/tutteli/niok/pathExtensions.kt#L14">source</a>)</span></span></div><p class="paragraph">Returns <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#toAbsolutePath--">Path.toAbsolutePath</a>.<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#toString--">Path.toString</a>.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="absolute-path-as-string.html">absolutePathAsString</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.5.0/src/main/kotlin/ch/tutteli/niok/pathExtensions.kt#L14">source</a>)</span></span></div><p class="paragraph">Returns <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#toAbsolutePath--">Path.toAbsolutePath</a>.<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#toString--">Path.toString</a>.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/kdoc/niok/ch.tutteli.niok/append-bytes.html b/docs/kdoc/niok/ch.tutteli.niok/append-bytes.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.4.7            </div>
+1.5.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -66,10 +66,10 @@
   <div class="cover ">
     <h1 class="cover"><span>append</span><wbr></wbr><span><span>Bytes</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="append-bytes.html"><span class="token function">appendBytes</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.4.7/src/main/kotlin/ch/tutteli/niok/pathDelegateToKotlinFile.kt#L15">source</a>)</span></span></div><p class="paragraph">Delegates to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html">kotlin.io.appendBytes</a>.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="append-bytes.html"><span class="token function">appendBytes</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.5.0/src/main/kotlin/ch/tutteli/niok/pathDelegateToKotlinFile.kt#L15">source</a>)</span></span></div><p class="paragraph">Delegates to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html">kotlin.io.appendBytes</a>.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/kdoc/niok/ch.tutteli.niok/append-text.html b/docs/kdoc/niok/ch.tutteli.niok/append-text.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.4.7            </div>
+1.5.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -66,10 +66,10 @@
   <div class="cover ">
     <h1 class="cover"><span>append</span><wbr></wbr><span><span>Text</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="append-text.html"><span class="token function">appendText</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">text<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">charset<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Charset</a><span class="token operator"> = </span>Charsets.UTF_8</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.4.7/src/main/kotlin/ch/tutteli/niok/pathDelegateToKotlinFile.kt#L21">source</a>)</span></span></div><p class="paragraph">Delegates to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html">kotlin.io.appendText</a>.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a><span class="token punctuation">.</span><a href="append-text.html"><span class="token function">appendText</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">text<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">charset<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Charset</a><span class="token operator"> = </span>Charsets.UTF_8</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/niok/tree/v1.5.0/src/main/kotlin/ch/tutteli/niok/pathDelegateToKotlinFile.kt#L21">source</a>)</span></span></div><p class="paragraph">Delegates to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html">kotlin.io.appendText</a>.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>