add clamp

0.4.10

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.11
+
+* `Common`
+    * Add `clamp` function
+
 ## 0.4.10
 
 * `Versions`:

README.md

@@ -1 +1,35 @@
 # MicroUtils
+
+This is a library with collection of tools for working in Kotlin environment. First of all, this library collection is oriented to use next technologies:
+
+* [`Kotlin Coroutines`](https://github.com/Kotlin/kotlinx.coroutines)
+* [`Kotlin Serialization`](https://github.com/Kotlin/kotlinx.serialization)
+* [`Kotlin Exposed`](https://github.com/JetBrains/Exposed)
+* [`Ktor`](https://ktor.io)
+
+<details>
+  <summary> <b>Android environment</b> </summary>
+
+You always can look at the <a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master/gradle.properties#L24-L34">properties file</a> to get information about current project dependencies, compile and build tools for `Android` target.
+
+</details>
+
+## Projects
+
+* `common` contains common tools for platform which usually are absent out-of-the-box when you starting project
+* `coroutines` is a module for `Kotlin Coroutines` with different things like subscribing on flows (`onEach` + `launchIn` shortcut :) )
+* `ktor` is a set of modules for `client`s and `server`s
+* `mime_types` is NOT lightweight set of `MimeType`s with a lot of different objected and serializable (with `Kotlin Serialization`) mime types
+* `pagination` is a complex of modules (explanation in [Complex modules structure](#complex-modules-structure) section) for lightweight pagination
+* `repos` is a complex of modules (explanation in [Complex modules structure](#complex-modules-structure) section) for `KeyValue`/`OneToMany`/`CRUD` repos created to be able to exclude some heavy dependencies when you need some simple and lightweight typical repositories
+
+## Complex modules structure
+
+Most of complex modules are built with next hierarchy:
+
+* `common` submodule for `API` things which are common for all platforms
+* `exposed` submodule contains realizations for exposed tables
+* `ktor` submodule is usually unavailable directly, because it contains its own submodules for clients and servers
+    * `common` part contains routes which are common for clients and servers
+    * `client` submodule contains clients which are usually using `UnifiedRequester` to make requests using routes from `ktor/common` module and some internal logic of requests
+    * `server` submodule (in most cases `JVM`-only) contains some extensions for `Route` instances which usually will give opportunity to proxy internet requests from `ktor/client` realization to some proxy object

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

common/src/commonMain/kotlin/dev/inmo/micro_utils/common/Clamp.kt

@@ -0,0 +1,10 @@
+package dev.inmo.micro_utils.common
+
+@Suppress("NOTHING_TO_INLINE")
+inline fun <T : Comparable<T>> T.clamp(min: T, max: T): T {
+    return when {
+        this < min -> min
+        this > max -> max
+        else -> this
+    }
+}

gradle.properties

@@ -40,5 +40,5 @@ dokka_version=1.4.20
 # Project data
 
 group=dev.inmo
-version=0.4.10
-android_code_version=14
+version=0.4.11
+android_code_version=15