Merge pull request #161 from solrudev/develop

0.19.5

Author: solrudev

.github/workflows/ci.yml

@@ -5,7 +5,6 @@ on:
     types:
       - opened
       - synchronize
-      - closed
 
 permissions:
   contents: read
@@ -148,74 +147,4 @@ jobs:
           if ! grep -q -v -E '(failure|cancelled)' <<< "$results"; then
             echo "One or more required jobs failed"
             exit 1
-          fi
-
-  publish:
-    name: Upload artifacts
-    runs-on: ubuntu-latest
-    if: github.repository == 'solrudev/Ackpine' && github.event.pull_request.base.ref == 'master' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release')
-    needs: [ build ]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0
-        with:
-          persist-credentials: false
-
-      - name: Setup environment
-        uses: ./.github/actions/setup-gradle-environment-action
-        with:
-          gradle-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
-
-      - name: Publish
-        run: |
-          ./gradlew publishAndReleaseToMavenCentral
-        env:
-          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.OSSRH_USERNAME }}
-          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.OSSRH_PASSWORD }}
-          ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
-          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
-          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
-
-  publish-docs:
-    name: Publish documentation
-    runs-on: ubuntu-latest
-    if: github.repository == 'solrudev/Ackpine' && github.event.pull_request.base.ref == 'master' && github.event.pull_request.merged == true
-    needs: [ build ]
-
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0
-        with:
-          persist-credentials: false
-          fetch-depth: 0
-
-      - name: Setup environment
-        uses: ./.github/actions/setup-gradle-environment-action
-        with:
-          gradle-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
-
-      - name: Set up Python
-        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0
-        with:
-          python-version: 3.13.9
-
-      - name: Prepare API docs
-        run: |
-          ./gradlew :api-documentation:dokkaGenerate
-
-      - name: Build MkDocs
-        run: |
-          pip3 install --upgrade pip && pip3 install mkdocs-material mkdocs-minify-plugin
-          mkdocs build
-
-      - name: Deploy docs
-        if: success()
-        uses: JamesIves/github-pages-deploy-action@4a3abc783e1a24aeb44c16e869ad83caf6b4cc23 # 4.7.4
-        with:
-          branch: gh-pages
-          folder: site
-          single-commit: true
+          fi

.github/workflows/publish.yml

@@ -0,0 +1,80 @@
+name: publish
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Upload artifacts
+    runs-on: ubuntu-latest
+    if: github.repository == 'solrudev/Ackpine' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0
+        with:
+          persist-credentials: false
+
+      - name: Setup environment
+        uses: ./.github/actions/setup-gradle-environment-action
+        with:
+          gradle-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
+
+      - name: Publish
+        run: |
+          ./gradlew publishAndReleaseToMavenCentral
+        env:
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.OSSRH_USERNAME }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.OSSRH_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
+
+  publish-docs:
+    name: Publish documentation
+    runs-on: ubuntu-latest
+    if: github.repository == 'solrudev/Ackpine' && github.event.pull_request.merged == true
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Setup environment
+        uses: ./.github/actions/setup-gradle-environment-action
+        with:
+          gradle-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0
+        with:
+          python-version: 3.13.12
+
+      - name: Prepare API docs
+        run: |
+          ./gradlew :api-documentation:dokkaGenerate
+
+      - name: Build MkDocs
+        run: |
+          pip3 install --upgrade pip && pip3 install mkdocs-material mkdocs-minify-plugin
+          mkdocs build
+
+      - name: Deploy docs
+        if: success()
+        uses: JamesIves/github-pages-deploy-action@4a3abc783e1a24aeb44c16e869ad83caf6b4cc23 # 4.7.4
+        with:
+          branch: gh-pages
+          folder: site
+          single-commit: true

README.md

