Merge pull request #745 from commercetools/fix-export-signatures-plugin

fix exportSignatures plugin
commercetools · Oct 17, 2024 · 6d48fbb · 6d48fbb
2 parents 35df01a + 937b23d
commit 6d48fbb
Show file tree

Hide file tree

Showing 25 changed files with 209 additions and 126 deletions.
diff --git a/build.gradle b/build.gradle
@@ -19,6 +19,9 @@ plugins {
 
     id "me.champeau.jmh" version "0.6.8"
     id "jacoco"
+
+    id "versioning"
+    id "srcinfo"
 }
 
 import java.text.SimpleDateFormat
@@ -87,6 +90,10 @@ subprojects { project ->
     apply from: "$rootDir/gradle-scripts/subproject-dependencies.gradle"
     apply from: "$rootDir/gradle-scripts/subproject-config.gradle"
 
+    if (project.file("build.gradle").exists()) {
+        apply from: "$rootDir/gradle-scripts/subproject-srcinfo-plugin.gradle"
+    }
+
     group='com.commercetools.sdk'
 
     version = globalVersion

diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
diff --git a/buildSrc/src/main/resources/META-INF/gradle-plugins/srcinfo.properties b/buildSrc/src/main/resources/META-INF/gradle-plugins/srcinfo.properties
diff --git a/buildSrc/src/main/resources/META-INF/gradle-plugins/versioning.properties b/buildSrc/src/main/resources/META-INF/gradle-plugins/versioning.properties
diff --git a/...s/internal-docs/src/main/java/com/commercetools/docs/meta/MigrationModelClassMapping.java b/...s/internal-docs/src/main/java/com/commercetools/docs/meta/MigrationModelClassMapping.java
@@ -265,6 +265,10 @@
  *   <td>{@link com.commercetools.api.models.cart.CartChangeTaxRoundingModeAction}</td>
  * </tr>
  * <tr>
+ *   <td>{@link io.sphere.sdk.carts.commands.updateactions.FreezeCart}</td>
+ *   <td>{@link com.commercetools.api.models.cart.CartFreezeCartAction}</td>
+ * </tr>
+ * <tr>
  *   <td>{@link io.sphere.sdk.carts.commands.updateactions.Recalculate}</td>
  *   <td>{@link com.commercetools.api.models.cart.CartRecalculateAction}</td>
  * </tr>
@@ -441,6 +445,10 @@
  *   <td>{@link com.commercetools.api.models.cart.CartSetShippingRateInputAction}</td>
  * </tr>
  * <tr>
+ *   <td>{@link io.sphere.sdk.carts.commands.updateactions.UnfreezeCart}</td>
+ *   <td>{@link com.commercetools.api.models.cart.CartUnfreezeCartAction}</td>
+ * </tr>
+ * <tr>
  *   <td>{@link io.sphere.sdk.carts.commands.updateactions.UpdateItemShippingAddress}</td>
  *   <td>{@link com.commercetools.api.models.cart.CartUpdateItemShippingAddressAction}</td>
  * </tr>

diff --git a/common-plugins/build.gradle b/common-plugins/build.gradle
@@ -0,0 +1,36 @@
+plugins {
+    id 'java-gradle-plugin'
+    id 'idea'
+    id 'org.jetbrains.kotlin.jvm' version "2.0.0"
+}
+
+repositories {
+    mavenCentral()
+}
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(11)
+    }
+}
+
+group = 'com.commercetools.sdk.plugins'
+version = '1.0'
+
+gradlePlugin {
+    plugins.register('srcinfo-plugin') {
+            id = 'srcinfo'
+            implementationClass = 'com.commercetools.sdk.plugins.SrcInfoPlugin'
+    }
+    plugins.register("versioning-plugin") {
+        id = 'versioning'
+        implementationClass = 'com.commercetools.sdk.plugins.VersioningPlugin'
+    }
+}
+
+dependencies {
+    implementation project(path: ':javaparser', configuration: 'shadow')
+    implementation "com.google.code.gson:gson:2.11.0"
+    implementation 'com.squareup:javapoet:1.13.0'
+    implementation 'com.google.guava:guava:33.3.1-jre'
+}
diff --git a/common-plugins/javaparser/build.gradle b/common-plugins/javaparser/build.gradle
@@ -0,0 +1,19 @@
+plugins {
+    id 'java'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+}
+
+group = 'com.commercetools.sdk.plugins'
+version = '1.0'
+
+repositories {
+    mavenCentral()
+}
+
+shadowJar {
+    relocate 'com.github.javaparser', 'shadow.javaparser'
+}
+
+dependencies {
+    implementation 'com.github.javaparser:javaparser-core:3.26.2'
+}
diff --git a/common-plugins/settings.gradle b/common-plugins/settings.gradle
@@ -0,0 +1 @@
+include("javaparser")
diff --git a/...ommercetools/sdk/plugins/GraphQLPlugin.kt → ...ommercetools/sdk/plugins/GraphQLPlugin.kt b/...ommercetools/sdk/plugins/GraphQLPlugin.kt → ...ommercetools/sdk/plugins/GraphQLPlugin.kt
diff --git a/.../commercetools/sdk/plugins/GraphQLTask.kt → .../commercetools/sdk/plugins/GraphQLTask.kt b/.../commercetools/sdk/plugins/GraphQLTask.kt → .../commercetools/sdk/plugins/GraphQLTask.kt
@@ -1,11 +1,11 @@
 package com.commercetools.sdk.plugins
 
