Merge pull request #1018 from mikepenz/develop

mikepenz · web-flow · commit a97cfb9df6d3 · 2024-08-23T10:00:38.000+02:00
dev -&gt; main
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@
 
 ## Latest releases 🛠
 
-- Kotlin 2.x && Multiplatform && Compose && Plugin | [v11.2.2](https://github.com/mikepenz/AboutLibraries/tree/v11.2.2)
+- Kotlin 2.x && Multiplatform && Compose && Plugin | [v11.2.3](https://github.com/mikepenz/AboutLibraries/tree/v11.2.3)
 
 ## Gradle Plugin
 
@@ -118,7 +118,8 @@ aboutLibraries {
     // Full license text for license IDs mentioned here will be included, even if no detected dependency uses them.
     additionalLicenses = ["mit", "mpl_2_0"]
     // Allows to exclude some fields from the generated meta data field.
-    excludeFields = ["developers", "funding"]
+    // If the class name is specified, the field is only excluded for that class; without a class name, the exclusion is global.
+    excludeFields = ["License.name", "developers", "funding"]
     // Enable inclusion of `platform` dependencies in the library report
     includePlatform = true
     // Define the strict mode, will fail if the project uses licenses not allowed
diff --git a/app-test/README.md b/app-test/README.md
@@ -0,0 +1,7 @@
+## Usage
+
+### Generate Dependency Information
+
+```bash
+./gradlew :app-test:exportLibraryDefinitions -PaboutLibraries.exportPath=files/
+```
diff --git a/app-test/build.gradle.kts b/app-test/build.gradle.kts
@@ -0,0 +1,21 @@
+plugins {
+    kotlin("multiplatform")
+    id("com.mikepenz.aboutlibraries.plugin")
+}
+
+kotlin {
+    jvm()
+
+    sourceSets {
+        jvmMain {
+            dependencies {
+                // https://mvnrepository.com/artifact/javax.annotation/javax.annotation-api
+                implementation("javax.annotation:javax.annotation-api:1.3.2")
+            }
+        }
+    }
+}
+
+aboutLibraries {
+    fetchRemoteLicense = true
+}
diff --git a/app-test/files/aboutlibraries.json b/app-test/files/aboutlibraries.json
diff --git a/gradle.properties b/gradle.properties
@@ -1,7 +1,7 @@
 GROUP=com.mikepenz
 
-VERSION_NAME=11.2.2
-VERSION_CODE=110202
+VERSION_NAME=11.2.3
+VERSION_CODE=110203
 POM_URL=https://github.com/mikepenz/AboutLibraries
 POM_SCM_URL=https://github.com/mikepenz/AboutLibraries
 POM_SCM_CONNECTION=scm:git@github.com:mikepenz/AboutLibraries.git
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -4,31 +4,31 @@ compileSdk = "34"
 minSdk = "21"
 targetSdk = "34"
 # build
-gradleBuild = "8.5.0"
+gradleBuild = "8.5.2"
 # kotlin
 dokka = "1.9.20"
-kotlinCore = { require = "2.0.0" }
+kotlinCore = { require = "2.0.20" }
 kotlinCoroutines = { require = "1.8.1" }
-kotlinxSerialization = "1.6.3"
+kotlinxSerialization = "1.7.1"
 kotlinxCollections = "0.3.7"
 # compose
 compose = "1.6.8"
 compose-plugin = "1.6.11"
 composeUi = "1.6.8" # foundation / material
 # androidx
-activity = "1.9.0"
+activity = "1.9.1"
 cardview = "1.0.0"
 constraintLayout = "2.1.4"
 core = "1.13.1"
-lifecycle = { require = "2.8.2" }
+lifecycle = { require = "2.8.4" }
 navigation = "2.7.7"
 recyclerView = "1.3.2"
 # google
 material = "1.12.0"
 # other
 accompanist = "0.34.0"
 fastAdapter = "5.7.0"
-gradleMvnPublish = "0.28.0"
+gradleMvnPublish = "0.29.0"
 iconics = "5.4.0"
 itemAnimators = "1.1.0"
 ivy = "2.5.2"
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/gradlew b/gradlew
@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -84,7 +86,8 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
+' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
diff --git a/gradlew.bat b/gradlew.bat
@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
diff --git a/plugin-build/gradle/wrapper/gradle-wrapper.jar b/plugin-build/gradle/wrapper/gradle-wrapper.jar
diff --git a/plugin-build/gradle/wrapper/gradle-wrapper.properties b/plugin-build/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/plugin-build/gradlew b/plugin-build/gradlew
@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -84,7 +86,8 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
+' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
diff --git a/plugin-build/gradlew.bat b/plugin-build/gradlew.bat
@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
diff --git a/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/AboutLibrariesExtension.kt b/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/AboutLibrariesExtension.kt
@@ -219,10 +219,14 @@ abstract class AboutLibrariesExtension {
     /**
      * Defines fields which will be excluded during the serialisation of the metadata output file.
      *
-     * Any field as included in the [com.mikepenz.aboutlibraries.plugin.mapping.Library] can theoretically be excluded.
+     * It is possible to qualify the field names by specifying the class name (e.g. "License.name").
+     * Permissible qualifiers are "ResultContainer", "Library", "Developer", "Organization", "Funding", "Scm",
+     * "License" and "MetaData".
+     * Unqualified field names (e.g. "description") are applied to the entire output.
+     *
      * ```
      * aboutLibraries {
-     *   excludeFields = arrayOf("description", "tag")
+     *   excludeFields = arrayOf("License.name", "ResultContainer.metadata", "description", "tag")
      * }
      * ```
      */
diff --git a/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/model/ResultContainer.kt b/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/model/ResultContainer.kt
@@ -1,7 +1,7 @@
 package com.mikepenz.aboutlibraries.plugin.model
 
-import com.mikepenz.aboutlibraries.plugin.mapping.Library
-import com.mikepenz.aboutlibraries.plugin.mapping.License
+import com.mikepenz.aboutlibraries.plugin.mapping.*
+import com.mikepenz.aboutlibraries.plugin.util.PartialObjectConverter
 import groovy.json.JsonGenerator
 import groovy.json.JsonOutput
 import java.io.File
@@ -26,10 +26,35 @@ class MetaData(
 )
 
 fun ResultContainer.writeToDisk(outputFile: File, excludeFields: Array<String>, prettyPrint: Boolean) {
-    val fieldNames = mutableListOf("artifactId", "groupId", "artifactFolder").also {
-        it.addAll(excludeFields)
+    val allowedExclusionQualifiers = setOf(
+        ResultContainer::class.simpleName,
+        Library::class.simpleName,
+        Developer::class.simpleName,
+        Organization::class.simpleName,
+        Funding::class.simpleName,
+        Scm::class.simpleName,
+        License::class.simpleName,
+        MetaData::class.simpleName,
+    )
+    val excludedQualifiedFieldNames = mutableSetOf(
+        "${Library::class.simpleName}.${Library::artifactId.name}",
+        "${Library::class.simpleName}.${Library::groupId.name}",
+        "${Library::class.simpleName}.${Library::artifactFolder.name}"
+    )
+    val excludedUnqualifiedFieldNames = mutableSetOf<String>()
+    excludeFields.forEach { excludedField ->
+        val segments = excludedField.split(".")
+        if (segments.size == 2 && allowedExclusionQualifiers.contains(segments.first())) {
+            excludedQualifiedFieldNames.add(excludedField)
+        } else {
+            excludedUnqualifiedFieldNames.add(excludedField)
+        }
     }
-    val jsonGenerator = JsonGenerator.Options().excludeNulls().excludeFieldsByName(fieldNames).build()
+    val jsonGenerator = JsonGenerator.Options()
+        .excludeNulls()
+        .excludeFieldsByName(excludedUnqualifiedFieldNames)
+        .addConverter(PartialObjectConverter(excludedQualifiedFieldNames))
+        .build()
     PrintWriter(OutputStreamWriter(outputFile.outputStream(), StandardCharsets.UTF_8), true).use {
         it.write(jsonGenerator.toJson(this).let { json -> if (prettyPrint) JsonOutput.prettyPrint(json) else json })
     }
diff --git a/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/util/PartialObjectConverter.kt b/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/util/PartialObjectConverter.kt
@@ -0,0 +1,32 @@
+package com.mikepenz.aboutlibraries.plugin.util
+
+import groovy.json.DefaultJsonGenerator
+import groovy.json.JsonGenerator
+import org.codehaus.groovy.runtime.DefaultGroovyMethods
+
+/**
+ * A converter for [JsonGenerator], which allows properties to be excluded from the output.
+ * The way it works is identical to the serialization of objects in [DefaultJsonGenerator].
+ * @property excludedQualifiedPropertyNames The qualified name (class name + property name)
+ * of the properties that should be excluded from serialization.
+ */
+class PartialObjectConverter(
+    private val excludedQualifiedPropertyNames: Set<String>,
+) : JsonGenerator.Converter {
+
+    private val targetClassNames: Set<String> = excludedQualifiedPropertyNames.mapTo(mutableSetOf()) { field ->
+        field.substringBeforeLast('.')
+    }
+
+    private val excludedPropertyNames = setOf("class", "declaringClass", "metaClass")
+
+    override fun handles(type: Class<*>?): Boolean {
+        return type != null && targetClassNames.contains(type.simpleName)
+    }
+
+    override fun convert(value: Any, key: String?): Any {
+        return DefaultGroovyMethods.getProperties(value).filterKeys { propertyName ->
+            propertyName !in excludedPropertyNames && "${value::class.simpleName}.$propertyName" !in excludedQualifiedPropertyNames
+        }
+    }
+}
diff --git a/settings.gradle b/settings.gradle
@@ -18,6 +18,7 @@ include ':aboutlibraries-compose-m3'
 include ':app'
 include ':app-desktop'
 include ':app-wasm'
+include ':app-test'
 
 includeBuild("plugin-build") {
     dependencySubstitution {
