Merge pull request #18 from LDRAlighieri/release/1.10.0

Release 1.10.0. New BOM module, update kotlin, material and other dependencies
LDRAlighieri · Dec 19, 2023 · 3eda8f7 · 3eda8f7
2 parents 12d7e6b + 184177c
commit 3eda8f7
Show file tree

Hide file tree

Showing 31 changed files with 323 additions and 239 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 # ChangeLog
 
 
+## Version 1.10.0
+
+* New: BOM (Bills of Materials) module:
+* Update: Kotlin to v1.9.21.
+* Update: Material components to v1.11.0.
+* Update: Minor update of other libraries.
+
+
 ## Version 1.9.0
 
 * New: Bindings list:

diff --git a/LICENSE b/LICENSE
@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2019-2023 Vladimir Raupov
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![Corbind](logo.svg)](https://ldralighieri.github.io/Corbind)
 
 [![Maven Central](https://img.shields.io/maven-central/v/ru.ldralighieri.corbind/corbind.svg)](https://search.maven.org/search?q=g:ru.ldralighieri.corbind)
-[![Kotlin Version](https://img.shields.io/badge/Kotlin-v1.9.10-blue.svg?logo=kotlin)](https://kotlinlang.org)
+[![Kotlin Version](https://img.shields.io/badge/Kotlin-v1.9.21-blue.svg?logo=kotlin)](https://kotlinlang.org)
 [![Kotlin Coroutines Version](https://img.shields.io/badge/Coroutines-v1.7.3-blue.svg)](https://kotlinlang.org/docs/reference/coroutines-overview.html)
 [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
@@ -27,34 +27,37 @@ Please consider giving this repository a star ⭐ if you like the project.
 
 Platform bindings:
 ```kotlin
-dependencies {
-    implementation("ru.ldralighieri.corbind:corbind:1.9.0")
+dependencies { 
+    implementation(platform("ru.ldralighieri.corbind:corbind-bom:2023.12.00"))
+    implementation("ru.ldralighieri.corbind:corbind")
 }
 ```
 
 AndroidX library bindings:
 ```kotlin
-dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-activity:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-appcompat:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-core:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-drawerlayout:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-fragment:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-leanback:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-lifecycle:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-navigation:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-recyclerview:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-slidingpanelayout:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-swiperefreshlayout:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-viewpager:1.9.0")
-    implementation("ru.ldralighieri.corbind:corbind-viewpager2:1.9.0")
+dependencies { 
+    implementation(platform("ru.ldralighieri.corbind:corbind-bom:2023.12.00"))
+    implementation("ru.ldralighieri.corbind:corbind-activity")
+    implementation("ru.ldralighieri.corbind:corbind-appcompat")
+    implementation("ru.ldralighieri.corbind:corbind-core")
+    implementation("ru.ldralighieri.corbind:corbind-drawerlayout")
+    implementation("ru.ldralighieri.corbind:corbind-fragment")
+    implementation("ru.ldralighieri.corbind:corbind-leanback")
+    implementation("ru.ldralighieri.corbind:corbind-lifecycle")
+    implementation("ru.ldralighieri.corbind:corbind-navigation")
+    implementation("ru.ldralighieri.corbind:corbind-recyclerview")
+    implementation("ru.ldralighieri.corbind:corbind-slidingpanelayout")
+    implementation("ru.ldralighieri.corbind:corbind-swiperefreshlayout")
+    implementation("ru.ldralighieri.corbind:corbind-viewpager")
+    implementation("ru.ldralighieri.corbind:corbind-viewpager2")
 }
 ```
 
 Google 'material' library bindings:
 ```kotlin
-dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-material:1.9.0")
+dependencies { 
+    implementation(platform("ru.ldralighieri.corbind:corbind-bom:2023.12.00"))
+    implementation("ru.ldralighieri.corbind:corbind-material")
 }
 ```
 
@@ -65,8 +68,9 @@ repositories {
     maven("https://oss.sonatype.org/content/repositories/snapshots/")
 }
 
-dependencies {
-   implementation("ru.ldralighieri.corbind:{module}:1.10.0-SNAPSHOT")
+dependencies { 
+    implementation(platform("ru.ldralighieri.corbind:corbind-bom:2024.01.00-SNAPSHOT"))
+    implementation("ru.ldralighieri.corbind:{module}")
 }
 ```
 

diff --git a/build-logic/convention/src/main/kotlin/LibraryConventionPlugin.kt b/build-logic/convention/src/main/kotlin/LibraryConventionPlugin.kt
@@ -23,7 +23,6 @@ import ru.ldralighieri.corbind.configureKotlinAndroid
 
 @Suppress("unused")
 class LibraryConventionPlugin : Plugin<Project> {
-    @Suppress("UnstableApiUsage")
     override fun apply(target: Project) {
         with(target) {
             with(pluginManager) {

diff --git a/build-logic/convention/src/main/kotlin/SpotlessConventionPlugin.kt b/build-logic/convention/src/main/kotlin/SpotlessConventionPlugin.kt
@@ -17,17 +17,15 @@
 import com.diffplug.gradle.spotless.SpotlessExtension
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-import org.gradle.api.artifacts.VersionCatalogsExtension
 import org.gradle.kotlin.dsl.configure
-import org.gradle.kotlin.dsl.getByType
+import ru.ldralighieri.corbind.libs
 
 @Suppress("unused")
 class SpotlessConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             pluginManager.apply("com.diffplug.spotless")
 
-            val libs = extensions.getByType<VersionCatalogsExtension>().named("libs")
             extensions.configure<SpotlessExtension> {
                 kotlin {
                     target("**/*.kt")

diff --git a/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+libs.kt b/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+libs.kt
@@ -0,0 +1,9 @@
+package ru.ldralighieri.corbind
+
+import org.gradle.api.Project
+import org.gradle.api.artifacts.VersionCatalog
+import org.gradle.api.artifacts.VersionCatalogsExtension
+import org.gradle.kotlin.dsl.getByType
+
+val Project.libs
+    get(): VersionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -30,6 +30,7 @@ plugins {
 apiValidation {
     ignoredProjects.add("sample")
     ignoredPackages.add("ru/ldralighieri/corbind/internal")
+    ignoredPackages.add("corbind-bom")
 }
 
 // Dependency updates

diff --git a/corbind-activity/README.md b/corbind-activity/README.md
@@ -5,18 +5,17 @@ To add androidx activity bindings, import `corbind-activity` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-activity:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-activity:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**OnBackPressedDispatcher** | [`backPresses`][OnBackPressedDispatcher_backPresses] | Called when OnBackPressedDispatcher.onBackPressed triggered. OnBackPressed events only 
-                         | [`backProgressed`][OnBackPressedDispatcher_backProgressed] | Called when OnBackPressedDispatcher.dispatchOnBackProgressed triggered. OnBackProgressed event only
-                         | [`backEvents`][OnBackPressedDispatcher_backEvents] | Called when any callback event triggered. All events
-
+| Component                   | Extension                                                  | Description                                                                                         |
+|-----------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
+| **OnBackPressedDispatcher** | [`backPresses`][OnBackPressedDispatcher_backPresses]       | Called when OnBackPressedDispatcher.onBackPressed triggered. OnBackPressed events only              |
+|                             | [`backProgressed`][OnBackPressedDispatcher_backProgressed] | Called when OnBackPressedDispatcher.dispatchOnBackProgressed triggered. OnBackProgressed event only |
+|                             | [`backEvents`][OnBackPressedDispatcher_backEvents]         | Called when any callback event triggered. All events                                                |
 
 ## Simple examples
 

diff --git a/corbind-appcompat/README.md b/corbind-appcompat/README.md
@@ -5,22 +5,21 @@ To add androidx appcompat bindings, import `corbind-appcompat` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-appcompat:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-appcompat:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**ActionMenuView** | [`itemClicks`][ActionMenuView_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event.
-**PopupMenu** | [`dismisses`][PopupMenu_dismisses] | Called when the associated menu has been dismissed.
-              | [`itemClicks`][PopupMenu_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event.
-**SearchView** | [`queryTextChanges`][SearchView_queryTextChanges] | Called when the query text is changed by the user.
-               | [`queryTextChangeEvents`][SearchView_queryTextChangeEvents] | A more advanced version of the `queryTextChanges`.
-**Toolbar** | [`itemClicks`][Toolbar_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event.
-            | [`navigationClicks`][Toolbar_navigationClicks] | Called whenever the user clicks the navigation button at the start of the toolbar.
-
+| Component          | Extension                                                   | Description                                                                             |
+|--------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------------------|
+| **ActionMenuView** | [`itemClicks`][ActionMenuView_itemClicks]                   | Called when a menu item is clicked if the item itself did not already handle the event. |
+| **PopupMenu**      | [`dismisses`][PopupMenu_dismisses]                          | Called when the associated menu has been dismissed.                                     |
+|                    | [`itemClicks`][PopupMenu_itemClicks]                        | Called when a menu item is clicked if the item itself did not already handle the event. |
+| **SearchView**     | [`queryTextChanges`][SearchView_queryTextChanges]           | Called when the query text is changed by the user.                                      |
+|                    | [`queryTextChangeEvents`][SearchView_queryTextChangeEvents] | A more advanced version of the `queryTextChanges`.                                      |
+| **Toolbar**        | [`itemClicks`][Toolbar_itemClicks]                          | Called when a menu item is clicked if the item itself did not already handle the event. |
+|                    | [`navigationClicks`][Toolbar_navigationClicks]              | Called whenever the user clicks the navigation button at the start of the toolbar.      |
 
 ## Example
 

diff --git a/corbind-bom/.gitignore b/corbind-bom/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/corbind-bom/README.md b/corbind-bom/README.md
@@ -0,0 +1,10 @@
+
+# corbind-bom
+
+Corbind Libraries BOM (Bills of Materials).
+
+```kotlin
+dependencies {
+    implementation(platform("ru.ldralighieri.corbind:corbind-bom:2023.12.00"))
+}
+```
diff --git a/corbind-bom/build.gradle.kts b/corbind-bom/build.gradle.kts
@@ -0,0 +1,24 @@
+plugins {
+    `java-platform`
+    id("com.vanniktech.maven.publish")
+}
+
+dependencies {
+    constraints {
+        api(projects.corbind)
+        api(projects.corbindActivity)
+        api(projects.corbindAppcompat)
+        api(projects.corbindCore)
+        api(projects.corbindDrawerlayout)
+        api(projects.corbindFragment)
+        api(projects.corbindLeanback)
+        api(projects.corbindLifecycle)
+        api(projects.corbindMaterial)
+        api(projects.corbindNavigation)
+        api(projects.corbindRecyclerview)
+        api(projects.corbindSlidingpanelayout)
+        api(projects.corbindSwiperefreshlayout)
+        api(projects.corbindViewpager)
+        api(projects.corbindViewpager2)
+    }
+}
diff --git a/corbind-bom/gradle.properties b/corbind-bom/gradle.properties
@@ -0,0 +1,22 @@
+#
+# Copyright 2023 Vladimir Raupov
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+VERSION_NAME=2023.12.00
+
+POM_ARTIFACT_ID=corbind-bom
+POM_NAME=Corbind Libraries BOM
+POM_DESCRIPTION=A compatible set of Corbind libraries
diff --git a/corbind-bom/proguard-rules.pro b/corbind-bom/proguard-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.kts.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
diff --git a/corbind-core/README.md b/corbind-core/README.md
@@ -5,16 +5,15 @@ To add androidx core bindings, import `corbind-core` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-core:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-core:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**NestedScrollView** | [`scrollChangeEvents`][NestedScrollView_scrollChangeEvents] | Called when the scroll position of a view changes.
-
+| Component            | Extension                                                   | Description                                        |
+|----------------------|-------------------------------------------------------------|----------------------------------------------------|
+| **NestedScrollView** | [`scrollChangeEvents`][NestedScrollView_scrollChangeEvents] | Called when the scroll position of a view changes. |
 
 ## Example
 

diff --git a/corbind-drawerlayout/README.md b/corbind-drawerlayout/README.md
@@ -5,16 +5,15 @@ To add androidx drawerlayout bindings, import `corbind-drawerlayout` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-drawerlayout:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-drawerlayout:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**DrawerLayout** | [`drawerOpens`][DrawerLayout_drawerOpens] | Called when a drawer has settled in a completely open or close state.
-
+| Component        | Extension                                 | Description                                                           |
+|------------------|-------------------------------------------|-----------------------------------------------------------------------|
+| **DrawerLayout** | [`drawerOpens`][DrawerLayout_drawerOpens] | Called when a drawer has settled in a completely open or close state. |
 
 ## Example
 

diff --git a/corbind-fragment/README.md b/corbind-fragment/README.md
@@ -5,16 +5,15 @@ To add androidx fragment bindings, import `corbind-fragment` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-fragment:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-fragment:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**FragmentManager** | [`resultEvents`][FragmentManager_resultEvents] | Called when any results set by setFragmentResult using the same requestKey.
-
+| Component           | Extension                                      | Description                                                                 |
+|---------------------|------------------------------------------------|-----------------------------------------------------------------------------|
+| **FragmentManager** | [`resultEvents`][FragmentManager_resultEvents] | Called when any results set by setFragmentResult using the same requestKey. |
 
 ## Simple examples
 

diff --git a/corbind-leanback/README.md b/corbind-leanback/README.md
@@ -5,18 +5,17 @@ To add androidx leanback bindings, import `corbind-leanback` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-leanback:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-leanback:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**SearchBar** | [`searchQueryChanges`][SearchBar_searchQueryChanges] | Called when the search bar detects a change in the query.
-              | [`searchQueryChangeEvents`][SearchBar_searchQueryChangeEvents] | A more advanced version of the `searchQueryChanges`.
-**SearchEditText** | [`keyboardDismisses`][SearchEditText_keyboardDismisses] | Called when the keyboard is dismissed.
-
+| Component          | Extension                                                      | Description                                               |
+|--------------------|----------------------------------------------------------------|-----------------------------------------------------------|
+| **SearchBar**      | [`searchQueryChanges`][SearchBar_searchQueryChanges]           | Called when the search bar detects a change in the query. |
+|                    | [`searchQueryChangeEvents`][SearchBar_searchQueryChangeEvents] | A more advanced version of the `searchQueryChanges`.      |
+| **SearchEditText** | [`keyboardDismisses`][SearchEditText_keyboardDismisses]        | Called when the keyboard is dismissed.                    |
 
 ## Example
 

diff --git a/corbind-lifecycle/README.md b/corbind-lifecycle/README.md
@@ -5,16 +5,15 @@ To add androidx lifecycle bindings, import `corbind-lifecycle` module:
 
 ```kotlin
 dependencies {
-    implementation("ru.ldralighieri.corbind:corbind-lifecycle:1.9.0")
+    implementation("ru.ldralighieri.corbind:corbind-lifecycle:1.10.0")
 }
 ```
 
 ## List of extensions
 
-Component | Extension | Description
---|---|--
-**Lifecycle** | [`events`][Lifecycle_events] | Called when any lifecycle event change.
-
+| Component     | Extension                    | Description                             |
+|---------------|------------------------------|-----------------------------------------|
+| **Lifecycle** | [`events`][Lifecycle_events] | Called when any lifecycle event change. |
 
 ## Simple examples