org.openrewrite.maven.utilities.RetainVersions Maven / Gradle / Ivy
Show all versions of rewrite-maven Show documentation
/*
* Copyright 2022 the original author or authors.
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* 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.maven.utilities;
import org.openrewrite.Recipe;
import org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId;
import org.openrewrite.maven.MavenVisitor;
import org.openrewrite.maven.search.FindDependency;
import org.openrewrite.maven.tree.ResolvedManagedDependency;
import org.openrewrite.xml.tree.Xml;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.function.Predicate;
public class RetainVersions {
/**
* Returns a list of recipes which can be applied to add explicit versions
* for dependencies matching the GAVs in param `retainVersions`
*/
public static List plan(MavenVisitor visitor, List retainVersions) {
List recipes = new ArrayList<>();
for (String gav : retainVersions) {
String[] split = gav.split(":");
String requestedRetainedGroupId = split[0];
String requestedRetainedArtifactId = split[1];
String requestedRetainedVersion = split.length == 3 ? split[2] : null;
Set existingDependencies = FindDependency.find(
visitor.getCursor().firstEnclosingOrThrow(Xml.Document.class),
requestedRetainedGroupId, requestedRetainedArtifactId);
// optimization for glob GAVs: more efficient to use one CDGIAAI recipe if they all will have the same version anyway
if (requestedRetainedVersion != null && noneMatch(existingDependencies, it -> it.getChild("version").isPresent())) {
recipes.add(new ChangeDependencyGroupIdAndArtifactId(requestedRetainedGroupId, requestedRetainedArtifactId, null, null,
requestedRetainedVersion, null, true, true));
continue;
}
for (Xml.Tag existingDependency : existingDependencies) {
String retainedGroupId = existingDependency.getChildValue("groupId")
.orElseThrow(() -> new IllegalStateException("Dependency tag must have groupId"));
String retainedArtifactId = existingDependency.getChildValue("artifactId")
.orElseThrow(() -> new IllegalStateException("Dependency tag must have artifactId"));
String retainedVersion = requestedRetainedVersion;
if (retainedVersion == null) {
if (existingDependency.getChildValue("version").isPresent()) {
continue;
} else {
ResolvedManagedDependency managedDependency = visitor.findManagedDependency(
retainedGroupId, retainedArtifactId);
retainedVersion = Objects.requireNonNull(managedDependency, String.format(
"'%s' from 'retainVersions' did not have a version specified and was not in the project's dependency management",
gav)).getVersion();
}
}
recipes.add(new ChangeDependencyGroupIdAndArtifactId(retainedGroupId, retainedArtifactId, null, null,
retainedVersion, null, true, true));
}
}
return recipes;
}
private static boolean noneMatch(Set existingDependencies, Predicate predicate) {
for (T existingDependency : existingDependencies) {
if (predicate.test(existingDependency)) {
return false;
}
}
return true;
}
}