Gradle dependency management refactoring #6139

sambsnyd · 2025-10-15T05:55:48Z

Gradle dependency declarations can take many forms. To list a subset of the variations:

dependencies {
        // Single-quoted and double quoted literal strings, with and without parentheses
    implementation 'com.google.guava:guava:29.0-jre'
    implementation "com.google.guava:guava:29.0-jre"
    compileOnly('com.google.guava:guava:29.0-jre')
    runtimeOnly("com.google.guava:guava:29.0-jre")


    // Map notation without parentheses
    implementation group: "com.google.guava", name: "guava", version: '29.0-jre'
    implementation(group: "com.google.guava", name: "guava", version: '29.0-jre')

    // interpolated
    def guavaVersion = '29.0-jre'
    implementation "com.google.guava:guava:$guavaVersion"
    implementation "com.google.guava:guava:${guavaVersion}"
    implementation group: "com.google.guava", name: "guava", version: guavaVersion
    implementation group: "com.google.guava", name: "guava", version: "$guavaVersion"
    implementation group: "com.google.guava", name: "guava", version: "${guavaVersion}"

    // Via project properties or ext properties
    implementation "com.google.guava:guava:${property('guavaVersion')}"
    implementation "com.google.guava:guava:${project.property('guavaVersion')}"n
    implementation "com.google.guava:guava:${project.findProperty('guavaVersion')}"
    implementation "com.google.guava:guava:${project.properties['guavaVersion']}"

    // Concatenation
    implementation 'com.google.guava:guava:' + guavaVersion

    // Multiple dependencies in single call (varargs, groovy only)
    implementation(
        'com.google.guava:guava-gwt:29.0-jre',
        'com.google.guava:guava:29.0-jre'
    )

    // platform() or enforcedPlatform() 
    implementation platform("com.google.guava:guava:29.0-jre")

    // version declared in platform/BOM, dependency substitution rule, etc.
    implementation("com.google.guava:guava")
}

The logic to handle these different syntax is scattered around the various dependency management recipes, which each of them covering incompletely-overlapping subsets.
This PR centralizes this syntactical knowledge into the GradleDependency trait and the GradleMultiDependency trait.

GradleDependency should now be a one-stop-shop for reading and refactoring dependency declarations of all kinds.
GradleMultiDependency exists only to abstract away the groovy-specific varargs version of a dependency declaration. This is necessary

Not every recipe has been updated to fully take advantage of this, but this PR is sprawling enough as-is.

Other enhancements include:

StringUtils.matchesGlob() no longer requires a null check to get the most commonly desired behavior
Remove need for org.openrewrite.gradle.internal.Dependency and its parser separate from org.openrewrite.maven.Dependency
Adoption of trait has slimmed a substantial number of lines from RemoveRedundantDependencyVersion and UpgradeDependencyVersion

…itself

- Refactored updateDependency() to accept GradleDependency parameter - Added getConfigurationName() method to GradleDependency trait - Fixed platform dependency handling in getPlatformDependency() - Updated scanner to use trait's getConfigurationName() method - Added varargs support attempt (not working yet) Current status: 71/75 tests passing (94.7%) Failing tests: - varargsDependency - leaveConstraintsAlone - mapNotationKStringTemplateInterpolation (2 variants)

- Added scanVarargsDependencies() to properly scan all literal dependencies in varargs calls - Added updateVarargsDependencies() to handle updating multiple dependencies in one call - The GradleDependency trait only processes first argument, so varargs need special handling - Varargs test now passes, but 3 other tests are failing and need investigation

- Created GradleMultiDependency trait to represent multiple dependencies in a single invocation - Uses synthetic J.MethodInvocation wrappers for each dependency - Provides map() method for clean functional transformation of dependencies - Refactored UpgradeDependencyVersion to use the new trait - Removed ad-hoc varargs handling code in favor of trait-based approach - Varargs test still passes, maintaining same 3 unrelated failing tests

- GradleMultiDependency now tracks groupId/artifactId filters from its Matcher - Added map(DependencyMatcher, mapper) method for explicit filtering - The trait only transforms dependencies that match the configured filters - This ensures selective updates when multiple dependencies are in one invocation - Added comprehensive tests to verify filtering behavior - Prevents unintended changes to non-matching dependencies in varargs

