Add dependency support for gradle

rewrite-gradle/build.gradle.kts

@@ -52,6 +52,7 @@ dependencies {
     testRuntimeOnly("org.gradle:gradle-testing-jvm:latest.release")
     testRuntimeOnly("com.gradle:gradle-enterprise-gradle-plugin:latest.release")
     testRuntimeOnly(project(":rewrite-java-17"))
+    testRuntimeOnly("org.projectlombok:lombok:latest.release")
 }
 
 tasks.withType<ShadowJar> {

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

@@ -0,0 +1,220 @@
+/*
+ * Copyright 2022 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.gradle;
+
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+import org.openrewrite.*;
+import org.openrewrite.gradle.util.Dependency;
+import org.openrewrite.gradle.util.DependencyStringNotationConverter;
+import org.openrewrite.groovy.GroovyIsoVisitor;
+import org.openrewrite.groovy.tree.G;
+import org.openrewrite.internal.ListUtils;
+import org.openrewrite.internal.lang.Nullable;
+import org.openrewrite.java.MethodMatcher;
+import org.openrewrite.java.marker.JavaProject;
+import org.openrewrite.java.marker.JavaSourceSet;
+import org.openrewrite.java.search.UsesType;
+import org.openrewrite.java.tree.Expression;
+import org.openrewrite.java.tree.J;
+import org.openrewrite.semver.Semver;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+@Value
+@EqualsAndHashCode(callSuper = true)
+public class AddDependency extends Recipe {
+    @Option(displayName = "Group",
+            description = "The first part of a dependency coordinate 'com.google.guava:guava:VERSION'.",
+            example = "com.google.guava")
+    String groupId;
+
+    @Option(displayName = "Artifact",
+            description = "The second part of a dependency coordinate 'com.google.guava:guava:VERSION'",
+            example = "guava")
+    String artifactId;
+
+    @Option(displayName = "Version",
+            description = "An exact version number or node-style semver selector used to select the version number.",
+            example = "29.X")
+    String version;
+
+    @Option(displayName = "Version pattern",
+            description = "Allows version selection to be extended beyond the original Node Semver semantics. So for example, " +
+                    "Setting 'version' to \"25-29\" can be paired with a metadata pattern of \"-jre\" to select Guava 29.0-jre",
+            example = "-jre",
+            required = false)
+    @Nullable
+    String versionPattern;
+
+    @Option(displayName = "Configuration",
+            description = "A configuration to use when it is not what can be inferred from usage. Most of the time this will be left empty, but " +
+                    "is used when adding a new as of yet unused dependency.",
+            example = "implementation",
+            required = false)
+    @Nullable
+    String configuration;
+
+    @Option(displayName = "Only if using",
+            description = "Used to determine if the dependency will be added and in which scope it should be placed.",
+            example = "org.junit.jupiter.api.*")
+    String onlyIfUsing;
+
+    @Option(displayName = "Classifier",
+            description = "A Maven classifier to add. Mostly commonly used to select shaded to test variants of a library.",
+            example = "test",
+            required = false)
+    @Nullable
+    String classifier;
+
+    @Option(displayName = "Extension",
+            description = "The extension of the dependency to add. If omitted Gradle defaults to assuming the type is \"jar\".",
+            example = "jar",
+            required = false)
+    @Nullable
+    String extension;
+
+    @Option(displayName = "Family pattern",
+            description = "A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. " +
+                    "Accepts '*' as a wildcard character.",
+            example = "com.fasterxml.jackson*",
+            required = false)
+    @Nullable
+    String familyPattern;
+
+    static final String DEPENDENCY_PRESENT = "org.openrewrite.gradle.AddDependency.DEPENDENCY_PRESENT";
+
+    @Override
+    public String getDisplayName() {
+        return "Add Gradle dependency";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Add a gradle dependency to a `build.gradle` file in the correct configuration based on where it is used.";
+    }
+
+    @Override
+    public Validated validate() {
+        Validated validated = super.validate();
+        if (version != null) {
+            validated = validated.or(Semver.validate(version, versionPattern));
+        }
+        return validated;
+    }
+
+    @Override
+    protected TreeVisitor<?, ExecutionContext> getApplicableTest() {
+        if (onlyIfUsing == null) {
+            return null;
+        }
+
+        return new UsesType<>(onlyIfUsing);
+    }
+
+    @Override
+    protected List<SourceFile> visit(List<SourceFile> before, ExecutionContext ctx) {
+        Map<JavaProject, String> configurationByProject = new HashMap<>();
+        for (SourceFile source : before) {
+            source.getMarkers().findFirst(JavaProject.class).ifPresent(javaProject ->
+                    source.getMarkers().findFirst(JavaSourceSet.class).ifPresent(sourceSet -> {
+                        if (source != new UsesType<>(onlyIfUsing).visit(source, ctx)) {
+                            configurationByProject.compute(javaProject, (jp, configuration) -> "implementation".equals(configuration) ?
+                                    configuration :
+                                    "test".equals(sourceSet.getName()) ? "testImplementation" : "implementation"
+                            );
+                        }
+                    }));
+        }
+
+        if (configurationByProject.isEmpty()) {
+            return before;
+        }
+
+        MethodMatcher dependencyDslMatcher = new MethodMatcher("DependencyHandlerSpec *(..)");
+        Pattern familyPatternCompiled = familyPattern == null ? null : Pattern.compile(familyPattern.replace("*", ".*"));
+
+        return ListUtils.map(before, s -> s.getMarkers().findFirst(JavaProject.class)
+                .map(javaProject -> (Tree) new GroovyIsoVisitor<ExecutionContext>() {
+                    @Override
+                    public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext executionContext) {
+                        J.MethodInvocation m = super.visitMethodInvocation(method, executionContext);
+                        if (dependencyDslMatcher.matches(m) && (configuration == null || configuration.equals(m.getSimpleName()))) {
+                            if (m.getArguments().get(0) instanceof J.Literal) {
+                                Dependency dependency = new DependencyStringNotationConverter().parse((String) ((J.Literal) m.getArguments().get(0)).getValue());
+                                if (groupId.equals(dependency.getGroupId()) && artifactId.equals(dependency.getArtifactId())) {
+                                    getCursor().putMessageOnFirstEnclosing(G.CompilationUnit.class, DEPENDENCY_PRESENT, true);
+                                }
+                            } else if (m.getArguments().get(0) instanceof G.MapEntry) {
+                                G.MapEntry groupEntry = null;
+                                G.MapEntry artifactEntry = null;
+
+                                for (Expression e : m.getArguments()) {
+                                    if (!(e instanceof G.MapEntry)) {
+                                        continue;
+                                    }
+                                    G.MapEntry arg = (G.MapEntry) e;
+                                    if (!(arg.getKey() instanceof J.Literal) || !(arg.getValue() instanceof J.Literal)) {
+                                        continue;
+                                    }
+                                    J.Literal key = (J.Literal) arg.getKey();
+                                    J.Literal value = (J.Literal) arg.getValue();
+                                    if (!(key.getValue() instanceof String) || !(value.getValue() instanceof String)) {
+                                        continue;
+                                    }
+                                    if ("group".equals(key.getValue())) {
+                                        groupEntry = arg;
+                                    } else if ("name".equals(key.getValue())) {
+                                        artifactEntry = arg;
+                                    }
+                                }
+
+                                if (groupEntry == null || artifactEntry == null) {
+                                    return m;
+                                }
+
+                                if (groupId.equals(((J.Literal) groupEntry.getValue()).getValue())
+                                        && artifactId.equals(((J.Literal) artifactEntry.getValue()).getValue())) {
+                                    getCursor().putMessageOnFirstEnclosing(G.CompilationUnit.class, DEPENDENCY_PRESENT, true);
+                                }
+                            }
+                        }
+
+                        return m;
+                    }
+
+                    @Override
+                    public G.CompilationUnit visitCompilationUnit(G.CompilationUnit cu, ExecutionContext executionContext) {
+                        G.CompilationUnit g = super.visitCompilationUnit(cu, executionContext);
+
+                        if (getCursor().getMessage(DEPENDENCY_PRESENT, false)) {
+                            return g;
+                        }
+
+                        String resolvedConfiguration = configuration == null ? configurationByProject.get(javaProject) : configuration;
+
+                        return (G.CompilationUnit) new AddDependencyVisitor(groupId, artifactId, version, versionPattern, resolvedConfiguration,
+                                classifier, extension, familyPatternCompiled).visitNonNull(g, ctx);
+                    }
+                }.visit(s, ctx))
+                .map(SourceFile.class::cast)
+                .orElse(s)
+        );
+    }
+}