-import com.github.javaparser.StaticJavaParser
-import com.github.javaparser.ast.CompilationUnit
-import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration
-import com.github.javaparser.ast.body.ConstructorDeclaration
-import com.github.javaparser.ast.body.MethodDeclaration
-import com.github.javaparser.ast.body.TypeDeclaration
+import shadow.javaparser.StaticJavaParser
+import shadow.javaparser.ast.CompilationUnit
+import shadow.javaparser.ast.body.ClassOrInterfaceDeclaration
+import shadow.javaparser.ast.body.ConstructorDeclaration
+import shadow.javaparser.ast.body.MethodDeclaration
+import shadow.javaparser.ast.body.TypeDeclaration
 import com.squareup.javapoet.*
 import org.gradle.api.DefaultTask
 import org.gradle.api.plugins.JavaPluginExtension

diff --git a/...etools/sdk/plugins/MigrationInfoPlugin.kt → ...etools/sdk/plugins/MigrationInfoPlugin.kt b/...etools/sdk/plugins/MigrationInfoPlugin.kt → ...etools/sdk/plugins/MigrationInfoPlugin.kt
@@ -1,12 +1,13 @@
 package com.commercetools.sdk.plugins
 
-import com.github.javaparser.StaticJavaParser
-import com.github.javaparser.ast.CompilationUnit
-import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration
-import com.github.javaparser.ast.body.TypeDeclaration
+import shadow.javaparser.StaticJavaParser
+import shadow.javaparser.ast.CompilationUnit
+import shadow.javaparser.ast.body.ClassOrInterfaceDeclaration
+import shadow.javaparser.ast.body.TypeDeclaration
 import com.google.common.base.CaseFormat
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import shadow.javaparser.ast.body.MethodDeclaration
 import java.io.File
 import java.io.IOException
 import java.io.Writer