- Add support for K.StringTemplate in map notation (GradleDependency.getVersionVariable) Fixes mapNotationKStringTemplateInterpolation test - Skip upgrading dependencies without versions unless they are platform dependencies Prevents upgrading constraint-governed dependencies Fixes leaveConstraintsAlone test All 75 UpgradeDependencyVersionTest tests passing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

- Remove redundant regex check in UpgradeDependencyVersion scanning phase GradleDependency.getVersionVariable() already returns null for literal versions, so checking !declaredVersion.matches("^[\\d\\.].*") was unnecessary - Clean up scanDependency to use trait methods directly (getGroupId/getArtifactId) instead of getDeclaredGroupId/getDeclaredArtifactId - Simplify updateDependency to check declaredVersion == null instead of checking isPlatform() for constraint handling All 75 UpgradeDependencyVersionTest tests still passing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

…andler. Incidentally resolves an OOM I was getting running locally due to ClasspathScanningLoader. There has to be something we can do to not have classgraph use all the memory.

rewrite-gradle/src/main/java/org/openrewrite/gradle/ChangeDependencyArtifactId.java

rewrite-gradle/src/main/java/org/openrewrite/gradle/ChangeDependencyGroupId.java

github-actions · 2025-10-15T19:24:26Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/RemoveRedundantDependencyVersions.java

                        J.MethodInvocation m = super.visitMethodInvocation(method, ctx);
-
-                        Optional<GradleDependency> maybeGradleDependency = new GradleDependency.Matcher()
+                        m = GradleMultiDependency.matcher()


Suggested change

m = GradleMultiDependency.matcher()

return GradleMultiDependency.matcher()

github-actions · 2025-10-15T19:24:26Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+import java.util.Optional;
+import java.util.stream.Collectors;


Suggested change

import java.util.Optional;

import java.util.stream.Collectors;

import java.util.Optional;

github-actions · 2025-10-15T19:24:27Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+    @Nullable
+    private static String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {
+        if (mi.getSimpleName().equals("property") || mi.getSimpleName().equals("findProperty")) {


Suggested change

@Nullable

private static String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {

if (mi.getSimpleName().equals("property") || mi.getSimpleName().equals("findProperty")) {

private static @Nullable String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {

if ("property".equals(mi.getSimpleName()) || "findProperty".equals(mi.getSimpleName())) {

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleMultiDependency.java

github-actions · 2025-10-15T19:24:27Z

rewrite-gradle/src/test/java/org/openrewrite/gradle/GradleMultiDependencyFilterTest.java

+          )
+        );
+    }
+}


Suggested change

}

}

rewrite-maven/src/test/java/org/openrewrite/maven/tree/DependencyTest.java

