Implement ReduceToCompileOnlyApi based on Attribute, not variant names

Author: britter

src/main/java/org/gradlex/jvm/dependency/conflict/resolution/rules/ReduceToCompileOnlyApiDependencyMetadataRule.java

@@ -16,17 +16,24 @@
 
 package org.gradlex.jvm.dependency.conflict.resolution.rules;
 
+import org.gradle.api.Action;
 import org.gradle.api.artifacts.CacheableRule;
 import org.gradle.api.artifacts.ComponentMetadataContext;
+import org.gradle.api.artifacts.ComponentMetadataDetails;
 import org.gradle.api.artifacts.ComponentMetadataRule;
+import org.gradle.api.artifacts.VariantMetadata;
+import org.gradle.api.attributes.Attribute;
+import org.gradle.api.attributes.Category;
+import org.gradle.api.attributes.Usage;
 
 import javax.inject.Inject;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 /**
  * See:
  * <a href="https://docs.gradle.org/current/userguide/component_metadata_rules.html#fixing_wrong_dependency_details">
- *     component_metadata_rules.html#fixing_wrong_dependency_details</a>
+ * component_metadata_rules.html#fixing_wrong_dependency_details</a>
  */
 @CacheableRule
 public abstract class ReduceToCompileOnlyApiDependencyMetadataRule implements ComponentMetadataRule {
@@ -40,7 +47,18 @@ public ReduceToCompileOnlyApiDependencyMetadataRule(String dependency) {
 
     @Override
     public void execute(ComponentMetadataContext context) {
-        context.getDetails().withVariant("runtime", v -> v.withDependencies(d -> d.removeAll(d.stream().filter(it -> dependency.equals(it.getModule().toString())).collect(Collectors.toList())))); // .pom
-        context.getDetails().withVariant("runtimeElements", v -> v.withDependencies(d -> d.removeAll(d.stream().filter(it -> dependency.equals(it.getModule().toString())).collect(Collectors.toList())))); // .module
+        withVariants(context.getDetails(), Usage.JAVA_RUNTIME, v -> v.withDependencies(d -> d.removeAll(d.stream().filter(it -> dependency.equals(it.getModule().toString())).collect(Collectors.toList()))));
+    }
+
+    private void withVariants(ComponentMetadataDetails details, String expectedUsage, Action<VariantMetadata> action) {
+        details.allVariants(v -> {
+            v.attributes(attributeContainer -> {
+                String usage = attributeContainer.getAttributes().getAttribute(Attribute.of(Usage.USAGE_ATTRIBUTE.getName(), String.class));
+                String category = attributeContainer.getAttributes().getAttribute(Attribute.of(Category.CATEGORY_ATTRIBUTE.getName(), String.class));
+                if (Objects.equals(usage, expectedUsage) && Objects.equals(category, Category.LIBRARY)) {
+                    action.execute(v);
+                }
+            });
+        });
     }
 }

src/test/groovy/org/gradlex/jvm/dependency/conflict/test/patch/ModifyDependenciesTest.groovy

@@ -4,15 +4,18 @@ import org.gradlex.jvm.dependency.conflict.test.fixture.GradleBuild
 
 class ModifyDependenciesTest extends AbstractPatchTest {
 
-    def "can remove dependencies"() {
-        given:
+    def setup() {
         if (GradleBuild.GRADLE6_TEST) {
             buildFile << """
-                configurations.compileClasspath {
+                configurations.configureEach {
                     attributes.attribute(Attribute.of("org.gradle.jvm.environment", String::class.java), "standard-jvm")
                 }
             """
         }
+    }
+
+    def "can remove dependencies"() {
+        given:
         buildFile << """
             jvmDependencyConflicts {
                 patch {
@@ -67,7 +70,7 @@ runtimeClasspath - Runtime classpath of source set 'main'.
 '''
     }
 
-    def "can reduce dependency scope to compile only"() {
+    def "can reduce dependency scope to compile only for standard variants"() {
         given:
         buildFile << """
             jvmDependencyConflicts {
@@ -93,6 +96,41 @@ compileClasspath - Compile classpath for source set 'main'.
 runtimeClasspath - Runtime classpath of source set 'main'.
 \\--- org.apache.commons:commons-text:1.11.0
 
+'''
+    }
+
+    def "can reduce dependency scope to compile only for non-standard variants"() {
+        given:
+        buildFile << """
+            jvmDependencyConflicts {
+                patch {
+                    module("com.google.guava:guava") {
+                       reduceToCompileOnlyApiDependency("com.google.errorprone:error_prone_annotations")
+                       reduceToCompileOnlyApiDependency("org.jspecify:jspecify")
+                       reduceToCompileOnlyApiDependency("com.google.j2objc:j2objc-annotations")
+                    }
+                }
+            }
+            dependencies {
+                implementation("com.google.guava:guava:33.4.8-jre")
+            }
+        """
+
+        expect: 'All dependencies are present on the compile classpath'
+        dependenciesCompile().output.contains '''
+compileClasspath - Compile classpath for source set 'main'.
+\\--- com.google.guava:guava:33.4.8-jre
+     +--- com.google.guava:failureaccess:1.0.3
+     +--- org.jspecify:jspecify:1.0.0
+     +--- com.google.errorprone:error_prone_annotations:2.36.0
+     \\--- com.google.j2objc:j2objc-annotations:3.0.0
+'''
+
+        and: 'Annotation libraries are not present on the runtime classpath'
+        dependenciesRuntime().output.contains '''
+runtimeClasspath - Runtime classpath of source set 'main'.
+\\--- com.google.guava:guava:33.4.8-jre
+     \\--- com.google.guava:failureaccess:1.0.3
 '''
     }