Skip to content

Commit

Permalink
v1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
robstoll committed May 31, 2024
1 parent 82696c8 commit a02fbc8
Show file tree
Hide file tree
Showing 44 changed files with 201 additions and 132 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
<!-- for main -->
<!--
[![Download](https://img.shields.io/badge/Download-1.1.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.kbox/kbox/1.1.0/jar)
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.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)
[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=robstoll_kbox&metric=alert_status)](https://sonarcloud.io/dashboard?id=robstoll_kbox)
-->

<!-- for a specific release -->

[![Download](https://img.shields.io/badge/Download-1.1.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.kbox/kbox/1.1.0/jar)
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.2.0)
[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)


Expand All @@ -31,7 +30,7 @@ KBox is published to maven central.
```
repositories { mavenCentral() }
dependencies {
implementation("ch.tutteli.kbox:kbox:1.1.0")
implementation("ch.tutteli.kbox:kbox:1.2.0")
}
```

Expand Down
10 changes: 6 additions & 4 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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 = "1.2.0-SNAPSHOT"
rootProject.version = "1.2.0"
rootProject.group = "ch.tutteli.kbox"
rootProject.description = "A utility library for Kotlin "
}
Expand Down Expand Up @@ -37,6 +37,7 @@ kotlin {
val kotlinVersion = KotlinVersion.KOTLIN_1_4
apiVersion.set(kotlinVersion)
languageVersion.set(kotlinVersion)
freeCompilerArgs.add("-Xexpect-actual-classes")
}

jvm { withJava() }
Expand Down Expand Up @@ -133,9 +134,10 @@ Release & deploy a commit
2. update main:
a) point to the tag, search for `tree/main` and replace it with `tree/vX.Y.Z` (README.md)
b) update badges
c) commit (modified docs/index.md, build.gradle.kts, README.md)
c) git tag vX.Y.Z
d) git push origin vX.Y.Z
c) gr dokkaHtml
d) commit (modified docs/index.md, docs/kdoc/*, build.gradle.kts, README.md)
e) git tag vX.Y.Z
f) git push origin vX.Y.Z
4. deploy to maven-central:
a) echo "enter the sonatype user token"
read SONATYPE_PW
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Download](https://img.shields.io/badge/Download-1.1.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.kbox/kbox/1.1.0/jar)
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.2.0)
[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)

# KBox
Expand All @@ -11,7 +11,7 @@ KBox is published to maven central.
```
repositories { mavenCentral() }
dependencies {
implementation("ch.tutteli.kbox:kbox:1.1.0")
implementation("ch.tutteli.kbox:kbox:1.2.0")
}
```

Expand Down
20 changes: 1 addition & 19 deletions docs/kdoc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
1.1.0 </div>
1.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>
Expand Down Expand Up @@ -89,24 +89,6 @@ <h2 class="">Packages</h2>
<div></div>
</div>
</div>
<a data-name="-779448838%2FPackages%2F788909594" anchor-label="ch.tutteli.kbox.impl" id="-779448838%2FPackages%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="kbox/ch.tutteli.kbox.impl/index.html">ch.tutteli.kbox.impl</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-779448838%2FPackages%2F788909594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
</div>
</div>
<div class="footer">
Expand Down
4 changes: 2 additions & 2 deletions docs/kdoc/kbox/ch.tutteli.kbox/-jvm-synchronized/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
1.1.0 </div>
1.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>
Expand All @@ -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/v1.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/v1.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/v1.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.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/v1.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.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/v1.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.jvm/-synchronized/index.html">Synchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v1.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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
1.1.0 </div>
1.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>
Expand All @@ -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/v1.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/v1.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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
1.1.0 </div>
1.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>
Expand All @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>invoke</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/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v1.1.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L23">source</a>)</span></span></div><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 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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v1.2.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L23">source</a>)</span></span></div><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="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
Loading

0 comments on commit a02fbc8

Please sign in to comment.