-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(script): add support for 'mavenId()' in 'class'
- Loading branch information
Showing
7 changed files
with
319 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
163 changes: 163 additions & 0 deletions
163
idea-plugin/src/main/kotlin/com/itangcent/idea/utils/MavenHelper.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package com.itangcent.idea.utils | ||
|
|
||
| import com.intellij.openapi.module.ModuleUtilCore | ||
| import com.intellij.psi.PsiClass | ||
| import com.itangcent.annotation.script.ScriptTypeName | ||
| import com.itangcent.common.utils.safe | ||
| import org.jetbrains.idea.maven.project.MavenProjectsManager | ||
| import org.jetbrains.plugins.gradle.service.project.data.ExternalProjectDataCache | ||
|
|
||
|
|
||
| /** | ||
| * Utility object for obtaining Maven identifiers of a given PsiClass through Maven or Gradle. | ||
| * | ||
| * @author tangcent | ||
| * @date 2024/08/11 | ||
| */ | ||
| object MavenHelper { | ||
|
|
||
| /** | ||
| * Attempts to retrieve the Maven ID of a PsiClass using Maven or Gradle. | ||
| * | ||
| * @param psiClass the PsiClass for which the Maven ID is to be retrieved. | ||
| * @return MavenIdData if found, null otherwise. | ||
| */ | ||
| fun getMavenId(psiClass: PsiClass): MavenIdData? { | ||
| return safe { | ||
| getMavenIdByMaven(psiClass) | ||
| } ?: safe { | ||
| getMavenIdByGradle(psiClass) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the Maven ID of a PsiClass using Maven. | ||
| * | ||
| * @param psiClass the PsiClass for which the Maven ID is to be retrieved. | ||
| * @return MavenIdData if found, null otherwise. | ||
| */ | ||
| private fun getMavenIdByMaven(psiClass: PsiClass): MavenIdData? { | ||
| val project = psiClass.project | ||
| val module = ModuleUtilCore.findModuleForPsiElement(psiClass) | ||
| ?: return null | ||
|
|
||
| val mavenProjectsManager = MavenProjectsManager.getInstance(project) | ||
| val mavenProject = mavenProjectsManager.findProject(module) ?: return null | ||
| val mavenId = mavenProject.mavenId | ||
| return MavenIdData( | ||
| groupId = mavenId.groupId!!, | ||
| artifactId = mavenId.artifactId!!, | ||
| version = mavenId.version!! | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the Maven ID of a PsiClass using Gradle. | ||
| * | ||
| * @param psiClass the PsiClass for which the Maven ID is to be retrieved. | ||
| * @return MavenIdData if found, null otherwise. | ||
| */ | ||
| private fun getMavenIdByGradle(psiClass: PsiClass): MavenIdData? { | ||
| val project = psiClass.project | ||
| val projectPath = project.basePath ?: return null | ||
| val externalProject = ExternalProjectDataCache.getInstance(project).getRootExternalProject(projectPath) | ||
| ?: return null | ||
|
|
||
| return MavenIdData( | ||
| groupId = externalProject.group, | ||
| artifactId = externalProject.name, | ||
| version = externalProject.version | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Data class representing Maven ID information. | ||
| */ | ||
| @ScriptTypeName("MavenId") | ||
| class MavenIdData( | ||
| val groupId: String, | ||
| val artifactId: String, | ||
| val version: String | ||
| ) { | ||
|
|
||
| /** | ||
| * Generates a Maven dependency snippet | ||
| */ | ||
| fun maven(): String { | ||
| return """ | ||
| <dependency> | ||
| <groupId>$groupId</groupId> | ||
| <artifactId>$artifactId</artifactId> | ||
| <version>$version</version> | ||
| </dependency> | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| /** | ||
| * Generates a Gradle implementation dependency snippet | ||
| */ | ||
| fun gradle(): String { | ||
| return """ | ||
| implementation group: '$groupId', name: '$artifactId', version: '$version' | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| /** | ||
| * Generates a Gradle implementation dependency snippet in short form. | ||
| */ | ||
| fun gradleShort(): String { | ||
| return """ | ||
| implementation '$groupId:$artifactId:$version' | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| /** | ||
| * Generates a Gradle implementation dependency snippet in Kotlin DSL. | ||
| */ | ||
| fun gradleKotlin(): String { | ||
| return """ | ||
| implementation("$groupId:$artifactId:$version") | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| /** | ||
| * Generates an SBT dependency snippet. | ||
| */ | ||
| fun sbt(): String { | ||
| return """ | ||
| libraryDependencies += "$groupId" % "$artifactId" % "$version" | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| /** | ||
| * Generates an Ivy dependency snippet. | ||
| */ | ||
| fun ivy(): String { | ||
| return """ | ||
| <dependency org="$groupId" name="$artifactId" rev="$version" /> | ||
| """.trimIndent() | ||
| } | ||
|
|
||
| override fun toString(): String { | ||
| return "$groupId:$artifactId:$version" | ||
| } | ||
|
|
||
| override fun equals(other: Any?): Boolean { | ||
| if (this === other) return true | ||
| if (other !is MavenIdData) return false | ||
|
|
||
| if (groupId != other.groupId) return false | ||
| if (artifactId != other.artifactId) return false | ||
| if (version != other.version) return false | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| override fun hashCode(): Int { | ||
| var result = groupId.hashCode() | ||
| result = 31 * result + artifactId.hashCode() | ||
| result = 31 * result + version.hashCode() | ||
| return result | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
idea-plugin/src/test/kotlin/com/itangcent/idea/utils/MavenHelperTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| package com.itangcent.idea.utils | ||
|
|
||
| import com.intellij.openapi.module.Module | ||
| import com.intellij.psi.PsiClass | ||
| import com.itangcent.idea.plugin.settings.ETHUtils | ||
| import com.itangcent.testFramework.PluginContextLightCodeInsightFixtureTestCase | ||
| import org.jetbrains.idea.maven.model.MavenId | ||
| import org.jetbrains.idea.maven.project.MavenProject | ||
| import org.jetbrains.idea.maven.project.MavenProjectsManager | ||
| import org.jetbrains.plugins.gradle.model.ExternalProject | ||
| import org.jetbrains.plugins.gradle.service.project.data.ExternalProjectDataCache | ||
| import org.mockito.Mockito.mockStatic | ||
| import org.mockito.kotlin.any | ||
| import org.mockito.kotlin.mock | ||
|
|
||
| /** | ||
| * Test class for [MavenHelper]. | ||
| * | ||
| * @author tangcent | ||
| * @date 2024/08/11 | ||
| */ | ||
| class MavenHelperTest : PluginContextLightCodeInsightFixtureTestCase() { | ||
|
|
||
| private lateinit var userCtrlPsiClass: PsiClass | ||
|
|
||
| override fun beforeBind() { | ||
| super.beforeBind() | ||
| userCtrlPsiClass = loadClass("api/UserCtrl.java")!! | ||
| } | ||
|
|
||
| fun testGetMavenIdByMaven() { | ||
| mockStatic(MavenProjectsManager::class.java).use { mavenProjectsManagerMock -> | ||
| val mavenProject = mock<MavenProject> { | ||
| on(it.mavenId) | ||
| .thenReturn(MavenId("com.itangcent", "intellij-idea-test", "1.0.0")) | ||
| } | ||
| val mavenProjectsManager = mock<MavenProjectsManager> { | ||
| on(it.findProject(any<Module>())) | ||
| .thenReturn(mavenProject) | ||
| } | ||
|
|
||
| mavenProjectsManagerMock.`when`<MavenProjectsManager> { | ||
| MavenProjectsManager.getInstance(project) | ||
| }.thenReturn(mavenProjectsManager) | ||
|
|
||
| val mavenId = MavenHelper.getMavenId(userCtrlPsiClass) | ||
|
|
||
| assertNotNull(mavenId) | ||
| assertEquals("com.itangcent", mavenId!!.groupId) | ||
| assertEquals("intellij-idea-test", mavenId.artifactId) | ||
| assertEquals("1.0.0", mavenId.version) | ||
| } | ||
| } | ||
|
|
||
| fun testGetMavenIdByGradle() { | ||
| mockStatic(ExternalProjectDataCache::class.java).use { externalProjectDataCacheMock -> | ||
| val externalProject = mock<ExternalProject> { | ||
| on(it.name) | ||
| .thenReturn("intellij-idea-test") | ||
| on(it.group) | ||
| .thenReturn("com.itangcent") | ||
| on(it.version) | ||
| .thenReturn("1.0.0") | ||
| } | ||
| val externalProjectDataCache = mock<ExternalProjectDataCache> { | ||
| on(it.getRootExternalProject(any())) | ||
| .thenReturn(externalProject) | ||
| } | ||
|
|
||
| externalProjectDataCacheMock.`when`<ExternalProjectDataCache> { | ||
| ExternalProjectDataCache.getInstance(project) | ||
| }.thenReturn(externalProjectDataCache) | ||
|
|
||
| val mavenIdData = MavenHelper.getMavenId(userCtrlPsiClass) | ||
|
|
||
| assertNotNull(mavenIdData) | ||
| assertEquals("com.itangcent", mavenIdData!!.groupId) | ||
| assertEquals("intellij-idea-test", mavenIdData.artifactId) | ||
| assertEquals("1.0.0", mavenIdData.version) | ||
| } | ||
| } | ||
|
|
||
| fun testMavenIdData() { | ||
| val mavenIdData = MavenIdData("com.itangcent", "intellij-idea-test", "1.0.0") | ||
| assertEquals("com.itangcent", mavenIdData.groupId) | ||
| assertEquals("intellij-idea-test", mavenIdData.artifactId) | ||
| assertEquals("1.0.0", mavenIdData.version) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| <dependency> | ||
| <groupId>com.itangcent</groupId> | ||
| <artifactId>intellij-idea-test</artifactId> | ||
| <version>1.0.0</version> | ||
| </dependency> | ||
| """.trimIndent(), mavenIdData.maven() | ||
| ) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| implementation group: 'com.itangcent', name: 'intellij-idea-test', version: '1.0.0' | ||
| """.trimIndent(), mavenIdData.gradle() | ||
| ) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| implementation 'com.itangcent:intellij-idea-test:1.0.0' | ||
| """.trimIndent(), mavenIdData.gradleShort() | ||
| ) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| implementation("com.itangcent:intellij-idea-test:1.0.0") | ||
| """.trimIndent(), mavenIdData.gradleKotlin() | ||
| ) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| <dependency org="com.itangcent" name="intellij-idea-test" rev="1.0.0" /> | ||
| """.trimIndent(), mavenIdData.ivy() | ||
| ) | ||
|
|
||
| assertEquals( | ||
| """ | ||
| libraryDependencies += "com.itangcent" % "intellij-idea-test" % "1.0.0" | ||
| """.trimIndent(), mavenIdData.sbt() | ||
| ) | ||
|
|
||
| assertEquals("com.itangcent:intellij-idea-test:1.0.0", mavenIdData.toString()) | ||
| ETHUtils.testCETH(mavenIdData) { MavenIdData("com.itangcent", "intellij-idea-test", "1.0.0") } | ||
| } | ||
| } |