org.openrewrite.xml.XsltTransformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-xml Show documentation
Eliminate tech-debt. Automatically.
There is a newer version: 8.40.2
/*
 * Copyright 2020 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.xml;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.intellij.lang.annotations.Language;
import org.openrewrite.*;
import org.openrewrite.internal.StringUtils;
import org.openrewrite.internal.lang.Nullable;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.Arrays;

import static java.util.Objects.requireNonNull;

@Value
@EqualsAndHashCode(callSuper = false)
@Incubating(since = "8.30.0")
public class XsltTransformation extends Recipe {

    @Nullable
    @Language("xml")
    @Option(displayName = "XSLT Configuration transformation",
            description = "The transformation to be applied.",
            example = "...",
            required = false)
    String xslt;

    @Nullable
    @Option(displayName = "XSLT Configuration transformation classpath resource",
            description = "Recipe transformation provided as a classpath resource.",
            example = "/changePlugin.xslt",
            required = false)
    String xsltResource;

    @Option(displayName = "File pattern",
            description = "A glob expression that can be used to constrain which directories or source files should be searched. " +
                          "Multiple patterns may be specified, separated by a semicolon `;`. " +
                          "If multiple patterns are supplied any of the patterns matching will be interpreted as a match.",
            example = "**/*.xml")
    String filePattern;

    @Override
    public String getDisplayName() {
        return "XSLT transformation";
    }

    @Override
    public String getDescription() {
        return "Apply the specified XSLT transformation on matching files. " +
               "Note that there are no format matching guarantees when running this recipe.";
    }

    @Override
    public TreeVisitor getVisitor() {
        TreeVisitor visitor = new XsltTransformationVisitor(loadResource(xslt, xsltResource));

        @SuppressWarnings("unchecked")
        TreeVisitor check = Preconditions.or(Arrays.stream(filePattern.split(";"))
                .map(FindSourceFiles::new)
                .map(FindSourceFiles::getVisitor)
                .toArray(TreeVisitor[]::new));

        return Preconditions.check(check, visitor);
    }

    @Override
    public Validated