@@ -37,7 +37,7 @@ Ackpine depends on Jetpack libraries, so it's also necessary to add the `google(
 
 ```toml
 [versions]
-ackpine = "0.19.4"
+ackpine = "0.19.5"
 
 [libraries]
 ackpine-core = { module = "ru.solrudev.ackpine:ackpine-core", version.ref = "ackpine" }
@@ -81,7 +81,7 @@ ackpine = [
 
 ```kotlin
 dependencies {
-    val ackpineVersion = "0.19.4"
+    val ackpineVersion = "0.19.5"
     implementation("ru.solrudev.ackpine:ackpine-core:$ackpineVersion")
 
     // optional - Kotlin extensions and Coroutines support

ackpine-core/src/androidTest/kotlin/ru/solrudev/ackpine/impl/testutil/SessionTest.kt

@@ -16,10 +16,10 @@
 
 package ru.solrudev.ackpine.impl.testutil
 
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.CoroutineStart.UNDISPATCHED
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async
+import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.withContext
 import kotlinx.coroutines.withTimeout
 import ru.solrudev.ackpine.remote.RemoteSession
@@ -34,39 +34,42 @@ import kotlin.time.Duration
 import kotlin.time.Duration.Companion.seconds
 
 @OptIn(ExperimentalContracts::class)
-context(scope: CoroutineScope)
 suspend fun <F : Failure> Session<F>.test(
 	timeout: Duration = 30.seconds,
 	block: suspend (Session<F>) -> Unit
 ): Session.State.Completed<F> {
 	contract {
 		callsInPlace(block, InvocationKind.EXACTLY_ONCE)
 	}
-	val resultDeferred = scope.async(start = UNDISPATCHED) {
-		withContext(Dispatchers.Default.limitedParallelism(1)) {
+	return coroutineScope {
+		val resultDeferred = async(
+			context = Dispatchers.Default.limitedParallelism(1),
+			start = UNDISPATCHED
+		) {
 			withTimeout(timeout) {
 				await()
 			}
 		}
+		block(this@test)
+		resultDeferred.await()
 	}
-	block(this)
-	return resultDeferred.await()
 }
 
 @OptIn(ExperimentalContracts::class)
-context(scope: CoroutineScope)
 suspend fun RemoteSession.test(
 	timeout: Duration = 30.seconds,
 	block: suspend (RemoteSession) -> Unit = {}
 ): RemoteSession.State {
 	contract {
 		callsInPlace(block, InvocationKind.EXACTLY_ONCE)
 	}
-	val resultDeferred = scope.async(start = UNDISPATCHED) {
-		awaitWithTimeout(timeout)
+	return coroutineScope {
+		val resultDeferred = async(start = UNDISPATCHED) {
+			awaitWithTimeout(timeout)
+		}
+		block(this@test)
+		resultDeferred.await()
 	}
-	block(this)
-	return resultDeferred.await()
 }
 
 suspend fun RemoteSession.awaitWithTimeout(timeout: Duration = 30.seconds): RemoteSession.State {

ackpine-resources/src/main/kotlin/ru/solrudev/ackpine/resources/ResolvableString.kt

@@ -165,7 +165,7 @@ public sealed interface ResolvableString : Serializable {
 private class TransientResource(
 	@param:StringRes private val stringId: Int,
 	private val args: Array<out Serializable>
-) : Resource(stringId, args) {
+) : Resource(*args) {
 
 	override fun stringId() = stringId
 

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/AckpineLibraryPlugin.kt

@@ -52,7 +52,7 @@ public class AckpineLibraryPlugin : Plugin<Project> {
 			?.named("libs")
 			?.findVersion("kotlin-for-consumers")
 			?.get()
-			?.displayName
+			?.requiredVersion
 			?: coreLibrariesVersion
 		val kotlinVersion = KotlinVersion.fromVersion(
 			stdlibVersion
@@ -69,10 +69,7 @@ public class AckpineLibraryPlugin : Plugin<Project> {
 			apiVersion = kotlinVersion
 			jvmTarget = JVM_1_8
 			jvmDefault = JvmDefaultMode.NO_COMPATIBILITY
-			freeCompilerArgs.addAll(
-				"-Xconsistent-data-class-copy-visibility",
-				"-Xcontext-parameters"
-			)
+			freeCompilerArgs.addAll("-Xconsistent-data-class-copy-visibility")
 		}
 
 		abiValidation {

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/publishing/AckpineArtifact.kt

@@ -16,23 +16,20 @@
 
 package ru.solrudev.ackpine.gradle.publishing
 
-import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
-import org.gradle.kotlin.dsl.property
-import javax.inject.Inject
 
 /**
  * Extension for Ackpine `library-publish` plugin.
  */
-public open class AckpineArtifact @Inject constructor(objectFactory: ObjectFactory) {
+public interface AckpineArtifact {
 
 	/**
 	 * Name of the published artifact.
 	 */
-	public val name: Property<String> = objectFactory.property<String>().convention("")
+	public val name: Property<String>
 
 	/**
 	 * Inception year of the published artifact.
 	 */
-	public val inceptionYear: Property<String> = objectFactory.property<String>().convention("2023")
+	public val inceptionYear: Property<String>
 }

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/publishing/AckpineLibraryPublishPlugin.kt

@@ -41,6 +41,8 @@ public class AckpineLibraryPublishPlugin : Plugin<Project> {
 				}
 			}
 			val artifact = ackpineLibraryExtension.extensions.create<AckpineArtifact>("artifact")
+			artifact.name.convention("")
+			artifact.inceptionYear.convention("2023")
 			configurePublishing(artifact.name, provider { description }, artifact.inceptionYear)
 		}
 	}

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/publishing/OptionalDependenciesPlugin.kt

@@ -20,6 +20,7 @@ import groovy.util.Node
 import groovy.util.NodeList
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.artifacts.component.ModuleComponentSelector
 import org.gradle.api.artifacts.result.ResolvedComponentResult
 import org.gradle.api.provider.Provider
 import org.gradle.api.publish.PublishingExtension
@@ -58,25 +59,30 @@ public class OptionalDependenciesPlugin : Plugin<Project> {
 	}
 
 	private fun Project.configurePom(
-		optionalDependencies: Provider<ResolvedComponentResult>
+		resolvedOptionalDependencies: Provider<ResolvedComponentResult>
 	) = extensions.configure<PublishingExtension> {
 		publications.withType<MavenPublication>().configureEach {
 			pom.withXml {
-				val dependencies = (asNode()
-					.get("dependencies") as NodeList)
-					.first() as Node
-				optionalDependencies
-					.get()
-					.dependencies
-					.forEach { optionalDependency ->
-						val (groupId, artifactId, version) = optionalDependency.requested.displayName.split(':')
-						dependencies.appendNode("dependency").run {
-							appendNode("groupId", groupId)
-							appendNode("artifactId", artifactId)
-							appendNode("version", version)
-							appendNode("optional", true)
-						}
+				val optionalDependencies = resolvedOptionalDependencies.get().dependencies
+				if (optionalDependencies.isEmpty()) {
+					return@withXml
+				}
+				val root = asNode()
+				val dependencies = (root.get("dependencies") as NodeList).firstOrNull() as Node?
+					?: root.appendNode("dependencies")
+				for (optionalDependency in optionalDependencies) {
+					val componentSelector = optionalDependency.requested
+					check(componentSelector is ModuleComponentSelector) {
+						"Optional dependency '${componentSelector.displayName}' is not a module dependency. " +
+								"Only external module dependencies are supported."
 					}
+					dependencies.appendNode("dependency").run {
+						appendNode("groupId", componentSelector.group)
+						appendNode("artifactId", componentSelector.module)
+						appendNode("version", componentSelector.version)
+						appendNode("optional", true)
+					}
+				}
 			}
 		}
 	}