org.openrewrite.maven.AddRepository 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;
import lombok.EqualsAndHashCode;
import lombok.RequiredArgsConstructor;
import lombok.Value;
import org.intellij.lang.annotations.Language;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Option;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.xml.AddToTagVisitor;
import org.openrewrite.xml.ChangeTagValueVisitor;
import org.openrewrite.xml.RemoveContentVisitor;
import org.openrewrite.xml.XPathMatcher;
import org.openrewrite.xml.tree.Xml;
import java.util.Objects;
import java.util.Optional;
@Value
@EqualsAndHashCode(callSuper = false)
public class AddRepository extends Recipe {
@Option(example = "repo-id", displayName = "Repository ID",
description = "A unique name to describe the repository.")
String id;
@Option(example = "http://myrepo.maven.com/repo", displayName = "Repository URL",
description = "The URL of the repository.")
String url;
@Option(example = "My Great Repo Name", required = false,
displayName = "Repository name",
description = "A display name for the repository.")
@Nullable
String repoName;
@Option(example = "default", required = false,
displayName = "Repository layout",
description = "The Maven layout of the repository.")
@Nullable
String layout;
@Option(required = false,
displayName = "Enable snapshots",
description = "Snapshots from the repository are available.")
@Nullable
Boolean snapshotsEnabled;
@Option(example = "warn", required = false,
displayName = "Snapshots checksum policy",
description = "Governs whether snapshots require checksums.")
@Nullable
String snapshotsChecksumPolicy;
@Option(example = "always", required = false,
displayName = "Snapshots update policy",
description = "The policy governing snapshot updating interval.")
@Nullable
String snapshotsUpdatePolicy;
@Option(required = false,
displayName = "Releases enabled",
description = "Releases from the repository are available")
@Nullable
Boolean releasesEnabled;
@Option(example = "fail", required = false,
displayName = "Releases checksum policy",
description = "Governs whether releases require checksums.")
@Nullable
String releasesChecksumPolicy;
@Option(example = "never", required = false,
displayName = "Releases update policy",
description = "The policy governing release updating interval.")
@Nullable
String releasesUpdatePolicy;
@Option(displayName = "Repository type",
description = "The type of repository to add.",
example = "Repository",
required = false)
@Nullable
Type type;
@RequiredArgsConstructor
public enum Type {
Repository("repository", "repositories"),
PluginRepository("pluginRepository", "pluginRepositories");
final String xmlTagSingle;
final String xmlTagPlural;
}
public Type getType() {
return type == null ? Type.Repository : type;
}
@Override
public String getDisplayName() {
return "Add repository";
}
@Override
public String getDescription() {
return "Adds a new Maven Repository or updates a matching repository.";
}
@Override
public TreeVisitor getVisitor() {
return new MavenIsoVisitor() {
private final XPathMatcher REPOS_MATCHER = new XPathMatcher("/project/" + getType().xmlTagPlural);
@Override
public Xml.Document visitDocument(Xml.Document document, ExecutionContext ctx) {
Xml.Tag root = document.getRoot();
if (!root.getChild(getType().xmlTagPlural).isPresent()) {
document = (Xml.Document) new AddToTagVisitor<>(root, Xml.Tag.build("<" + getType().xmlTagPlural + "/>"))
.visitNonNull(document, ctx, getCursor().getParentOrThrow());
}
return super.visitDocument(document, ctx);
}
@Override
public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext ctx) {
Xml.Tag repositories = super.visitTag(tag, ctx);
if (REPOS_MATCHER.matches(getCursor())) {
Optional maybeRepo = repositories.getChildren().stream()
.filter(repo ->
getType().xmlTagSingle.equals(repo.getName()) &&
(id.equals(repo.getChildValue("id").orElse(null)) || (isReleasesEqual(repo) && isSnapshotsEqual(repo))) &&
url.equals(repo.getChildValue("url").orElse(null))
)
.findAny();
if (maybeRepo.isPresent()) {
Xml.Tag repo = maybeRepo.get();
if (repoName != null && !Objects.equals(repoName, repo.getChildValue("name").orElse(null))) {
//noinspection OptionalGetWithoutIsPresent
repositories = (Xml.Tag) new ChangeTagValueVisitor<>(repo.getChild("name").get(), repoName)
.visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
}
if (repoName != null && layout != null && !Objects.equals(layout, repo.getChildValue("layout").orElse(null))) {
//noinspection OptionalGetWithoutIsPresent
repositories = (Xml.Tag) new ChangeTagValueVisitor<>(repo.getChild("layout").get(), repoName)
.visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
maybeUpdateModel();
}
if (!isReleasesEqual(repo)) {
Xml.Tag releases = repo.getChild("releases").orElse(null);
if (releases == null) {
repositories = (Xml.Tag) new AddToTagVisitor<>(repo, Xml.Tag.build(assembleReleases()))
.visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
} else {
repositories = (Xml.Tag) new RemoveContentVisitor<>(releases, true)
.visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
if (!isNoSnapshots()) {
repositories = (Xml.Tag) new AddToTagVisitor<>(repo, Xml.Tag.build(assembleReleases()))
.visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
}
}
maybeUpdateModel();
}
if (!isSnapshotsEqual(repo)) {
Xml.Tag snapshots = repo.getChild("snapshots").orElse(null);
if (snapshots == null) {
repositories = (Xml.Tag) new AddToTagVisitor<>(repo, Xml.Tag.build(assembleSnapshots())).visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
} else {
repositories = (Xml.Tag) new RemoveContentVisitor<>(snapshots, true).visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
if (!isNoSnapshots()) {
repositories = (Xml.Tag) new AddToTagVisitor<>(repo, Xml.Tag.build(assembleSnapshots())).visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
}
}
maybeUpdateModel();
}
} else {
@Language("xml")
String sb = "<" + getType().xmlTagSingle + ">\n" +
assembleTagWithValue("id", id) +
assembleTagWithValue("url", url) +
assembleTagWithValue("name", repoName) +
assembleTagWithValue("layout", layout) +
assembleReleases() +
assembleSnapshots() +
"\n";
Xml.Tag repoTag = Xml.Tag.build(sb);
repositories = (Xml.Tag) new AddToTagVisitor<>(repositories, repoTag).visitNonNull(repositories, ctx, getCursor().getParentOrThrow());
maybeUpdateModel();
}
}
return repositories;
}
};
}
private String assembleTagWithValue(String tag, @Nullable String value) {
StringBuilder sb = new StringBuilder();
if (value != null) {
sb.append("<");
sb.append(tag);
sb.append(">");
sb.append(value);
sb.append("\n");
}
return sb.toString();
}
private String assembleReleases() {
StringBuilder sb = new StringBuilder();
if (releasesUpdatePolicy != null || releasesEnabled != null || releasesChecksumPolicy != null) {
sb.append("");
if (releasesEnabled != null) {
sb.append(assembleTagWithValue("enabled", String.valueOf(releasesEnabled.booleanValue())));
}
if (releasesUpdatePolicy != null) {
sb.append(assembleTagWithValue("updatePolicy", releasesUpdatePolicy));
}
if (releasesChecksumPolicy != null) {
sb.append(assembleTagWithValue("checksumPolicy", releasesChecksumPolicy));
}
sb.append(" \n");
}
return sb.toString();
}
private String assembleSnapshots() {
StringBuilder sb = new StringBuilder();
if (snapshotsEnabled != null || snapshotsChecksumPolicy != null || snapshotsUpdatePolicy != null) {
sb.append("");
if (snapshotsEnabled != null) {
sb.append(assembleTagWithValue("enabled", String.valueOf(snapshotsEnabled.booleanValue())));
}
if (snapshotsUpdatePolicy != null) {
sb.append(assembleTagWithValue("updatePolicy", snapshotsUpdatePolicy));
}
if (snapshotsChecksumPolicy != null) {
sb.append(assembleTagWithValue("checksumPolicy", snapshotsChecksumPolicy));
}
sb.append(" \n");
}
return sb.toString();
}
private boolean isReleasesEqual(Xml.Tag repo) {
Xml.Tag releases = repo.getChild("releases").orElse(null);
if (releases == null) {
return isNoReleases();
} else {
return Objects.equals(releasesEnabled == null ? null : String.valueOf(releasesEnabled.booleanValue()), releases.getChildValue("enabled").orElse(null))
&& Objects.equals(releasesUpdatePolicy, releases.getChildValue("updatePolicy").orElse(null))
&& Objects.equals(releasesChecksumPolicy, releases.getChildValue("checksumPolicy").orElse(null));
}
}
private boolean isNoReleases() {
return releasesEnabled == null && releasesUpdatePolicy == null && releasesChecksumPolicy == null;
}
private boolean isSnapshotsEqual(Xml.Tag repo) {
Xml.Tag snapshots = repo.getChild("snapshots").orElse(null);
if (snapshots == null) {
return isNoSnapshots();
} else {
return Objects.equals(snapshotsEnabled == null ? null : String.valueOf(snapshotsEnabled.booleanValue()), snapshots.getChildValue("enabled").orElse(null))
&& Objects.equals(snapshotsUpdatePolicy, snapshots.getChildValue("updatePolicy").orElse(null))
&& Objects.equals(snapshotsChecksumPolicy, snapshots.getChildValue("checksumPolicy").orElse(null));
}
}
private boolean isNoSnapshots() {
return snapshotsEnabled == null && snapshotsUpdatePolicy == null && snapshotsChecksumPolicy == null;
}
}