release: SDK 3.0.0

Author: arnaud-roland

Makefile

@@ -9,4 +9,7 @@ aar:
 
 clean:
 	rm -f public-sdk/Batch.aar
-	cd Sources && ./gradlew clean
+	cd Sources && ./gradlew clean
+
+doc:
+	cd Sources && ./gradlew :sdk:dokkaGeneratePublicationHtml

Sources/.gitignore

@@ -27,5 +27,7 @@
 **/.idea/saveactions_settings.xml
 **/.idea/assetWizardSettings.xml
 **/.idea/jarRepositories.xml
+**/.idea/AndroidProjectSystem.xml
+**/.idea/RunConfigurations.xml
 
 **/.idea/compiler.xml

Sources/build.gradle.kts

@@ -1,10 +1,13 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 plugins {
-    id("com.android.application") version ProjectConsts.ANDROID_GRADLE_PLUGIN_VERSION apply false
-    id("com.android.library") version ProjectConsts.ANDROID_GRADLE_PLUGIN_VERSION apply false
-    id("org.jetbrains.kotlin.android") version ProjectConsts.KOTLIN_VERSION apply false
-    id("com.google.gms.google-services") version ProjectConsts.GMS_GRADLE_PLUGIN_VERSION apply false
-    id("io.codearte.nexus-staging") version "0.30.0"
-    id("org.sonarqube") version "4.2.1.3168"
+    alias(libs.plugins.android.application) apply false
+    alias(libs.plugins.android.library) apply false
+    alias(libs.plugins.kotlin.android) apply false
+    alias(libs.plugins.kotlin.jvm) apply false
+    alias(libs.plugins.gms.google.services) apply false
+    alias(libs.plugins.testify) apply false
+    alias(libs.plugins.nexus.staging)
+    alias(libs.plugins.dokka)
+    alias(libs.plugins.kfmt)
 }

Sources/buildSrc/build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("org.jetbrains.kotlin.jvm")
+}
+
+dependencies {
+    compileOnly(libs.dokka.core)
+    implementation(libs.dokka.base)
+    testImplementation(libs.kotlin.test)
+    testImplementation(libs.dokka.base.test.utils)
+    testImplementation(libs.dokka.test.api)
+}

Sources/buildSrc/src/main/java/Consts.kt

@@ -0,0 +1,16 @@
+package com.batch.dokka.plugin
+
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
+import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
+
+class FilterPublicSDKClassesPlugin : DokkaPlugin() {
+
+    val filterExtension by extending {
+        plugin<DokkaBase>().preMergeDocumentableTransformer providing ::FilterPublicSDKClassesTransformer
+    }
+
+    @OptIn(DokkaPluginApiPreview::class)
+    override fun pluginApiPreviewAcknowledgement() = PluginApiPreviewAcknowledgement
+}

Sources/dokka-limit-public-api/build.gradle.kts

@@ -0,0 +1,44 @@
+package com.batch.dokka.plugin
+
+import org.jetbrains.dokka.base.transformers.documentables.SuppressedByConditionDocumentableFilterTransformer
+import org.jetbrains.dokka.model.Annotations
+import org.jetbrains.dokka.model.DClasslike
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.model.properties.WithExtraProperties
+import org.jetbrains.dokka.plugability.DokkaContext
+
+class FilterPublicSDKClassesTransformer(
+    context: DokkaContext,
+) : SuppressedByConditionDocumentableFilterTransformer(context) {
+
+    override fun shouldBeSuppressed(d: Documentable): Boolean {
+
+        // Non class types are public, as otherwise dokka will skip complete packages
+        // Enums, fields, etc are also public as all that matters is the Class' PublicSDK
+        // annotation.
+        val isPublic = when (d) {
+            is DClasslike -> d.isBatchPublicSDK()
+            else -> true
+        }
+
+        if (!isPublic) {
+            context.logger.warn("Suppressing non-PublicSDK documentable '${d.name}'")
+        }
+
+        return !isPublic
+    }
+}
+
+fun DClasslike.isBatchPublicSDK(): Boolean {
+    val annotations: List<Annotations.Annotation> =
+        (this as? WithExtraProperties<*>)
+            ?.extra
+            ?.allOfType<Annotations>()
+            ?.flatMap { a -> a.directAnnotations.flatMap { it.value } }
+            ?: emptyList()
+
+    return annotations.any { it.isBatchPublicSDK() }
+}
+
+fun Annotations.Annotation.isBatchPublicSDK(): Boolean =
+    dri.packageName == "com.batch.android.annotation" && dri.classNames == "PublicSDK"

Sources/dokka-limit-public-api/src/main/kotlin/FilterPublicSDKClassesPlugin.kt

@@ -0,0 +1 @@
+com.batch.dokka.plugin.FilterPublicSDKClassesPlugin

Sources/dokka-limit-public-api/src/main/kotlin/FilterPublicSDKClassesTransformer.kt

@@ -20,3 +20,6 @@ android.useAndroidX=true
 android.enableJetifier=false
 gnsp.disableApplyOnlyOnRootProjectEnforcement=true
 kotlin.stdlib.default.dependency=false
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
+ksp.incremental=false