org.openrewrite.java.spring.http.ReplaceStringLiteralsWithHttpHeadersConstants Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rewrite-spring Show documentation
Eliminate legacy Spring patterns and migrate between major Spring Boot versions. Automatically.
There is a newer version: 5.19.0
/*
 * 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.java.spring.http;

import org.openrewrite.*;
import org.openrewrite.internal.lang.Nullable;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.ReplaceStringLiteralWithConstant;
import org.openrewrite.java.tree.J;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;

import static org.openrewrite.java.spring.http.ReplaceStringLiteralsWithMediaTypeConstants.declaresSpringWebDependency;

public class ReplaceStringLiteralsWithHttpHeadersConstants extends ScanningRecipe {

    private static final List MEDIA_TYPES = Arrays.asList(
            "ALL_VALUE",
            "APPLICATION_ATOM_XML_VALUE",
            "APPLICATION_CBOR_VALUE",
            "APPLICATION_FORM_URLENCODED_VALUE",
            "APPLICATION_GRAPHQL_VALUE",
            "APPLICATION_GRAPHQL_RESPONSE_VALUE",
            "APPLICATION_JSON_VALUE",
            "APPLICATION_JSON_UTF8_VALUE",
            "APPLICATION_OCTET_STREAM_VALUE",
            "APPLICATION_PDF_VALUE",
            "APPLICATION_PROBLEM_JSON_VALUE",
            "APPLICATION_PROBLEM_JSON_UTF8_VALUE",
            "APPLICATION_PROBLEM_XML_VALUE",
            "APPLICATION_PROTOBUF_VALUE",
            "APPLICATION_RSS_XML_VALUE",
            "APPLICATION_NDJSON_VALUE",
            "APPLICATION_STREAM_JSON_VALUE",
            "APPLICATION_XHTML_XML_VALUE",
            "APPLICATION_XML_VALUE",
            "IMAGE_GIF_VALUE",
            "IMAGE_JPEG_VALUE",
            "IMAGE_PNG_VALUE",
            "MULTIPART_FORM_DATA_VALUE",
            "MULTIPART_MIXED_VALUE",
            "MULTIPART_RELATED_VALUE",
            "TEXT_EVENT_STREAM_VALUE",
            "TEXT_HTML_VALUE",
            "TEXT_MARKDOWN_VALUE",
            "TEXT_PLAIN_VALUE",
            "TEXT_XML_VALUE");

    @Override
    public String getDisplayName() {
        return "Replace String literals with `MediaType` constants";
    }

    @Override
    public String getDescription() {
        return "Replace String literals with `org.springframework.http.MediaType` constants.";
    }

    @Override
    public AtomicBoolean getInitialValue(ExecutionContext ctx) {
        return new AtomicBoolean(false);
    }

    @Override
    public TreeVisitor getScanner(AtomicBoolean acc) {
        return new TreeVisitor() {
            @Override
            public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
                if (!acc.get() && tree instanceof SourceFile) {
                    acc.set(declaresSpringWebDependency((SourceFile) tree, ctx));
                }
                return tree;
            }
        };
    }

    @Override
    public TreeVisitor getVisitor(AtomicBoolean acc) {
        return Preconditions.check(acc.get(), new JavaIsoVisitor() {
            @Override
            public J preVisit(J tree, ExecutionContext ctx) {
                stopAfterPreVisit();
                for (String mediaType : MEDIA_TYPES) {
                    try {
                        doAfterVisit(new ReplaceStringLiteralWithConstant("org.springframework.http.MediaType." + mediaType).getVisitor());
                    } catch (IllegalArgumentException ignore) {
                        // this is typically a NoSuchFieldException when an older version of Spring is used
                    }
                }
                return tree;
            }
        });
    }
}