org.openrewrite.maven.AddProfile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-maven Show documentation
Eliminate tech-debt. Automatically.
There is a newer version: 8.40.3
/*
 * Copyright 2023 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.Value;
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.RemoveContentVisitor;
import org.openrewrite.xml.XPathMatcher;
import org.openrewrite.xml.tree.Xml;

import java.util.Optional;

@Value
@EqualsAndHashCode(callSuper = false)
public class AddProfile extends Recipe {
    private static final XPathMatcher PROJECT_MATCHER = new XPathMatcher("/project");

    @Option(displayName = "id",
            description = "The profile id.",
            example = "default")
    String id;

    @Option(displayName = "Activation",
            description = "activation details of a maven profile, provided as raw XML.",
            example = "foo",
            required = false)
    @Nullable
    String activation;

    @Option(displayName = "Properties",
            description = "properties of a maven profile, provided as raw XML.",
            example = "foobar",
            required = false)
    @Nullable
    String properties;

    @Option(displayName = "build",
            description = "build details of a maven profile, provided as raw XML.",
            example = "foo",
            required = false)
    @Nullable
    String build;

    @Override
    public String getDisplayName() {
        return "Add Maven profile";
    }

    @Override
    public String getDescription() {
        return "Add a maven profile to a `pom.xml` file.";
    }

    @Override
    public TreeVisitor getVisitor() {
        return new AddProfile.AddProfileVisitor();
    }

    private class AddProfileVisitor extends MavenIsoVisitor {

        @Override
        public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext ctx) {
            Xml.Tag t = super.visitTag(tag, ctx);

            if (PROJECT_MATCHER.matches(getCursor())) {
                Optional maybeProfiles = t.getChild("profiles");
                Xml.Tag profiles;
                if (maybeProfiles.isPresent()) {
                    profiles = maybeProfiles.get();
                } else {
                    t = (Xml.Tag) new AddToTagVisitor<>(t, Xml.Tag.build("")).visitNonNull(t, ctx, getCursor().getParentOrThrow());
                    //noinspection OptionalGetWithoutIsPresent
                    profiles = t.getChild("profiles").get();
                }

                Optional maybeProfile = profiles.getChildren().stream()
                        .filter(profile ->
                                profile.getChildValue("id").get().equals(id)
                        )
                        .findAny();

                if (maybeProfile.isPresent()) {
                    Xml.Tag profile = maybeProfile.get();

                    t = (Xml.Tag) new RemoveContentVisitor(profile, false).visitNonNull(t, ctx, getCursor().getParentOrThrow());

                }
                Xml.Tag profileTag = Xml.Tag.build("\n" +
                                                   "" + id + "\n" +
                                                   (activation != null ? activation.trim() + "\n" : "") +
                                                   (properties != null ? properties.trim() + "\n" : "") +
                                                   (build != null ? build.trim() + "\n" : "") +
                                                   "");
                t = (Xml.Tag) new AddToTagVisitor<>(profiles, profileTag).visitNonNull(t, ctx, getCursor().getParentOrThrow());

            }

            return t;
        }
    }
}