@@ -263,22 +264,22 @@ class MigrationInfoPlugin : Plugin<Project> {
 
 
 
-//    fun classInfo(file: File, info: ClassOrInterfaceDeclaration, hash: String): List<Pair<String, Map<String, String>>> {
-//        return info.methods.map { methodInfo ->
-//            "${info.fullyQualifiedName.get()}#${methodInfo.signature}" to mapOf(
-//                    "type" to "method",
-//                    "gitHash" to hash,
-//                    "methodName" to methodInfo.name.toString(),
-//                    "simpleName" to "${info.name}#${methodInfo.name}",
-//                    "name" to "${info.fullyQualifiedName.get()}#${methodInfo.name}",
-//                    "file" to file.toString(),
-//                    "start" to methodInfo.begin.get().line.toString(),
-//                    "end" to methodInfo.end.get().line.toString(),
-//                    "srcUrl" to "https://github.com/commercetools/commercetools-sdk-java-v2/blob/${hash}/${file}#L${methodInfo.begin.get().line}-L${methodInfo.end.get().line}",
-//                    "sdkV1Method" to methodInfo.methodBody()
-//            )
-//        }
-//    }
+    fun classInfo(file: File, info: ClassOrInterfaceDeclaration, hash: String): List<Pair<String, Map<String, String>>> {
+        return info.methods.map { methodInfo ->
+            "${info.fullyQualifiedName.get()}#${methodInfo.signature}" to mapOf(
+                    "type" to "method",
+                    "gitHash" to hash,
+                    "methodName" to methodInfo.name.toString(),
+                    "simpleName" to "${info.name}#${methodInfo.name}",
+                    "name" to "${info.fullyQualifiedName.get()}#${methodInfo.name}",
+                    "file" to file.toString(),
+                    "start" to methodInfo.begin.get().line.toString(),
+                    "end" to methodInfo.end.get().line.toString(),
+                    "srcUrl" to "https://github.com/commercetools/commercetools-sdk-java-v2/blob/${hash}/${file}#L${methodInfo.begin.get().line}-L${methodInfo.end.get().line}",
+                    "sdkV1Method" to methodInfo.methodBody()
+            )
+        }
+    }
 
     fun ClassOrInterfaceDeclaration.v2Class(v2BaseFolder: List<String>): String {
 
@@ -326,33 +327,33 @@ class MigrationInfoPlugin : Plugin<Project> {
         return v2Classes.joinToString(", ");
     }
 
-//    fun ClassOrInterfaceDeclaration.v1CreateCommandClassUsage(): Pair<String, String> {
-//
-//        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
-//            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
-//        }
-//        val v1PackageName = this.fullyQualifiedName.map { it.replace("." + this.name.toString(), "") }.get()
-//        val v1ModelPackageName = v1PackageName.replace(".commands", "");
-//
-//        return this.getMethodsByName("of").map { "$v1ModelPackageName.${it.parameters.filter { it.nameAsString.contains("draft", true) }.map { it.typeAsString }.firstOrNull() ?: "" }" to "of(${it.parameters.joinToString(",") { it.typeAsString }})" }.first()
-//    }
-//
-//    fun ClassOrInterfaceDeclaration.v1UpdateCommandClassUsage(): Pair<String, String> {
-//
-//        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
-//            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
-//        }
-//
-//        return this.getMethodsByName("of").filter { it.parameters.any { it.typeAsString.startsWith("UpdateAction") } }.map { "" to "of(${it.parameters.joinToString(",") { it.typeAsString.split("<").first() + if (it.isVarArgs) "..." else "" }})" }.first()
-//    }
-//
-//    fun ClassOrInterfaceDeclaration.v1DeleteCommandClassUsage(): Pair<String, String> {
-//
-//        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
-//            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
-//        }
-//        return this.getMethodsByName("of").filter { it.parameters.any { it.typeAsString.startsWith("Versioned") } }.map { "" to "of(${it.parameters.joinToString(",") { it.typeAsString.split("<").first() }})" }.firstOrNull() ?: Pair("", "")
-//    }
+    fun ClassOrInterfaceDeclaration.v1CreateCommandClassUsage(): Pair<String, String> {
+
+        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
+            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
+        }
+        val v1PackageName = this.fullyQualifiedName.map { it.replace("." + this.name.toString(), "") }.get()
+        val v1ModelPackageName = v1PackageName.replace(".commands", "");
+
+        return this.getMethodsByName("of").map { "$v1ModelPackageName.${it.parameters.filter { it.nameAsString.contains("draft", true) }.map { it.typeAsString }.firstOrNull() ?: "" }" to "of(${it.parameters.joinToString(",") { it.typeAsString }})" }.first()
+    }
+
+    fun ClassOrInterfaceDeclaration.v1UpdateCommandClassUsage(): Pair<String, String> {
+
+        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
+            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
+        }
+
+        return this.getMethodsByName("of").filter { it.parameters.any { it.typeAsString.startsWith("UpdateAction") } }.map { "" to "of(${it.parameters.joinToString(",") { it.typeAsString.split("<").first() + if (it.isVarArgs) "..." else "" }})" }.first()
+    }
+
+    fun ClassOrInterfaceDeclaration.v1DeleteCommandClassUsage(): Pair<String, String> {
+
+        if (commandClassUsageV1Mapping.containsKey(this.fullyQualifiedName.get())) {
+            return commandClassUsageV1Mapping.get(this.fullyQualifiedName.get()) ?: Pair("", "")
+        }
+        return this.getMethodsByName("of").filter { it.parameters.any { it.typeAsString.startsWith("Versioned") } }.map { "" to "of(${it.parameters.joinToString(",") { it.typeAsString.split("<").first() }})" }.firstOrNull() ?: Pair("", "")
+    }
 
     fun ClassOrInterfaceDeclaration.v2CommandClassUsage(): String {
 
@@ -486,17 +487,18 @@ class MigrationInfoPlugin : Plugin<Project> {
             "io.sphere.sdk.projects.commands.updateactions.ChangeMessages" to "removed",
     )
 
-//    fun MethodDeclaration.methodBody(): String {
-//        val methodBody = this.body
-//        if (!methodBody.isPresent) {
-//            return ""
-//        }
-//        val bodyRange = methodBody.get().tokenRange.get().toString()
-//        return bodyRange.substring(1, bodyRange.length - 1).trimIndent()
-//    }
+    fun MethodDeclaration.methodBody(): String {
+        val methodBody = this.body
+        if (!methodBody.isPresent) {
+            return ""
+        }
+        val bodyRange = methodBody.get().tokenRange.get().toString()
+        return bodyRange.substring(1, bodyRange.length - 1).trimIndent()
+    }
 }
 
 fun String.packageName(): String {
+    CaseFormat.LOWER_CAMEL.to(CaseFormat.UPPER_CAMEL, this)
     if (this.isEmpty() or this.contains(".").not()) return ""
     val packageFolder = Paths.get(this.replace(".", "/"))
     return packageFolder.parent.toString().replace("/", ".");

diff --git a/...k/plugins/MigrationInfoPluginExtension.kt → ...k/plugins/MigrationInfoPluginExtension.kt b/...k/plugins/MigrationInfoPluginExtension.kt → ...k/plugins/MigrationInfoPluginExtension.kt
diff --git a/...ommercetools/sdk/plugins/SrcInfoPlugin.kt → ...ommercetools/sdk/plugins/SrcInfoPlugin.kt b/...ommercetools/sdk/plugins/SrcInfoPlugin.kt → ...ommercetools/sdk/plugins/SrcInfoPlugin.kt
@@ -1,14 +1,16 @@
 package com.commercetools.sdk.plugins;
 
-import com.github.javaparser.StaticJavaParser
-import com.github.javaparser.ast.CompilationUnit
-import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration
-import com.github.javaparser.ast.body.MethodDeclaration
-import com.github.javaparser.ast.body.TypeDeclaration
-import com.github.javaparser.ast.expr.NormalAnnotationExpr
+import shadow.javaparser.ParserConfiguration.LanguageLevel
+import shadow.javaparser.ast.CompilationUnit
+import shadow.javaparser.ast.body.ClassOrInterfaceDeclaration
+import shadow.javaparser.ast.body.MethodDeclaration
+import shadow.javaparser.ast.body.TypeDeclaration
+import shadow.javaparser.ast.expr.NormalAnnotationExpr
 import com.google.gson.stream.JsonWriter
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import shadow.javaparser.JavaParser
+import shadow.javaparser.ParserConfiguration
 import java.io.File
 import java.io.IOException
 import java.io.Writer
@@ -32,11 +34,14 @@ class SrcInfoPlugin : Plugin<Project> {
     private fun createExportTask(project: Project) {
         val extension = project.extensions.create("srcInfo", SrcInfoPluginExtension::class.java)
         val exportTask = project.task("exportSignatures")
+        val parserConfiguration = ParserConfiguration()
+        parserConfiguration.languageLevel = LanguageLevel.JAVA_17
+        val javaParser = JavaParser(parserConfiguration)
         exportTask.group = "documentation"
         exportTask.doLast {
             val outputFolder = extension.outputFolder.map { o -> Paths.get(o) }.getOrElse(project.buildDir.resolve("src-info").toPath())
             val docsUrnOnly = extension.docsUrnOnly.getOrElse(false)
-            outputFolder.toFile().mkdir()
+            outputFolder.toFile().mkdirs()
             val javaFiles = project.fileTree(mapOf("dir" to extension.baseFolder.getOrElse("src"), "include" to "**/*.java")).files
             val fileWriter: Writer = Files.newBufferedWriter(outputFolder.resolve(project.name + ".json"))
             val writer = JsonWriter(fileWriter)
@@ -46,7 +51,7 @@ class SrcInfoPlugin : Plugin<Project> {
             writer.beginObject()
             javaFiles.forEach { file ->
                 run {
-                    javaFileInfo(file, project, hash, extension.includePackages.orNull, docsUrnOnly).forEach { entry ->
+                    javaFileInfo(javaParser, file, project, hash, extension.includePackages.orNull, docsUrnOnly).forEach { entry ->
                         run {
                             writer.name(entry.key)
                             writer.beginObject()
@@ -65,8 +70,9 @@ class SrcInfoPlugin : Plugin<Project> {
         }
     }
 
-    private fun javaFileInfo(file: File, project: Project, hash: String, includePackages: List<String>?, docsUrnOnly: Boolean):  Map<String, Map<String, String>> {
-        val parse: CompilationUnit = StaticJavaParser.parse(file)
+    private fun javaFileInfo(javaParser: JavaParser, file: File, project: Project, hash: String, includePackages: List<String>?, docsUrnOnly: Boolean):  Map<String, Map<String, String>> {
+        val parse: CompilationUnit = javaParser.parse(file).result.get()
+
         val relativeFile = file.relativeTo(project.rootDir)
         if (includePackages != null && includePackages.firstOrNull { s: String -> parse.packageDeclaration.get().nameAsString.startsWith(s) } == null) {
             return emptyMap()

diff --git a/...ols/sdk/plugins/SrcInfoPluginExtension.kt → ...ols/sdk/plugins/SrcInfoPluginExtension.kt b/...ols/sdk/plugins/SrcInfoPluginExtension.kt → ...ols/sdk/plugins/SrcInfoPluginExtension.kt
diff --git a/...ercetools/sdk/plugins/VersioningPlugin.kt → ...ercetools/sdk/plugins/VersioningPlugin.kt b/...ercetools/sdk/plugins/VersioningPlugin.kt → ...ercetools/sdk/plugins/VersioningPlugin.kt
diff --git a/.../sdk/plugins/VersioningPluginExtension.kt → .../sdk/plugins/VersioningPluginExtension.kt b/.../sdk/plugins/VersioningPluginExtension.kt → .../sdk/plugins/VersioningPluginExtension.kt
diff --git a/gradle-scripts/subproject-config.gradle b/gradle-scripts/subproject-config.gradle
@@ -60,14 +60,6 @@ ext {
     buildInfoPackage = "io.vrap.rmf.base.client"
 }
 
-srcInfo {
-    includePackages = [
-            "example",
-            "commercetools"
-    ]
-    docsUrnOnly = true
-}
-
 tasks.register('integrationTest', Test) {
     description = "Runs integration tests."
     group = "verification"

diff --git a/gradle-scripts/subproject-plugins.gradle b/gradle-scripts/subproject-plugins.gradle
@@ -2,5 +2,3 @@ apply plugin: 'idea'
 
 apply plugin: 'java'
 apply plugin: 'java-library' // needed to make sure that transitive deps have 'compile' scope
-
-apply plugin: 'srcinfo'
diff --git a/gradle-scripts/subproject-srcinfo-plugin.gradle b/gradle-scripts/subproject-srcinfo-plugin.gradle
@@ -0,0 +1,9 @@
+apply plugin: 'srcinfo'
+
+srcInfo {
+    includePackages = [
+            "example",
+            "commercetools"
+    ]
+    docsUrnOnly = true
+}
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,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,5 +2,3 @@ apply plugin: 'idea'

		apply plugin: 'java'
		apply plugin: 'java-library' // needed to make sure that transitive deps have 'compile' scope

		apply plugin: 'srcinfo'