v2.2.0 Pair/Triple/TupleN.flatten

Author: robstoll

README.md

@@ -1,28 +1,28 @@
 <!-- for main -->
 
-[![Download](https://img.shields.io/badge/Download-2.1.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.1.0)
+[![Download](https://img.shields.io/badge/Download-2.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.2.0)
 [![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/kbox/workflows/Ubuntu/badge.svg?event=push)](https://github.com/robstoll/kbox/actions?query=workflow%3AUbuntu+branch%3Amain)
 [![Build Status Windows](https://github.com/robstoll/kbox/workflows/Windows/badge.svg?event=push)](https://github.com/robstoll/kbox/actions?query=workflow%3AWindows+branch%3Amain)
 
 
 <!-- for a specific release -->
 <!--
-[![Download](https://img.shields.io/badge/Download-2.1.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.1.0)
+[![Download](https://img.shields.io/badge/Download-2.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.2.0)
 [![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
 -->
 
 # KBox
 KBox is a very small but useful utility library for Kotlin (JVM, Android and JS) providing functions which are missing
 in the stdlib such as:
-- [failIf](https://github.com/robstoll/kbox/tree/main/src/commonMain/kotlin/ch/tutteli/kbox/failIf.kt)
-- [takeIf](https://github.com/robstoll/kbox/blob/main/src/commonMain/kotlin/ch/tutteli/kbox/takeIf.kt)
-- [blankToNull](https://github.com/robstoll/kbox/blob/main/src/commonMain/kotlin/ch/tutteli/kbox/blankToNull.kt)
-- [isNotNullAndNotEmpty/Blank](https://github.com/robstoll/kbox/blob/main/src/commonMain/kotlin/ch/tutteli/kbox/isNotNullAndNot.kt)
-- [identity](https://github.com/robstoll/kbox/blob/main/src/commonMain/kotlin/ch/tutteli/kbox/identity.kt)
-- [Tuple4(Like) - Tuple9(Like)](https://github.com/robstoll/kbox/tree/main/src/commonMain/generated/kotlin/ch/tutteli/kbox)  
+- [failIf](https://github.com/robstoll/kbox/blob/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/failIf.kt)
+- [takeIf](https://github.com/robstoll/kbox/blob/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/takeIf.kt)
+- [blankToNull](https://github.com/robstoll/kbox/blob/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/blankToNull.kt)
+- [isNotNullAndNotEmpty/Blank](https://github.com/robstoll/kbox/blob/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/isNotNullAndNot.kt)
+- [identity](https://github.com/robstoll/kbox/blob/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/identity.kt)
+- [Tuple4(Like) - Tuple9(Like)](https://github.com/robstoll/kbox/tree/v2.2.0/src/commonMain/generated/kotlin/ch/tutteli/kbox)  
   (including functions mapComponentX, append, glue)
-- [Triple/Pair.mapFirst/Second/Third](https://github.com/robstoll/kbox/tree/main/src/commonMain/generated/kotlin/ch/tutteli/kbox/tupleMap.kt#L12)
+- [Triple/Pair.mapFirst/Second/Third](https://github.com/robstoll/kbox/tree/v2.2.0/src/commonMain/generated/kotlin/ch/tutteli/kbox/tupleMap.kt#L12)
 
 and more, see the [Documentation](https://robstoll.github.io/kbox/kdoc/) for a full list.
 
@@ -33,7 +33,7 @@ KBox is published to maven central.
 ```
 repositories { mavenCentral() }
 dependencies {
-    implementation("ch.tutteli.kbox:kbox:2.1.0")
+    implementation("ch.tutteli.kbox:kbox:2.2.0")
 }
 ```
 

build.gradle.kts

@@ -4,8 +4,8 @@ import java.nio.file.StandardCopyOption
 
 buildscript {
     // needs to be defined in here because otherwise tutteli-publish plugin does not have this information when applied
-    // and we want that it to apply the ch.tutteli conventions
-    rootProject.version = "2.2.0-SNAPSHOT"
+    // and we use/apply it in the conventions
+    rootProject.version = "2.2.0"
     rootProject.group = "ch.tutteli.kbox"
     rootProject.description = "A utility library for Kotlin"
     extra.set("generationFolder", project.files("src/commonMain/generated/kotlin"))
@@ -22,8 +22,6 @@ plugins {
     alias(libs.plugins.nexus.publish)
 }
 
-
-
 kotlin {
     sourceSets {
         commonMain {
@@ -98,7 +96,7 @@ Release & deploy a commit
 --------------------------------
 1. search for X.Y.Z-SNAPSHOT and replace with X.Y.Z
 2. update main:
-    a) point to the tag, search for `tree/main` and replace it with `tree/vX.Y.Z` (README.md)
+    a) point to the tag, search for `(tree|blob)/main` and replace it with `$1/vX.Y.Z` (README.md)
     b) update badges
     c) gr dokkaHtml
     d) commit (modified docs/index.md, docs/kdoc/*, build.gradle.kts, README.md)

docs/index.md

@@ -1,4 +1,4 @@
-[![Download](https://img.shields.io/badge/Download-2.1.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.1.0)
+[![Download](https://img.shields.io/badge/Download-2.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.2.0)
 [![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
 
 # KBox
@@ -11,7 +11,7 @@ KBox is published to maven central.
 ```
 repositories { mavenCentral() }
 dependencies {
-    implementation("ch.tutteli.kbox:kbox:2.1.0")
+    implementation("ch.tutteli.kbox:kbox:2.2.0")
 }
 ```
 

docs/kdoc/-k-box/ch.tutteli.kbox/-jvm-synchronized/index.html

@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-2.1.0            </div>
+2.2.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@
     <h1 class="cover"><span>Jvm</span><wbr></wbr><span><span>Synchronized</span></span></h1>
     <div class="platform-hinted  with-platform-tabs" data-platform-hinted="data-platform-hinted">
       <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain" data-active="" data-toggle=":dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":dokkaHtml/jsMain" data-filterable-set=":dokkaHtml/jsMain" data-toggle=":dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":dokkaHtml/jvmMain" data-filterable-set=":dokkaHtml/jvmMain" data-toggle=":dokkaHtml/jvmMain">jvm</button></div>
-<div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">expect </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.1.0/src/commonMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Stands for <code class="lang-kotlin">kotlin.jvm.Synchronized</code> on the JVM platform and a dummy annotation on the other platforms.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jsMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">actual </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.1.0/src/jsMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Without any effects on the JS Platform.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="index.html">JvmSynchronized</a><span class="token operator"> = </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.1.0/src/jvmMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L6">source</a>)</span></span></div><p class="paragraph">Typealias for <code class="lang-kotlin">kotlin.jvm.Synchronized</code>.</p></div>    </div>
+<div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">expect </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Stands for <code class="lang-kotlin">kotlin.jvm.Synchronized</code> on the JVM platform and a dummy annotation on the other platforms.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jsMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">actual </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.2.0/src/jsMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Without any effects on the JS Platform.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="index.html">JvmSynchronized</a><span class="token operator"> = </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.2.0/src/jvmMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L6">source</a>)</span></span></div><p class="paragraph">Typealias for <code class="lang-kotlin">kotlin.jvm.Synchronized</code>.</p></div>    </div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-peeking-iterator/-companion/index.html

@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-2.1.0            </div>
+2.2.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -65,7 +65,7 @@
   <div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">Companion</span></div>
   <div class="cover ">
     <h1 class="cover"><span><span>Companion</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.1.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L16">source</a>)</span></span></div><p class="paragraph">Necessary so that extension methods can extend it.</p></div></div>
+    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.2.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L16">source</a>)</span></span></div><p class="paragraph">Necessary so that extension methods can extend it.</p></div></div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
@@ -82,7 +82,7 @@ <h2 class="">Functions</h2>
                   </span></span></div>
               <div>
                 <div class="title">
-                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">operator </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">itr<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterator/index.html">Iterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">PeekingIterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Platform independent method which creates a <a href="../index.html">PeekingIterator</a> based on a given <a href="invoke.html">itr</a>.</p></div></div></div>
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">operator </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">itr<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-iterator/index.html">Iterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">PeekingIterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Platform independent method which creates a <a href="../index.html">PeekingIterator</a> based on a given <a href="invoke.html">itr</a>.</p></div></div></div>
                 </div>
               </div>
             </div>