shanman190 · 2025-10-15T19:07:45Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+     * Helper method to extract a string value from various expression types.
+     * Handles literals, identifiers, field access, method invocations, and GStrings.
+     */
+    private @Nullable String extractValueAsString(Expression value) {


I'm a little worried about the prints contained in here for a couple of reasons:

Sustainability/Incorrect results

If a marker exists on one of these elements from a previous recipe, then the marker information will end up being printed here

shanman190 · 2025-10-15T19:12:36Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+            GradleDependencyConfiguration gdc = getConfiguration(gradleProject, methodInvocation);
+            if (gdc == null && !(DEPENDENCY_DSL_MATCHER.matches(methodInvocation) && !"project".equals(methodInvocation.getSimpleName()))) {
+                return null;
+            }


callout: We're already performing this same check within isDependencyDeclaration above.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-10-15T19:40:19Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/RemoveRedundantDependencyVersions.java

                        J.MethodInvocation m = super.visitMethodInvocation(method, ctx);
-
-                        Optional<GradleDependency> maybeGradleDependency = new GradleDependency.Matcher()
+                        m = GradleMultiDependency.matcher()


Suggested change

m = GradleMultiDependency.matcher()

return GradleMultiDependency.matcher()

github-actions · 2025-10-15T19:40:19Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+import java.util.Optional;
+import java.util.stream.Collectors;


Suggested change

import java.util.Optional;

import java.util.stream.Collectors;

import java.util.Optional;

github-actions · 2025-10-15T19:40:19Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+    @Nullable
+    private static String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {
+        if (mi.getSimpleName().equals("property") || mi.getSimpleName().equals("findProperty")) {


Suggested change

@Nullable

private static String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {

if (mi.getSimpleName().equals("property") || mi.getSimpleName().equals("findProperty")) {

private static @Nullable String extractPropertyNameFromMethodInvocation(J.MethodInvocation mi) {

if ("property".equals(mi.getSimpleName()) || "findProperty".equals(mi.getSimpleName())) {

github-actions · 2025-10-15T19:40:20Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+    @Nullable
+    private static String extractPropertyNameFromGBinary(G.Binary binary) {


Suggested change

@Nullable

private static String extractPropertyNameFromGBinary(G.Binary binary) {

private static @Nullable String extractPropertyNameFromGBinary(G.Binary binary) {

github-actions · 2025-10-15T19:40:20Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+                    ((G.MapLiteral) firstArg).getElements() : m.getArguments().stream()
+                    .filter(G.MapEntry.class::isInstance)
+                    .map(G.MapEntry.class::cast)
+                    .collect(Collectors.toList());


Suggested change

.collect(Collectors.toList());

.collect(toList());

github-actions · 2025-10-15T19:40:20Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+                    ((G.MapLiteral) firstArg).getElements() : m.getArguments().stream()
+                    .filter(G.MapEntry.class::isInstance)
+                    .map(G.MapEntry.class::cast)
+                    .collect(Collectors.toList());


Suggested change

.collect(Collectors.toList());

.collect(toList());

github-actions · 2025-10-15T19:40:20Z

rewrite-gradle/src/main/java/org/openrewrite/gradle/trait/GradleDependency.java

+                    m.getArguments().stream()
+                            .filter(G.MapEntry.class::isInstance)
+                            .map(G.MapEntry.class::cast)
+                            .collect(Collectors.toList());


Suggested change

.collect(Collectors.toList());

.collect(toList());

github-actions · 2025-10-15T19:40:20Z

rewrite-gradle/src/test/java/org/openrewrite/gradle/GradleMultiDependencyFilterTest.java

+          )
+        );
+    }
+}


Suggested change

}

}

sambsnyd requested a review from shanman190 October 15, 2025 05:55

github-project-automation bot added this to OpenRewrite Oct 15, 2025

github-project-automation bot moved this to In Progress in OpenRewrite Oct 15, 2025

sambsnyd and others added 16 commits October 15, 2025 12:19

Moving functionality into GradleDependency trait

f7fae91

Move DependencyStringNotationConverter functionality onto Dependency …

e12f4cd

…itself

Move DependencyStringNotationConverter functionality onto Dependency …

feae057

…itself

WIP

52c7825

WIP

2846dab

Remove now-unnecessary null checks before using StringUtils.matchesGlob

de4da35

Use trait to add support for kotlin gradle scripts to FindDependencyH…

f850edc

…andler. Incidentally resolves an OOM I was getting running locally due to ClasspathScanningLoader. There has to be something we can do to not have classgraph use all the memory.

Use trait for ChangeDependencyArtifactId and ChangeDependencyGroupId

7deb7d5

License

cdc0ee2

Match test expectation to updated behavior

069755b

sambsnyd force-pushed the dependency-refactoring branch from cc760b3 to 069755b Compare October 15, 2025 19:19

github-actions bot reviewed Oct 15, 2025

View reviewed changes

shanman190 approved these changes Oct 15, 2025

View reviewed changes

github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Oct 15, 2025

sambsnyd and others added 2 commits October 15, 2025 12:29

Apply suggestions from code review

936bb4a

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Fix code suggestion

df151a1

github-actions bot reviewed Oct 15, 2025

View reviewed changes

	m = GradleMultiDependency.matcher()
	return GradleMultiDependency.matcher()

		import java.util.Optional;
		import java.util.stream.Collectors;

+                        )
+                      );
+                  }
+              }

                
                    No newline at end of file

		@Nullable
		private static String extractPropertyNameFromGBinary(G.Binary binary) {

	@Nullable
	private static String extractPropertyNameFromGBinary(G.Binary binary) {
	private static @Nullable String extractPropertyNameFromGBinary(G.Binary binary) {

Gradle dependency management refactoring #6139

Are you sure you want to change the base?

Gradle dependency management refactoring #6139

Uh oh!

Conversation

sambsnyd commented Oct 15, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shanman190 Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

shanman190 Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants